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

public class AlertHandler
extends JcmsFormHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected Member	alertAuthor
protected java.util.Date	alertEndDate
protected Alert.Level[]	alertLevelList
protected AlertQueryBuilder.ReadMode	alertReadMode
protected java.util.Date	alertStartDate
protected Workspace	alertWorkspace
protected AlertQueryBuilder	aqb
protected static Alert.Level[]	DEFAULT_ALERT_LEVELS
static AlertQueryBuilder.ReadMode	DEFAULT_READ_MODE
protected java.util.Date	moreDate
protected boolean	opRead
protected boolean	opReadAll
protected boolean	opUnread
protected boolean	pagerAll
protected int	pageSize
static java.lang.String	PARAM_ALERT_AUTHOR
static java.lang.String	PARAM_ALERT_END_DATE
static java.lang.String	PARAM_ALERT_LEVEL
static java.lang.String	PARAM_ALERT_READ_MODE
static java.lang.String	PARAM_ALERT_START_DATE
static java.lang.String	PARAM_ALERT_WORKSPACE
static java.lang.String	PARAM_MORE_DATE
protected boolean	reverse
protected java.lang.String	sort
protected int	start

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

contextMap, editFieldSet, formStep, noRedirect, noSendRedirect, popupEdition, redirect, redirectOnClosePopup, REVISION, 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, 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, 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
AlertHandler()

Method Summary

Modifier and Type	Method and Description
PageResult<Alert>	getAlertsPageResult()
java.lang.String	getAlertStatusResponse()
Member	getAvailableAlertAuthor()
java.util.Date	getAvailableAlertEndDate()
java.util.List<Alert.Level>	getAvailableAlertLevelList()
protected java.util.List<java.lang.String>	getAvailableAlertLevelListValues() Internal.
Alert.Level[]	getAvailableAlertLevels()
AlertQueryBuilder.ReadMode	getAvailableAlertReadMode()
java.util.Date	getAvailableAlertStartDate()
Workspace	getAvailableAlertWorkspace()
java.lang.String	getMoreAlertParams() Compute the AJAX parameters for the AJAX "more" button
int	getPageSize()
java.lang.String	getSort()
int	getStart()
boolean	hasMore() True if there are more Datas than the default results list.
boolean	isLevelAction()
boolean	isLevelInfo()
boolean	isLevelWarning()
boolean	isPagerAll()
boolean	isReadAllMode()
boolean	isReadModeRead()
boolean	isReadModeUnread()
boolean	isReverse()
boolean	processAction() Method to be implemented to check/validate action to be performed and process them.
void	setAlertAppPager_pagerAll(java.lang.String v)
void	setAlertAppPager_pageSize(java.lang.String v)
void	setAlertAppPager_reverse(java.lang.String v)
void	setAlertAppPager_sort(java.lang.String v)
void	setAlertAppPager_start(java.lang.String v)
void	setAlertAuthor(java.lang.String v)
void	setAlertEndDate(java.lang.String v)
void	setAlertLevel(java.lang.String[] v)
void	setAlertMoreDate(java.lang.String v)
void	setAlertReadMode(java.lang.String alertReadMode)
void	setAlerts(java.lang.String[] v)
void	setAlertStartDate(java.lang.String v)
void	setAlertWorkspace(java.lang.String v)
void	setOpRead(java.lang.String v)
void	setOpReadAll(java.lang.String v)
void	setOpUnread(java.lang.String v)
boolean	showMarkAllAsRead()

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

afterValidation, checkMissingField, getAvailableMainLanguage, getClosePopupUrl, getControllerContext, getEditFieldSet, getFormStep, getFormStepCount, getFormStepFinishLabel, getFormStepHiddenFields, 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, 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, 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

PARAM_ALERT_AUTHOR

public static final java.lang.String PARAM_ALERT_AUTHOR

See Also:

Constant Field Values

PARAM_ALERT_END_DATE

public static final java.lang.String PARAM_ALERT_END_DATE

See Also:

Constant Field Values

PARAM_ALERT_START_DATE

public static final java.lang.String PARAM_ALERT_START_DATE

See Also:

Constant Field Values

PARAM_ALERT_WORKSPACE

public static final java.lang.String PARAM_ALERT_WORKSPACE

See Also:

Constant Field Values

PARAM_ALERT_LEVEL

