Package com.jalios.jcms.recommendation

Class 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
    Author:
    Kevin Bransard

    • Field Detail

      • RECOMMENDATION_ID_PARAM

        public static final java.lang.String RECOMMENDATION_ID_PARAM
        See Also:
        Constant Field Values

      • RECOMMENDED_DATA_ID_PARAM

        public static final java.lang.String RECOMMENDED_DATA_ID_PARAM
        See Also:
        Constant Field Values

      • RECOMMENDATION_MODAL_TAB_PARAM

        public static final java.lang.String RECOMMENDATION_MODAL_TAB_PARAM
        See Also:
        Constant Field Values

      • RECOMMENDATION_MODAL_TAB_TRACKING

        public static final java.lang.String RECOMMENDATION_MODAL_TAB_TRACKING
        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

      • groupSet

        protected java.util.Set<Group> groupSet

      • message

        protected java.lang.String message

      • sendCopy

        protected boolean sendCopy

      • sendToAuthor

        protected boolean sendToAuthor

      • existingRecommendationList

        protected java.util.List<Recommendation> existingRecommendationList

      • context

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

      • 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()
        Returns:
        always returns true
        Since:
        jcms-8.0.0

      • performCancel

        protected boolean performCancel()
        Returns:
        true
        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)

      • setHideRecipients

        public void setHideRecipients​(java.lang.String v)
        Parameters:
        v - hideRecipients
        Since:
        jcms-10.0.8 / JCMS-9339

      • getAvailableHideRecipients

        public boolean getAvailableHideRecipients()
        Returns:
        hideRecipients
        Since:
        jcms-10.0.8 / JCMS-9339

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