AlertAppHandler (JCMS API)

java.lang.Object
- com.jalios.jcms.context.JcmsContext
- - com.jalios.jcms.context.JcmsJspContext
  - - com.jalios.jcms.handler.JcmsFormHandler
    - - com.jalios.jcms.alert.AlertHandler
      - com.jalios.jcms.alert.AlertAppHandler

All Implemented Interfaces:

JcmsConstants, JaliosConstants
```
public class AlertAppHandler
extends AlertHandler
```
Handler to display alerts, and recommendations in an APP.

Since:

jcms-10.0.0

Version:

$Revision: 119516 $

Author:

Sylvain Devaux

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`AlertAppHandler.AbstractUIFilter<E>` Abstract filter provided in the UI.
`static class`	`AlertAppHandler.AlertLevelFilter`
`static class`	`AlertAppHandler.ReadModeFilter`
`static class`	`AlertAppHandler.SendModeFilter`
`static class`	`AlertAppHandler.UITab` Simple POJO to handle render of UI navigation tabs.
`static class`	`AlertAppHandler.ViewMode`

Field Summary

Fields
Modifier and Type	Field and Description
`protected AlertAppHandler.ViewMode`	`alertViewMode`
`protected static java.lang.String`	`APP_DEFAULT_NO_RESULTS_ICON` The JCMS default "no results in APP" icon.
`protected static java.lang.String`	`APP_INNER_JSP` Default Alert app inner jsp.
`protected static java.lang.String`	`APP_JSP` Default Alert app template.
`protected static AlertAppHandler.UITab`	`DEFAULT_APP_TAB`
`protected static RecommendationQueryBuilder.SendMode`	`DEFAULT_RECO_SEND_MODE`
`protected static AlertAppHandler.ViewMode`	`DEFAULT_VIEW_MODE`
`static java.lang.String`	`EDIT_ALERT_RULES_PARAM`
`protected boolean`	`isEditAlertRulesValidated`
`static java.lang.String`	`OP_READ`
`static java.lang.String`	`OP_UNREAD`
`static java.lang.String`	`PARAM_ALERT_TAB`
`static java.lang.String`	`PARAM_ALERT_VIEW_MODE`
`static java.lang.String`	`PARAM_ALERTS`
`static java.lang.String`	`PARAM_PAGER_PEFIX`
`static java.lang.String`	`PARAM_RECO_RECIPIENT`
`static java.lang.String`	`PARAM_RECO_SEND_MODE`
`protected Member`	`recoRecipient`
`protected RecommendationQueryBuilder.SendMode`	`recoSendMode`
`static java.lang.String`	`REVISION`
`protected RecommendationQueryBuilder`	`rqb`
`protected AlertAppHandler.UITab`	`uiTab` Represents the current / active tab selected by the user (or the default one).

Fields inherited from class com.jalios.jcms.alert.AlertHandler
alertAuthor, alertEndDate, alertLevelList, alertReadMode, alertStartDate, alertWorkspace, aqb, DEFAULT_ALERT_LEVELS, DEFAULT_READ_MODE, DEFAULT_REVERSE, moreDate, opRead, opReadAll, opReadAllPub, opUnfollow, opUnfollowRead, opUnread, pagerAll, pageSize, PARAM_ALERT_AUTHOR, PARAM_ALERT_END_DATE, PARAM_ALERT_LEVEL, PARAM_ALERT_PAGER_REVERSE, PARAM_ALERT_READ_MODE, PARAM_ALERT_START_DATE, PARAM_ALERT_WORKSPACE, PARAM_MORE_DATE, reverse, sort, start

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, userZoneId, 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, 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_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, SESSION_AUTHORIZED_FILENAMES_SET, SPRITE_ICON_PREFIX, STATS_REPORT_DIR, STATUS_PROP, 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_SIZE_PROP_PREFIX, URL_REGEXP, VID_LOGGED_MEMBER, 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

AlertAppHandler()

