Package com.jalios.jcms.recommendation

Class Recommendation

    • Field Detail

      • dataId

        protected transient java.lang.String dataId

      • data

        protected transient Data data

      • workspaceId

        protected transient java.lang.String workspaceId

      • workspace

        protected transient Workspace workspace

      • message

        protected java.lang.String message

      • recipientSet

        protected transient java.util.Set<Member> recipientSet

      • groupSet

        protected transient java.util.Set<Group> groupSet

    • Constructor Detail

      • Recommendation

        public Recommendation()

      • Recommendation

        public Recommendation​(Alert.Level level,
                      Data data,
                      Member author,
                      java.util.Set<Member> recipientSet,
                      java.util.Set<Group> groupSet,
                      java.lang.String message)

    • Method Detail

      • checkIntegrity

        public ControllerStatus checkIntegrity​(java.util.Map context)
        Description copied from class: Data
        Checks whether or not data integrity constraints are respected.
        Overrides:
        checkIntegrity in class Data
        Parameters:
        context - a map which contains context parameters (may be null)
        Returns:
        a ControllerStatus

      • getRecipientAndGroupMemberSet

        public java.util.Set<Member> getRecipientAndGroupMemberSet()
        Returns:
        a Set of Member, by getting recipientSet Members & Members belonging to the Group Set of the Recommendation
        Since:
        jcms-8.0.0

      • getData

        public Data getData()

      • setData

        public void setData​(Data v)
        Sets 'data' (and workspace if applyable)
        Parameters:
        v - data to set

      • getDataId

        public java.lang.String getDataId()
        Do not call this method. It is reserved for DBData mapping.
        Returns:
        return recommended data's identifier

      • setDataId

        public void setDataId​(java.lang.String v)
        Do not call this method. It is reserved for DBData mapping.
        Parameters:
        v - id of data to set

      • initializeDBDataCollections

        public void initializeDBDataCollections()
        Description copied from class: Data
        This methods force the collections of the DBData to be initialized()
        Overrides:
        initializeDBDataCollections in class Data

      • getMessage

        public java.lang.String getMessage()

      • setMessage

        public void setMessage​(java.lang.String message)

      • getRecipientSet

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

      • setRecipientSet

        public void setRecipientSet​(java.util.Set<Member> recipientSet)

      • getRecipientIdSet

        public java.util.Set<java.lang.String> getRecipientIdSet()
        Do not call this method. It is reserved for Recipient Member mapping.
        Returns:
        a Set of Member ids
        Since:
        jcms-8.0.0

      • setRecipientIdSet

        public void setRecipientIdSet​(java.util.Set<java.lang.String> idSet)
        Do not call this method. It is reserved for Recipient Member mapping.
        Parameters:
        idSet - the Set of member ids
        Since:
        jcms-8.0.0

      • getGroupSet

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

      • setGroupSet

        public void setGroupSet​(java.util.Set<Group> groupSet)

      • getGroupIdSet

        public java.util.Set<java.lang.String> getGroupIdSet()
        Do not call this method. It is reserved for Recipient Member mapping.
        Returns:
        a Set of Group ids
        Since:
        jcms-8.0.0

      • setGroupIdSet

        public void setGroupIdSet​(java.util.Set<java.lang.String> idSet)
        Do not call this method. It is reserved for Recipient Member mapping.
        Parameters:
        idSet - the Set of group ids
        Since:
        jcms-8.0.0

      • getLevelValue

        public int getLevelValue()

      • setLevelValue

        public void setLevelValue​(int v)

      • setLevelValue

        public void setLevelValue​(java.lang.Integer v)
        Do not call this method. It is reserved for DBData mapping.
        Parameters:
        v - the value
        Since:
        jcms-8.0.1

      • setLevel

        public void setLevel​(Alert.Level level)

      • getWorkspace

        public Workspace getWorkspace()

      • getWorkspaceId

        public java.lang.String getWorkspaceId()
        Do not call this method. It is reserved for DBData mapping.

      • setWorkspaceId

        public void setWorkspaceId​(java.lang.String v)
        Do not call this method. It is reserved for DBData mapping.

      • getHideRecipients

        public boolean getHideRecipients()
        Returns:
        true if recipients should be hidden from recommendation
        Since:
        jcms-10.0.8

      • setHideRecipients

        public void setHideRecipients​(java.lang.Boolean hideRecipients)
        Parameters:
        hideRecipients - weither recipients should be hidden from recommendation
        Since:
        jcms-10.0.8

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class Data

      • exportXmlField

        public void exportXmlField​(java.lang.StringBuffer sb,
                           int indentLevel)
        Description copied from class: Data
        Fills the given StringBuffer with Xml export of fields of this data.
        Overrides:
        exportXmlField in class Data
        Parameters:
        sb - the StringBuffer
        indentLevel - the indent level