com.jalios.jcms.handler

Class EditPublicationHandler

java.lang.Object

com.jalios.jcms.context.JcmsContext

com.jalios.jcms.context.JcmsJspContext

com.jalios.jcms.handler.JcmsFormHandler

com.jalios.jcms.handler.EditDataHandler

com.jalios.jcms.handler.EditPublicationHandler

All Implemented Interfaces:

JcmsConstants, JaliosConstants

Direct Known Subclasses:

DocUploadHandler, EditFileDocumentHandler, EditFormHandler, EditPortalElementHandler, ValidateStateChangePublicationHandler

public abstract class EditPublicationHandler
extends EditDataHandler

This form handler processes Publication forms.

Version:

$Revision: 48025 $

Author:

Olivier Dedieu

See Also:

Publication

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Date	adate
protected java.lang.String	anchor
protected Member	author
protected int	authorizedGroupsAddCount
protected java.util.TreeSet<Group>	authorizedGroupSet
protected java.util.TreeSet<Member>	authorizedMemberSet
protected int	authorizedMemberSetAddCount
protected java.util.Set<Category>	categorySet
protected java.lang.String[]	cids
static java.lang.String	DISPLAY_URL_TOKEN
protected java.util.Date	edate
protected java.util.Map<java.lang.String,FieldStatus>	fieldStatusMap
protected java.util.TreeSet<java.lang.String>	friendlyURLSet
static java.lang.String	ID_TOKEN
protected Workflow	internalWf
protected boolean	isAuthorForced
protected boolean	isCategorized
protected boolean	isContentType
protected boolean	isDBType
protected boolean	isFormType
protected boolean	isPortletType
protected boolean	isTracked
protected boolean	isUGCType
protected int	itemPos
protected java.lang.String	listToProcess
protected java.lang.String	mainLanguage
protected boolean	majorUpdate
protected int	oldPstatus
protected boolean	opAddItem
protected boolean	opAddItemReadRights
protected boolean	opAddItemUpdateRights
protected int	openTab
protected boolean	opMerge
protected java.util.Date	pdate
static java.lang.String	PREVIEW_URL_TOKEN
protected int	pstatus
protected java.lang.Class<? extends Publication>	pubClass
protected Publication	publication
protected int	reviewRating
static java.lang.String	REVISION
protected java.lang.String[]	roleIds
protected java.util.HashMap<java.lang.String,java.util.TreeSet<Member>>	roleMap
protected Member[]	roleMembers
protected java.util.Date	sdate
protected boolean	showAllTabs
protected boolean	showContentTabOnly
protected java.lang.String[]	templates
protected java.lang.String	title
protected java.util.HashMap<java.lang.String,java.lang.String>	titleML
protected java.lang.String	typeLabel
protected int	updateGroupsAddCount
protected java.util.TreeSet<Group>	updateGroupSet
protected java.util.TreeSet<Member>	updateMemberSet
protected int	updateMemberSetAddCount
protected Workflow	wf
protected java.lang.String	wfNote
protected Publication	workingPub
protected WSTypeEntry	wste

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

extFormHandler, formStep, id, isDeleteForced, op, opCancel, opCreate, opDelete, opFinish, opNext, opPrevious, opRefresh, opUpdate, resultOpCreate, resultOpDelete, resultOpUpdate

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

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

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

