com.jalios.jcms.caddy

Class PublicationCaddyManagerHandler

java.lang.Object

com.jalios.jcms.context.JcmsContext

com.jalios.jcms.context.JcmsJspContext

com.jalios.jcms.handler.JcmsFormHandler

com.jalios.jcms.caddy.AbstractCaddyManagerHandler

com.jalios.jcms.caddy.PublicationCaddyManagerHandler

All Implemented Interfaces:

JcmsConstants, JaliosConstants

public class PublicationCaddyManagerHandler
extends AbstractCaddyManagerHandler

This form handler process Publication Caddy Manager actions.

Version:

$Revision: 113694 $

See Also:

Caddy

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Date	adate
protected java.lang.String	authorId
protected Group[]	authorizedGroups
protected int	authorizedGroupsAddCount
protected java.util.TreeSet<Member>	authorizedMemberSet
protected int	authorizedMemberSetAddCount
protected java.util.TreeSet<Category>	categorySet
protected java.util.Date	commonAdate
protected java.lang.String	commonAuthorId
protected Group[]	commonAuthorizedGroups
protected java.util.TreeSet<Member>	commonAuthorizedMemberSet
protected java.util.TreeSet<Category>	commonCategorySet
protected java.lang.Class<? extends Publication>	commonClass
protected java.util.Date	commonEdate
protected java.lang.String	commonMainLanguage
protected java.util.Date	commonPdate
protected java.lang.String[]	commonTemplates
protected boolean	commonTracked
protected boolean	commonTrackedAvailable
protected Group[]	commonUpdateGroups
protected java.util.TreeSet<Member>	commonUpdateMemberSet
protected Workflow	commonWF
protected WFState	commonWFState
protected java.lang.String	commonWSId
protected java.util.Date	edate
protected boolean	generateFriendlyURLs
protected boolean	isTracked
protected boolean	isTrackedProvided
protected java.lang.String	mainLanguage
protected boolean	majorUpdate
protected Member	newAuthor
protected Workspace	newWS
protected java.lang.String	newWSId
protected boolean	noAdate
protected boolean	noCategory
protected boolean	noCommonCategory
protected boolean	noEdate
protected boolean	noPdate
protected boolean	noReadRight
protected boolean	noUpdateRight
protected java.lang.String	opRefine
protected java.util.Date	pdate
protected int	pstatus
protected java.lang.String[]	refcids
protected java.lang.String[]	reftypes
protected boolean	removeFriendlyURLs
static java.lang.String	REVISION
protected java.lang.String[]	templates
protected Group[]	updateGroups
protected int	updateGroupsAddCount
protected java.util.TreeSet<Member>	updateMemberSet
protected int	updateMemberSetAddCount
protected Workflow	wf

Fields inherited from class com.jalios.jcms.caddy.AbstractCaddyManagerHandler

applyInEmptyFields, deleteDataExtension, doSearchAndReplace, forceDelete, ignoreIntegrityCheck, opClearCaddy, opDelete, openTab, opPreview, opRemoveCaddy, opUpdate, PREVIOUS_TAB, replaceLangList, replacePattern, searchPattern, useRegExp

Fields inherited from class com.jalios.jcms.handler.JcmsFormHandler

contextMap, editFieldSet, formStep, noRedirect, noSendRedirect, popupEdition, redirect, redirectOnClosePopup, workspaceForced

Fields 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_SET_ATTRIBUTE, jsboSet, jsfoSet, out, pageContext, SHOW_EDIT_ICON, STYLE_HEADER

Fields inherited from class com.jalios.jcms.context.JcmsContext

browser, caddy, channel, inFO, initDone, initWorkspace, isAdmin, isAjaxRequest, isDBMember, isDebug, isLogged, loggedMember, request, response, userCountry, userLang, userLocale, workspace

Fields inherited from interface com.jalios.jcms.JcmsConstants

ADATE_SEARCH, ADMIN_NOTES_PROP, ADVANCED_TAB, AJAX_MODE_ATTR, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, COUNTRY_SPRITE, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, 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, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, 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, 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_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, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SESSION_AUTHORIZED_FILENAMES_SET, SPRITE_ICON_PREFIX, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, SUCCESS_MSG, TEMPLATE_TAB, 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, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, URL_REGEXP, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML

Fields 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_YEAR

Constructor Summary

Constructors

