Package com.jalios.jcms.caddy
Class PublicationCaddyHandler
java.lang.Object
com.jalios.jcms.context.JcmsContext
com.jalios.jcms.context.JcmsJspContext
com.jalios.jcms.handler.JcmsFormHandler
com.jalios.jcms.caddy.AbstractCaddyHandler<PublicationCaddyContext>
com.jalios.jcms.caddy.PublicationCaddyHandler
- All Implemented Interfaces:
JcmsConstants,JaliosConstants
This form handler process Publication Caddy Manager actions.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected TypeFieldEntryprotected TypeFieldEntryprotected TypeFieldEntryprotected TypeFieldEntryprotected TypeFieldEntryprotected TypeFieldEntryprotected TypeFieldEntryprotected TypeFieldEntryprotected TypeFieldEntryprotected TypeFieldEntryprotected TypeFieldEntryprotected TypeFieldEntryprotected TypeFieldEntryprotected TypeFieldEntryprotected TypeFieldEntryprotected TypeFieldEntryprotected TypeFieldEntryprotected TypeFieldEntryprotected TypeFieldEntryprotected TypeFieldEntryprotected TypeFieldEntryprotected TypeFieldEntryprotected Stringprotected TypeFieldEntryprotected String[]protected String[]protected TypeFieldEntryprotected TypeFieldEntryprotected TypeFieldEntryFields inherited from class com.jalios.jcms.caddy.AbstractCaddyHandler
messageOnSuccess, opClearCaddy, openTab, opPreview, opRemoveCaddy, PREVIOUS_TABFields inherited from class com.jalios.jcms.handler.JcmsFormHandler
contextMap, csrfValidationEnabled, editFieldSet, formStep, noRedirect, noSendRedirect, op, openTabId, opFinish, opNext, opPrevious, popupEdition, redirect, redirectOnClosePopup, workspaceForcedFields inherited from class com.jalios.jcms.context.JcmsJspContext
AJAX_REQUEST_ATTRIBUTES, BODY_HEADER, CSS_FOOTER, CSS_HEADER, cssboMap, cssfoMap, CUSTOM_HEADER, editIcon, HTTPEQUIV_HEADER, httpequivMap, HTTPNAME_HEADER, httpnameMap, initEditIcon, JAVASCRIPT_CODE_SET_ATTRIBUTE, JAVASCRIPT_MODULE_SET_ATTRIBUTE, JAVASCRIPT_SET_ATTRIBUTE, jsboSet, jsfoSet, out, pageContext, SHOW_EDIT_ICON, STYLE_HEADERFields inherited from class com.jalios.jcms.context.JcmsContext
browser, caddy, channel, inFO, initDone, initWorkspace, isAdmin, isAjaxRequest, isDBMember, isDebug, isDebugTemplatePath, isLogged, loggedMember, request, response, userCountry, userLang, userLocale, userZoneId, workspaceFields inherited from interface com.jalios.util.JaliosConstants
CRLF, MILLIS_IN_ONE_DAY, MILLIS_IN_ONE_HOUR, MILLIS_IN_ONE_MINUTE, MILLIS_IN_ONE_MONTH, MILLIS_IN_ONE_SECOND, MILLIS_IN_ONE_WEEK, MILLIS_IN_ONE_YEARFields inherited from interface com.jalios.jcms.JcmsConstants
ADATE_SEARCH, ADVANCED_TAB, AJAX_MODE_ATTR, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, CLASS_PROPERTY, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, COUNTRY_SPRITE, CS_TYPOLOGY_ROOT_CAT_VID, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DATA_DIRECTORY, DEFAULT_PHOTO_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, GENERATIONAL_STORE_DIRECTORY, GLYPH_ICON_PREFIX, ICON_ARCHIVE, ICON_ICON_PREFIX, ICON_LOCK, ICON_LOCK_STRONG, ICON_PREFIX_PROP, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, IS_IN_FRONT_OFFICE, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JCMS_TOASTR_COLLECTION, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LANG_SPRITE, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_CREATE_STR, OP_DEEP_COPY, OP_DEEP_COPY_STR, OP_DEEP_DELETE, OP_DEEP_DELETE_STR, OP_DELETE, OP_DELETE_STR, OP_MERGE, OP_MERGE_STR, OP_UPDATE, OP_UPDATE_STR, ORGANIZATION_ROOT_GROUP_PROP, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_PROP_PREFIX, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_PROP_PREFIX, PHOTO_LARGE_WIDTH, PHOTO_MINI, PHOTO_MINI_HEIGHT, PHOTO_MINI_PROP_PREFIX, PHOTO_MINI_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_PROP_PREFIX, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_PROP_PREFIX, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_PROP_PREFIX, PHOTO_TINY_WIDTH, PHOTO_XLARGE, PHOTO_XLARGE_HEIGHT, PHOTO_XLARGE_PROP_PREFIX, PHOTO_XLARGE_WIDTH, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, RAW_CONTENT_ICON_PREFIX, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SECURITY_LOG_FILE, SESSION_AUTHORIZED_FILENAMES_SET, SPRITE_ICON_PREFIX, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, SUCCESS_MSG, SVG_ICON_PREFIX, SVGINLINE_ICON_PREFIX, SVGSPRITE_ICON_PREFIX, TEMPLATE_TAB, THEME_DIR, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, TTCARD_MEDIA_HEIGHT, TTCARD_MEDIA_WIDTH, TYPES_ICON_ALT_PROP, TYPES_ICON_SUFFIX_PROP, TYPES_ICON_TITLE_PROP, TYPES_PREFIX_PROP, TYPES_THUMB_SUFFIX_PROP, TYPES_UNKNOWN_CLASS_PROP, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, UPLOAD_PERMISSION_COUNT_PROP_PREFIX, UPLOAD_PERMISSION_SIZE_PROP_PREFIX, URL_REGEXP, VID_LOGGED_MEMBER, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanCheck if all publication in the caddy are trashablebooleanCheck if all publication in the caddy are untrashableintintintString[]Group[]intintString[]booleanintintintintString[]longString[]Group[]Class<? extends Publication> Retrieve the mainlanguage common to all publication, if any.Class<? extends Publication> Retrieve the common super class of all publicaiton in the caddybooleanRetrieve the tracked value common to all publication, this getter is only valid ifisCommonTrackedAvailable()is true.Retrieve the type of data being handled by this handlerbooleanCheck whether friendly URL should be automatically generated from publication's category and title.protected StringgetJsp()Retrieve the path of the JSP.protected PublicationCaddyContextgetNewCaddyContext(Caddy caddy, Member member) Retrieve a new instance of CaddyContext.protected AbstractCaddyProcess<PublicationCaddyContext> Retrieve a new instance of CaddyProcess to start action when required.booleanGet the value of noAdate.booleanGets the value of noCategorybooleanGets the value of noCommonCategorybooleanGet the value of noEdate.booleanGet the value of noPdate.booleanGet the value of noReadRight.booleanGet the value of noUpdateRight.intGet the value of pstatus.booleanCheck if friendly url will be removed during update.String[]Retrieve the templates value that were asked to be set for publication.intintintintbooleanCheck if a common tracked value was found for all publication of the caddybooleanisExpanded(Category cat, String inputName) Check if the specified category has been expanded in the treecatbooleanisPortal()Check if all publication in the caddy arePortal.booleanCheck if all publication in the caddy arePortalElement.booleanCheck if all publication in the caddy arePortlet.booleanCheck if all publication in the caddy arePortletSkinable.booleanCheck if publication in the caddy are of same class.booleanCheck if publication in the caddy use the same Workflow.booleanMethod to be implemented to check/validate action to be performed and process them.voidsetAbilities(String[] abilities) voidSet the value of adate.voidvoidsetAlignTable(String[] v) voidvoidvoidvoidsetAuthorizedGroupsAddCount(int v) voidsetAuthorizedMemberIds(String[] mbrIds) Set the value of authorizedMemberIds.voidvoidsetBackColor(String[] v) voidsetBackImage(String[] v) voidsetBehaviorCopy(String[] v) voidvoidsetBorderColor(String[] v) voidvoidsetCacheType(String[] v) voidvoidvoidSet the value of cids.voidsetCondition(String[] v) voidsetCssFile(String[] v) voidSet the value of edate.voidsetExactCategory(boolean v) voidsetExpandState(String[] v) voidsetGenerateFriendlyURLs(boolean generate) Set whether friendly URL should be automatically generated from publication's category and title.voidvoidvoidvoidvoidsetInvalidClass(String[] v) voidvoidsetMainLanguage(String lang) Set the main language to assign to all publication.voidSet whether the update perform by the caddy on publication should be a major updatedvoidsetNewWSId(String v) voidsetNoAdate(boolean v) Set the value of noAdate.voidsetNoCategory(boolean v) Set the value of noCategory.voidsetNoCommonCategory(boolean v) Set the value of noCommonCategory.voidsetNoEdate(boolean v) Set the value of noEdate.voidsetNoPdate(boolean v) Set the value of noPdate.voidsetNoReadRight(boolean v) Set the value of noReadRight.voidsetNoUpdateRight(boolean v) Set the value of noUpdateRight.voidvoidsetOpTrash(String v) voidSet the value of pdate.voidsetPopupState(String[] v) voidsetPstatus(int v) Set the value of pstatus.voidsetRefineCids(String[] refcids) Sets the cids to be used in refine operation to select publications which belong to the corresponding categories (remove all the others from the caddy).voidsetRefineTypes(String[] reftypes) Important: This setter trigger an immediate action modifying the caddy content! Sets the types of publication to keep in the caddy.voidsetRemoveFriendlyURLs(boolean remove) Set if friendly urls should be removed for all publication of the caddyvoidvoidsetSilentUpdate(String val) voidsetSkinClasses(String[] v) voidsetSkinFooter(String[] v) voidsetTemplates(String[] templates) Set the templates to define for the set of publication in the caddy.voidsetTracked(String track) Set whether publication should be tracked or not.voidsetUpdateGroups(String[] v) voidsetUpdateGroupsAddCount(int v) voidsetUpdateMemberIds(String[] mbrIds) Set the value of updateMemberIds.voidsetUpdateMemberSetAddCount(int v) voidbooleanprotected booleanMethods inherited from class com.jalios.jcms.caddy.AbstractCaddyHandler
context, getAvailableForceDelete, getClassificationLevelSettings, getCSVExportUrl, getDefaultForceDelete, getOpenTab, getReplacePattern, getSearchPattern, getTrooleanSettings, init, isApplyingInEmptyFields, isIgnoringIntegrityCheck, isPreviewing, isSearchAndReplaceLangSelected, isTabForced, isUsingRegExp, performClearCaddy, performDelete, performRemoveCaddy, performUpdate, previewSearchAndReplace, searchAndReplace, setApplyInEmptyFields, setClassificationLevel, setForceDelete, setIgnoreIntegrityCheck, setOpClearCaddy, setOpDelete, setOpenTab, setOpPreview, setOpRemoveCaddy, setOpUpdate, setRemoveIds, setReplacePattern, setSearchAndReplaceLang, setSearchPattern, setUseRegExp, showClassificationLevel, startBackgroundProcessAndRedirect, validateClearCaddy, validateDelete, validateRemoveCaddy, validateSearchAndReplaceMethods inherited from class com.jalios.jcms.handler.JcmsFormHandler
afterValidation, canStartProcess, checkMissingField, getAvailableMainLanguage, getBackgroundProcess, getClosePopupUrl, getControllerContext, getEditFieldSet, getFormStep, getFormStepCount, getFormStepFinishLabel, getFormStepHiddenFields, getFormStepLabels, getFormStepPrefixProp, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenFieldML, getMainLangValue, getMainLangValueArray, getMLMap, getMLMapArray, getModalRedirect, getMonolingualValue, getMonolingualValueArray, getMultilingualMainValue, getMultilingualMainValueArray, getMultilingualMLMap, getMultilingualMLMapArray, getOpenTabId, getRedirect, getRedirectOnClosePopup, getWorkspace, isFieldEdition, isFieldMissing, isFormStepClickable, isPartialFieldEdition, isPopupEdition, isWorkspaceForced, mapStringArrayToMapStringList, mapStringListToMapStringArray, mustSendForbiddenOnCSRF, performFinish, performNext, performPrevious, processStatus, sanitize, sanitize, sendRedirect, sendRedirect, setEditField, setFormStep, setNoRedirect, setNoSendRedirect, setOpenTabId, setOpFinish, setOpNext, setOpPrevious, setPopupEdition, setRedirect, setRedirectOnClosePopup, setWorkspace, setWs, showCancelButton, showFinishButton, showNextButton, showPreviousButton, startProcess, updateUploadedFields, validate, validateCSRF, validateFinish, validateNext, validatePreviousMethods inherited from class com.jalios.jcms.context.JcmsJspContext
addAvoidanceLink, addBodyAttributes, addCSSHeader, addCSSHeader, addCSSHeader, addCSSHeader, addCustomHeader, addHandlebarTemplate, addHttpEquivHeader, addHttpNameHeader, addJavaScript, addJavaScript, addJavaScript, addJavaScriptCode, addJavaScriptModule, addPrefetchHeader, addStyleHeader, addStyleHeader, addSvgSpriteIcon, addWebAssets, canAccessAdminArea, checkAccess, checkAccess, checkCSRF, debugDisplayContext, disablePacker, forceEditIcon, forceUpdate, getAjaxRequestAttribute, getAjaxRequestId, getAllHeadersDiffMap, getAllHeadersMap, getAvoidanceLinks, getBackOfficeCSSHeader, getBackOfficeJavaScriptSet, getBodyAttributes, getContentForm, getCSSHeaders, getCtxCategories, getCurrentCategory, getCustomHeaders, getDocType, getFinalCSSFooterMap, getFinalCSSMap, getFinalJavaScriptModuleSet, getFinalJavaScriptSet, getFrontOfficeCSSHeader, getFrontOfficeJavaScriptSet, getHandlebarTemplates, getHttpEquivHeaders, getHttpNameHeaders, getJavaScriptCodeSet, getJavaScriptModuleSet, getJavaScriptSet, getPageContext, getPageTitle, getPageZone, getPortal, getPortalCategory, getPortlet, getPublication, getStyleHeaders, getSvgSprites, getSvgSpritesHtml, getTemplateUsage, internalSetupEmptyHeader, isEditIcon, isEditIcon, isEditIconForPublish, isEditIconForPublish, isPrintView, registerDisplayContext, removeAjaxRequestAttribute, setAjaxRequestAttribute, setAjaxRequestId, setAllHeadersDiffMap, setDocType, setEditIcon, setPageContext, setPageTitle, setPageZone, setShowEditIcon, setTemplateUsage, showEditIcon, showEditIcon, showEditIconMethods inherited from class com.jalios.jcms.context.JcmsContext
addMsg, addMsg, addMsgSession, addMsgSession, addToastr, addToastr, addToastrSession, addToastrSession, applySelector, canAccessAdminArea, copyMsgListToMsgSessionList, forceWorkspaceUpdate, getBaseUrl, getBrowser, getCaddy, getContextPath, getErrorMsg, getErrorMsgList, getErrorMsgSession, getErrorMsgSessionList, getInfoMsg, getInfoMsgList, getInfoMsgSession, getInfoMsgSessionList, getLoggedMember, getMsgList, getMsgSessionList, getRequest, getResponse, getSession, getSuccessMsg, getSuccessMsgList, getSuccessMsgSession, getSuccessMsgSessionList, getToastrCollection, getToastrSessionCollection, getUploadedFiles, getUploadedFiles, getUrlWithCommonUpdatedParams, getUserCountry, getUserLang, getUserLocale, getUserZoneId, getWarningMsg, getWarningMsgList, getWarningMsgSession, getWarningMsgSessionList, glp, isAdmin, isAdminZone, isAjaxRequest, isDBMember, isDebug, isDebugTemplate, isInFrontOffice, isLogged, isWorkZone, removeMessage, removeMessage, removeMsg, select, sendError, sendError, sendForbidden, sendForbidden, sendRedirect, sendRedirect, sendRedirect, setErrorMsg, setErrorMsg, setErrorMsgSession, setErrorMsgSession, setInfoMsg, setInfoMsg, setInfoMsgSession, setInfoMsgSession, setLoggedMember, setRequest, setResponse, setSuccessMsg, setSuccessMsg, setSuccessMsgSession, setSuccessMsgSession, setWarningMsg, setWarningMsg, setWarningMsgSession, setWarningMsgSession, updateWorkspace, validateRegexp, validateSchedule
-
Field Details
-
opRefine
-
refcids
-
reftypes
-
childTFE
-
exactCategoryTFE
-
cssFileTFE
-
skinClassesTFE
-
expandStateTFE
-
popupStateTFE
-
backImageTFE
-
borderTFE
-
backColorTFE
-
borderColorTFE
-
insetTopTFE
-
insetLeftTFE
-
cellPaddingTFE
-
insetRightTFE
-
insetBottomTFE
-
widthTFE
-
alignTableTFE
-
alignVTFE
-
alignHTFE
-
cacheTypeTFE
-
cacheSensibilityTFE
-
invalidClassTFE
-
invalidTimeTFE
-
behaviorCopyTFE
-
conditionTFE
-
-
Constructor Details
-
PublicationCaddyHandler
public PublicationCaddyHandler()
-
-
Method Details
-
processAction
Description copied from class:JcmsFormHandlerMethod to be implemented to check/validate action to be performed and process them.Default implementation is to return false. No need to call super method.
This method may NOT be invoked at all if security validation are not met.
You must ensure your handler and JSP can work properly without any code invoked in this method.
- Overrides:
processActionin classAbstractCaddyHandler<PublicationCaddyContext>- Returns:
- false if no redirection is needed, true otherwise
- Throws:
IOException- IO Exception
-
getJsp
Description copied from class:AbstractCaddyHandlerRetrieve the path of the JSP.- Specified by:
getJspin classAbstractCaddyHandler<PublicationCaddyContext>- Returns:
- a path relative to the webapp root.
-
validateCommonPdateEdate
public boolean validateCommonPdateEdate() -
setOpRefine
-
setRefineCids
Sets the cids to be used in refine operation to select publications which belong to the corresponding categories (remove all the others from the caddy).- Parameters:
refcids- The id of the category that is to be used to select a subset of the caddy.
-
setRefineTypes
Important: This setter trigger an immediate action modifying the caddy content! Sets the types of publication to keep in the caddy.- Parameters:
reftypes- The types to keep in the caddy.
-
setOpTrash
-
getDataClass
Description copied from class:AbstractCaddyHandlerRetrieve the type of data being handled by this handler- Specified by:
getDataClassin classAbstractCaddyHandler<PublicationCaddyContext>- Returns:
- a Data class
-
getNewCaddyContext
Description copied from class:AbstractCaddyHandlerRetrieve a new instance of CaddyContext.- Specified by:
getNewCaddyContextin classAbstractCaddyHandler<PublicationCaddyContext>- Parameters:
caddy- the current Caddymember- the logged Member- Returns:
- a AbstractCaddyContext instance
-
getNewCaddyProcess
Description copied from class:AbstractCaddyHandlerRetrieve a new instance of CaddyProcess to start action when required.- Specified by:
getNewCaddyProcessin classAbstractCaddyHandler<PublicationCaddyContext>- Returns:
- a AbstractCaddyProcess instance
-
validateUpdate
protected boolean validateUpdate()- Overrides:
validateUpdatein classAbstractCaddyHandler<PublicationCaddyContext>
-
getCategorySet
- Returns:
- a Set of Category
-
isExpanded
Check if the specified category has been expanded in the treecat- Parameters:
cat- the category to check, must not be nullinputName- this parameter is not used- Returns:
- true if the given category must be expanded
- Since:
- jcms-3.0
-
isWFHomogeneous
public boolean isWFHomogeneous()Check if publication in the caddy use the same Workflow.- Returns:
- true if all publication in the caddy use the same Workflow
- Since:
- jcms-4.1
-
getCommonWorkflow
-
getCommonWFState
-
isTypeHomogeneous
public boolean isTypeHomogeneous()Check if publication in the caddy are of same class.- Returns:
- true if all publication in the caddy are of the same type
- Since:
- jcms-4.1
-
getCommonClass
-
getCommonSuperClass
Retrieve the common super class of all publicaiton in the caddy- Returns:
- a class, return null, Publication.class is guaranteed to be at least the most commont one
- Since:
- jcms-10.0.4 / JCMS-5407
-
isPortletSkinable
public boolean isPortletSkinable()Check if all publication in the caddy arePortletSkinable.- Returns:
- true if all publication in the caddy are PortletSkinable
- Since:
- jcms-10.0.4 / JCMS-5407
-
isPortalElement
public boolean isPortalElement()Check if all publication in the caddy arePortalElement.- Returns:
- true if all publication in the caddy are PortalElement
- Since:
- jcms-10.0.4 / JCMS-5407
-
isPortlet
public boolean isPortlet()Check if all publication in the caddy arePortlet.- Returns:
- true if all publication in the caddy are Portlet
- Since:
- jcms-10.0.4 / JCMS-5407
-
isPortal
public boolean isPortal()Check if all publication in the caddy arePortal.- Returns:
- true if all publication in the caddy are Portal
- Since:
- jcms-10.0.4 / JCMS-5407
-
containsOnlyTrashablePublication
public boolean containsOnlyTrashablePublication()Check if all publication in the caddy are trashable- Returns:
- true if all publication in the caddy are trashable
- Since:
- jcms-10.0.5 / JCMS-8353
-
containsOnlyUntrashablePublication
public boolean containsOnlyUntrashablePublication()Check if all publication in the caddy are untrashable- Returns:
- true if all publication in the caddy are untrashable
- Since:
- jcms-10.0.7 / JCMS-9473
-
getAuthorId
-
getAuthor
-
setAuthorId
-
getAvailableNewWS
-
setNewWSId
-
getTemplates
Retrieve the templates value that were asked to be set for publication.- Returns:
- an array of template name or null if no templates was requested
-
setTemplates
Set the templates to define for the set of publication in the caddy.- Parameters:
templates- an array of template name, or null to skipp
-
getPstatus
public int getPstatus()Get the value of pstatus.- Returns:
- Value of pstatus.
-
setPstatus
public void setPstatus(int v) Set the value of pstatus.- Parameters:
v- Value to assign to pstatus.
-
setPdate
Set the value of pdate.- Parameters:
v- Value to assign to pdate.
-
setEdate
Set the value of edate.- Parameters:
v- Value to assign to edate.
-
setAdate
Set the value of adate.- Parameters:
v- Value to assign to adate.
-
getNoPdate
public boolean getNoPdate()Get the value of noPdate.- Returns:
- Value of noPdate.
-
setNoPdate
public void setNoPdate(boolean v) Set the value of noPdate.- Parameters:
v- Value to assign to noPdate.
-
getNoEdate
public boolean getNoEdate()Get the value of noEdate.- Returns:
- Value of noEdate.
-
setNoEdate
public void setNoEdate(boolean v) Set the value of noEdate.- Parameters:
v- Value to assign to noEdate.
-
getNoAdate
public boolean getNoAdate()Get the value of noAdate.- Returns:
- Value of noAdate.
-
setNoAdate
public void setNoAdate(boolean v) Set the value of noAdate.- Parameters:
v- Value to assign to noAdate.
-
setAuthorizedMemberIds
Set the value of authorizedMemberIds.- Parameters:
mbrIds- Value to assign to authorizedMemberIds.- Since:
- jcms-2.1
-
getAvailableAuthorizedGroups
-
getAvailableAuthor
-
getAvailableTemplates
-
setAuthorizedGroups
-
setAuthorizedGroupsAddCount
public void setAuthorizedGroupsAddCount(int v) -
setAuthorizedMemberSetAddCount
public void setAuthorizedMemberSetAddCount(int v) -
setUpdateMemberSetAddCount
public void setUpdateMemberSetAddCount(int v) -
getAuthorizedGroupsCount
public int getAuthorizedGroupsCount() -
getAuthorizedGroupsAddCount
public int getAuthorizedGroupsAddCount() -
getAvailableAuthorizedMemberSet
-
getAvailableUpdateMemberSet
-
getAvailablePdate
-
getAvailableEdate
-
getAvailableAdate
-
getAvailableRestrictUpdateRights
-
setRestrictUpdateRights
-
setUpdateMemberIds
Set the value of updateMemberIds.- Parameters:
mbrIds- Value to assign to updateMemberIds.- Since:
- jcms-3.2
-
getAvailableUpdateGroups
-
setUpdateGroups
-
setUpdateGroupsAddCount
public void setUpdateGroupsAddCount(int v) -
getUpdateGroupsCount
public int getUpdateGroupsCount() -
getUpdateGroupsAddCount
public int getUpdateGroupsAddCount() -
getAuthorizedMemberSetCount
public int getAuthorizedMemberSetCount() -
getUpdateMemberSetCount
public int getUpdateMemberSetCount() -
getUpdateMemberSetAddCount
public int getUpdateMemberSetAddCount() -
getNoReadRight
public boolean getNoReadRight()Get the value of noReadRight.- Returns:
- Value of noReadRight.
-
setNoReadRight
public void setNoReadRight(boolean v) Set the value of noReadRight.- Parameters:
v- Value to assign to noReadRight.
-
getNoUpdateRight
public boolean getNoUpdateRight()Get the value of noUpdateRight.- Returns:
- Value of noUpdateRight.
-
setNoUpdateRight
public void setNoUpdateRight(boolean v) Set the value of noUpdateRight.- Parameters:
v- Value to assign to noUpdateRight.
-
setNoCategory
public void setNoCategory(boolean v) Set the value of noCategory.- Parameters:
v- Value to assign to noCategory.
-
getNoCategory
public boolean getNoCategory()Gets the value of noCategory- Returns:
- true if category should be removed from all publication
-
setNoCommonCategory
public void setNoCommonCategory(boolean v) Set the value of noCommonCategory.- Parameters:
v- Value to assign to noCommonCategory.
-
getNoCommonCategory
public boolean getNoCommonCategory()Gets the value of noCommonCategory- Returns:
- true if category common to all publication should be removed
-
setCids
Set the value of cids.- Parameters:
cids- Value to assign to cids.
-
setTracked
Set whether publication should be tracked or not.- Parameters:
track- true to enable reader tracker for all publication false to disable it- Since:
- jcms-5.0.0
-
isCommonTrackedAvailable
public boolean isCommonTrackedAvailable()Check if a common tracked value was found for all publication of the caddy- Returns:
- true if a common value could be computed, false if value differ
- Since:
- jcms-5.0.0
-
getCommonTracked
public boolean getCommonTracked()Retrieve the tracked value common to all publication, this getter is only valid ifisCommonTrackedAvailable()is true.- Returns:
- the common tracked value of all publication
- Since:
- jcms-5.0.0
-
setMainLanguage
Set the main language to assign to all publication.- Parameters:
lang- an ISO-639 language code- Since:
- jcms-5.5.0
-
getCommonMainLanguage
Retrieve the mainlanguage common to all publication, if any.- Returns:
- an ISO-639 language code or null if no common language could be computed
- Since:
- jcms-5.5.0
-
setMajorUpdate
Set whether the update perform by the caddy on publication should be a major updated- Parameters:
v- the value of this parameter is ignored, as long as this method is invoked the update will be a major update- Since:
- jcms-5.7.0
-
getRemoveFriendlyURLs
public boolean getRemoveFriendlyURLs()Check if friendly url will be removed during update.- Returns:
- true if friendly urls should be removed for all publication of the caddy
- Since:
- jcms-5.5.0
-
setRemoveFriendlyURLs
public void setRemoveFriendlyURLs(boolean remove) Set if friendly urls should be removed for all publication of the caddy- Parameters:
remove- true to remove friendly url, false to leave as is- Since:
- jcms-5.5.0
-
getGenerateFriendlyURLs
public boolean getGenerateFriendlyURLs()Check whether friendly URL should be automatically generated from publication's category and title.- Returns:
- true if friendly URL will be generated
- Since:
- jcms-5.5.0
-
setGenerateFriendlyURLs
public void setGenerateFriendlyURLs(boolean generate) Set whether friendly URL should be automatically generated from publication's category and title.- Parameters:
generate- true to generate new friendly url (added to existing one), false to leave friendly url as is- Since:
- jcms-5.5.0
-
setChild
-
getAvailableChild
-
setExactCategory
public void setExactCategory(boolean v) -
getAvailableExactCategory
public boolean getAvailableExactCategory() -
setCssFile
-
getAvailableCssFile
-
setSkinClasses
-
getAvailableSkinClasses
-
setExpandState
-
getAvailableExpandState
-
setPopupState
-
getAvailablePopupState
-
setBackImage
-
getAvailableBackImage
-
setBorder
-
getAvailableBorder
public int getAvailableBorder() -
setBackColor
-
getAvailableBackColor
-
setBorderColor
-
getAvailableBorderColor
-
setInsetTop
-
getAvailableInsetTop
public int getAvailableInsetTop() -
setInsetLeft
-
getAvailableInsetLeft
public int getAvailableInsetLeft() -
setCellPadding
-
getAvailableCellPadding
public int getAvailableCellPadding() -
setInsetRight
-
getAvailableInsetRight
public int getAvailableInsetRight() -
setInsetBottom
-
getAvailableInsetBottom
public int getAvailableInsetBottom() -
setWidth
-
getAvailableWidth
-
setAlignTable
-
getAvailableAlignTable
-
setAlignV
-
getAvailableAlignV
-
setAlignH
-
getAvailableAlignH
-
setCacheType
-
getAvailableCacheType
-
setCacheSensibility
-
getAvailableCacheSensibility
-
setInvalidClass
-
getAvailableInvalidClass
-
setInvalidTime
-
getAvailableInvalidTime
public long getAvailableInvalidTime() -
setBehaviorCopy
-
getAvailableBehaviorCopy
-
setCondition
-
getAvailableCondition
-
setAbilities
-
getAvailableAbilities
-
setSilentUpdate
-