com.jalios.jcms.recommendation

Class RecommendationHandler

java.lang.Object

com.jalios.jcms.context.JcmsContext

com.jalios.jcms.context.JcmsJspContext

com.jalios.jcms.handler.JcmsFormHandler

com.jalios.jcms.recommendation.RecommendationHandler

All Implemented Interfaces:

JcmsConstants, JaliosConstants

public class RecommendationHandler
extends JcmsFormHandler

This class is the handler for the form to send a Recommendation.

Since:

jcms-8.0.0

Version:

$Revision: 83924 $

Author:

Kevin Bransard

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	alertLevelKey
protected java.util.Map<java.lang.String,java.lang.Object>	context
protected java.util.List<Recommendation>	existingRecommendationList
protected java.util.Set<Group>	groupSet
protected java.lang.String	message
protected boolean	opCancel
protected boolean	opForceSend
protected boolean	opSend
protected java.util.Set<Member>	recipientSet
protected Recommendation	recommendation
protected Data	recommendedData
static java.lang.String	REVISION
protected boolean	sendCopy
protected boolean	sendToAuthor

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
RecommendationHandler()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAvailableAlertLevelKey()
java.util.Set<Group>	getAvailableGroupSet()
java.util.Set<Member>	getAvailableMemberSet()
java.lang.String	getAvailableMessage()
java.lang.String	getAvailableSendCopy()
java.lang.String	getAvailableSendToAuthor()
java.util.Map<java.lang.String,java.lang.Object>	getContext()
java.util.List<Recommendation>	getExistingRecommendationList()
Recommendation	getRecommendation()
Data	getRecommendedData()
protected boolean	performCancel()
protected boolean	performSend()
boolean	processAction() Method to be implemented to check/validate action to be performed and process them.
void	setAlertLevelKey(java.lang.String v)
void	setExistingRecommendationList(java.util.List<Recommendation> existingRecommendationList)
void	setGroups(java.lang.String[] v)
void	setMembers(java.lang.String[] v)
void	setMessage(java.lang.String v)
void	setOpCancel(java.lang.String v)
void	setOpForceSend(java.lang.String v)
void	setOpSend(java.lang.String v)
void	setRecommendedDataId(java.lang.String recommendedDataId)
void	setSendCopy(boolean v)
void	setSendToAuthor(boolean sendToAuthor)
protected boolean	validateCancel()
protected boolean	validateSend()

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, getRedirect, getRedirectOnClosePopup, getWorkspace, init, isFieldEdition, isFieldMissing, isPartialFieldEdition, isPopupEdition, isWorkspaceForced, processStatus, 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, 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

REVISION

public static final java.lang.String REVISION

See Also:

Constant Field Values

recommendedData

protected Data recommendedData

opSend

protected boolean opSend

opForceSend

protected boolean opForceSend

opCancel

protected boolean opCancel

recipientSet

protected java.util.Set<Member> recipientSet

message

protected java.lang.String message

sendCopy

protected boolean sendCopy

sendToAuthor

protected boolean sendToAuthor

recommendation

protected Recommendation recommendation

existingRecommendationList

protected java.util.List<Recommendation> existingRecommendationList

context

protected java.util.Map<java.lang.String,java.lang.Object> context

groupSet

protected java.util.Set<Group> groupSet

alertLevelKey

protected java.lang.String alertLevelKey

Constructor Detail

RecommendationHandler

public RecommendationHandler()

Method Detail

getContext

public java.util.Map<java.lang.String,java.lang.Object> getContext()

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

validateSend

protected boolean validateSend()

Returns:

true if the sending of the Recommendation has been validated

Since:

jcms-8.0.0

validateCancel

protected boolean validateCancel()

Returns:

true if the opCancel is validated

Since:

jcms-8.0.2

performSend

protected boolean performSend()

Since:

jcms-8.0.0

performCancel

protected boolean performCancel()

Since:

jcms-8.0.2

setRecommendedDataId

public void setRecommendedDataId(java.lang.String recommendedDataId)

getRecommendedData

public Data getRecommendedData()

setOpSend

public void setOpSend(java.lang.String v)

setOpForceSend

public void setOpForceSend(java.lang.String v)

setOpCancel

public void setOpCancel(java.lang.String v)

setGroups

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

getAvailableGroupSet

public java.util.Set<Group> getAvailableGroupSet()

setMembers

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

getAvailableMemberSet

public java.util.Set<Member> getAvailableMemberSet()

setMessage

public void setMessage(java.lang.String v)

getAvailableMessage

public java.lang.String getAvailableMessage()

setSendCopy

public void setSendCopy(boolean v)

getAvailableSendCopy

public java.lang.String getAvailableSendCopy()

setSendToAuthor

public void setSendToAuthor(boolean sendToAuthor)

getAvailableSendToAuthor

public java.lang.String getAvailableSendToAuthor()

getExistingRecommendationList

public java.util.List<Recommendation> getExistingRecommendationList()

setExistingRecommendationList

public void setExistingRecommendationList(java.util.List<Recommendation> existingRecommendationList)

setAlertLevelKey

public void setAlertLevelKey(java.lang.String v)

getAvailableAlertLevelKey

public java.lang.String getAvailableAlertLevelKey()

getRecommendation

public Recommendation getRecommendation()