Constructors
Constructor and Description
`AlertAppHandler()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAlertAppStatusResponse()`
`ControlSettings<?>`	`getAlertAuthorSettings()`
`DateSettings`	`getAlertEndSettings()`
`ControlSettings<?>`	`getAlertLevelSettings(Alert.Level alertLevel, java.lang.String userLang)`
`DateSettings`	`getAlertStartSettings()`
`ControlSettings<?>`	`getAlertWorkspaceSettings()`
`java.lang.String`	`getAppBodyJsp()`
`java.lang.String`	`getAppHeaderJsp()`
`java.lang.String`	`getAppHeaderTitle(java.lang.String userLang)`
`static java.lang.String`	`getAppInnerJsp()`
`static java.lang.String`	`getAppJsp()`
`java.lang.String`	`getAppSidebarJsp()`
`Member`	`getAvailableAlertAuthor()` In recommendations case, when SendMode is sent, returns loggedMember as forced author filter.
`AlertAppHandler.ViewMode`	`getAvailableAlertViewMode()`
`Member`	`getAvailableRecoRecipient()` In recommendations case, when SendMode is received, then forces recipient filter to be loggedMember.
`RecommendationQueryBuilder.SendMode`	`getAvailableRecoSendMode()`
`AlertAppHandler.UITab`	`getAvailableUITab()`
`EditMemberHandler`	`getEditMemberHandler()`
`java.util.Collection<AlertAppHandler.AlertLevelFilter>`	`getLevelFilters()`
`protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,?>>`	`getMoreAlertParamsMap()` Compute the AJAX parameters for the AJAX "more" button, depending on view, and compliant filters
`protected java.util.Date`	`getMoreDate()`
`java.lang.String`	`getNoResultsIcon()`
`java.lang.String`	`getNoResultsMessage()`
`java.util.Collection<AlertAppHandler.ReadModeFilter>`	`getReadModeFilters()`
`ControlSettings<?>`	`getReadModeSettings(AlertQueryBuilder.ReadMode readMode, java.lang.String userLang)`
`PageResult<Recommendation>`	`getRecommendationsPageResult()`
`ControlSettings<?>`	`getRecoRecipientSettings()`
`ControlSettings<?>`	`getRecoSendModeSettings(RecommendationQueryBuilder.SendMode sendMode, java.lang.String userLang)`
`int`	`getResultsCount()`
`java.util.Collection<AlertAppHandler.SendModeFilter>`	`getSendModeFilters()`
`java.util.Collection<AlertAppHandler.UITab>`	`getTabs()`
`ControlSettings<?>`	`getUITabSettings(AlertAppHandler.UITab uiTab)`
`boolean`	`hasMore()` True if there are more Datas than the default results list.
`boolean`	`isActive(AlertAppHandler.AlertLevelFilter levelFilter)` Check if given Alert level filter is active.
`boolean`	`isActive(AlertAppHandler.ReadModeFilter readModeFilter)` Check if given ReadState filter is active.
`boolean`	`isActive(AlertAppHandler.SendModeFilter sendModeFilter)`
`boolean`	`isActive(AlertAppHandler.UITab uiTab)`
`boolean`	`isAlertDisplay()`
`boolean`	`isCardView()`
`boolean`	`isEditAlertRulesValidated()`
`boolean`	`isListView()`
`boolean`	`isReadAllMode()` Override for it to return false when displaying recommendations.
`boolean`	`isReadModeRead()` Override for it to return false when displaying recommendations.
`boolean`	`isReadModeUnread()` Override for it to return false when displaying recommendations.
`boolean`	`isReceivedSendMode()`
`boolean`	`isRecommendationDisplay()`
`boolean`	`isSentSendMode()`
`boolean`	`processAction()` Method to be implemented to check/validate action to be performed and process them.
`void`	`setAlertTab(java.lang.String v)`
`void`	`setAlertViewMode(AlertAppHandler.ViewMode alertViewMode)`
`void`	`setEditAlertRules(java.lang.String v)`
`void`	`setEditMemberHandler(EditMemberHandler memberH)`
`void`	`setOpUpdateAlertRules(java.lang.String v)`
`void`	`setRecoRecipient(java.lang.String v)`
`void`	`setRecoSendMode(java.lang.String recoSendMode)`
`boolean`	`showAlertRulesEditor()`
`boolean`	`showCutomizeAlertRules()`
`boolean`	`showResultList()` Convenient method to indicate to the UI if results view will rendered.