Constructor and Description
PublicationCaddyManagerHandler()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	compute() This methods computes all the common attributes of the publication in the caddy.
protected void	computeWorkingPubSet()
Member	getAuthor()
java.lang.String	getAuthorId()
int	getAuthorizedGroupsAddCount()
int	getAuthorizedGroupsCount()
int	getAuthorizedMemberSetCount()
java.util.Date	getAvailableAdate()
Member	getAvailableAuthor()
Group[]	getAvailableAuthorizedGroups()
java.util.Set<Member>	getAvailableAuthorizedMemberSet()
java.util.Date	getAvailableEdate()
Workspace	getAvailableNewWS()
java.util.Date	getAvailablePdate()
java.lang.String[]	getAvailableTemplates()
Group[]	getAvailableUpdateGroups()
java.util.Set<Member>	getAvailableUpdateMemberSet()
java.util.SortedSet<Category>	getCategorySet()
java.lang.Class<? extends Publication>	getCommonClass()
java.lang.String	getCommonMainLanguage() Retrieve the mainlanguage common to all publication, if any.
boolean	getCommonTracked() Retrieve the tracked value common to all publication, this getter is only valid if isCommonTrackedAvailable() is true.
WFState	getCommonWFState()
Workflow	getCommonWorkflow()
java.lang.Class<? extends Data>	getDataClass() Retrieve the type of data being handled by this handler
boolean	getGenerateFriendlyURLs() Check whether friendly URL should be automatically generated from publication's category and title.
boolean	getNoAdate() Get the value of noAdate.
boolean	getNoCategory() Gets the value of noCategory
boolean	getNoCommonCategory() Gets the value of noCommonCategory
boolean	getNoEdate() Get the value of noEdate.
boolean	getNoPdate() Get the value of noPdate.
boolean	getNoReadRight() Get the value of noReadRight.
boolean	getNoUpdateRight() Get the value of noUpdateRight.
int	getPstatus() Get the value of pstatus.
boolean	getRemoveFriendlyURLs() Check if friendly url will be removed during update.
java.lang.String[]	getTemplates() Retrieve the templates value that were asked to be set for publication.
int	getUpdateGroupsAddCount()
int	getUpdateGroupsCount()
int	getUpdateMemberSetAddCount()
int	getUpdateMemberSetCount()
boolean	isCommonTrackedAvailable() Check if a common tracked value was found for all publication of the caddy
boolean	isExpanded(Category cat, java.lang.String inputName) Check if the specified category has been expanded in the treecat
boolean	isTypeHomogeneous() Check if publication in the caddy are of same class.
boolean	isWFHomogeneous() Check if publication in the caddy use the same Workflow.
boolean	processAction() Method to be implemented to check/validate action to be performed and process them.
void	setAdate(java.lang.String v) Set the value of adate.
void	setAuthorId(java.lang.String v)
void	setAuthorizedGroups(java.lang.String[] v)
void	setAuthorizedGroupsAddCount(int v)
void	setAuthorizedMemberIds(java.lang.String[] mbrIds) Set the value of authorizedMemberIds.
void	setAuthorizedMemberSetAddCount(int v)
void	setCids(java.lang.String[] cids) Set the value of cids.
void	setEdate(java.lang.String v) Set the value of edate.
void	setGenerateFriendlyURLs(boolean generate) Set whether friendly URL should be automatically generated from publication's category and title.
void	setMainLanguage(java.lang.String lang) Set the main language to assign to all publication.
void	setMajorUpdate(java.lang.String v) Set whether the update perform by the caddy on publication should be a major updated
void	setNewWSId(java.lang.String v)
void	setNoAdate(boolean v) Set the value of noAdate.
void	setNoCategory(boolean v) Set the value of noCategory.
void	setNoCommonCategory(boolean v) Set the value of noCommonCategory.
void	setNoEdate(boolean v) Set the value of noEdate.
void	setNoPdate(boolean v) Set the value of noPdate.
void	setNoReadRight(boolean v) Set the value of noReadRight.
void	setNoUpdateRight(boolean v) Set the value of noUpdateRight.
void	setOpRefine(java.lang.String v)
void	setPdate(java.lang.String v) Set the value of pdate.
void	setPstatus(int v) Set the value of pstatus.
void	setRefineCids(java.lang.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).
void	setRefineTypes(java.lang.String[] reftypes) Important: This setter trigger an immediate action modifying the caddy content! Sets the types of publication to keep in the caddy.
void	setRemoveFriendlyURLs(boolean remove) Set if friendly urls should be removed for all publication of the caddy
void	setTemplates(java.lang.String[] templates) Set the templates to define for the set of publication in the caddy.
void	setTracked(boolean track) Set whether publication should be tracked or not.
void	setUpdateGroups(java.lang.String[] v)
void	setUpdateGroupsAddCount(int v)
void	setUpdateMemberIds(java.lang.String[] mbrIds) Set the value of updateMemberIds.
void	setUpdateMemberSetAddCount(int v)
boolean	validateCommonPdateEdate()

