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:
AddArticleHandler,DocUploadHandler,DuplicateModalHandler,EditAbstractJPortalHandler,EditFileDocumentHandler,EditFormHandler,EditPortalElementHandler,generated.EditShortcutHandler,ValidateStateChangePublicationHandler
public class EditPublicationHandler extends EditDataHandler
This form handler processesPublicationforms.- Author:
- Olivier Dedieu
- See Also:
Publication
-
-
Field Summary
Fields Modifier and Type Field Description protected java.util.Dateadateprotected java.lang.Stringanchorprotected java.util.Set<Workspace>attachWorkspaceSetprotected Memberauthorprotected intauthorizedGroupsAddCountprotected java.util.TreeSet<Group>authorizedGroupSetprotected java.util.TreeSet<Member>authorizedMemberSetprotected intauthorizedMemberSetAddCountprotected java.util.Set<Category>categorySetprotected booleancheckMemberForRequestUnlockprotected java.lang.String[]cidsprotected intclassificationLevelstatic java.lang.StringCTX_SKIP_ACTIVITYstatic java.lang.StringDISPLAY_URL_TOKENprotected booleandoNotStoreprotected java.util.Dateedateprotected java.util.Map<java.lang.String,FieldStatus>fieldStatusMapprotected java.util.TreeSet<java.lang.String>friendlyURLSetstatic java.lang.StringID_TOKENprotected booleanignoreWorkspaceComplianceprotected WorkflowinternalWfprotected booleanisAuthorForcedprotected booleanisContentTypeprotected booleanisDBTypeprotected booleanisFormTypeprotected booleanisPortletTypeprotected booleanisTrackedprotected booleanisUGCTypeprotected intitemPosstatic java.lang.StringLAST_PUBLICATION_NOT_STOREDSession attribute name used to store the last Publication not created, by user request.protected java.lang.StringlistToProcessprotected java.lang.StringmainLanguageprotected booleanmajorUpdateprotected intoldPstatusprotected booleanopAddItemprotected booleanopAddItemReadRightsprotected booleanopAddItemUpdateRightsprotected intopenTabprotected booleanopLockprotected booleanopMergeprotected booleanopRequestUnlockprotected booleanopTrashprotected booleanopUnlockprotected booleanopUntrashprotected java.util.Datepdatestatic java.lang.StringPREVIEW_URL_TOKENprotected intpstatusprotected java.lang.Class<? extends Publication>pubClassprotected Publicationpublicationprotected booleanreadAckprotected java.lang.StringrequestUnlockMessageprotected booleanrestrictUpdateRightsprotected intreviewRatingprotected java.lang.String[]roleIdsprotected java.util.HashMap<java.lang.String,java.util.TreeSet<Member>>roleMapprotected Member[]roleMembersprotected java.util.Datesdateprotected booleanshowAllTabsprotected booleanshowContentTabOnlyprotected booleanskipActivityprotected java.lang.String[]templatesprotected java.lang.Stringtitleprotected java.util.HashMap<java.lang.String,java.lang.String>titleMLprotected java.lang.StringtypeLabelprotected intupdateGroupsAddCountprotected java.util.TreeSet<Group>updateGroupSetprotected java.util.TreeSet<Member>updateMemberSetprotected intupdateMemberSetAddCountprotected booleanuseDefaultCategoriesprotected booleanuseDefaultCategoriesModifiedprotected booleanuseDefaultReadRightsprotected booleanuseDefaultReadRightsModifiedbooleanuseDefaultUpdateRightsbooleanuseDefaultUpdateRightsModifiedprotected Workflowwfprotected java.lang.StringwfNoteprotected PublicationworkingPubprotected WSTypeEntrywste-
Fields inherited from class com.jalios.jcms.handler.EditDataHandler
extFormHandler, id, isDeleteForced, opCancel, opCreate, opDelete, opRefresh, opUpdate, resultOpCreate, resultOpDelete, resultOpUpdate
-
Fields inherited from class com.jalios.jcms.handler.JcmsFormHandler
contextMap, csrfValidationEnabled, editFieldSet, formStep, noRedirect, noSendRedirect, op, opFinish, opNext, opPrevious, 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, isDebugTemplatePath, isLogged, loggedMember, request, response, userCountry, userLang, userLocale, userZoneId, workspace
-
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
-
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, CLASS_PROPERTY, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, COUNTRY_SPRITE, CS_TYPOLOGY_ROOT_CAT_VID, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DATA_DIRECTORY, DEFAULT_PHOTO_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, GLYPH_ICON_PREFIX, ICON_ARCHIVE, ICON_ICON_PREFIX, ICON_LOCK, ICON_LOCK_STRONG, ICON_PREFIX_PROP, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, IS_IN_FRONT_OFFICE, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JCMS_TOASTR_COLLECTION, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LANG_SPRITE, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_CREATE_STR, OP_DEEP_COPY, OP_DEEP_COPY_STR, OP_DEEP_DELETE, OP_DEEP_DELETE_STR, OP_DELETE, OP_DELETE_STR, OP_MERGE, OP_MERGE_STR, OP_UPDATE, OP_UPDATE_STR, ORGANIZATION_ROOT_GROUP_PROP, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_PROP_PREFIX, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_PROP_PREFIX, PHOTO_LARGE_WIDTH, PHOTO_MINI, PHOTO_MINI_HEIGHT, PHOTO_MINI_PROP_PREFIX, PHOTO_MINI_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_PROP_PREFIX, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_PROP_PREFIX, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_PROP_PREFIX, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, RAW_CONTENT_ICON_PREFIX, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SECURITY_LOG_FILE, SESSION_AUTHORIZED_FILENAMES_SET, SPRITE_ICON_PREFIX, STATS_REPORT_DIR, STATUS_PROP, STORE_DIR, STORE_XML, SUCCESS_MSG, SVG_ICON_PREFIX, SVGINLINE_ICON_PREFIX, 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, UPLOAD_PERMISSION_COUNT_PROP_PREFIX, UPLOAD_PERMISSION_SIZE_PROP_PREFIX, URL_REGEXP, VID_LOGGED_MEMBER, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML
-
-
Constructor Summary
Constructors Constructor Description EditPublicationHandler()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleancannotRead()Returns true if the loggedMember cannot read this publication.booleancheckStrongLock()protected booleancontainsHiddenFields()booleancontainsHiddenParts()static voiddoWorkflowUpdate(Publication origPub, Publication updatedPub, EditPublicationHandler handler)java.util.HashMap<java.lang.String,java.lang.String>getAllAvailableTitleML()java.lang.StringgetAnchor()Get the value of anchor.intgetAuthorizedGroupsCount()intgetAuthorizedMemberSetCount()java.util.DategetAvailableAdate()java.util.Set<Workspace>getAvailableAttachWorkspaceSet()MembergetAvailableAuthor()java.util.Set<Group>getAvailableAuthorizedGroupSet()java.util.Set<Member>getAvailableAuthorizedMemberSet()Category[]getAvailableCategories()intgetAvailableClassificationLevel()Retrieve the classification level current available for the edition in progressjava.util.DategetAvailableEdate()java.lang.ObjectgetAvailableField(java.lang.String field)Get value of the given field calling getAvailable{field}().java.util.TreeSet<java.lang.String>getAvailableFriendlyURLSet()WorkflowgetAvailableInternalWorkflow()java.lang.StringgetAvailableMainLanguage()booleangetAvailableMajorUpdate()java.util.DategetAvailablePdate()intgetAvailablePstatus()booleangetAvailableReadAck()booleangetAvailableRestrictUpdateRights()java.util.HashMap<java.lang.String,java.util.TreeSet<Member>>getAvailableRoleMap()java.util.DategetAvailableSdate()booleangetAvailableSkipActivity()TypeTemplateEntrygetAvailableTemplateEntry(java.lang.String usage)java.lang.String[]getAvailableTemplates()java.lang.StringgetAvailableTitle()java.lang.StringgetAvailableTitle(java.lang.String lang)java.util.HashMap<java.lang.String,java.lang.String>getAvailableTitleML()booleangetAvailableTracked()java.util.Set<Group>getAvailableUpdateGroupSet()java.util.Set<Member>getAvailableUpdateMemberSet()booleangetAvailableUseDefaultCategories()booleangetAvailableUseDefaultReadRights()Check if default read rights should be used.booleangetAvailableUseDefaultUpdateRights()Check if default update rights should be used.java.lang.StringgetAvailableWFNote()WorkspacegetAvailableWorkspace()java.util.Set<Category>getCategorySet(java.lang.String inputName)Returns the root set bound to the given inputNameEnumerateSettingsgetClassificationLevelSettings()Retrieve a settings suitable to edit a classification level in the current context.protected java.lang.StringgetClosePopupUrl()protected java.util.HashMap<java.lang.String,java.lang.Object>getControllerContext()Build a controller context.java.lang.Class<? extends Data>getDataClass()java.util.Set<Group>getDefaultAuthorizedGroupSet()This method should be overriden by sub-classesjava.util.Set<Member>getDefaultAuthorizedMemberSet()This method should be overriden by sub-classesjava.util.Set<Category>getDefaultCategorySet()This method should be overriden by sub-classesjava.lang.StringgetDefaultTemplateUsage()Returns the default template usage used to display the publication.java.util.Set<Group>getDefaultUpdateGroupSet()This method should be overriden by sub-classesjava.util.Set<Member>getDefaultUpdateMemberSet()This method should be overriden by sub-classesjava.lang.StringgetDoNotStore()Retrieve the current value of the doNotStore option.FieldStatusgetFieldStatus(java.lang.String fieldName)Returns the FieldStatus for the given field.java.util.Set<Category>getHiddenCatSet(java.util.Set<Category> typeRemovedCatSet)booleangetIgnoreWorkspaceCompliance()Returns true if workspace compliance is ignored ; false otherwise.java.util.TreeSet<Member>getMemberSetAssignedToRole(java.lang.String roleId)intgetOldPstatus()intgetOpenTab()PublicationgetPublication()java.lang.Class<? extends Publication>getPublicationClass()booleangetShowAllTabs()booleangetShowContentTabOnly()java.lang.StringgetTabLabel(java.lang.String tabId)java.lang.ObjectgetTitleFieldValue(boolean isTitleML)Retrieve an UNESCAPED version of the title(s).java.lang.StringgetTypeLabel()Returns the label of the edited type.intgetUpdateGroupsCount()intgetUpdateMemberSetCount()java.lang.StringgetWorkAreaCss()Returns the css class used for style, and javascript window resize in footer in popup edition.WorkflowgetWorkflow()booleangetWorkspaceComplianceWarning()Returns true if workspace compliance warning message is ignored ; false otherwise.ControlSettingsgetWorkspaceSettings()WSTypeEntrygetWSTypeEntry()protected voidinit()Method to implement if you need to initialize your handler from parameter received, prior to all security validation.protected voidinitWorkspace()protected booleaninternalPerformCreate()protected booleaninternalPerformDelete()protected booleaninternalPerformUpdate()booleanisAdvancedTabHidden()booleanisCategoryTabHidden()booleanisClassificationTabHidden()Check if the classification tab should be hidden or notprotected booleanisCommonRightTabHidden(boolean isReadTab)booleanisContentTabOnly()booleanisDBType()Returns true if the publication class extends DBData.booleanisExpanded(Category cat, java.lang.String inputName)booleanisFieldEdition(java.lang.String field)booleanisForm()booleanisFormStepClickable()Returns true if the form step are clickable.booleanisLocked()Returns true if the publication is (weakly) locked (by another Member).booleanisReadRightTabHidden()booleanisStrongLocked()Returns true if the publication is locked (strong lock) by another Member.booleanisTabForced()booleanisTemplateTabHidden()booleanisUpdateRightTabHidden()booleanisWorkflowTabHidden()protected voidlock()protected booleanmustSendForbiddenOnCSRF()Check behavior to apply on CSRF error.booleanperformAddItem()booleanperformAddItemReadRights()booleanperformAddItemUpdateRights()booleanperformCreate()booleanperformDelete()booleanperformLock()booleanperformMerge()booleanperformRefresh()booleanperformRequestUnlock()booleanperformTrash()Effectively update the publication so it is put in the trash.booleanperformUnlock()booleanperformUntrash()Effectively update the publication so it is removed from trash.booleanperformUpdate()voidprepare()booleanprocessAction()Method to be implemented to check/validate action to be performed and process them.protected booleanprocessStatus(ControllerStatus status)Process the ControllerStatus: do nothing if OK, or send on forbidden, or put a warning message in the request.protected voidreleaseDBWorkingPub()voidresetCategorySet()Invalidate any computed cache of the categorySet valueprotected voidsendRedirect()voidsetAdate(java.lang.String v)voidsetAnchor(java.lang.String v)Set the value of anchor.voidsetAttachWorkspaceIds(java.lang.String[] v)voidsetAuthor(java.lang.String v)voidsetAuthorForced(boolean v, Member author)voidsetAuthorizedGroupIds(java.lang.String[] v)voidsetAuthorizedMemberIds(java.lang.String[] v)voidsetAuthorizedMemberSetAddCount(int v)voidsetCheckMemberForRequestUnlock(java.lang.String v)voidsetCids(java.lang.String[] v)voidsetClassificationLevel(int level)Set the classification level to assign to the edited publicationvoidsetDoNotStore(java.lang.String str)Request that create operation is not stored after successful validation.voidsetEdate(java.lang.String v)voidsetFields(Publication pub)Set the common (Publication) fields.voidsetFriendlyURL(java.lang.String[] v)voidsetId(java.lang.String id)Set the value of id.voidsetIgnoreWorkspaceCompliance(boolean v)Set or disabled workspace compliance check.voidsetInternalWf(java.lang.String internalWf)voidsetItemPos(int v)voidsetMainLanguage(java.lang.String v)voidsetMajorUpdate(java.lang.String v)voidsetOpAddItem(java.lang.String v)voidsetOpAddItemReadRights(java.lang.String v)voidsetOpAddItemUpdateRights(java.lang.String v)voidsetOpenTab(int openTab)Set the open tabvoidsetOpLock(java.lang.String v)voidsetOpMerge(java.lang.String v)voidsetOpRequestUnlock(java.lang.String v)voidsetOpTrash(java.lang.String v)Request publication to be moved in trash.voidsetOpUnlock(java.lang.String v)voidsetOpUntrash(java.lang.String v)Request publication to be moved outside trash and restored to its previous state.voidsetOpUpdateMajor(java.lang.String v)voidsetPdate(java.lang.String v)voidsetPstatus(int v)voidsetReadAck(boolean v)voidsetRequestUnlockMessage(java.lang.String v)voidsetRestrictUpdateRights(java.lang.String v)voidsetRoleId(java.lang.String[] v)voidsetSdate(java.lang.String v)voidsetShowAllTabs(boolean v)voidsetShowContentTabOnly(boolean v)voidsetSilentUpdate(java.lang.String val)voidsetSkipActivity(java.lang.String v)If true skip the ESN activityvoidsetTemplates(java.lang.String[] v)voidsetTitle(java.lang.String[] v)voidsetTracked(boolean v)voidsetUpdateGroupIds(java.lang.String[] v)voidsetUpdateMemberIds(java.lang.String[] v)voidsetUpdateMemberSetAddCount(int v)voidsetUseDefaultCategories(boolean useDefaultCategories)voidsetUseDefaultReadRights(boolean useDefaultReadRights)Explicitely request the use of default read rights instead of any read rights that might be specified.voidsetUseDefaultUpdateRights(boolean useDefaultUpdateRights)Explicitely request the use of default update rights instead of any update rights that might be specified.voidsetWfNote(java.lang.String v)voidsetWorkspaceComplianceWarning(boolean workspaceComplianceWarning)Set or disabled workspace compliance warning message.voidsetWSTypeEntry(WSTypeEntry wste)Force the WSTypeEntry to use with the specified onebooleanshowAttachWorkspaceSet()booleanshowForceDelete()Returns true if the "Force deletion" option must be proposed.booleanshowFriendlyURL()booleanshowLanguageChooser()booleanshowLockWarning()Returns true if the lock warning message must be displayed.booleanshowMainLanguage()booleanshowReadAck()booleanshowReaderTracker()booleanshowSDate()booleanshowWFRole()protected voidunlock()voidupdateCids(java.lang.String[] v)Update the cids (this method is called by setCids() and all setCidsXXX() methods)booleanvalidateAddItem()booleanvalidateAddItemReadRights()booleanvalidateAddItemUpdateRights()booleanvalidateBeforeOp()booleanvalidateCreate()booleanvalidateDelete()booleanvalidateFieldFormat()booleanvalidateForm()Returns true if the publication class can be published in workspace.booleanvalidateLock()booleanvalidateMember()booleanvalidateMerge()booleanvalidateRequestUnlock()booleanvalidateTrash()Check all condition required are met to authorize current publication to be put in the trash.booleanvalidateUnlock()booleanvalidateUntrash()Check all condition required are met to authorize current publication to be removed from the trash.booleanvalidateUpdate()booleanvalidateWorkspace()protected booleanworkflowHasNotBeenChanged()-
Methods inherited from class com.jalios.jcms.handler.EditDataHandler
afterValidation, createUploadedFileDocument, createUploadedFileDocument, createUploadedFileDocument, createUploadedFileDocument, getAvailableData, getAvailableDataArray, getAvailableExtraDataMap, getAvailableExtraDBDataMap, getDeleteRedirect, getEnumLabels, getEnumValues, getExtFormHandler, getId, getModalRedirect, getTabGroupMaxCount, handleRestResponse, isFirstAccess, performCancel, performCreateExtension, performUpdateExtension, processDataId, processDataIds, processDataIds, processMLData, processMLDataArray, restValidation, setExtFormHandler, setExtraDBKeys, setExtraDBValues, setExtraKeys, setExtraValues, setFields, setForceDelete, setOpCancel, setOpCreate, setOpDelete, setOpRefresh, setOpUpdate, validateCancel, validateCreateExtension, validateRefresh, validateUpdateExtension, validateUploadedFileDocument, validateUploadedFileDocument, validateUploadedFileDocument, validateUploadedFileDocument
-
Methods inherited from class com.jalios.jcms.handler.JcmsFormHandler
canStartProcess, checkMissingField, getBackgroundProcess, 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, getMonolingualValue, getMonolingualValueArray, getMultilingualMainValue, getMultilingualMainValueArray, getMultilingualMLMap, getMultilingualMLMapArray, getRedirect, getRedirectOnClosePopup, getWorkspace, isFieldMissing, isPartialFieldEdition, isPopupEdition, isWorkspaceForced, mapStringArrayToMapStringList, mapStringListToMapStringArray, performFinish, performNext, performPrevious, sanitize, sanitize, sendRedirect, sendRedirect, setEditField, setFormStep, setNoRedirect, setNoSendRedirect, setOpFinish, setOpNext, setOpPrevious, setPopupEdition, setRedirect, setRedirectOnClosePopup, setWorkspace, setWs, showCancelButton, showFinishButton, showNextButton, showPreviousButton, startProcess, updateUploadedField, updateUploadedFields, updateUploadedFields, validate, validateCSRF, validateFinish, validateNext, validatePrevious
-
Methods inherited from class com.jalios.jcms.context.JcmsJspContext
addAvoidanceLink, addBodyAttributes, addCSSHeader, addCSSHeader, addCSSHeader, addCSSHeader, addCustomHeader, addHandlebarTemplate, addHttpEquivHeader, addHttpNameHeader, addJavaScript, addJavaScript, addJavaScript, addJavaScriptCode, addPrefetchHeader, addStyleHeader, addStyleHeader, addWebAssets, checkAccess, checkAccess, checkCSRF, debugDisplayContext, disablePacker, forceEditIcon, forceUpdate, getAjaxRequestAttribute, getAjaxRequestId, getAllHeadersDiffMap, getAllHeadersMap, getAvoidanceLinks, getBackOfficeCSSHeader, getBackOfficeJavaScriptSet, getBodyAttributes, getContentForm, getCSSHeaders, getCtxCategories, getCurrentCategory, getCustomHeaders, getDocType, getFinalCSSFooterMap, getFinalCSSMap, getFinalJavaScriptSet, getFrontOfficeCSSHeader, getFrontOfficeJavaScriptSet, getHandlebarTemplates, getHttpEquivHeaders, getHttpNameHeaders, getJavaScriptCodeSet, getJavaScriptSet, getJSONBridge, getPageContext, getPageTitle, getPageZone, getPortal, getPortalCategory, getPortlet, getStyleHeaders, getTemplateUsage, internalSetupEmptyHeader, isEditIcon, isEditIcon, isEditIconForPublish, isEditIconForPublish, isPrintView, registerDisplayContext, removeAjaxRequestAttribute, setAjaxRequestAttribute, setAjaxRequestId, setAllHeadersDiffMap, setDocType, setEditIcon, setPageContext, setPageTitle, setPageZone, setShowEditIcon, setTemplateUsage, showEditIcon, showEditIcon, showEditIcon, workaroundBrowserBaseHrefBug
-
Methods inherited from class com.jalios.jcms.context.JcmsContext
addCookie, addMsg, addMsg, addMsgSession, addMsgSession, addToastr, addToastr, addToastrSession, addToastrSession, applySelector, copyMsgListToMsgSessionList, forceWorkspaceUpdate, getBaseUrl, getBrowser, getCaddy, getContextPath, getErrorMsg, getErrorMsgList, getErrorMsgSession, getErrorMsgSessionList, getInfoMsg, getInfoMsgList, getInfoMsgSession, getInfoMsgSessionList, getLoggedMember, getMsgList, getMsgSessionList, getRequest, getResponse, getSession, getSuccessMsg, getSuccessMsgList, getSuccessMsgSession, getSuccessMsgSessionList, getToastrCollection, getToastrSessionCollection, getUploadedFile, getUploadedFileList, getUploadedFiles, getUploadedFiles, getUrlWithCommonUpdatedParams, getUserCountry, getUserLang, getUserLocale, getUserZoneId, getWarningMsg, getWarningMsgList, getWarningMsgSession, getWarningMsgSessionList, glp, isAdmin, isAdminZone, isAjaxRequest, isDBMember, isDebug, isDebugTemplate, isInFrontOffice, isLogged, isWebdavAccess, isWorkZone, removeMessage, removeMessage, removeMsg, retrieveUploadedFile, select, sendError, sendError, sendForbidden, sendForbidden, sendRedirect, sendRedirect, sendRedirect, setErrorMsg, setErrorMsg, setErrorMsgSession, setErrorMsgSession, setInfoMsg, setInfoMsg, setInfoMsgSession, setInfoMsgSession, setLoggedMember, setRequest, setResponse, setSuccessMsg, setSuccessMsg, setSuccessMsgSession, setSuccessMsgSession, setWarningMsg, setWarningMsg, setWarningMsgSession, setWarningMsgSession, updateWorkspace, validateRegexp, validateSchedule
-
-
-
-
Field Detail
-
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
-
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=trueparameter.
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
-
classificationLevel
protected int classificationLevel
-
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
-
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
-
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
-
workingPub
protected Publication workingPub
-
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
-
-
Method Detail
-
getDataClass
public java.lang.Class<? extends Data> getDataClass()
- Specified by:
getDataClassin classEditDataHandler
-
getPublicationClass
public java.lang.Class<? extends Publication> getPublicationClass()
-
getPublication
public Publication getPublication()
- Overrides:
getPublicationin classJcmsJspContext- 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()
-
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:JcmsFormHandlerMethod 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:
initin classJcmsFormHandler
-
getOldPstatus
public int getOldPstatus()
-
processAction
public boolean processAction() throws java.io.IOExceptionDescription copied from class:JcmsFormHandlerMethod to be implemented to check/validate action to be performed and process them.Default implementation is to return false. No need to call super method.
This method may NOT be invoked at all if security validation are not met.
You must ensure your handler and JSP can work properly without any code invoked in this method.
- Overrides:
processActionin classEditDataHandler- Returns:
- false if no redirection is needed, true otherwise
- Throws:
java.io.IOException- IO Exception
-
mustSendForbiddenOnCSRF
protected boolean mustSendForbiddenOnCSRF()
Description copied from class:JcmsFormHandlerCheck 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:
mustSendForbiddenOnCSRFin classJcmsFormHandler- 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:
sendRedirectin classEditDataHandler- Throws:
java.io.IOException
-
getClosePopupUrl
protected java.lang.String getClosePopupUrl()
- Overrides:
getClosePopupUrlin classJcmsFormHandler
-
initWorkspace
protected void initWorkspace()
-
validateMember
public boolean validateMember() throws java.io.IOException- Throws:
java.io.IOException
-
validateForm
public boolean validateForm() throws java.io.IOExceptionReturns 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:JcmsFormHandlerProcess the ControllerStatus: do nothing if OK, or send on forbidden, or put a warning message in the request.- Overrides:
processStatusin classJcmsFormHandler- 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<java.lang.String,java.lang.Object> getControllerContext()
Description copied from class:JcmsFormHandlerBuild a controller context. I.E. add request, response and loggedMember.- Overrides:
getControllerContextin classEditDataHandler- 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()
-
doWorkflowUpdate
public static void doWorkflowUpdate(Publication origPub, Publication updatedPub, EditPublicationHandler handler)
-
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.IOExceptionCheck 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.IOExceptionEffectively 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.IOExceptionCheck 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.IOExceptionEffectively 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:
performRefreshin classEditDataHandler- 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:
isFieldEditionin classJcmsFormHandler- Parameters:
field- field name- 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
-
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()
-
isClassificationTabHidden
public boolean isClassificationTabHidden()
Check if the classification tab should be hidden or not- Returns:
- true to hide tab, false to display it
- Since:
- 10.0.8 / JCMS-10746
-
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 categoryinputName- 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()
-
setUseDefaultReadRights
public void setUseDefaultReadRights(boolean useDefaultReadRights)
Explicitely request the use of default read rights instead of any read rights that might be specified.- Parameters:
useDefaultReadRights- true to request use of default authorize group/member Set instead of the specified authorized group/member ids, false to use specified value.- Since:
- jcms-10.0.4 / JCMS-7744
- See Also:
getDefaultAuthorizedMemberSet(),setAuthorizedMemberIds(String[]),getDefaultAuthorizedGroupSet(),setAuthorizedGroupIds(String[])
-
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
-
setUseDefaultUpdateRights
public void setUseDefaultUpdateRights(boolean useDefaultUpdateRights)
Explicitely request the use of default update rights instead of any update rights that might be specified.- Parameters:
useDefaultUpdateRights- true to request use of default update group/member Set instead of the specified update group/member ids, false to use specified value.- Since:
- jcms-10.0.4 / JCMS-7744
- See Also:
getDefaultUpdateMemberSet(),setUpdateMemberIds(String[]),getDefaultUpdateGroupSet(),setUpdateGroupIds(String[])
-
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)
-
getAvailableClassificationLevel
public int getAvailableClassificationLevel()
Retrieve the classification level current available for the edition in progress- Returns:
- a classification level
- Since:
- 10.0.8 / JCMS-10746
-
setClassificationLevel
public void setClassificationLevel(int level)
Set the classification level to assign to the edited publication- Parameters:
level- a value from 0 for unclassified publication toClassificationManager.getMaximumLevel()(included) for highly classified publication. 0 if used if null is specified.- Since:
- 10.0.8 / JCMS-10746
-
getClassificationLevelSettings
public EnumerateSettings getClassificationLevelSettings()
Retrieve a settings suitable to edit a classification level in the current context.- Returns:
- a new EnumerateSettings instance
- Since:
- 10.0.8 / JCMS-10746
-
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
-
getAvailableField
public java.lang.Object getAvailableField(java.lang.String field)
Description copied from class:EditDataHandlerGet value of the given field calling getAvailable{field}(). Called by widgets and meta templates See alsoEditDataHandler.getEnumValues(String)andEditDataHandler.getEnumLabels(String, String)- Overrides:
getAvailableFieldin classEditDataHandler- Parameters:
field- the field name- Returns:
- Object return by getAvailable
-
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:
setIdin classEditDataHandler- 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)
-
getAvailableMainLanguage
public java.lang.String getAvailableMainLanguage()
- Overrides:
getAvailableMainLanguagein classJcmsFormHandler- Returns:
- the main language of the publication.
-
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:JcmsFormHandlerReturns true if the form step are clickable.- Overrides:
isFormStepClickablein classJcmsFormHandler- Returns:
- true if the form step are clickable.
-
getWorkspaceSettings
public ControlSettings getWorkspaceSettings()
-
-