Methods inherited from class com.jalios.jcms.alert.AlertHandler
getAlertParentDataId, getAlertsPageResult, getAlertStatusResponse, getAvailableAlertEndDate, getAvailableAlertLevelList, getAvailableAlertLevelListValues, getAvailableAlertLevels, getAvailableAlertReadMode, getAvailableAlerts, getAvailableAlertStartDate, getAvailableAlertWorkspace, getFormStepHiddenFields, getMemberAlertSettings, getMoreAlertParams, getMoreDateRestriction, getPageSize, getSort, getStart, hasResults, isLevelAction, isLevelInfo, isLevelWarning, isOpReadAllPub, isOpUnfollow, isOpUnfollowRead, isPagerAll, isReadAllAlert, isReverse, isUnfollowableAlert, setAlertAppPager_pagerAll, setAlertAppPager_pageSize, setAlertAppPager_reverse, setAlertAppPager_sort, setAlertAppPager_start, setAlertAuthor, setAlertEndDate, setAlertLevel, setAlertListReverse, setAlertMoreDate, setAlertReadMode, setAlerts, setAlertStartDate, setAlertWorkspace, setOpRead, setOpReadAll, setOpReadAllPub, setOpUnfollow, setOpUnfollowRead, setOpUnread, showMarkAllAsRead, validateMember

Methods inherited from class com.jalios.jcms.handler.JcmsFormHandler
afterValidation, checkMissingField, getAvailableMainLanguage, getClosePopupUrl, getControllerContext, getEditFieldSet, getFormStep, getFormStepCount, getFormStepFinishLabel, getFormStepLabels, getFormStepPrefixProp, 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, getRedirect, getRedirectOnClosePopup, getWorkspace, init, isFieldEdition, isFieldMissing, isPartialFieldEdition, isPopupEdition, isWorkspaceForced, mapStringArrayToMapStringList, mapStringListToMapStringArray, processStatus, sanitize, sanitize, sendRedirect, sendRedirect, setEditField, setFormStep, setNoRedirect, setNoSendRedirect, setPopupEdition, setRedirect, setRedirectOnClosePopup, setWorkspace, setWs, showCancelButton, showFinishButton, showNextButton, 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, addWebAssets, checkAccess, checkAccess, checkCSRF, debugDisplayContext, disablePacker, forceEditIcon, forceUpdate, getAjaxRequestAttribute, getAjaxRequestId, getAllHeadersDiffMap, getAllHeadersMap, getBackOfficeCSSHeader, getBackOfficeJavaScriptSet, getBodyAttributes, getContentForm, getCSSHeaders, getCtxCategories, getCurrentCategory, getCustomHeaders, getDocType, getFinalCSSFooterMap, getFinalCSSMap, getFinalJavaScriptSet, getFrontOfficeCSSHeader, getFrontOfficeJavaScriptSet, 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, 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, getUrlWithCommonUpdatedParams, getUserCountry, getUserLang, getUserLocale, getUserZoneId, getWarningMsg, getWarningMsgList, getWarningMsgSession, getWarningMsgSessionList, glp, isAdmin, isAjaxRequest, isDBMember, isDebug, isInFrontOffice, isLogged, isWebdavAccess, removeMessage, removeMessage, 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, validateRegexp, validateSchedule

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

- Field Detail
  - REVISION
```
public static final java.lang.String REVISION
```
    See Also:
    
    Constant Field Values
  - PARAM_ALERT_VIEW_MODE
```
public static final java.lang.String PARAM_ALERT_VIEW_MODE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_VIEW_MODE
```
protected static final AlertAppHandler.ViewMode DEFAULT_VIEW_MODE
```
  - PARAM_ALERT_TAB
```
public static final java.lang.String PARAM_ALERT_TAB
```
    See Also:
    
    Constant Field Values
  - DEFAULT_APP_TAB
```
protected static final AlertAppHandler.UITab DEFAULT_APP_TAB
```
  - PARAM_RECO_RECIPIENT
```
public static final java.lang.String PARAM_RECO_RECIPIENT
```
    See Also:
    
    Constant Field Values
  - PARAM_RECO_SEND_MODE
```
public static final java.lang.String PARAM_RECO_SEND_MODE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_RECO_SEND_MODE
```
protected static final RecommendationQueryBuilder.SendMode DEFAULT_RECO_SEND_MODE
```
  - PARAM_PAGER_PEFIX