AJAX_REQUEST_ATTRIBUTES, BODY_HEADER, 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, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, 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, ICON_ARCHIVE, ICON_LOCK, ICON_LOCK_STRONG, 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, 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_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SESSION_AUTHORIZED_FILENAMES_SET, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_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
EditPublicationHandler()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	cannotRead() Returns true if the loggedMember cannot read this publication.
boolean	containsHiddenParts()
java.util.HashMap<java.lang.String,java.lang.String>	getAllAvailableTitleML()
java.lang.String	getAnchor() Get the value of anchor.
int	getAuthorizedGroupsCount()
int	getAuthorizedMemberSetCount()
java.util.Date	getAvailableAdate()
Member	getAvailableAuthor()
java.util.Set<Group>	getAvailableAuthorizedGroupSet()
java.util.Set<Member>	getAvailableAuthorizedMemberSet()
Category[]	getAvailableCategories()
java.util.Date	getAvailableEdate()
java.util.TreeSet<java.lang.String>	getAvailableFriendlyURLSet()
Workflow	getAvailableInternalWorkflow()
java.lang.String	getAvailableMainLanguage()
boolean	getAvailableMajorUpdate()
java.util.Date	getAvailablePdate()
int	getAvailablePstatus()
java.util.HashMap<java.lang.String,java.util.TreeSet<Member>>	getAvailableRoleMap()
java.util.Date	getAvailableSdate()
TypeTemplateEntry	getAvailableTemplateEntry(java.lang.String usage)
java.lang.String[]	getAvailableTemplates()
java.lang.String	getAvailableTitle()
java.lang.String	getAvailableTitle(java.lang.String lang)
java.util.HashMap<java.lang.String,java.lang.String>	getAvailableTitleML()
boolean	getAvailableTracked()
java.util.Set<Group>	getAvailableUpdateGroupSet()
java.util.Set<Member>	getAvailableUpdateMemberSet()
java.lang.String	getAvailableWFNote()
Workspace	getAvailableWorkspace()
java.util.Set<Category>	getCategorySet(java.lang.String inputName) Returns the root set bound to the given inputName
protected java.util.HashMap	getControllerContext() Build a controller context.
java.lang.Class<? extends Data>	getDataClass()
java.util.Set<Group>	getDefaultAuthorizedGroupSet() This method should be overriden by sub-classes
java.util.Set<Member>	getDefaultAuthorizedMemberSet() This method should be overriden by sub-classes
java.util.Set<Category>	getDefaultCategorySet() This method should be overriden by sub-classes
java.lang.String	getDefaultTemplateUsage() Returns the default template usage used to display the publication.
java.util.Set<Group>	getDefaultUpdateGroupSet() This method should be overriden by sub-classes
java.util.Set<Member>	getDefaultUpdateMemberSet() This method should be overriden by sub-classes
FieldStatus	getFieldStatus(java.lang.String fieldName) Returns the FieldStatus for the given field.
java.util.Set<Category>	getHiddenCatSet(java.util.Set<Category> typeRemovedCatSet)
java.util.TreeSet<Member>	getMemberSetAssignedToRole(java.lang.String roleId)
int	getOpenTab()
Publication	getPublication()
abstract java.lang.Class<? extends Publication>	getPublicationClass()
boolean	getShowAllTabs()
boolean	getShowContentTabOnly()
java.lang.String	getTabLabel(java.lang.String tabId)
java.lang.Object	getTitleFieldValue(boolean isTitleML)
java.lang.String	getTypeLabel() Returns the label of the edited type.
int	getUpdateGroupsCount()
int	getUpdateMemberSetCount()
java.lang.String	getWorkAreaCss() Returns the css class used for style, and javascript window resize in footer in popup edition.
Workflow	getWorkflow()
WSTypeEntry	getWSTypeEntry()
protected void	init() Method to implement if you need to initialize your handler from parameter received, prior to all security validation.
protected boolean	internalPerformCreate()
protected boolean	internalPerformDelete()
protected boolean	internalPerformUpdate()
boolean	isAdvancedTabHidden()
boolean	isCategoryTabHidden()
boolean	isContentTabOnly()
boolean	isDBType() Returns true if the publication class extends DBData.
boolean	isExpanded(Category cat, java.lang.String inputName)
boolean	isFieldEdition(java.lang.String field)
boolean	isForm() Is this handler dedicated to Form sub-class processing.
boolean	isLocked() Returns true if the publication is (weakly) locked.
boolean	isReadRightTabHidden()
boolean	isStrongLocked() Returns true if the publication is a FileDocument with a strong lock.
boolean	isTabForced()
boolean	isTemplateTabHidden()
boolean	isUpdateRightTabHidden()
boolean	isWorkflowTabHidden()
boolean	performAddItem()
boolean	performAddItemReadRights()
boolean	performAddItemUpdateRights()
boolean	performCreate()
boolean	performDelete()
boolean	performMerge()
boolean	performRefresh()
boolean	performUpdate()
void	prepare()
boolean	processAction() Method to be implemented to check/validate action to be performed and process them.
protected boolean	processStatus(ControllerStatus status) Process the ControllerStatus: do nothing if OK, or send on forbidden, or put a warning message in the request.
protected void	releaseDBWorkingPub()
protected void	sendRedirect()
void	setAdate(java.lang.String v)
void	setAnchor(java.lang.String v) Set the value of anchor.
void	setAuthor(java.lang.String v)
void	setAuthorForced(boolean v, Member author)
void	setAuthorizedGroupIds(java.lang.String[] v)
void	setAuthorizedMemberIds(java.lang.String[] v)
void	setAuthorizedMemberSetAddCount(int v)
void	setCids(java.lang.String[] v)
void	setEdate(java.lang.String v)
void	setFields(Publication pub) Set the common (Publication) fields.
void	setFriendlyURL(java.lang.String[] v) Set the friendly urls.
void	setId(java.lang.String id) Set the value of id.
void	setInternalWf(java.lang.String internalWf)
void	setItemPos(int v)
void	setMainLanguage(java.lang.String v) Set the main language.
void	setMajorUpdate(java.lang.String v)
void	setOpAddItem(java.lang.String v)
void	setOpAddItemReadRights(java.lang.String v)
void	setOpAddItemUpdateRights(java.lang.String v)
void	setOpenTab(int openTab) Set the open tab
void	setOpMerge(java.lang.String v)
void	setPdate(java.lang.String v)
void	setPstatus(int v)
void	setRoleId(java.lang.String[] v) Set the role ids
void	setSdate(java.lang.String v)
void	setShowAllTabs(boolean v)
void	setShowContentTabOnly(boolean v) since jcms-5.5.0
void	setTemplates(java.lang.String[] v)
void	setTitle(java.lang.String[] v)
void	setTracked(boolean v)
void	setUpdateGroupIds(java.lang.String[] v)
void	setUpdateMemberIds(java.lang.String[] v)
void	setUpdateMemberSetAddCount(int v)
void	setWfNote(java.lang.String v)
boolean	showForceDelete() Returns true if the "Force deletion" option must be proposed.
boolean	showFriendlyURL()
boolean	showLockWarning() Returns true if the lock warning message must be displayed.
boolean	showMainLanguage()
boolean	showReaderTracker()
boolean	showSDate()
boolean	showWFRole()
void	updateCids(java.lang.String[] v) Update the cids (this method is called by setCids() and all setCidsXXX() methods)
boolean	validateAddItem()
boolean	validateAddItemReadRights()
boolean	validateAddItemUpdateRights()
boolean	validateBeforeOp()
boolean	validateCreate()
boolean	validateDelete()
boolean	validateFieldFormat()
boolean	validateMember()
boolean	validateMerge()
boolean	validateUpdate()
boolean	validateWorkspace()

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