Methods inherited from class com.jalios.jcms.caddy.AbstractCaddyManagerHandler

deleteDataExtension, getAvailableForceDelete, getControllerContext, getDefaultForceDelete, getOpenTab, getReplacePattern, getSearchPattern, isApplyingInEmptyFields, isDeletingDataExtension, isIgnoringIntegrityCheck, isPreviewing, isSearchAndReplaceLangSelected, isTabForced, isUsingRegExp, performRemoveCaddy, previewSearchAndReplace, processMultipleStatus, searchAndReplace, setApplyInEmptyFields, setDeleteDataExtension, setForceDelete, setIgnoreIntegrityCheck, setOpClearCaddy, setOpDelete, setOpenTab, setOpPreview, setOpRemoveCaddy, setOpUpdate, setRemoveIds, setReplacePattern, setSearchAndReplaceLang, setSearchPattern, setUseRegExp, validateRemoveCaddy, validateSearchAndReplace

Methods inherited from class com.jalios.jcms.handler.JcmsFormHandler

afterValidation, checkMissingField, getAvailableMainLanguage, getClosePopupUrl, getEditFieldSet, getFormStep, getFormStepCount, getFormStepFinishLabel, getFormStepHiddenFields, getFormStepLabels, getFormStepPrefixProp, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenFieldML, getMainLangValue, getMainLangValueArray, getMLMap, getMLMapArray, getModalRedirect, getRedirect, getRedirectOnClosePopup, getWorkspace, init, isFieldEdition, isFieldMissing, isPartialFieldEdition, isPopupEdition, isWorkspaceForced, processStatus, sendRedirect, sendRedirect, setEditField, setFormStep, setNoRedirect, setNoSendRedirect, setPopupEdition, setRedirect, setRedirectOnClosePopup, setWorkspace, setWs, showCancelButton, showFinishButton, showNextButton, showPreviousButton, updateUploadedField, updateUploadedFields, validate

Methods inherited from class com.jalios.jcms.context.JcmsJspContext

addBodyAttributes, addCSSHeader, addCSSHeader, addCSSHeader, addCSSHeader, addCustomHeader, addHttpEquivHeader, addHttpNameHeader, addJavaScript, addJavaScript, addJavaScript, addJavaScriptCode, addPrefetchHeader, addStyleHeader, addStyleHeader, checkAccess, checkAccess, checkCSRF, debugDisplayContext, disablePacker, forceEditIcon, forceUpdate, getAjaxRequestAttribute, getAjaxRequestId, getAllHeadersDiffMap, getAllHeadersMap, getBackOfficeCSSHeader, getBackOfficeJavaScriptSet, getBodyAttributes, getContentForm, getCSSHeaders, getCtxCategories, getCurrentCategory, getCustomHeaders, getDocType, getFinalCSSFooterMap, getFinalCSSMap, getFinalJavaScriptSet, getFormElementCount, getFrontOfficeCSSHeader, getFrontOfficeJavaScriptSet, getHttpEquivHeaders, getHttpNameHeaders, getJavaScriptCodeSet, getJavaScriptSet, getJSONBridge, getPackVersion, getPageContext, getPageTitle, getPageZone, getPortal, getPortalCategory, getPortlet, getPublication, getStyleHeaders, getTemplateUsage, internalSetupEmptyHeader, isEditIcon, isEditIcon, isEditIconForPublish, isEditIconForPublish, isPrintView, registerDisplayContext, removeAjaxRequestAttribute, setAjaxRequestAttribute, setAjaxRequestId, setAllHeadersDiffMap, setDocType, setEditIcon, setFormElementCount, setPageContext, setPageTitle, setPageZone, setShowEditIcon, setTemplateUsage, showEditIcon, showEditIcon, showEditIcon, workaroundBrowserBaseHrefBug