```
public static final java.lang.String PARAM_PAGER_PEFIX
```
    See Also:
    
    Constant Field Values
  - APP_JSP
```
protected static final java.lang.String APP_JSP
```
    Default Alert app template.
    
    See Also:
    
    Constant Field Values
  - APP_INNER_JSP
```
protected static final java.lang.String APP_INNER_JSP
```
    Default Alert app inner jsp.
    
    See Also:
    
    Constant Field Values
  - PARAM_ALERTS
```
public static final java.lang.String PARAM_ALERTS
```
    See Also:
    
    Constant Field Values
  - OP_READ
```
public static final java.lang.String OP_READ
```
    See Also:
    
    Constant Field Values
  - OP_UNREAD
```
public static final java.lang.String OP_UNREAD
```
    See Also:
    
    Constant Field Values
  - APP_DEFAULT_NO_RESULTS_ICON
```
protected static final java.lang.String APP_DEFAULT_NO_RESULTS_ICON
```
    The JCMS default "no results in APP" icon.
    Full property: icon.app.no-result
    
    See Also:
    
    Constant Field Values
  - EDIT_ALERT_RULES_PARAM
```
public static final java.lang.String EDIT_ALERT_RULES_PARAM
```
    See Also:
    
    Constant Field Values
  - isEditAlertRulesValidated
```
protected boolean isEditAlertRulesValidated
```
  - rqb
```
protected RecommendationQueryBuilder rqb
```
  - recoSendMode
```
protected RecommendationQueryBuilder.SendMode recoSendMode
```
  - recoRecipient
```
protected Member recoRecipient
```
  - alertViewMode
```
protected AlertAppHandler.ViewMode alertViewMode
```
  - uiTab
```
protected AlertAppHandler.UITab uiTab
```
    Represents the current / active tab selected by the user (or the default one).
- Constructor Detail
  - AlertAppHandler
```
public AlertAppHandler()
```
- Method Detail
  - setEditMemberHandler
```
public void setEditMemberHandler(EditMemberHandler memberH)
```
  - getEditMemberHandler
```
public EditMemberHandler getEditMemberHandler()
```
  - 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 AlertHandler
    
    Returns:
    
    false if no redirection is needed, true otherwise
    
    Throws:
    
    java.io.IOException - IO Exception
  - setEditAlertRules
```
public void setEditAlertRules(java.lang.String v)
```
  - showCutomizeAlertRules
```
public boolean showCutomizeAlertRules()
```
    Returns:
    
    true if "alert rules editor" link should be available.
  - showAlertRulesEditor
```
public boolean showAlertRulesEditor()
```
    Returns:
    
    true when the alert rules editor must be displayed
  - setOpUpdateAlertRules
```
public void setOpUpdateAlertRules(java.lang.String v)
```
  - isEditAlertRulesValidated
```
public boolean isEditAlertRulesValidated()
```
  - getAlertAppStatusResponse
```
public java.lang.String getAlertAppStatusResponse()
```
    Returns:
    
    the total alerts unread count taking in account current filters
    
    Since:
    
    jcms-10.0.1
  - getResultsCount
```
public int getResultsCount()
```
    Overrides:
    
    getResultsCount in class AlertHandler
    
    Returns:
    
    results count for current user filters
    
    See Also:
    
    AlertQueryBuilder.getResultsCount()
  - getRecommendationsPageResult
```
public PageResult<Recommendation> getRecommendationsPageResult()
```
  - getAlertAuthorSettings
```
public ControlSettings<?> getAlertAuthorSettings()
```
  - getAvailableAlertAuthor
```
public Member getAvailableAlertAuthor()
```
    In recommendations case, when SendMode is sent, returns loggedMember as forced author filter.
    
    Overrides:
    
    getAvailableAlertAuthor in class AlertHandler
    
    Returns:
    
    the member to use as Alerts recipient filter
    
    Since:
    
    jcms-10.0.2
  - getAlertStartSettings
```
public DateSettings getAlertStartSettings()
```
  - getAlertEndSettings
```
public DateSettings getAlertEndSettings()
```
  - getAlertWorkspaceSettings