afterValidation, createUploadedFileDocument, createUploadedFileDocument, createUploadedFileDocument, createUploadedFileDocument, getAvailableData, getAvailableDataArray, getAvailableExtraDataMap, getAvailableExtraDBDataMap, getExtFormHandler, getFormStep, getFormStepCount, getId, handleRestResponse, isFirstAccess, performCancel, performCreateExtension, performFinish, performNext, performPrevious, performUpdateExtension, processDataId, processDataIds, processDataIds, processMLData, processMLDataArray, restValidation, setExtFormHandler, setExtraDBKeys, setExtraDBValues, setExtraKeys, setExtraValues, setFields, setForceDelete, setFormStep, setOpCancel, setOpCreate, setOpDelete, setOpFinish, setOpNext, setOpPrevious, setOpRefresh, setOpUpdate, showCancelButton, showFinishButton, showNextButton, showPreviousButton, validateCancel, validateCreateExtension, validateFinish, validateNext, validatePrevious, validateRefresh, validateUpdateExtension, validateUploadedFileDocument, validateUploadedFileDocument, validateUploadedFileDocument, validateUploadedFileDocument

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

checkMissingField, getEditFieldSet, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenFieldML, getMainLangValue, getMainLangValueArray, getMLMap, getMLMapArray, getRedirect, getRedirectOnClosePopup, getWorkspace, isFieldMissing, isPartialFieldEdition, isPopupEdition, isWorkspaceForced, sendRedirect, sendRedirect, setEditField, setNoRedirect, setNoSendRedirect, setPopupEdition, setRedirect, setRedirectOnClosePopup, setWorkspace, setWs, 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, getFinalCSSMap, getFinalJavaScriptSet, getFormElementCount, getFrontOfficeCSSHeader, getFrontOfficeJavaScriptSet, getHttpEquivHeaders, getHttpNameHeaders, getJavaScriptCodeSet, getJavaScriptSet, getJSONBridge, getPackVersion, getPageContext, getPageTitle, getPageZone, getPortal, getPortalCategory, getPortlet, getStyleHeaders, getTemplateUsage, internalSetupEmptyHeader, isEditIcon, isEditIcon, isPrintView, registerDisplayContext, removeAjaxRequestAttribute, setAjaxRequestAttribute, setAjaxRequestId, setAllHeadersDiffMap, setDocType, setEditIcon, setFormElementCount, setPageContext, setPageTitle, setPageZone, setShowEditIcon, setTemplateUsage, 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, 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, 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

