Class EditNotificationCriteriaHandler
- 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.EditNotificationCriteriaHandler
-
- All Implemented Interfaces:
JcmsConstants,JaliosConstants
public class EditNotificationCriteriaHandler extends EditDataHandler
-
-
Field Summary
Fields Modifier and Type Field Description protected java.util.Set<Category>categorySetprotected java.lang.StringcatModeprotected java.util.Set<java.lang.Class<? extends Publication>>classSetstatic intCRITERIA_STEPprotected java.lang.String[]documentKindsprotected booleanexactCatprotected booleanisCreatestatic intKINDS_STEPprotected intmutationTypeprotected Notificationnotificationprotected NotificationCriterianotificationCriteriaprotected DatanotifiedDataprotected java.lang.StringopenTabprotected intperiodTypeprotected WorkspacerefineWSstatic intSTEP_COUNTprotected java.lang.Stringtextprotected java.lang.StringtextModestatic intTYPES_STEPprotected NotificationCriteriaworkingData-
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 EditNotificationCriteriaHandler()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.ListgetAllClassList()java.util.Set<Category>getAvailableCategorySet()java.lang.StringgetAvailableCatMode()java.util.Set<java.lang.Class<? extends Publication>>getAvailableClassSet()java.lang.String[]getAvailableDocumentKinds()booleangetAvailableExactCat()intgetAvailableMutationType()intgetAvailablePeriodType()WorkspacegetAvailableRefineWS()java.lang.StringgetAvailableText()java.lang.StringgetAvailableTextMode()java.lang.Class<? extends Data>getDataClass()intgetFormStepCount()Retrieve the total number of steps used for edition when invoking this form handler.java.lang.StringgetFormStepHiddenFields()java.lang.StringgetFormStepPrefixProp()java.lang.StringgetOpenTab()protected java.lang.StringgetQueryString()booleanisCatModeAnd()booleanisFormStepClickable()Returns true if the form step are clickable.protected booleanperformDelete()protected booleanperformFinish()booleanprocessAction()Method to be implemented to check/validate action to be performed and process them.voidsetCatMode(java.lang.String v)voidsetCids(java.lang.String[] v)voidsetDocumentKinds(java.lang.String[] kinds)voidsetExactCat(java.lang.String v)voidsetFields(Data data)Set the common (Data) fields.voidsetId(java.lang.String id)voidsetMutationType(int v)voidsetNotifiedData(java.lang.String v)voidsetOpenTab(java.lang.String v)voidsetPeriodType(int v)voidsetRefineWS(java.lang.String v)voidsetText(java.lang.String v)voidsetTextMode(java.lang.String v)voidsetTypes(java.lang.String[] types)booleanshowCategoryOptions()booleanshowDocumentKinds()Indicates if thedocument kindsfiltering should be available given current notification's types.booleanshowFinishButton()Check if the "Finish" button should be displayed in step modal form.booleanshowNextButton()Check if the "Next" button should be displayed in step modal form.booleanshowTextOptions()protected booleanvalidateDelete()protected booleanvalidateFinish()booleanvalidateMember()protected booleanvalidateNext()-
Methods inherited from class com.jalios.jcms.handler.EditDataHandler
afterValidation, createUploadedFileDocument, createUploadedFileDocument, createUploadedFileDocument, createUploadedFileDocument, getAvailableData, getAvailableDataArray, getAvailableExtraDataMap, getAvailableExtraDBDataMap, getAvailableField, getControllerContext, getDeleteRedirect, getEnumLabels, getEnumValues, getExtFormHandler, getId, getModalRedirect, getTabGroupMaxCount, handleRestResponse, isFirstAccess, performCancel, performCreateExtension, performRefresh, performUpdateExtension, processDataId, processDataIds, processDataIds, processMLData, processMLDataArray, restValidation, sendRedirect, setExtFormHandler, setExtraDBKeys, setExtraDBValues, setExtraKeys, setExtraValues, 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, getAvailableMainLanguage, getBackgroundProcess, getClosePopupUrl, getEditFieldSet, getFormStep, getFormStepFinishLabel, getFormStepLabels, 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, init, isFieldEdition, isFieldMissing, isPartialFieldEdition, isPopupEdition, isWorkspaceForced, mapStringArrayToMapStringList, mapStringListToMapStringArray, mustSendForbiddenOnCSRF, performNext, performPrevious, processStatus, sanitize, sanitize, sendRedirect, sendRedirect, setEditField, setFormStep, setNoRedirect, setNoSendRedirect, setOpFinish, setOpNext, setOpPrevious, setPopupEdition, setRedirect, setRedirectOnClosePopup, setWorkspace, setWs, showCancelButton, showPreviousButton, startProcess, updateUploadedField, updateUploadedFields, updateUploadedFields, validate, validateCSRF, 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, getPublication, 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
-
CRITERIA_STEP
public static final int CRITERIA_STEP
- See Also:
- Constant Field Values
-
TYPES_STEP
public static final int TYPES_STEP
- See Also:
- Constant Field Values
-
KINDS_STEP
public static final int KINDS_STEP
- See Also:
- Constant Field Values
-
STEP_COUNT
public static final int STEP_COUNT
- See Also:
- Constant Field Values
-
notificationCriteria
protected NotificationCriteria notificationCriteria
-
notifiedData
protected Data notifiedData
-
notification
protected Notification notification
-
periodType
protected int periodType
-
mutationType
protected int mutationType
-
categorySet
protected java.util.Set<Category> categorySet
-
catMode
protected java.lang.String catMode
-
exactCat
protected boolean exactCat
-
text
protected java.lang.String text
-
textMode
protected java.lang.String textMode
-
classSet
protected java.util.Set<java.lang.Class<? extends Publication>> classSet
-
documentKinds
protected java.lang.String[] documentKinds
-
refineWS
protected Workspace refineWS
-
workingData
protected NotificationCriteria workingData
-
isCreate
protected boolean isCreate
-
openTab
protected java.lang.String openTab
-
-
Method Detail
-
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
-
validateMember
public boolean validateMember()
-
validateNext
protected boolean validateNext() throws java.io.IOException- Overrides:
validateNextin classJcmsFormHandler- Throws:
java.io.IOException
-
validateFinish
protected boolean validateFinish() throws java.io.IOException- Overrides:
validateFinishin classJcmsFormHandler- Throws:
java.io.IOException
-
performFinish
protected boolean performFinish() throws java.io.IOException- Overrides:
performFinishin classJcmsFormHandler- Throws:
java.io.IOException
-
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.
-
validateDelete
protected boolean validateDelete() throws java.io.IOException- Throws:
java.io.IOException
-
performDelete
protected boolean performDelete() throws java.io.IOException- Throws:
java.io.IOException
-
setFields
public void setFields(Data data)
Description copied from class:EditDataHandlerSet the common (Data) fields. This method is also a hook for sub-classed to fill some field (or do anything else) before a create or an update.- Overrides:
setFieldsin classEditDataHandler- Parameters:
data- the publication to set the fields
-
getQueryString
protected java.lang.String getQueryString()
-
getFormStepCount
public int getFormStepCount()
Description copied from class:JcmsFormHandlerRetrieve the total number of steps used for edition when invoking this form handler.The default implementation of this method is to return 1, corresponding to one step (which means only 1 screen being displayed).
You can provide a custom FormHandler to override this behavior.
See jcore/doSteps.jspf for use of this method.
- Overrides:
getFormStepCountin classJcmsFormHandler- Returns:
- the total number of steps in this formhandler
-
getFormStepPrefixProp
public java.lang.String getFormStepPrefixProp()
- Overrides:
getFormStepPrefixPropin classJcmsFormHandler- Returns:
- the prefix prop for the steps
-
showNextButton
public boolean showNextButton()
Description copied from class:JcmsFormHandlerCheck if the "Next" button should be displayed in step modal form.The default implementation of this method is to return true unless the finish button is being displayed by method
JcmsFormHandler.showFinishButton().You can provide a custom FormHandler to override this behavior.
See jcore/doStepButtons.jspf for use of this method.
- Overrides:
showNextButtonin classJcmsFormHandler- Returns:
- true to display the "Next" button, false to hide it
-
showFinishButton
public boolean showFinishButton()
Description copied from class:JcmsFormHandlerCheck if the "Finish" button should be displayed in step modal form.The default implementation of this method is to return true if the current step (as returned by
JcmsFormHandler.getFormStep()is the last one (as compared withJcmsFormHandler.getFormStepCount().You can provide a custom FormHandler to override this behavior.
See jcore/doStepButtons.jspf for use of this method.
- Overrides:
showFinishButtonin classJcmsFormHandler- Returns:
- true to display the "Finish" button, false to hide it
-
getFormStepHiddenFields
public java.lang.String getFormStepHiddenFields()
- Overrides:
getFormStepHiddenFieldsin classJcmsFormHandler
-
getDataClass
public java.lang.Class<? extends Data> getDataClass()
- Specified by:
getDataClassin classEditDataHandler
-
setId
public void setId(java.lang.String id)
- Overrides:
setIdin classEditDataHandler
-
setNotifiedData
public void setNotifiedData(java.lang.String v)
-
showCategoryOptions
public boolean showCategoryOptions()
-
showTextOptions
public boolean showTextOptions()
-
setOpenTab
public void setOpenTab(java.lang.String v)
-
getOpenTab
public java.lang.String getOpenTab()
-
setPeriodType
public void setPeriodType(int v)
-
getAvailablePeriodType
public int getAvailablePeriodType()
-
setMutationType
public void setMutationType(int v)
-
getAvailableMutationType
public int getAvailableMutationType()
-
setCids
public void setCids(java.lang.String[] v)
-
getAvailableCategorySet
public java.util.Set<Category> getAvailableCategorySet()
-
setText
public void setText(java.lang.String v)
-
getAvailableText
public java.lang.String getAvailableText()
-
setTextMode
public void setTextMode(java.lang.String v)
-
getAvailableTextMode
public java.lang.String getAvailableTextMode()
-
setCatMode
public void setCatMode(java.lang.String v)
-
getAvailableCatMode
public java.lang.String getAvailableCatMode()
-
isCatModeAnd
public boolean isCatModeAnd()
-
setExactCat
public void setExactCat(java.lang.String v)
-
getAvailableExactCat
public boolean getAvailableExactCat()
-
setTypes
public void setTypes(java.lang.String[] types)
-
getAvailableClassSet
public java.util.Set<java.lang.Class<? extends Publication>> getAvailableClassSet()
-
getAllClassList
public java.util.List getAllClassList()
-
setRefineWS
public void setRefineWS(java.lang.String v)
-
getAvailableRefineWS
public Workspace getAvailableRefineWS()
-
setDocumentKinds
public void setDocumentKinds(java.lang.String[] kinds)
-
getAvailableDocumentKinds
public java.lang.String[] getAvailableDocumentKinds()
-
showDocumentKinds
public boolean showDocumentKinds()
Indicates if thedocument kindsfiltering should be available given current notification's types.- Returns:
- true if all notification's type(s) are FileDocument types, false, otherwise.
- Since:
- jcms-9.0.3
-
-