Methods inherited from class com.jalios.jcms.context.JcmsContext

addCookie, addMsg, addMsg, addMsgSession, addMsgSession, applySelector, forceWorkspaceUpdate, getBaseUrl, getBrowser, getCaddy, getContextPath, getErrorMsg, getErrorMsgList, getErrorMsgSession, getErrorMsgSessionList, getInfoMsg, getInfoMsgList, getInfoMsgSession, getInfoMsgSessionList, getLoggedMember, getMsgList, getMsgSessionList, getRequest, getResponse, getSession, getSuccessMsg, getSuccessMsgList, getSuccessMsgSession, getSuccessMsgSessionList, getUploadedFile, getUploadedFileList, getUrlWithCommonUpdatedParams, getUserCountry, getUserLang, getUserLocale, getWarningMsg, getWarningMsgList, getWarningMsgSession, getWarningMsgSessionList, glp, isAdmin, isAjaxRequest, isDBMember, isDebug, isInFrontOffice, isLogged, isWebdavAccess, removeMessage, removeMessage, retrieveUploadedFile, select, sendForbidden, sendForbidden, sendRedirect, sendRedirect, sendRedirect, setErrorMsg, setErrorMsg, setErrorMsgSession, setErrorMsgSession, setInfoMsg, setInfoMsg, setInfoMsgSession, setInfoMsgSession, setLoggedMember, setRequest, setResponse, setSuccessMsg, setSuccessMsg, setSuccessMsgSession, setSuccessMsgSession, setWarningMsg, setWarningMsg, setWarningMsgSession, setWarningMsgSession, validateRegexp, validateSchedule

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

REVISION

public static final java.lang.String REVISION

See Also:

Constant Field Values

opRefine

protected java.lang.String opRefine

refcids

protected java.lang.String[] refcids

reftypes

protected java.lang.String[] reftypes

noCategory

protected boolean noCategory

noCommonCategory

protected boolean noCommonCategory

authorId

protected java.lang.String authorId

commonAuthorId

protected java.lang.String commonAuthorId

newWSId

protected java.lang.String newWSId

commonWSId

protected java.lang.String commonWSId

commonTracked

protected boolean commonTracked

commonTrackedAvailable

protected boolean commonTrackedAvailable

isTrackedProvided

protected boolean isTrackedProvided

isTracked

protected boolean isTracked

templates

protected java.lang.String[] templates

commonTemplates

protected java.lang.String[] commonTemplates

pstatus

protected int pstatus

pdate

protected java.util.Date pdate

commonPdate

protected java.util.Date commonPdate

edate

protected java.util.Date edate

commonEdate

protected java.util.Date commonEdate

adate

protected java.util.Date adate

commonAdate

protected java.util.Date commonAdate

noPdate

protected boolean noPdate

noEdate

protected boolean noEdate

noAdate

protected boolean noAdate

commonMainLanguage

protected java.lang.String commonMainLanguage

mainLanguage

protected java.lang.String mainLanguage

majorUpdate

protected boolean majorUpdate

removeFriendlyURLs

protected boolean removeFriendlyURLs

generateFriendlyURLs

protected boolean generateFriendlyURLs

noReadRight

protected boolean noReadRight

authorizedMemberSet

protected java.util.TreeSet<Member> authorizedMemberSet

commonAuthorizedMemberSet

protected java.util.TreeSet<Member> commonAuthorizedMemberSet

authorizedMemberSetAddCount

protected int authorizedMemberSetAddCount

authorizedGroups

protected Group[] authorizedGroups

commonAuthorizedGroups

protected Group[] commonAuthorizedGroups

authorizedGroupsAddCount

protected int authorizedGroupsAddCount

noUpdateRight

protected boolean noUpdateRight

updateGroups

protected Group[] updateGroups

commonUpdateGroups

protected Group[] commonUpdateGroups

updateGroupsAddCount

protected int updateGroupsAddCount

updateMemberSet

protected java.util.TreeSet<Member> updateMemberSet

commonUpdateMemberSet

protected java.util.TreeSet<Member> commonUpdateMemberSet

updateMemberSetAddCount

protected int updateMemberSetAddCount

categorySet

protected java.util.TreeSet<Category> categorySet

commonCategorySet

protected java.util.TreeSet<Category> commonCategorySet

commonClass

protected java.lang.Class<? extends Publication> commonClass