ID_TOKEN

public static final java.lang.String ID_TOKEN

See Also:

Constant Field Values

DISPLAY_URL_TOKEN

public static final java.lang.String DISPLAY_URL_TOKEN

See Also:

Constant Field Values

PREVIEW_URL_TOKEN

public static final java.lang.String PREVIEW_URL_TOKEN

See Also:

Constant Field Values

opMerge

protected boolean opMerge

opAddItem

protected boolean opAddItem

opAddItemReadRights

protected boolean opAddItemReadRights

opAddItemUpdateRights

protected boolean opAddItemUpdateRights

majorUpdate

protected boolean majorUpdate

title

protected java.lang.String title

titleML

protected java.util.HashMap<java.lang.String,java.lang.String> titleML

cids

protected java.lang.String[] cids

templates

protected java.lang.String[] templates

pstatus

protected int pstatus

oldPstatus

protected int oldPstatus

pdate

protected java.util.Date pdate

edate

protected java.util.Date edate

sdate

protected java.util.Date sdate

adate

protected java.util.Date adate

wfNote

protected java.lang.String wfNote

authorizedMemberSetAddCount

protected int authorizedMemberSetAddCount

authorizedGroupsAddCount

protected int authorizedGroupsAddCount

updateMemberSetAddCount

protected int updateMemberSetAddCount

updateGroupsAddCount

protected int updateGroupsAddCount

anchor

protected java.lang.String anchor

isTracked

protected boolean isTracked

mainLanguage

protected java.lang.String mainLanguage

friendlyURLSet

protected java.util.TreeSet<java.lang.String> friendlyURLSet

roleIds

protected java.lang.String[] roleIds

roleMembers

protected Member[] roleMembers

roleMap

protected java.util.HashMap<java.lang.String,java.util.TreeSet<Member>> roleMap

publication

protected Publication publication

pubClass

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

wste

protected WSTypeEntry wste

wf

protected Workflow wf

internalWf

protected Workflow internalWf

author

protected Member author

isAuthorForced

protected boolean isAuthorForced

categorySet

protected java.util.Set<Category> categorySet

authorizedMemberSet

protected java.util.TreeSet<Member> authorizedMemberSet

authorizedGroupSet

protected java.util.TreeSet<Group> authorizedGroupSet

updateMemberSet

protected java.util.TreeSet<Member> updateMemberSet

updateGroupSet

protected java.util.TreeSet<Group> updateGroupSet

openTab