public static final java.lang.String PARAM_ALERT_LEVEL

See Also:

Constant Field Values

PARAM_ALERT_READ_MODE

public static final java.lang.String PARAM_ALERT_READ_MODE

See Also:

Constant Field Values

DEFAULT_READ_MODE

public static final AlertQueryBuilder.ReadMode DEFAULT_READ_MODE

PARAM_MORE_DATE

public static final java.lang.String PARAM_MORE_DATE

See Also:

Constant Field Values

aqb

protected AlertQueryBuilder aqb

alertAuthor

protected Member alertAuthor

alertStartDate

protected java.util.Date alertStartDate

alertEndDate

protected java.util.Date alertEndDate

alertWorkspace

protected Workspace alertWorkspace

alertReadMode

protected AlertQueryBuilder.ReadMode alertReadMode

DEFAULT_ALERT_LEVELS

protected static final Alert.Level[] DEFAULT_ALERT_LEVELS

alertLevelList

protected Alert.Level[] alertLevelList

moreDate

protected java.util.Date moreDate

opRead

protected boolean opRead

opUnread

protected boolean opUnread

opReadAll

protected boolean opReadAll

sort

protected java.lang.String sort

reverse

protected boolean reverse

start

protected int start

pageSize

protected int pageSize

pagerAll

protected boolean pagerAll

Constructor Detail

AlertHandler

public AlertHandler()

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 JcmsFormHandler

Returns:

false if no redirection is needed, true otherwise

Throws:

java.io.IOException - IO Exception

getAlertsPageResult

public PageResult<Alert> getAlertsPageResult()

setAlertAuthor

public void setAlertAuthor(java.lang.String v)

getAvailableAlertAuthor

public Member getAvailableAlertAuthor()

setAlertStartDate

public void setAlertStartDate(java.lang.String v)

getAvailableAlertStartDate

public java.util.Date getAvailableAlertStartDate()

getAvailableAlertEndDate

public java.util.Date getAvailableAlertEndDate()

setAlertEndDate

public void setAlertEndDate(java.lang.String v)

setAlertWorkspace

public void setAlertWorkspace(java.lang.String v)

getAvailableAlertWorkspace

public Workspace getAvailableAlertWorkspace()

setAlertReadMode

public void setAlertReadMode(java.lang.String alertReadMode)

getAvailableAlertReadMode

public AlertQueryBuilder.ReadMode getAvailableAlertReadMode()

isReadModeRead

public boolean isReadModeRead()

isReadModeUnread

public boolean isReadModeUnread()

isReadAllMode

public boolean isReadAllMode()

setAlertLevel

public void setAlertLevel(java.lang.String[] v)

getAvailableAlertLevels

public Alert.Level[] getAvailableAlertLevels()

getAvailableAlertLevelList

public java.util.List<Alert.Level> getAvailableAlertLevelList()

getAvailableAlertLevelListValues

protected java.util.List<java.lang.String> 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

public void setAlertMoreDate(java.lang.String v)

hasMore

public boolean hasMore()

True if there are more Datas than the default results list.

Returns:

true ie More button should be displayed

getMoreAlertParams

public java.lang.String getMoreAlertParams()

Compute the AJAX parameters for the AJAX "more" button

Returns:

a JSON map for data-jalios-options

setOpRead

public void setOpRead(java.lang.String v)

setOpUnread

public void setOpUnread(java.lang.String v)

setOpReadAll

public void setOpReadAll(java.lang.String v)

setAlerts

public void setAlerts(java.lang.String[] v)

showMarkAllAsRead

public boolean showMarkAllAsRead()

setAlertAppPager_sort

public void setAlertAppPager_sort(java.lang.String v)

getSort

public java.lang.String getSort()

setAlertAppPager_reverse

public void setAlertAppPager_reverse(java.lang.String v)

isReverse

public boolean isReverse()

setAlertAppPager_start

public void setAlertAppPager_start(java.lang.String v)

getStart

public int getStart()

setAlertAppPager_pageSize

public void setAlertAppPager_pageSize(java.lang.String v)

getPageSize

public int getPageSize()

setAlertAppPager_pagerAll

public void setAlertAppPager_pagerAll(java.lang.String v)

isPagerAll

public boolean isPagerAll()

getAlertStatusResponse

public final java.lang.String getAlertStatusResponse()

Returns:

the AlertStatus as a String for current logged member