Class EditPublicationHandler

    • Field Detail

      • 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
      • CTX_SKIP_ACTIVITY

        public static final java.lang.String CTX_SKIP_ACTIVITY
        See Also:
        Constant Field Values
      • LAST_PUBLICATION_NOT_STORED

        public static final java.lang.String LAST_PUBLICATION_NOT_STORED
        Session attribute name used to store the last Publication not created, by user request.

        Creation can be cancelled with doNotStore=true parameter.
        Used by "work/lastPublicationXml.jsp" to dump the last Data content as XML.

        See Also:
        setDoNotStore(String), Constant Field Values
      • opMerge

        protected boolean opMerge
      • opAddItem

        protected boolean opAddItem
      • opAddItemReadRights

        protected boolean opAddItemReadRights
      • opAddItemUpdateRights

        protected boolean opAddItemUpdateRights
      • majorUpdate

        protected boolean majorUpdate
      • opTrash

        protected boolean opTrash
      • opUntrash

        protected boolean opUntrash
      • 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
      • restrictUpdateRights

        protected boolean restrictUpdateRights
      • anchor

        protected java.lang.String anchor
      • isTracked

        protected boolean isTracked
      • readAck

        protected boolean readAck
      • 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
      • pubClass

        protected java.lang.Class<? extends Publication> pubClass
      • 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
      • attachWorkspaceSet

        protected java.util.Set<Workspace> attachWorkspaceSet
      • 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
      • reviewRating

        protected int reviewRating
      • listToProcess

        protected java.lang.String listToProcess
      • itemPos

        protected int itemPos
      • fieldStatusMap

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

        protected boolean doNotStore
      • opLock

        protected boolean opLock
      • opUnlock

        protected boolean opUnlock
      • opRequestUnlock

        protected boolean opRequestUnlock
      • checkMemberForRequestUnlock

        protected boolean checkMemberForRequestUnlock
      • requestUnlockMessage

        protected java.lang.String requestUnlockMessage
      • ignoreWorkspaceCompliance

        protected boolean ignoreWorkspaceCompliance
      • skipActivity

        protected boolean skipActivity
      • useDefaultCategories

        protected boolean useDefaultCategories
      • useDefaultCategoriesModified

        protected boolean useDefaultCategoriesModified
      • useDefaultReadRights

        protected boolean useDefaultReadRights
      • useDefaultReadRightsModified

        protected boolean useDefaultReadRightsModified
      • useDefaultUpdateRights

        public boolean useDefaultUpdateRights
      • useDefaultUpdateRightsModified

        public boolean useDefaultUpdateRightsModified
    • Constructor Detail

      • EditPublicationHandler

        public EditPublicationHandler()
    • Method Detail

      • getPublicationClass

        public 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()
      • setWSTypeEntry

        public void setWSTypeEntry​(WSTypeEntry wste)
        Force the WSTypeEntry to use with the specified one
        Parameters:
        wste - must not be null
        Since:
        jcms-10.0.6 / JCMS-8724
      • 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
      • getOldPstatus

        public int getOldPstatus()
      • 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 - IO Exception
      • mustSendForbiddenOnCSRF

        protected boolean mustSendForbiddenOnCSRF()
        Description copied from class: JcmsFormHandler
        Check behavior to apply on CSRF error.

        Default behavior is to send forbidden redirect, this method allows the redirection to be skipped and form to be displayed.

        Override with extreme precaution, if you want to display form on CSRF error, make sure user is authorized to access data manipulated.

        Overrides:
        mustSendForbiddenOnCSRF in class JcmsFormHandler
        Returns:
        true to send forbidden (default), false to display form with current user data. In both case processAction is not invoked.
      • validateBeforeOp

        public boolean validateBeforeOp()
      • releaseDBWorkingPub

        protected void releaseDBWorkingPub()
      • lock

        protected void lock()
      • unlock

        protected void unlock()
      • sendRedirect

        protected void sendRedirect()
                             throws java.io.IOException
        Overrides:
        sendRedirect in class EditDataHandler
        Throws:
        java.io.IOException
      • initWorkspace

        protected void initWorkspace()
      • validateMember

        public boolean validateMember()
                               throws java.io.IOException
        Throws:
        java.io.IOException
      • validateForm

        public boolean validateForm()
                             throws java.io.IOException
        Returns true if the publication class can be published in workspace.
        Returns:
        true if the publication class can be published in workspace.
        Throws:
        java.io.IOException - if an exception occurs
        Since:
        jcms-8.0.3, jcms-9.0.1
      • 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 - if an error occurs
      • 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
      • workflowHasNotBeenChanged

        protected boolean workflowHasNotBeenChanged()
      • setSilentUpdate

        public void setSilentUpdate​(java.lang.String val)
      • 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
      • validateTrash

        public boolean validateTrash()
                              throws java.io.IOException
        Check all condition required are met to authorize current publication to be put in the trash.
        Returns:
        true if operation can be performed, false otherwise
        Throws:
        java.io.IOException - if this exception occures
        Since:
        jcms-10.0.5 / JCMS-8353
      • performTrash

        public boolean performTrash()
                             throws java.io.IOException
        Effectively update the publication so it is put in the trash.
        Returns:
        true, indicating a redirect must be performed
        Throws:
        java.io.IOException - if this exception occures
        Since:
        jcms-10.0.5 / JCMS-8353
      • validateUntrash

        public boolean validateUntrash()
                                throws java.io.IOException
        Check all condition required are met to authorize current publication to be removed from the trash.
        Returns:
        true if operation can be performed, false otherwise
        Throws:
        java.io.IOException - if this exception occures
        Since:
        jcms-10.0.5 / JCMS-8353
      • performUntrash

        public boolean performUntrash()
                               throws java.io.IOException
        Effectively update the publication so it is removed from trash.
        Returns:
        true, indicating a redirect must be performed
        Throws:
        java.io.IOException - if this exception occures
        Since:
        jcms-10.0.5 / JCMS-8353
      • validateLock

        public boolean validateLock()
                             throws java.io.IOException
        Throws:
        java.io.IOException
      • performLock

        public boolean performLock()
                            throws java.io.IOException
        Throws:
        java.io.IOException
      • validateUnlock

        public boolean validateUnlock()
                               throws java.io.IOException
        Throws:
        java.io.IOException
      • performUnlock

        public boolean performUnlock()
                              throws java.io.IOException
        Throws:
        java.io.IOException
      • validateRequestUnlock

        public boolean validateRequestUnlock()
                                      throws java.io.IOException
        Throws:
        java.io.IOException
      • performRequestUnlock

        public boolean performRequestUnlock()
                                     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
      • 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
      • showReadAck

        public boolean showReadAck()
      • showAttachWorkspaceSet

        public boolean showAttachWorkspaceSet()
      • showMainLanguage

        public boolean showMainLanguage()
      • showSDate

        public boolean showSDate()
      • showFriendlyURL

        public boolean showFriendlyURL()
      • showLanguageChooser

        public boolean showLanguageChooser()
        Returns:
        true if channel is multilingual and current Publication type has at least one multilingual field.
      • 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 (by another Member).
        Returns:
        true if the publication is (weakly) locked (by another Member).
        Since:
        jcms-5.7.0
      • isStrongLocked

        public boolean isStrongLocked()
        Returns true if the publication is locked (strong lock) by another Member.
        Returns:
        true if the publication is locked (strong lock) by another Member.
        Since:
        jcms-5.7.0
      • checkStrongLock

        public boolean checkStrongLock()
      • 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
      • containsHiddenFields

        protected boolean containsHiddenFields()
      • setShowAllTabs

        public void setShowAllTabs​(boolean v)
      • getShowAllTabs

        public boolean getShowAllTabs()
      • setShowContentTabOnly

        public void setShowContentTabOnly​(boolean v)
      • getShowContentTabOnly

        public boolean getShowContentTabOnly()
      • isContentTabOnly

        public boolean isContentTabOnly()
      • isCategoryTabHidden

        public boolean isCategoryTabHidden()
      • isReadRightTabHidden

        public boolean isReadRightTabHidden()
      • isUpdateRightTabHidden

        public boolean isUpdateRightTabHidden()
      • isCommonRightTabHidden

        protected boolean isCommonRightTabHidden​(boolean isReadTab)
      • isTemplateTabHidden

        public boolean isTemplateTabHidden()
      • isWorkflowTabHidden

        public boolean isWorkflowTabHidden()
      • isAdvancedTabHidden

        public boolean isAdvancedTabHidden()
      • setUseDefaultCategories

        public void setUseDefaultCategories​(boolean useDefaultCategories)
      • getAvailableUseDefaultCategories

        public boolean getAvailableUseDefaultCategories()
      • 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
      • resetCategorySet

        public void resetCategorySet()
        Invalidate any computed cache of the categorySet value
        Since:
        jcms-10.0.6 / JCMS-8724
      • getHiddenCatSet

        public java.util.Set<Category> getHiddenCatSet​(java.util.Set<Category> typeRemovedCatSet)
        Parameters:
        typeRemovedCatSet - the root of categories for custom fields
        Returns:
        the hidden categories
        Since:
        jcms-5.6.2
      • isExpanded

        public boolean isExpanded​(Category cat,
                                  java.lang.String inputName)
        Parameters:
        cat - the category
        inputName - the name of the input
        Returns:
        true if the given category must be expanded
        Since:
        jcms-3.0
      • getTitleFieldValue

        public java.lang.Object getTitleFieldValue​(boolean isTitleML)
        Retrieve an UNESCAPED version of the title(s).

        DO NOT print this value in HTML without proper encoding.

        Parameters:
        isTitleML - true if the title is multilingual
        Returns:
        a String (for monolingual title) or a Map<String,String> (for multilingual title)
      • 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()
      • getAvailableWFNote

        public java.lang.String getAvailableWFNote()
      • getAvailableUseDefaultReadRights

        public boolean getAvailableUseDefaultReadRights()
        Check if default read rights should be used.

        If corresponding setter was not invoked at all, the behavior is as follow :

        • if authorized group/member set value are specified they are used, otherwise
        • for create operation, the default rights are used
        • for updated operation, the existing publication rights are used
        Returns:
        true to use default authorized group/member Set, false for behavior describe above.
        Since:
        jcms-10.0.4 / JCMS-7744
        See Also:
        setUseDefaultReadRights(boolean)
      • getAvailableAuthorizedMemberSet

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

        public java.util.Set<Member> getDefaultAuthorizedMemberSet()
        This method should be overriden by sub-classes
        Returns:
        the default authorized member Set (never retun null).
        Since:
        jcms-3.0
      • getAvailableAuthorizedGroupSet

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

        public int getAuthorizedGroupsCount()
      • getUpdateGroupsCount

        public int getUpdateGroupsCount()
      • getDefaultAuthorizedGroupSet

        public java.util.Set<Group> getDefaultAuthorizedGroupSet()
        This method should be overriden by sub-classes
        Returns:
        the default authorized group Set (never return null).
        Since:
        jcms-3.0
      • getDefaultCategorySet

        public java.util.Set<Category> getDefaultCategorySet()
        This method should be overriden by sub-classes
        Returns:
        the default category Set.
        Since:
        jcms-3.0
      • getAvailableUseDefaultUpdateRights

        public boolean getAvailableUseDefaultUpdateRights()
        Check if default update rights should be used.

        If corresponding setter was not invoked at all, the behavior is as follow :

        • if authorized group/member set value are specified they are used, otherwise
        • for create operation, the default rights is used
        • for updated operation, the existing publication rights are used
        Returns:
        true to use default update group/member Set, false for behavior describe above.
        Since:
        jcms-10.0.4 / JCMS-7744
        See Also:
        setUseDefaultUpdateRights(boolean)
      • getAvailableUpdateMemberSet

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

        public java.util.Set<Member> getDefaultUpdateMemberSet()
        This method should be overriden by sub-classes
        Returns:
        the default update member Set (never retun null).
        Since:
        jcms-4.0
      • getAvailableUpdateGroupSet

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

        public java.util.Set<Group> getDefaultUpdateGroupSet()
        This method should be overriden by sub-classes
        Returns:
        the default update group Set (never retun null).
        Since:
        jcms-4.0
      • getAvailableRestrictUpdateRights

        public boolean getAvailableRestrictUpdateRights()
      • setRestrictUpdateRights

        public void setRestrictUpdateRights​(java.lang.String v)
      • 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)
        Parameters:
        v - the cids
        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
      • setOpUpdateMajor

        public void setOpUpdateMajor​(java.lang.String v)
      • setOpMerge

        public void setOpMerge​(java.lang.String v)
      • setOpLock

        public void setOpLock​(java.lang.String v)
      • setOpUnlock

        public void setOpUnlock​(java.lang.String v)
      • setOpRequestUnlock

        public void setOpRequestUnlock​(java.lang.String v)
      • setCheckMemberForRequestUnlock

        public void setCheckMemberForRequestUnlock​(java.lang.String v)
      • setRequestUnlockMessage

        public void setRequestUnlockMessage​(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()
      • setOpTrash

        public void setOpTrash​(java.lang.String v)
        Request publication to be moved in trash.

        Any invocation of this setter will request the trash action (value itself is ignored)

        Parameters:
        v - any value
        Since:
        jcms-10.0.5 / JCMS-8353
      • setOpUntrash

        public void setOpUntrash​(java.lang.String v)
        Request publication to be moved outside trash and restored to its previous state.

        Any invocation of this setter will request the untrash action (value itself is ignored)

        Parameters:
        v - any value
        Since:
        jcms-10.0.5 / JCMS-8353
      • isForm

        public boolean isForm()
        Returns:
        true if this handler is 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)
      • getAvailableTracked

        public boolean getAvailableTracked()
      • setReadAck

        public void setReadAck​(boolean v)
      • getAvailableReadAck

        public boolean getAvailableReadAck()
      • getAvailableWorkspace

        public Workspace getAvailableWorkspace()
        Returns:
        Returns the workspace.
      • setMainLanguage

        public void setMainLanguage​(java.lang.String v)
      • setFriendlyURL

        public void setFriendlyURL​(java.lang.String[] v)
      • 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)
      • 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
      • setDoNotStore

        public void setDoNotStore​(java.lang.String str)
        Request that create operation is not stored after successful validation.

        If enabled, the Data is validated, but not stored in JStore or JcmsDB, instead the Data is added has a session attribute LAST_PUBLICATION_NOT_STORED.

        Can be used with redirect value "work/lastPublicationXml.jsp" to dump the Data content as XML.

        Default is false.

        Parameters:
        str - a boolean value as string
        Since:
        jcms-9.0.0
        See Also:
        LAST_PUBLICATION_NOT_STORED
      • getDoNotStore

        public java.lang.String getDoNotStore()
        Retrieve the current value of the doNotStore option.

        See setDoNotStore(String) for complete information of behavior introduced by this option.

        Returns:
        a String representation of the doNotStore boolean option, true if create operation should be skipped, false if operation should be performed as usual
        See Also:
        setDoNotStore(String)
      • setIgnoreWorkspaceCompliance

        public void setIgnoreWorkspaceCompliance​(boolean v)
        Set or disabled workspace compliance check. If workspace compliance is enabled and the publication type cannot be published in the selected workspace, another workspace will be searched.
        Parameters:
        v - the value
        Since:
        jcms-9.0.0
      • getIgnoreWorkspaceCompliance

        public boolean getIgnoreWorkspaceCompliance()
        Returns true if workspace compliance is ignored ; false otherwise.
        Returns:
        true if workspace compliance is ignored ; false otherwise.
        Since:
        jcms-9.0.0
      • getWorkspaceComplianceWarning

        public boolean getWorkspaceComplianceWarning()
        Returns true if workspace compliance warning message is ignored ; false otherwise.
        Returns:
        true if workspace compliance warning message is ignored ; false otherwise.
        Since:
        jcms-9.0.2
      • setWorkspaceComplianceWarning

        public void setWorkspaceComplianceWarning​(boolean workspaceComplianceWarning)
        Set or disabled workspace compliance warning message. If workspace compliance is enabled and the publication type cannot be published in the selected workspace, a warning message is displayed to the user.
        Parameters:
        workspaceComplianceWarning - the value
        Since:
        jcms-9.0.2
      • setAttachWorkspaceIds

        public void setAttachWorkspaceIds​(java.lang.String[] v)
      • getAvailableAttachWorkspaceSet

        public java.util.Set<Workspace> getAvailableAttachWorkspaceSet()
      • setSkipActivity

        public void setSkipActivity​(java.lang.String v)
        If true skip the ESN activity
        Parameters:
        v - the value
        Since:
        jcms-10.0.0
      • getAvailableSkipActivity

        public boolean getAvailableSkipActivity()
      • isFormStepClickable

        public boolean isFormStepClickable()
        Description copied from class: JcmsFormHandler
        Returns true if the form step are clickable.
        Overrides:
        isFormStepClickable in class JcmsFormHandler
        Returns:
        true if the form step are clickable.