protected int openTab

showAllTabs

protected boolean showAllTabs

showContentTabOnly

protected boolean showContentTabOnly

typeLabel

protected java.lang.String typeLabel

isContentType

protected boolean isContentType

isPortletType

protected boolean isPortletType

isFormType

protected boolean isFormType

isUGCType

protected boolean isUGCType

isDBType

protected boolean isDBType

isCategorized

protected boolean isCategorized

reviewRating

protected int reviewRating

listToProcess

protected java.lang.String listToProcess

itemPos

protected int itemPos

workingPub

protected Publication workingPub

fieldStatusMap

protected java.util.Map<java.lang.String,FieldStatus> fieldStatusMap

Constructor Detail

EditPublicationHandler

public EditPublicationHandler()

Method Detail

getDataClass

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

Specified by:

getDataClass in class EditDataHandler

getPublicationClass

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

getPublication

public Publication getPublication()

Overrides:

getPublication in class JcmsJspContext

Returns:

the current Content or Form if not null, or the Portlet (or null). Slow: we DO NOT cache this value (so do not use this getter every 2millisecs).

setInternalWf

public void setInternalWf(java.lang.String internalWf)

getAvailableInternalWorkflow

public Workflow getAvailableInternalWorkflow()

getWorkflow

public Workflow getWorkflow()

getWSTypeEntry

public WSTypeEntry getWSTypeEntry()

getTabLabel

public java.lang.String getTabLabel(java.lang.String tabId)

init

protected void init()

Description copied from class: JcmsFormHandler

Method to implement if you need to initialize your handler from parameter received, prior to all security validation.

You must absolutely not perform any action which modify data or site configuration.

Therefore it is strongly recommend NOT TO implement this method, or use very wisely.

Overrides:

init in class JcmsFormHandler

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 EditDataHandler

Returns:

false if no redirection is needed, true otherwise

Throws:

java.io.IOException

validateBeforeOp

public boolean validateBeforeOp()

releaseDBWorkingPub

protected void releaseDBWorkingPub()

sendRedirect

protected void sendRedirect()
                     throws java.io.IOException

Overrides:

sendRedirect in class EditDataHandler

Throws:

java.io.IOException

validateMember

public boolean validateMember()
                       throws java.io.IOException

Throws:

java.io.IOException

validateWorkspace

public boolean validateWorkspace()
                          throws java.io.IOException

Throws:

java.io.IOException

processStatus

protected boolean processStatus(ControllerStatus status)
                         throws java.io.IOException

Description copied from class: JcmsFormHandler

Process the ControllerStatus: do nothing if OK, or send on forbidden, or put a warning message in the request.

Overrides:

processStatus in class JcmsFormHandler

Parameters:

status - the ControllerStatus to be processed

Returns:

true when status is OK, false if status was a failure (forbidden or anything else)

Throws:

java.io.IOException

validateFieldFormat

public boolean validateFieldFormat()

validateCreate

public boolean validateCreate()
                       throws java.io.IOException

Throws:

java.io.IOException

performCreate

public boolean performCreate()
                      throws java.io.IOException

Throws:

java.io.IOException

internalPerformCreate

protected boolean internalPerformCreate()
                                 throws java.io.IOException

Throws:

java.io.IOException

getControllerContext

protected java.util.HashMap getControllerContext()

Description copied from class: JcmsFormHandler

Build a controller context. I.E. add request, response and loggedMember.

Overrides:

getControllerContext in class EditDataHandler

Returns:

the HashMap which contains the context

validateUpdate

public boolean validateUpdate()
                       throws java.io.IOException

Throws:

java.io.IOException

performUpdate

public boolean performUpdate()
                      throws java.io.IOException

Throws:

java.io.IOException

internalPerformUpdate

protected boolean internalPerformUpdate()
                                 throws java.io.IOException

Throws:

java.io.IOException

validateDelete

public boolean validateDelete()
                       throws java.io.IOException

Throws:

java.io.IOException

performDelete

public boolean performDelete()
                      throws java.io.IOException

