Package com.jalios.jcms.alert
Class AlertHandler
java.lang.Object
com.jalios.jcms.context.JcmsContext
com.jalios.jcms.context.JcmsJspContext
com.jalios.jcms.handler.JcmsFormHandler
com.jalios.jcms.alert.AlertHandler
- All Implemented Interfaces:
JcmsConstants,JaliosConstants
- Direct Known Subclasses:
AlertAppHandler,AlertTopbarHandler
A super handler to query loggedMember's alerts.
- Since:
- jcms-10.0.0
- Author:
- Sylvain Devaux
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Memberprotected booleanprotected Dateprotected Alert.Level[]protected PageResult<Alert> protected AlertQueryBuilder.ReadModeprotected Dateprotected Workspaceprotected AlertQueryBuilderprotected static final Alert.Level[]static final AlertQueryBuilder.ReadModeprotected static final booleanprotected Dateprotected booleanprotected booleanprotected booleanprotected booleanprotected booleanprotected booleanprotected booleanprotected intstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringprotected booleanprotected Stringprotected intFields 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, 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_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 TypeMethodDescriptionstatic StringgetAlertParentDataId(Alert alert) Searches for the alert data (If available) parentfinal StringInternal.protected MemberAlertSettingsCompute the AJAX parameters for the AJAX "more" buttonprotected Dateprotected org.hibernate.criterion.SimpleExpressionintintgetSort()intgetStart()booleanhasMore()True if there are more Datas than the default results list.booleanprotected voidinitSort()booleanbooleanbooleanbooleanbooleanbooleanbooleanstatic booleanisReadAllAlert(Alert alert) booleanbooleanbooleanbooleanstatic booleanisUnfollowableAlert(Alert alert, Member mbr) booleanMethod to be implemented to check/validate action to be performed and process them.voidvoidvoidDeprecated.voidvoidvoidvoidvoidvoidsetAlertEndDate(String dateStr) voidsetAlertLevel(String[] v) voidTo change alert list order to be reverse or not.voidvoidsetAlertReadMode(String alertReadMode) voidvoidsetAlertStartDate(String dateStr) voidprotected voidsetMoreAlertScrollParams(Map<String, Object> paramsSecondMap) voidvoidvoidsetOpReadAllPub(boolean opReadAllPub) voidsetOpUnfollow(boolean opUnfollow) voidsetOpUnfollowRead(boolean opUnfollowRead) voidvoidsetReverse(boolean v) protected voidsetSortAndReverse(MemberAlertSettings.Sort alertSort) booleanReturns true when there are at least one unread alert.booleanConvenient method to indicate to the UI if results view will rendered.protected booleanMethods inherited from class com.jalios.jcms.handler.JcmsFormHandler
afterValidation, canStartProcess, checkMissingField, getAvailableMainLanguage, getBackgroundProcess, getClosePopupUrl, getControllerContext, getEditFieldSet, getFormStep, getFormStepCount, getFormStepFinishLabel, getFormStepLabels, getFormStepPrefixProp, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenFieldML, getMainLangValue, getMainLangValueArray, getMLMap, getMLMapArray, getModalRedirect, getMonolingualValue, getMonolingualValueArray, getMultilingualMainValue, getMultilingualMainValueArray, getMultilingualMLMap, getMultilingualMLMapArray, getOpenTabId, getRedirect, getRedirectOnClosePopup, getWorkspace, 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
-
PARAM_ALERT_AUTHOR
- See Also:
-
PARAM_ALERT_END_DATE
- See Also:
-
PARAM_ALERT_START_DATE
- See Also:
-
PARAM_ALERT_WORKSPACE
- See Also:
-
PARAM_ALERT_PAGER_REVERSE
- See Also:
-
PARAM_ALERT_PAGER_START
- See Also:
-
PARAM_ALERT_DAILYDATE
- See Also:
-
PARAM_ALERT_DISPLAYED_ALERTS
- See Also:
-
PARAM_ALERT_LEVEL
- See Also:
-
PARAM_ALERT_READ_MODE
- See Also:
-
DEFAULT_READ_MODE
-
PARAM_MORE_DATE
- See Also:
-
opUnfollow
protected boolean opUnfollow -
opUnfollowRead
protected boolean opUnfollowRead -
opReadAllPub
protected boolean opReadAllPub -
alertPageResult
-
aqb
-
alertAuthor
-
alertStartDate
-
alertEndDate
-
alertDailyDate
protected boolean alertDailyDate -
displayedAlertRowIdSet
-
alertWorkspace
-
alertReadMode
-
DEFAULT_ALERT_LEVELS
-
alertLevelList
-
moreDate
-
opRead
protected boolean opRead -
opUnread
protected boolean opUnread -
opReadAll
protected boolean opReadAll -
DEFAULT_REVERSE
protected static final boolean DEFAULT_REVERSE- See Also:
-
sort
-
reverse
protected boolean reverse -
start
protected int start -
pageSize
protected int pageSize -
pagerAll
protected boolean pagerAll
-
-
Constructor Details
-
AlertHandler
public AlertHandler()
-
-
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 classJcmsFormHandler- Returns:
- false if no redirection is needed, true otherwise
- Throws:
IOException- IO Exception
-
validateMember
protected boolean validateMember()- Returns:
- true if loggedMember is not null, false otherwise.
- Since:
- jcms-10.0.2
-
getFormStepHiddenFields
- Overrides:
getFormStepHiddenFieldsin classJcmsFormHandler- Since:
- jcms-10.0.2
-
getResultsCount
public int getResultsCount()- Returns:
- results count for current user filters
- Since:
- jcms-10.0.2
- See Also:
-
getAlertsPageResult
-
initSort
protected void initSort() -
setSortAndReverse
-
getMoreDateRestriction
protected org.hibernate.criterion.SimpleExpression getMoreDateRestriction()- Returns:
- date restriction for "More" button, with reverse param handled.
- Since:
- jcms-10.0.2
-
setAlertAuthor
-
getAvailableAlertAuthor
- Returns:
- the member to use as author filter
- Since:
- jcms-10.0.0
-
setAlertStartDate
-
getAvailableAlertStartDate
-
getAvailableAlertEndDate
-
setAlertEndDate
-
setAlertDailyDate
-
setAlertDisplayedAlerts
-
setAlertWorkspace
-
getAvailableAlertWorkspace
-
setAlertReadMode
-
getAvailableAlertReadMode
-
isReadModeRead
public boolean isReadModeRead() -
isReadModeUnread
public boolean isReadModeUnread() -
isReadAllMode
public boolean isReadAllMode() -
setAlertLevel
-
getAvailableAlertLevels
-
getAvailableAlertLevelList
-
getAvailableAlertLevelListValues
Internal. Used to fill the controlTag with user value(s).- Returns:
- the VALUES of the alert level list
-
isLevelInfo
public boolean isLevelInfo() -
isLevelWarning
public boolean isLevelWarning() -
isLevelAction
public boolean isLevelAction() -
setAlertMoreDate
-
hasMore
public boolean hasMore()True if there are more Datas than the default results list.- Returns:
- true ie More button should be displayed
-
getMoreDate
- Returns:
- if there are result(s), the creation date of last result.
- Since:
- jcms-10.0.2
-
getMoreAlertParamsMap
- Returns:
- params for More button
- Since:
- jcms-10.0.2
-
setMoreAlertScrollParams
-
getMoreAlertParams
Compute the AJAX parameters for the AJAX "more" button- Returns:
- a JSON map for data-jalios-options
- Since:
- jcms-10.0.0
-
setOpRead
-
setOpUnread
-
setOpReadAll
-
setAlerts
-
getAvailableAlerts
-
showResultList
public boolean showResultList()Convenient method to indicate to the UI if results view will rendered.Return false to indicate APP Body is something else than results.
- Returns:
- weither result list is to be rendered (whatever results count). true by default
- Since:
- jcms-10.0.2
-
showMarkAllAsRead
public boolean showMarkAllAsRead()Returns true when there are at least one unread alert.- Returns:
- weither action "Mark all (alerts) as read" should be provided to the user
- Since:
- jcms-10.0.2
-
hasResults
public boolean hasResults()- Returns:
- true if there is at least one result and results list is to be displayed.
- Since:
- jcms-10.0.2
- See Also:
-
setAlertAppPager_sort
-
getSort
-
setAlertAppPager_reverse
Deprecated. -
setAlertListReverse
To change alert list order to be reverse or not.- Parameters:
v- reverse order to set- Since:
- jcms-10.0.3
-
setReverse
public void setReverse(boolean v) -
isReverse
public boolean isReverse()- Returns:
- weither alert list order must be reverse or not.
If user reverse choice misses from HTTP parameters, loads member preference if any.
Else, return default reverse.
- Since:
- jcms-10.0.3
-
getMemberAlertSettings
-
setAlertAppPager_start
-
getStart
public int getStart() -
setAlertAppPager_pageSize
-
getPageSize
public int getPageSize() -
setAlertAppPager_pagerAll
-
isPagerAll
public boolean isPagerAll() -
getAlertStatusResponse
- Returns:
- the
AlertStatusas aStringfor current logged member
-
getAlertParentDataId
Searches for the alert data (If available) parent -
isOpUnfollow
public boolean isOpUnfollow() -
setOpUnfollow
public void setOpUnfollow(boolean opUnfollow) -
isOpUnfollowRead
public boolean isOpUnfollowRead() -
setOpUnfollowRead
public void setOpUnfollowRead(boolean opUnfollowRead) -
isOpReadAllPub
public boolean isOpReadAllPub() -
setOpReadAllPub
public void setOpReadAllPub(boolean opReadAllPub) -
isUnfollowableAlert
-
isReadAllAlert
- Parameters:
alert- theAlert- Returns:
- true if the Alert can provide read all action (All alerts on the same data will be marked as read)
- Since:
- jcms-10.0.2
-