Interface InboxBean

    • Method Detail

      • getWebMessages

        WebMessages getWebMessages()
                            throws WebBeanException
        Returns the Inbox messages in a WebMessages instance. This method is affected by the Inbox flags which instructs the Intelligence Server how much details to bring back.
        Returns:
        the Inbox messages
        Throws:
        WebBeanException - thrown if the Inbox messages can not be retrieved.
      • getInboxFlags

        int getInboxFlags()
        Returns a flag of EnumDSSXMLInboxFlags indicating how much details to include in the returned Inbox messages, as well as those details about removing and saving Inbox messages.
        Returns:
        a flag indicating how much details to return. The default value is DssXmlInboxBrowsingInfo.
      • setInboxFlags

        void setInboxFlags​(int flags)
        Sets the flag of EnumDSSXMLInboxFlags indicating how much details to include in the returned Inbox messages, as well as those details about removing and saving Inbox messages.
        Parameters:
        flags - a flag indicating how much details.
      • removeInboxMessage

        void removeInboxMessage​(java.lang.String messageID)
                         throws WebBeanException
        Removes a single message from the Inbox.
        Parameters:
        messageID - the message ID of an Inbox message.
        Throws:
        WebBeanException - thrown if the message can not be removed from the Inbox.
      • saveToInbox

        void saveToInbox​(java.lang.String messageID,
                         int stateID)
                  throws WebBeanException
        Saves a message along with its specific state into Inbox. The Inbox flags is used in this method to specify what to keep in the saved Inbox message.
        Parameters:
        messageID - the message ID of an message
        stateID - the state id of an message. The default state id is -1, meaning the latest state.
        Throws:
        WebBeanException - thrown if the message can not be saved to the Inbox.
      • saveToInbox

        void saveToInbox​(java.lang.String messageID)
                  throws WebBeanException
        Saves a message with its latest state into Inbox. The Inbox flags is used in this method to specify what to keep in the saved Inbox message.
        Parameters:
        messageID - the message id of an message.
        Throws:
        WebBeanException - thrown if the message can not be saved to the Inbox.
      • isSavedInInbox

        boolean isSavedInInbox​(java.lang.String messageID)
                        throws WebBeanException
        Returns true if the specified message has already been saved in the Inbox.
        Parameters:
        messageID - the message ID of an message.
        Returns:
        true if the specified message is saved.
        Throws:
        WebBeanException - thrown if this information can not be retrieved from backend.
      • getSortField

        int getSortField()
        Returns the sorting field of the Inbox messages.
        Returns:
        the sorting field specified in EnumWebMessageSortByField. The default value is WebMessageSortByCreationTime.WebMessageSortByCreationTime
      • setSortField

        void setSortField​(int sortField)
        Sets the sorting field of the Inbox messages.
        Parameters:
        sortField - the sorting field specified in EnumWebMessageSortByField.
      • isSortAscending

        boolean isSortAscending()
        Returns true if the sorting is in ascending order.
        Returns:
        true if the sorting if in ascending order.
      • setSortAscending

        void setSortAscending​(boolean asc)
        Sets the Inbox message sorting order.
        Parameters:
        asc - true if the sorting order is ascending.
      • setRenameEditable

        void setRenameEditable​(java.lang.String messageID)
        Marks a message for renaming.
        Parameters:
        messageID - message marked for renaming.
        Since:
        MicroStrategy Web 9.0.0
      • getRenameEditable

        java.lang.String getRenameEditable()
        Returns:
        the rename editable message ID.
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        setRenameEditable(String)
      • cancelRename

        void cancelRename()
        Cancels the message ID and name set via setRenameEditable(String)
        Since:
        MicroStrategy Web 9.0.0