Throws:

java.io.IOException

internalPerformDelete

protected boolean internalPerformDelete()
                                 throws java.io.IOException

Throws:

java.io.IOException

validateMerge

public boolean validateMerge()

performMerge

public boolean performMerge()
                     throws java.io.IOException

Throws:

java.io.IOException

validateAddItem

public boolean validateAddItem()

performAddItem

public boolean performAddItem()
                       throws java.io.IOException

Throws:

java.io.IOException

validateAddItemReadRights

public boolean validateAddItemReadRights()

performAddItemReadRights

public boolean performAddItemReadRights()
                                 throws java.io.IOException

Throws:

java.io.IOException

validateAddItemUpdateRights

public boolean validateAddItemUpdateRights()

performAddItemUpdateRights

public boolean performAddItemUpdateRights()
                                   throws java.io.IOException

Throws:

java.io.IOException

performRefresh

public boolean performRefresh()
                       throws java.io.IOException

Overrides:

performRefresh in class EditDataHandler

Throws:

java.io.IOException

prepare

public void prepare()

setFields

public void setFields(Publication pub)

Set the common (Publication) fields. This method is also a hook for sub-classed to fill some field (or do anything else) before a create or an update.

Parameters:

pub - the publication to set the fields

Since:

jcms-4.0

isFieldEdition

public boolean isFieldEdition(java.lang.String field)

Overrides:

isFieldEdition in class JcmsFormHandler

Returns:

true if this handler is invoked to edit only some fields of the data

See Also:

JcmsFormHandler.getEditFieldSet()

isDBType

public boolean isDBType()

Returns true if the publication class extends DBData.

Returns:

true if the publication class extends DBData.

Since:

jcms-6.0.0

showWFRole

public boolean showWFRole()

showReaderTracker

public boolean showReaderTracker()

Returns:

true if reader tracker input choice must be displayed for current Publication edited

showMainLanguage

public boolean showMainLanguage()

showSDate

public boolean showSDate()

showFriendlyURL

public boolean showFriendlyURL()

showForceDelete

public boolean showForceDelete()

Returns true if the "Force deletion" option must be proposed.

Returns:

true if the "Force deletion" option must be proposed.

Since:

jcms-5.5.0

isLocked

public boolean isLocked()

Returns true if the publication is (weakly) locked.

Returns:

true if the publication is (weakly) locked.

Since:

jcms-5.7.0

isStrongLocked

public boolean isStrongLocked()

Returns true if the publication is a FileDocument with a strong lock.

Returns:

true if the publication is a FileDocument with a strong lock.

Since:

jcms-5.7.0

showLockWarning

public boolean showLockWarning()

Returns true if the lock warning message must be displayed.

Returns:

true if the lock warning message must be displayed.

Since:

jcms-5.7.0

setOpenTab

public void setOpenTab(int openTab)

Set the open tab

Parameters:

openTab - the tab to open

Since:

jcms-4.0

getOpenTab

public int getOpenTab()

Returns:

the open tab

Since:

jcms-4.0

isTabForced

public boolean isTabForced()

Returns:

true if a tab has been forced

Since:

jcms-4.0

containsHiddenParts

public boolean containsHiddenParts()

Returns:

true if there is at least one tab hidden

Since:

jcms-5.7.1

setShowAllTabs

public void setShowAllTabs(boolean v)

Since:

jcms-4.0

getShowAllTabs

public boolean getShowAllTabs()

Since:

jcms-4.0

setShowContentTabOnly

public void setShowContentTabOnly(boolean v)

since jcms-5.5.0

getShowContentTabOnly

public boolean getShowContentTabOnly()

Since:

jcms-5.5.0

isContentTabOnly

public boolean isContentTabOnly()

Since:

jcms-5.5.0

isCategoryTabHidden

public boolean isCategoryTabHidden()

Since:

jcms-4.0

isReadRightTabHidden

public boolean isReadRightTabHidden()

Since:

jcms-4.0

isUpdateRightTabHidden

public boolean isUpdateRightTabHidden()

