EditNotificationCriteriaHandler (JCMS API)

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 and Description
`protected java.util.Set<Category>`	`categorySet`
`protected java.lang.String`	`catMode`
`protected java.util.Set<java.lang.Class<? extends Publication>>`	`classSet`
`static int`	`CRITERIA_STEP`
`protected boolean`	`exactCat`
`protected boolean`	`isCreate`
`protected int`	`mutationType`
`protected Notification`	`notification`
`protected NotificationCriteria`	`notificationCriteria`
`protected Data`	`notifiedData`
`protected java.lang.String`	`openTab`
`protected int`	`periodType`
`protected Workspace`	`refineWS`
`protected java.lang.String`	`text`
`protected java.lang.String`	`textMode`
`static int`	`TYPES_STEP`
`protected NotificationCriteria`	`workingData`

Fields inherited from class com.jalios.jcms.handler.EditDataHandler
extFormHandler, id, isDeleteForced, op, opCancel, opCreate, opDelete, opFinish, opNext, opPrevious, opRefresh, opUpdate, resultOpCreate, resultOpDelete, resultOpUpdate, REVISION

Fields inherited from class com.jalios.jcms.handler.JcmsFormHandler
contextMap, editFieldSet, formStep, noRedirect, noSendRedirect, 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, isLogged, loggedMember, request, response, userCountry, userLang, userLocale, workspace

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, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, COUNTRY_SPRITE, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, 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, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, 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, 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_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, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SESSION_AUTHORIZED_FILENAMES_SET, SPRITE_ICON_PREFIX, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, SUCCESS_MSG, 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, URL_REGEXP, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML

Fields inherited from interface com.jalios.util.JaliosConstants
CRLF, MILLIS_IN_ONE_DAY, MILLIS_IN_ONE_HOUR, MILLIS_IN_ONE_MINUTE, MILLIS_IN_ONE_MONTH, MILLIS_IN_ONE_SECOND, MILLIS_IN_ONE_WEEK, MILLIS_IN_ONE_YEAR

Constructor Summary

Constructors
Constructor and Description

EditNotificationCriteriaHandler()

Constructors
Constructor and Description
`EditNotificationCriteriaHandler()`

Method Summary

Methods
Modifier and Type	Method and Description
`java.util.List`	`getAllClassList()`
`java.util.Set<Category>`	`getAvailableCategorySet()`
`java.lang.String`	`getAvailableCatMode()`
`java.util.Set<java.lang.Class<? extends Publication>>`	`getAvailableClassSet()`
`boolean`	`getAvailableExactCat()`
`int`	`getAvailableMutationType()`
`int`	`getAvailablePeriodType()`
`Workspace`	`getAvailableRefineWS()`
`java.lang.String`	`getAvailableText()`
`java.lang.String`	`getAvailableTextMode()`
`java.lang.Class<? extends Data>`	`getDataClass()`
`int`	`getFormStepCount()` Retrieve the total number of steps used for edition when invoking this form handler.
`java.lang.String`	`getFormStepHiddenFields()`
`java.lang.String`	`getFormStepPrefixProp()`
`java.lang.String`	`getOpenTab()`
`protected java.lang.String`	`getQueryString()`
`boolean`	`isCatModeAnd()`
`protected boolean`	`performDelete()`
`protected boolean`	`performFinish()`
`boolean`	`processAction()` Method to be implemented to check/validate action to be performed and process them.
`void`	`setCatMode(java.lang.String v)`
`void`	`setCids(java.lang.String[] v)`
`void`	`setExactCat(java.lang.String v)`
`void`	`setFields(Data data)` Set the common (Data) fields.
`void`	`setId(java.lang.String id)`
`void`	`setMutationType(int v)`
`void`	`setNotifiedData(java.lang.String v)`
`void`	`setOpenTab(java.lang.String v)`
`void`	`setPeriodType(int v)`
`void`	`setRefineWS(java.lang.String v)`
`void`	`setText(java.lang.String v)`
`void`	`setTextMode(java.lang.String v)`
`void`	`setTypes(java.lang.String[] types)`
`boolean`	`showCategoryOptions()`
`boolean`	`showFinishButton()` Check if the "Finish" button should be displayed in step modal form.
`boolean`	`showNextButton()` Check if the "Next" button should be displayed in step modal form.
`boolean`	`showTextOptions()`
`protected boolean`	`validateDelete()`
`protected boolean`	`validateFinish()`
`boolean`	`validateMember()`
`protected boolean`	`validateNext()`