```
public ControlSettings<?> getAlertWorkspaceSettings()
```
  - getReadModeSettings
```
public ControlSettings<?> getReadModeSettings(AlertQueryBuilder.ReadMode readMode,
                                              java.lang.String userLang)
```
  - getReadModeFilters
```
public java.util.Collection<AlertAppHandler.ReadModeFilter> getReadModeFilters()
```
  - isActive
```
public boolean isActive(AlertAppHandler.ReadModeFilter readModeFilter)
```
    Check if given ReadState filter is active.
    
    Parameters:
    
    readModeFilter - the filter value to test
    
    Returns:
    
    boolean
  - getAlertLevelSettings
```
public ControlSettings<?> getAlertLevelSettings(Alert.Level alertLevel,
                                                java.lang.String userLang)
```
  - getLevelFilters
```
public java.util.Collection<AlertAppHandler.AlertLevelFilter> getLevelFilters()
```
  - isActive
```
public boolean isActive(AlertAppHandler.AlertLevelFilter levelFilter)
```
    Check if given Alert level filter is active.
    
    Parameters:
    
    levelFilter - the filter value to test
    
    Returns:
    
    boolean
  - showResultList
```
public boolean showResultList()
```
    Description copied from class: AlertHandler
    
    Convenient method to indicate to the UI if results view will rendered.
    Return false to indicate APP Body is something else than results.
    
    Overrides:
    
    showResultList in class AlertHandler
    
    Returns:
    
    false if Alert rules editor is asked, default choice otherwise.
  - setRecoSendMode
```
public void setRecoSendMode(java.lang.String recoSendMode)
```
  - getAvailableRecoSendMode
```
public RecommendationQueryBuilder.SendMode getAvailableRecoSendMode()
```
  - isSentSendMode
```
public boolean isSentSendMode()
```
  - isReceivedSendMode
```
public boolean isReceivedSendMode()
```
  - getRecoSendModeSettings
```
public ControlSettings<?> getRecoSendModeSettings(RecommendationQueryBuilder.SendMode sendMode,
                                                  java.lang.String userLang)
```
  - getSendModeFilters
```
public java.util.Collection<AlertAppHandler.SendModeFilter> getSendModeFilters()
```
  - isActive
```
public boolean isActive(AlertAppHandler.SendModeFilter sendModeFilter)
```
  - setRecoRecipient
```
public void setRecoRecipient(java.lang.String v)
```
  - getAvailableRecoRecipient
```
public Member getAvailableRecoRecipient()
```
    In recommendations case, when SendMode is received, then forces recipient filter to be loggedMember.
    
    Returns:
    
    the member to use as recommendation recipient filter
    
    Since:
    
    jcms-10.0.2
  - getRecoRecipientSettings
```
public ControlSettings<?> getRecoRecipientSettings()
```
  - hasMore
```
public boolean hasMore()
```
    True if there are more Datas than the default results list.
    
    Overrides:
    
    hasMore in class AlertHandler
    
    Returns:
    
    true ie More button should be displayed
  - getMoreDate
```
protected java.util.Date getMoreDate()
```
    Overrides:
    
    getMoreDate in class AlertHandler
    
    Returns:
    
    if there are result(s), the creation date of last result.
  - getMoreAlertParamsMap
```
protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,?>> getMoreAlertParamsMap()
```
    Compute the AJAX parameters for the AJAX "more" button, depending on view, and compliant filters
    
    Overrides:
    
    getMoreAlertParamsMap in class AlertHandler
    
    Returns:
    
    a map to be converted into JSON for data-jalios-options attribute
    
    Since:
    
    jcms-10.0.2
  - getAppJsp
```
public static java.lang.String getAppJsp()
```
    Returns:
    
    the unique APP JSP entry point
  - getAppInnerJsp
```
public static java.lang.String getAppInnerJsp()
```
    Returns:
    
    the unique APP JSP entry point
  - getAppHeaderTitle
```
public java.lang.String getAppHeaderTitle(java.lang.String userLang)
```
    Parameters:
    
    userLang - the user lang
    
    Returns:
    
    app header title depending on the current tab.
  - getAppHeaderJsp
```
public java.lang.String getAppHeaderJsp()
```
  - getAppBodyJsp