Since:

jcms-4.0

isTemplateTabHidden

public boolean isTemplateTabHidden()

Since:

jcms-4.0

isWorkflowTabHidden

public boolean isWorkflowTabHidden()

Since:

jcms-4.0

isAdvancedTabHidden

public boolean isAdvancedTabHidden()

Since:

jcms-4.0

getAvailableCategories

public Category[] getAvailableCategories()

getCategorySet

public java.util.Set<Category> getCategorySet(java.lang.String inputName)

Returns the root set bound to the given inputName

Parameters:

inputName - the name of category set to get

Returns:

a Set of Category

Since:

jcms-3.0

getHiddenCatSet

public java.util.Set<Category> getHiddenCatSet(java.util.Set<Category> typeRemovedCatSet)

Returns:

the hidden categories

Since:

jcms-5.6.2

isExpanded

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

Returns:

true if the given category must be expanded

Since:

jcms-3.0

getTitleFieldValue

public java.lang.Object getTitleFieldValue(boolean isTitleML)

getAvailableTitle

public java.lang.String getAvailableTitle()

getAllAvailableTitleML

public java.util.HashMap<java.lang.String,java.lang.String> getAllAvailableTitleML()

getAvailableTitleML

public java.util.HashMap<java.lang.String,java.lang.String> getAvailableTitleML()

getAvailableTitle

public java.lang.String getAvailableTitle(java.lang.String lang)

getAvailableTemplateEntry

public TypeTemplateEntry getAvailableTemplateEntry(java.lang.String usage)

getAvailableTemplates

public java.lang.String[] getAvailableTemplates()

getAvailablePstatus

public int getAvailablePstatus()

getAvailablePdate

public java.util.Date getAvailablePdate()

getAvailableEdate

public java.util.Date getAvailableEdate()

getAvailableSdate

public java.util.Date getAvailableSdate()

getAvailableAdate

public java.util.Date getAvailableAdate()

Since:

jcms-4.1.1

getAvailableWFNote

public java.lang.String getAvailableWFNote()

getAvailableAuthorizedMemberSet

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

Since:

jcms-2.1

getDefaultAuthorizedMemberSet

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

This method should be overriden by sub-classes

Since:

jcms-3.0

getAvailableAuthorizedGroupSet

public java.util.Set<Group> getAvailableAuthorizedGroupSet()

Since:

jcms-2.1

getAuthorizedGroupsCount

public int getAuthorizedGroupsCount()

getUpdateGroupsCount

public int getUpdateGroupsCount()

getDefaultAuthorizedGroupSet

public java.util.Set<Group> getDefaultAuthorizedGroupSet()

This method should be overriden by sub-classes

Since:

jcms-3.0

getDefaultCategorySet

public java.util.Set<Category> getDefaultCategorySet()

This method should be overriden by sub-classes

Since:

jcms-3.0

getAvailableUpdateMemberSet

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

Since:

jcms-4.0

getDefaultUpdateMemberSet

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

This method should be overriden by sub-classes

Since:

jcms-4.0

getAvailableUpdateGroupSet

public java.util.Set<Group> getAvailableUpdateGroupSet()

Since:

jcms-4.0

getDefaultUpdateGroupSet

public java.util.Set<Group> getDefaultUpdateGroupSet()

This method should be overriden by sub-classes

Since:

jcms-4.0

getAvailableAuthor

public Member getAvailableAuthor()

Returns:

the selected author

Since:

jcms-5.0.0

setAuthorForced

public void setAuthorForced(boolean v,
                   Member author)

updateCids

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

Update the cids (this method is called by setCids() and all setCidsXXX() methods)

Since:

jcms-4.0

getDefaultTemplateUsage

public java.lang.String getDefaultTemplateUsage()

Returns the default template usage used to display the publication. This default tempalte may change between Content and Portlets

Returns:

String the default usage

Since:

jcms-6.0.0

setOpMerge

public void setOpMerge(java.lang.String v)

setOpAddItem

public void setOpAddItem(java.lang.String v)