Methods inherited from class com.jalios.jcms.handler.EditDataHandler
afterValidation, createUploadedFileDocument, createUploadedFileDocument, createUploadedFileDocument, createUploadedFileDocument, getAvailableData, getAvailableDataArray, getAvailableExtraDataMap, getAvailableExtraDBDataMap, getAvailableField, getControllerContext, getEnumLabels, getEnumValues, getExtFormHandler, getId, getTabGroupMaxCount, handleRestResponse, isFirstAccess, performCancel, performCreateExtension, performNext, performPrevious, performRefresh, performUpdateExtension, processDataId, processDataIds, processDataIds, processMLData, processMLDataArray, restValidation, sendRedirect, setExtFormHandler, setExtraDBKeys, setExtraDBValues, setExtraKeys, setExtraValues, setForceDelete, setOpCancel, setOpCreate, setOpDelete, setOpFinish, setOpNext, setOpPrevious, setOpRefresh, setOpUpdate, validateCancel, validateCreateExtension, validatePrevious, validateRefresh, validateUpdateExtension, validateUploadedFileDocument, validateUploadedFileDocument, validateUploadedFileDocument, validateUploadedFileDocument

Methods inherited from class com.jalios.jcms.handler.JcmsFormHandler
checkMissingField, getAvailableMainLanguage, getEditFieldSet, getFormStep, getFormStepFinishLabel, getFormStepLabels, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenFieldML, getMainLangValue, getMainLangValueArray, getMLMap, getMLMapArray, getRedirect, getRedirectOnClosePopup, getWorkspace, init, isFieldEdition, isFieldMissing, isPartialFieldEdition, isPopupEdition, isWorkspaceForced, processStatus, sendRedirect, sendRedirect, setEditField, setFormStep, setNoRedirect, setNoSendRedirect, setPopupEdition, setRedirect, setRedirectOnClosePopup, setWorkspace, setWs, showCancelButton, showPreviousButton, updateUploadedField, updateUploadedFields, validate

Methods inherited from class com.jalios.jcms.context.JcmsJspContext
addBodyAttributes, addCSSHeader, addCSSHeader, addCSSHeader, addCSSHeader, addCustomHeader, addHttpEquivHeader, addHttpNameHeader, addJavaScript, addJavaScript, addJavaScript, addJavaScriptCode, addPrefetchHeader, addStyleHeader, addStyleHeader, checkAccess, checkAccess, checkCSRF, debugDisplayContext, disablePacker, forceEditIcon, forceUpdate, getAjaxRequestAttribute, getAjaxRequestId, getAllHeadersDiffMap, getAllHeadersMap, getBackOfficeCSSHeader, getBackOfficeJavaScriptSet, getBodyAttributes, getContentForm, getCSSHeaders, getCtxCategories, getCurrentCategory, getCustomHeaders, getDocType, getFinalCSSFooterMap, getFinalCSSMap, getFinalJavaScriptSet, getFormElementCount, getFrontOfficeCSSHeader, getFrontOfficeJavaScriptSet, getHttpEquivHeaders, getHttpNameHeaders, getJavaScriptCodeSet, getJavaScriptSet, getJSONBridge, getPackVersion, getPageContext, getPageTitle, getPageZone, getPortal, getPortalCategory, getPortlet, getPublication, getStyleHeaders, getTemplateUsage, internalSetupEmptyHeader, isEditIcon, isEditIcon, isEditIconForPublish, isEditIconForPublish, isPrintView, registerDisplayContext, removeAjaxRequestAttribute, setAjaxRequestAttribute, setAjaxRequestId, setAllHeadersDiffMap, setDocType, setEditIcon, setFormElementCount, setPageContext, setPageTitle, setPageZone, setShowEditIcon, setTemplateUsage, showEditIcon, showEditIcon, showEditIcon, workaroundBrowserBaseHrefBug

Methods inherited from class com.jalios.jcms.context.JcmsContext
addCookie, addMsg, addMsg, addMsgSession, addMsgSession, applySelector, forceWorkspaceUpdate, getBaseUrl, getBrowser, getCaddy, getContextPath, getErrorMsg, getErrorMsgList, getErrorMsgSession, getErrorMsgSessionList, getInfoMsg, getInfoMsgList, getInfoMsgSession, getInfoMsgSessionList, getLoggedMember, getMsgList, getMsgSessionList, getRequest, getResponse, getSession, getSuccessMsg, getSuccessMsgList, getSuccessMsgSession, getSuccessMsgSessionList, getUploadedFile, getUploadedFileList, getUrlWithCommonUpdatedParams, getUserCountry, getUserLang, getUserLocale, getWarningMsg, getWarningMsgList, getWarningMsgSession, getWarningMsgSessionList, glp, isAdmin, isAjaxRequest, isDBMember, isDebug, isInFrontOffice, isLogged, isWebdavAccess, removeMessage, removeMessage, retrieveUploadedFile, select, sendForbidden, sendForbidden, sendRedirect, sendRedirect, sendRedirect, setErrorMsg, setErrorMsg, setErrorMsgSession, setErrorMsgSession, setInfoMsg, setInfoMsg, setInfoMsgSession, setInfoMsgSession, setLoggedMember, setRequest, setResponse, setSuccessMsg, setSuccessMsg, setSuccessMsgSession, setSuccessMsgSession, setWarningMsg, setWarningMsg, setWarningMsgSession, setWarningMsgSession, validateRegexp, validateSchedule

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - 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
  - 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