```
public java.lang.String getAppBodyJsp()
```
  - getAppSidebarJsp
```
public java.lang.String getAppSidebarJsp()
```
  - getNoResultsIcon
```
public java.lang.String getNoResultsIcon()
```
    Returns:
    
    the right "APP No results" icon to use when there's no results, depending on the query.
    
    Since:
    
    jcms-10.0.2
  - getNoResultsMessage
```
public java.lang.String getNoResultsMessage()
```
    Returns:
    
    the right message when there's no Alerts or no Recommendations
  - setAlertViewMode
```
public void setAlertViewMode(AlertAppHandler.ViewMode alertViewMode)
```
  - getAvailableAlertViewMode
```
public AlertAppHandler.ViewMode getAvailableAlertViewMode()
```
  - isListView
```
public boolean isListView()
```
  - isCardView
```
public boolean isCardView()
```
  - isReadModeUnread
```
public boolean isReadModeUnread()
```
    Override for it to return false when displaying recommendations.
    
    Overrides:
    
    isReadModeUnread in class AlertHandler
  - isReadModeRead
```
public boolean isReadModeRead()
```
    Override for it to return false when displaying recommendations.
    
    Overrides:
    
    isReadModeRead in class AlertHandler
  - isReadAllMode
```
public boolean isReadAllMode()
```
    Override for it to return false when displaying recommendations.
    
    Overrides:
    
    isReadAllMode in class AlertHandler
  - setAlertTab
```
public void setAlertTab(java.lang.String v)
```
  - getAvailableUITab
```
public AlertAppHandler.UITab getAvailableUITab()
```
    Returns:
    
    the current / active tab in the app. Never returns null.
  - getTabs
```
public java.util.Collection<AlertAppHandler.UITab> getTabs()
```
    Returns:
    
    the (ordered) tabs to display
  - isAlertDisplay
```
public boolean isAlertDisplay()
```
  - isRecommendationDisplay
```
public boolean isRecommendationDisplay()
```
  - isActive
```
public boolean isActive(AlertAppHandler.UITab uiTab)
```
    Parameters:
    
    uiTab - the ui tab to test if it is active
    
    Returns:
    
    true if given UITab is currently selected / active.
  - getUITabSettings
```
public ControlSettings<?> getUITabSettings(AlertAppHandler.UITab uiTab)
```
    Parameters:
    
    uiTab - the current UITab
    
    Returns:
    
    the ControlSettings to use for Tabs navigation.

Class AlertAppHandler

Nested Class Summary

Field Summary

Fields inherited from class com.jalios.jcms.alert.AlertHandler

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.alert.AlertHandler

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

REVISION

PARAM_ALERT_VIEW_MODE

DEFAULT_VIEW_MODE

PARAM_ALERT_TAB

DEFAULT_APP_TAB

PARAM_RECO_RECIPIENT

PARAM_RECO_SEND_MODE

DEFAULT_RECO_SEND_MODE

PARAM_PAGER_PEFIX

APP_JSP

APP_INNER_JSP

PARAM_ALERTS

OP_READ

OP_UNREAD

APP_DEFAULT_NO_RESULTS_ICON

EDIT_ALERT_RULES_PARAM

isEditAlertRulesValidated

rqb

recoSendMode

recoRecipient

alertViewMode

uiTab

Constructor Detail

AlertAppHandler

Method Detail

setEditMemberHandler

getEditMemberHandler

processAction

setEditAlertRules

showCutomizeAlertRules

showAlertRulesEditor

setOpUpdateAlertRules

isEditAlertRulesValidated

getAlertAppStatusResponse

getResultsCount

getRecommendationsPageResult

getAlertAuthorSettings

getAvailableAlertAuthor

getAlertStartSettings

getAlertEndSettings

getAlertWorkspaceSettings

getReadModeSettings

getReadModeFilters

isActive

getAlertLevelSettings

getLevelFilters

isActive

showResultList

setRecoSendMode

getAvailableRecoSendMode

isSentSendMode

isReceivedSendMode

getRecoSendModeSettings

getSendModeFilters

isActive

setRecoRecipient

getAvailableRecoRecipient

getRecoRecipientSettings

hasMore

getMoreDate

getMoreAlertParamsMap

getAppJsp

getAppInnerJsp