Package com.jalios.jcms.workspace
Class EditWorkspaceCommonHandler
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.workspace.AbstractEditWorkspaceHandler
com.jalios.jcms.workspace.EditWorkspaceCommonHandler
- All Implemented Interfaces:
JcmsConstants,JaliosConstants
This form handler process
Workspace forms.- Author:
- Jean-Philippe Encausse
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Member[]protected intprotected HashSetprotected intprotected booleanprotected Groupprotected booleanprotected Stringprotected PortalInterfaceprotected intprotected booleanprotected intprotected Workspaceprotected Categoryprotected Stringprotected HashMapFields inherited from class com.jalios.jcms.workspace.AbstractEditWorkspaceHandler
alertThreshold, GENERAL_TAB, isAlertThresholdValidated, openTab, PREVIOUS_TAB, quotaUnit, quotaValue, useDefaultQuota, workingWSFields inherited from class com.jalios.jcms.handler.EditDataHandler
id, isDeleteForced, opCancel, opCreate, opDelete, opRefresh, opUpdate, resultOpCreate, resultOpDelete, resultOpUpdateFields inherited from class com.jalios.jcms.handler.JcmsFormHandler
contextMap, csrfValidationEnabled, editFieldSet, formStep, noRedirect, noSendRedirect, op, openTabId, opFinish, opNext, opPrevious, popupEdition, redirect, redirectOnClosePopup, workspaceForcedFields inherited from class com.jalios.jcms.context.JcmsJspContext
AJAX_REQUEST_ATTRIBUTES, BODY_HEADER, CSS_FOOTER, CSS_HEADER, cssboMap, cssfoMap, CUSTOM_HEADER, editIcon, HTTPEQUIV_HEADER, httpequivMap, HTTPNAME_HEADER, httpnameMap, initEditIcon, JAVASCRIPT_CODE_SET_ATTRIBUTE, JAVASCRIPT_MODULE_SET_ATTRIBUTE, JAVASCRIPT_SET_ATTRIBUTE, jsboSet, jsfoSet, out, pageContext, SHOW_EDIT_ICON, STYLE_HEADERFields inherited from class com.jalios.jcms.context.JcmsContext
browser, caddy, channel, inFO, initDone, initWorkspace, isAdmin, isAjaxRequest, isDBMember, isDebug, isDebugTemplatePath, isLogged, loggedMember, request, response, userCountry, userLang, userLocale, userZoneId, workspaceFields inherited from interface com.jalios.util.JaliosConstants
CRLF, MILLIS_IN_ONE_DAY, MILLIS_IN_ONE_HOUR, MILLIS_IN_ONE_MINUTE, MILLIS_IN_ONE_MONTH, MILLIS_IN_ONE_SECOND, MILLIS_IN_ONE_WEEK, MILLIS_IN_ONE_YEARFields inherited from interface com.jalios.jcms.JcmsConstants
ADATE_SEARCH, ADVANCED_TAB, AJAX_MODE_ATTR, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, CLASS_PROPERTY, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, COUNTRY_SPRITE, CS_TYPOLOGY_ROOT_CAT_VID, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DATA_DIRECTORY, DEFAULT_PHOTO_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, GENERATIONAL_STORE_DIRECTORY, GLYPH_ICON_PREFIX, ICON_ARCHIVE, ICON_ICON_PREFIX, ICON_LOCK, ICON_LOCK_STRONG, ICON_PREFIX_PROP, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, IS_IN_FRONT_OFFICE, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JCMS_TOASTR_COLLECTION, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LANG_SPRITE, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_CREATE_STR, OP_DEEP_COPY, OP_DEEP_COPY_STR, OP_DEEP_DELETE, OP_DEEP_DELETE_STR, OP_DELETE, OP_DELETE_STR, OP_MERGE, OP_MERGE_STR, OP_UPDATE, OP_UPDATE_STR, ORGANIZATION_ROOT_GROUP_PROP, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_PROP_PREFIX, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_PROP_PREFIX, PHOTO_LARGE_WIDTH, PHOTO_MINI, PHOTO_MINI_HEIGHT, PHOTO_MINI_PROP_PREFIX, PHOTO_MINI_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_PROP_PREFIX, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_PROP_PREFIX, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_PROP_PREFIX, PHOTO_TINY_WIDTH, PHOTO_XLARGE, PHOTO_XLARGE_HEIGHT, PHOTO_XLARGE_PROP_PREFIX, PHOTO_XLARGE_WIDTH, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, RAW_CONTENT_ICON_PREFIX, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SECURITY_LOG_FILE, SESSION_AUTHORIZED_FILENAMES_SET, SPRITE_ICON_PREFIX, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, SUCCESS_MSG, SVG_ICON_PREFIX, SVGINLINE_ICON_PREFIX, SVGSPRITE_ICON_PREFIX, TEMPLATE_TAB, THEME_DIR, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, TTCARD_MEDIA_HEIGHT, TTCARD_MEDIA_WIDTH, TYPES_ICON_ALT_PROP, TYPES_ICON_SUFFIX_PROP, TYPES_ICON_TITLE_PROP, TYPES_PREFIX_PROP, TYPES_THUMB_SUFFIX_PROP, TYPES_UNKNOWN_CLASS_PROP, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, UPLOAD_PERMISSION_COUNT_PROP_PREFIX, UPLOAD_PERMISSION_SIZE_PROP_PREFIX, URL_REGEXP, VID_LOGGED_MEMBER, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionintMember[]intRetrieve the classification level current available for the edition in progressbooleanGet the value of closed.booleanGet the value of incoming mail.intRetrieve the minimum classification level current available for the edition in progressbooleanGet the value of model.intGet the value of order.getAvailableTitle(String lang) Retrieve a settings suitable to edit a classification level in the current context.booleanbooleanMethod to be implemented to check/validate action to be performed and process them.voidsetAdministrators(String[] v) voidsetAdministratorsAddCount(int v) voidvoidsetClassificationLevel(int level) Set the classification level to assign to the edited workspacevoidsetClosed(boolean v) Set the value of closed.voidvoidvoidsetIncomingMailEnabled(boolean enable) Set the value of incoming mail.voidvoidsetLanguage(String[] v) voidvoidsetMinClassificationLevel(int level) Set the minimum classification level to assign to the edited workspacevoidsetModel(boolean v) Set the value of model.voidsetOrder(int v) Set the value of order.voidvoidsetTagRoot(String v) voidbooleanCheck if the classification level field should be displayedMethods inherited from class com.jalios.jcms.workspace.AbstractEditWorkspaceHandler
getAvailableAlertThreshold, getAvailableId, getAvailableQuotaUnit, getAvailableQuotaValue, getAvailableUseDefaultQuota, getControllerContext, getDataClass, getOpenTab, getWorkspace, isTabForced, performCreate, performDelete, performRefresh, performUpdate, sendRedirect, setAlertThreshold, setId, setOpenTab, setQuotaUnit, setQuotaValue, setUseDefaultQuota, validateCreate, validateDelete, validatePercentValues, validateUpdateMethods inherited from class com.jalios.jcms.handler.EditDataHandler
afterValidation, createUploadedFileDocument, createUploadedFileDocument, createUploadedFileDocument, createUploadedFileDocument, getAvailableData, getAvailableDataArray, getAvailableExtraDataMap, getAvailableExtraDBDataMap, getAvailableField, getDeleteRedirect, getEnumLabels, getEnumValues, getId, getModalRedirect, getTabGroupMaxCount, handleRestResponse, isExtraDataHidden, isFirstAccess, performCancel, processDataId, processDataIds, processDataIds, processMLData, processMLDataArray, restValidation, setExtraDBKeys, setExtraDBValues, setExtraKeys, setExtraValues, setFields, setForceDelete, setOpCancel, setOpCreate, setOpDelete, setOpRefresh, setOpUpdate, validateCancel, validateRefresh, validateUploadedFileDocument, validateUploadedFileDocument, validateUploadedFileDocument, validateUploadedFileDocumentMethods inherited from class com.jalios.jcms.handler.JcmsFormHandler
canStartProcess, checkMissingField, getAvailableMainLanguage, getBackgroundProcess, getClosePopupUrl, getEditFieldSet, getFormStep, getFormStepCount, getFormStepFinishLabel, getFormStepHiddenFields, getFormStepLabels, getFormStepPrefixProp, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenFieldML, getMainLangValue, getMainLangValueArray, getMLMap, getMLMapArray, getMonolingualValue, getMonolingualValueArray, getMultilingualMainValue, getMultilingualMainValueArray, getMultilingualMLMap, getMultilingualMLMapArray, getOpenTabId, getRedirect, getRedirectOnClosePopup, init, isFieldEdition, isFieldMissing, isFormStepClickable, isPartialFieldEdition, isPopupEdition, isWorkspaceForced, mapStringArrayToMapStringList, mapStringListToMapStringArray, mustSendForbiddenOnCSRF, performFinish, performNext, performPrevious, processStatus, sanitize, sanitize, sendRedirect, sendRedirect, setEditField, setFormStep, setNoRedirect, setNoSendRedirect, setOpenTabId, setOpFinish, setOpNext, setOpPrevious, setPopupEdition, setRedirect, setRedirectOnClosePopup, setWorkspace, setWs, showCancelButton, showFinishButton, showNextButton, showPreviousButton, startProcess, updateUploadedFields, validate, validateCSRF, validateFinish, validateNext, validatePreviousMethods inherited from class com.jalios.jcms.context.JcmsJspContext
addAvoidanceLink, addBodyAttributes, addCSSHeader, addCSSHeader, addCSSHeader, addCSSHeader, addCustomHeader, addHandlebarTemplate, addHttpEquivHeader, addHttpNameHeader, addJavaScript, addJavaScript, addJavaScript, addJavaScriptCode, addJavaScriptModule, addPrefetchHeader, addStyleHeader, addStyleHeader, addSvgSpriteIcon, addWebAssets, canAccessAdminArea, checkAccess, checkAccess, checkCSRF, debugDisplayContext, disablePacker, forceEditIcon, forceUpdate, getAjaxRequestAttribute, getAjaxRequestId, getAllHeadersDiffMap, getAllHeadersMap, getAvoidanceLinks, getBackOfficeCSSHeader, getBackOfficeJavaScriptSet, getBodyAttributes, getContentForm, getCSSHeaders, getCtxCategories, getCurrentCategory, getCustomHeaders, getDocType, getFinalCSSFooterMap, getFinalCSSMap, getFinalJavaScriptModuleSet, getFinalJavaScriptSet, getFrontOfficeCSSHeader, getFrontOfficeJavaScriptSet, getHandlebarTemplates, getHttpEquivHeaders, getHttpNameHeaders, getJavaScriptCodeSet, getJavaScriptModuleSet, getJavaScriptSet, getPageContext, getPageTitle, getPageZone, getPortal, getPortalCategory, getPortlet, getPublication, getStyleHeaders, getSvgSprites, getSvgSpritesHtml, getTemplateUsage, internalSetupEmptyHeader, isEditIcon, isEditIcon, isEditIconForPublish, isEditIconForPublish, isPrintView, registerDisplayContext, removeAjaxRequestAttribute, setAjaxRequestAttribute, setAjaxRequestId, setAllHeadersDiffMap, setDocType, setEditIcon, setPageContext, setPageTitle, setPageZone, setShowEditIcon, setTemplateUsage, showEditIcon, showEditIcon, showEditIconMethods inherited from class com.jalios.jcms.context.JcmsContext
addMsg, addMsg, addMsgSession, addMsgSession, addToastr, addToastr, addToastrSession, addToastrSession, applySelector, canAccessAdminArea, copyMsgListToMsgSessionList, forceWorkspaceUpdate, getBaseUrl, getBrowser, getCaddy, getContextPath, getErrorMsg, getErrorMsgList, getErrorMsgSession, getErrorMsgSessionList, getInfoMsg, getInfoMsgList, getInfoMsgSession, getInfoMsgSessionList, getLoggedMember, getMsgList, getMsgSessionList, getRequest, getResponse, getSession, getSuccessMsg, getSuccessMsgList, getSuccessMsgSession, getSuccessMsgSessionList, getToastrCollection, getToastrSessionCollection, getUploadedFiles, getUploadedFiles, getUrlWithCommonUpdatedParams, getUserCountry, getUserLang, getUserLocale, getUserZoneId, getWarningMsg, getWarningMsgList, getWarningMsgSession, getWarningMsgSessionList, glp, isAdmin, isAdminZone, isAjaxRequest, isDBMember, isDebug, isDebugTemplate, isInFrontOffice, isLogged, isWorkZone, removeMessage, removeMessage, removeMsg, select, sendError, sendError, sendForbidden, sendForbidden, sendRedirect, sendRedirect, sendRedirect, setErrorMsg, setErrorMsg, setErrorMsgSession, setErrorMsgSession, setInfoMsg, setInfoMsg, setInfoMsgSession, setInfoMsgSession, setLoggedMember, setRequest, setResponse, setSuccessMsg, setSuccessMsg, setSuccessMsgSession, setSuccessMsgSession, setWarningMsg, setWarningMsg, setWarningMsgSession, setWarningMsgSession, updateWorkspace, validateRegexp, validateSchedule
-
Field Details
-
administrators
-
administratorsAddCount
protected int administratorsAddCount -
catSet
-
tagRoot
-
order
protected int order -
model
protected boolean model -
closed
protected boolean closed -
title
-
titleML
-
parent
-
defaultGroup
-
mainPortal
-
incomingMailEnabled
protected boolean incomingMailEnabled -
incomingMailLocalPart
-
classificationLevel
protected int classificationLevel -
minClassificationLevel
protected int minClassificationLevel
-
-
Constructor Details
-
EditWorkspaceCommonHandler
public EditWorkspaceCommonHandler()
-
-
Method Details
-
processAction
Description copied from class:JcmsFormHandlerMethod to be implemented to check/validate action to be performed and process them.Default implementation is to return false. No need to call super method.
This method may NOT be invoked at all if security validation are not met.
You must ensure your handler and JSP can work properly without any code invoked in this method.
- Overrides:
processActionin classAbstractEditWorkspaceHandler- Returns:
- false if no redirection is needed, true otherwise
- Throws:
IOException- IO Exception
-
setFields
- Overrides:
setFieldsin classAbstractEditWorkspaceHandler
-
setAdministrators
-
getAvailableAdministrators
-
setAdministratorsAddCount
public void setAdministratorsAddCount(int v) -
getAdministratorsCount
public int getAdministratorsCount() -
getAvailableCatSet
-
setCatSet
-
getAvailableTagRoot
-
setTagRoot
-
getAvailableOrder
public int getAvailableOrder()Get the value of order.- Returns:
- Value of order.
-
setOrder
public void setOrder(int v) Set the value of order.- Parameters:
v- Value to assign to order.
-
getAvailableModel
public boolean getAvailableModel()Get the value of model.- Returns:
- Value of model.
-
setModel
public void setModel(boolean v) Set the value of model.- Parameters:
v- Value to assign to model.
-
getAvailableClosed
public boolean getAvailableClosed()Get the value of closed.- Returns:
- Value of closed.
-
setClosed
public void setClosed(boolean v) Set the value of closed.- Parameters:
v- Value to assign to closed.
-
getAvailableTitle
-
getAvailableTitle
-
setTitle
-
getAvailableTitleML
-
setLanguage
-
getAvailableLanguage
-
getAvailableDefaultLanguage
-
isCurrentAndParentAdministrator
public boolean isCurrentAndParentAdministrator() -
getAvailableParent
-
setParent
-
getAvailableDefaultGroup
-
setDefaultGroup
-
getAvailableMainPortal
-
setMainPortal
-
setIncomingMailEnabled
public void setIncomingMailEnabled(boolean enable) Set the value of incoming mail.- Parameters:
enable- Value to assign to incoming mail.- Since:
- jcms-9.0.0
-
getAvailableIncomingMailEnabled
public boolean getAvailableIncomingMailEnabled()Get the value of incoming mail.- Returns:
- Value of incoming mail.
- Since:
- jcms-9.0.0
-
setIncomingMailLocalPart
-
getAvailableIncomingMailLocalPart
-
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 workspace- Parameters:
level- a value from 0 for unclassified workspace toClassificationManager.getMaximumLevel()(included) for highly classified workspace. 0 if used if null is specified.- Since:
- 10.0.8 / JCMS-10746
-
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
-
showClassification
public boolean showClassification()Check if the classification level field should be displayed- Returns:
- true to display field, false otherwise
- Since:
- 10.0.8 / JCMS-10746
-
getAvailableMinClassificationLevel
public int getAvailableMinClassificationLevel()Retrieve the minimum classification level current available for the edition in progress- Returns:
- a classification level
- Since:
- 10.0.8 / JCMS-10746
-
setMinClassificationLevel
public void setMinClassificationLevel(int level) Set the minimum classification level to assign to the edited workspace- Parameters:
level- a value from 0 toClassificationManager.getMaximumLevel()- Since:
- 10.0.8 / JCMS-10746
-