```
  - refineWS
```
protected Workspace refineWS
```
  - workingData
```
protected NotificationCriteria workingData
```
  - isCreate
```
protected boolean isCreate
```
  - openTab
```
protected java.lang.String openTab
```
- Constructor Detail
  - EditNotificationCriteriaHandler
```
public EditNotificationCriteriaHandler()
```
- Method Detail
  - processAction
```
public boolean processAction()
                      throws java.io.IOException
```
    Description copied from class: JcmsFormHandler
    
    Method to be implemented to check/validate action to be performed and process them.
    Default implementation is to return false. No need to call super method.
    This method may NOT be invoked at all if security validation are not met.
    You must ensure your handler and JSP can work properly without any code invoked in this method.
    
    Overrides:
    
    processAction in class EditDataHandler
    
    Returns:
    false if no redirection is needed, true otherwise
    
    Throws:
    
    java.io.IOException - IO Exception
  - validateMember
```
public boolean validateMember()
```
  - validateNext
```
protected boolean validateNext()
                        throws java.io.IOException
```
    Overrides:
    
    validateNext in class EditDataHandler
    
    Throws:
    
    java.io.IOException
  - validateFinish
```
protected boolean validateFinish()
                          throws java.io.IOException
```
    Overrides:
    
    validateFinish in class EditDataHandler
    
    Throws:
    
    java.io.IOException
  - performFinish
```
protected boolean performFinish()
                         throws java.io.IOException
```
    Overrides:
    
    performFinish in class EditDataHandler
    
    Throws:
    
    java.io.IOException
  - 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: EditDataHandler
    
    Set 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:
    
    setFields in class EditDataHandler
    
    Parameters:
    data - the publication to set the fields
  - getQueryString
```
protected java.lang.String getQueryString()
```
  - getFormStepCount
```
public int getFormStepCount()
```
    Description copied from class: JcmsFormHandler
    
    Retrieve 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:
    
    getFormStepCount in class JcmsFormHandler
    
    Returns:
    the total number of steps in this formhandler
  - getFormStepPrefixProp
```
public java.lang.String getFormStepPrefixProp()
```
    Overrides:
    
    getFormStepPrefixProp in class JcmsFormHandler
    
    Returns:
    the prefix prop for the steps
  - showNextButton
```
public boolean showNextButton()
```
    Description copied from class: JcmsFormHandler
    
    Check 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:
    
    showNextButton in class JcmsFormHandler
    
    Returns:
    true to display the "Next" button, false to hide it
  - showFinishButton
```
public boolean showFinishButton()
```
    Description copied from class: JcmsFormHandler
    
    Check 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 with JcmsFormHandler.getFormStepCount().
    You can provide a custom FormHandler to override this behavior.
    See jcore/doStepButtons.jspf for use of this method.
    
    Overrides:
    
    showFinishButton in class JcmsFormHandler
    
    Returns:
    true to display the "Finish" button, false to hide it
  - getFormStepHiddenFields
```
public java.lang.String getFormStepHiddenFields()
```
    Overrides:
    
    getFormStepHiddenFields in class JcmsFormHandler
  - getDataClass
```
public java.lang.Class<? extends Data> getDataClass()
```
    Specified by:
    
    getDataClass in class EditDataHandler
  - setId
```
public void setId(java.lang.String id)
```
    Overrides:
    
    setId in class EditDataHandler
  - 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()
```

Class EditNotificationCriteriaHandler

Field Summary

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

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

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

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

Fields inherited from interface com.jalios.jcms.JcmsConstants

Fields inherited from interface com.jalios.util.JaliosConstants

Constructor Summary

Method Summary

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

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

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

Methods inherited from class com.jalios.jcms.context.JcmsContext

Methods inherited from class java.lang.Object

Field Detail

CRITERIA_STEP

TYPES_STEP

notificationCriteria

notifiedData

notification

periodType

mutationType

categorySet

catMode

exactCat

text

textMode

classSet

refineWS

workingData

isCreate

openTab

Constructor Detail

EditNotificationCriteriaHandler

Method Detail

processAction

validateMember

validateNext

validateFinish

performFinish

validateDelete

performDelete

setFields

getQueryString

getFormStepCount

getFormStepPrefixProp

showNextButton

showFinishButton

getFormStepHiddenFields

getDataClass

setId

setNotifiedData

showCategoryOptions

showTextOptions

setOpenTab

getOpenTab

setPeriodType

getAvailablePeriodType

setMutationType

getAvailableMutationType

setCids

getAvailableCategorySet

setText

getAvailableText

setTextMode

getAvailableTextMode

setCatMode

getAvailableCatMode

isCatModeAnd

setExactCat

getAvailableExactCat

setTypes

getAvailableClassSet

getAllClassList

setRefineWS

getAvailableRefineWS