commonWF

protected Workflow commonWF

commonWFState

protected WFState commonWFState

wf

protected Workflow wf

newAuthor

protected Member newAuthor

newWS

protected Workspace newWS

Constructor Detail

PublicationCaddyManagerHandler

public PublicationCaddyManagerHandler()

Method Detail

computeWorkingPubSet

protected void computeWorkingPubSet()

compute

protected void compute()

This methods computes all the common attributes of the publication in the caddy.

processAction

public boolean processAction()
                      throws java.io.IOException

Description copied from class: JcmsFormHandler

Method 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:

processAction in class AbstractCaddyManagerHandler

Returns:

false if no redirection is needed, true otherwise

Throws:

java.io.IOException - IO Exception

validateCommonPdateEdate

public boolean validateCommonPdateEdate()

setOpRefine

public void setOpRefine(java.lang.String v)

setRefineCids

public void setRefineCids(java.lang.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).

Parameters:

refcids - The id of the category that is to be used to select a subset of the caddy.

setRefineTypes

public void setRefineTypes(java.lang.String[] reftypes)

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.

getDataClass

public java.lang.Class<? extends Data> getDataClass()

Description copied from class: AbstractCaddyManagerHandler

Retrieve the type of data being handled by this handler

Specified by:

getDataClass in class AbstractCaddyManagerHandler

Returns:

a Data class

getCategorySet

public java.util.SortedSet<Category> getCategorySet()

Returns:

a Set of Category

isExpanded

public boolean isExpanded(Category cat,
                 java.lang.String inputName)

Check if the specified category has been expanded in the treecat

Parameters:

cat - the category to check, must not be null

inputName - 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

public Workflow getCommonWorkflow()

getCommonWFState

public WFState 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

public java.lang.Class<? extends Publication> getCommonClass()

getAuthorId

public java.lang.String getAuthorId()

getAuthor

public Member getAuthor()

setAuthorId

public void setAuthorId(java.lang.String v)

getAvailableNewWS

public Workspace getAvailableNewWS()

setNewWSId

public void setNewWSId(java.lang.String v)

getTemplates

public java.lang.String[] 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

public void setTemplates(java.lang.String[] templates)

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

public void setPdate(java.lang.String v)

Set the value of pdate.

Parameters:

v - Value to assign to pdate.

setEdate

public void setEdate(java.lang.String v)

Set the value of edate.

Parameters:

v - Value to assign to edate.

setAdate

public void setAdate(java.lang.String v)

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

public void setAuthorizedMemberIds(java.lang.String[] mbrIds)

Set the value of authorizedMemberIds.

Parameters:

mbrIds - Value to assign to authorizedMemberIds.

Since:

jcms-2.1

getAvailableAuthorizedGroups

public Group[] getAvailableAuthorizedGroups()

getAvailableAuthor

public Member getAvailableAuthor()

getAvailableTemplates

public java.lang.String[] getAvailableTemplates()

setAuthorizedGroups

public void setAuthorizedGroups(java.lang.String[] v)

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

public java.util.Set<Member> getAvailableAuthorizedMemberSet()

getAvailableUpdateMemberSet

public java.util.Set<Member> getAvailableUpdateMemberSet()

getAvailablePdate

public java.util.Date getAvailablePdate()

getAvailableEdate

public java.util.Date getAvailableEdate()

getAvailableAdate

public java.util.Date getAvailableAdate()

setUpdateMemberIds

public void setUpdateMemberIds(java.lang.String[] mbrIds)

Set the value of updateMemberIds.

Parameters:

mbrIds - Value to assign to updateMemberIds.

Since:

jcms-3.2

getAvailableUpdateGroups

public Group[] getAvailableUpdateGroups()

setUpdateGroups

public void setUpdateGroups(java.lang.String[] v)

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

public void setCids(java.lang.String[] cids)

Set the value of cids.

Parameters:

cids - Value to assign to cids.

setTracked

public void setTracked(boolean track)

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 if isCommonTrackedAvailable() is true.

Returns:

the common tracked value of all publication

Since:

jcms-5.0.0

setMainLanguage

public void setMainLanguage(java.lang.String lang)

Set the main language to assign to all publication.

Parameters:

lang - an ISO-639 language code

Since:

jcms-5.5.0

getCommonMainLanguage

public java.lang.String 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

public void setMajorUpdate(java.lang.String v)

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