setOpAddItemReadRights

public void setOpAddItemReadRights(java.lang.String v)

setOpAddItemUpdateRights

public void setOpAddItemUpdateRights(java.lang.String v)

setMajorUpdate

public void setMajorUpdate(java.lang.String v)

getAvailableMajorUpdate

public boolean getAvailableMajorUpdate()

isForm

public boolean isForm()

Is this handler dedicated to Form sub-class processing. Overrided by EditFormHandler.

Since:

jcms-4.0

setItemPos

public void setItemPos(int v)

setId

public void setId(java.lang.String id)

Set the value of id.

Overrides:

setId in class EditDataHandler

Parameters:

id - Value to assign to id.

setTitle

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

setCids

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

setAuthor

public void setAuthor(java.lang.String v)

setTemplates

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

setPstatus

public void setPstatus(int v)

setPdate

public void setPdate(java.lang.String v)

setEdate

public void setEdate(java.lang.String v)

setSdate

public void setSdate(java.lang.String v)

setAdate

public void setAdate(java.lang.String v)

setWfNote

public void setWfNote(java.lang.String v)

setAuthorizedMemberSetAddCount

public void setAuthorizedMemberSetAddCount(int v)

getAuthorizedMemberSetCount

public int getAuthorizedMemberSetCount()

setAuthorizedMemberIds

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

setAuthorizedGroupIds

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

setUpdateMemberSetAddCount

public void setUpdateMemberSetAddCount(int v)

getUpdateMemberSetCount

public int getUpdateMemberSetCount()

setUpdateMemberIds

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

setUpdateGroupIds

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

getAnchor

public java.lang.String getAnchor()

Get the value of anchor.

Returns:

Value of anchor.

setAnchor

public void setAnchor(java.lang.String v)

Set the value of anchor.

Parameters:

v - Value to assign to anchor.

setTracked

public void setTracked(boolean v)

Since:

jcms-4.0.2

getAvailableTracked

public boolean getAvailableTracked()

Since:

jcms-4.0.2

getAvailableWorkspace

public Workspace getAvailableWorkspace()

Returns:

Returns the workspace.

setMainLanguage

public void setMainLanguage(java.lang.String v)

Set the main language.

Since:

jcms-5.5.0

getAvailableMainLanguage

public java.lang.String getAvailableMainLanguage()

Returns:

the main language of the publication.

setFriendlyURL

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

Set the friendly urls.

Since:

jcms-5.5.0

getAvailableFriendlyURLSet

public java.util.TreeSet<java.lang.String> getAvailableFriendlyURLSet()

Returns:

the friendly urls HashMap (including the default language)

Since:

jcms-5.5.0

setRoleId

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

Set the role ids

Since:

jcms-5.5.0

getAvailableRoleMap

public java.util.HashMap<java.lang.String,java.util.TreeSet<Member>> getAvailableRoleMap()

Returns:

the roleMap

Since:

jcms-5.5.0

getMemberSetAssignedToRole

public java.util.TreeSet<Member> getMemberSetAssignedToRole(java.lang.String roleId)

Parameters:

roleId - a WFRole id

Returns:

the set of member assigned to the given roleId

Since:

jcms-5.5.0

getTypeLabel

public java.lang.String getTypeLabel()

Returns the label of the edited type.

Returns:

the label of the edited type.

Since:

jcms-5.7.0

cannotRead

public boolean cannotRead()

Returns true if the loggedMember cannot read this publication.

Returns:

true if the loggedMember cannot read this publication.

Since:

jcms-5.7.0

getWorkAreaCss

public java.lang.String getWorkAreaCss()

Returns the css class used for style, and javascript window resize in footer in popup edition.

Returns:

the css class used for style, and javascript window resize in footer in popup edition.

Since:

jcms-5.7.0

getFieldStatus

public FieldStatus getFieldStatus(java.lang.String fieldName)

Returns the FieldStatus for the given field.

Parameters:

fieldName - the name of the field

Returns:

the FieldStatus for the given field (never null).

Since:

jcms-6.0.1