Package com.microstrategy.web.objects

Interface WebInboxSource

  • public interface WebInboxSource
    The WebInboxSource object exposes methods to manipulate the user inbox. The inbox is a list of executed reports and manipulation states of those reports that the user may use to retrieve previously executed reports. Individual reports are described in the form of a message, identified by the message ID and the manipulation state. Functions include the ability to retrieve, save and delete messages.
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Method Detail

      • getInboxMessagesAsXML

        java.lang.String getInboxMessagesAsXML()
                                throws WebObjectsException
        Returns the current inbox messages.
        Returns:
        An XML structure of the inbox messages retrieved.
        Throws:
        WebObjectsException - Thrown if an error occurs in the XML creation.

      • getMessageStatusList

        WebMessageStatusList getMessageStatusList()
        Returns a collection object WebMessageStatusList containing a list of message IDs and their status. The MessageStatusList property is used to set the status of a list of messages.
        Returns:
        A collection object WebMessageStatusList containing a list of message IDs and their status.

      • removeInboxMessage

        void removeInboxMessage​(java.lang.String messageID)
                 throws WebObjectsException
        Removes the specified inbox message. If that message is still executing, the execution is cancelled.
        Throws:
        WebObjectsException - Thrown if an error occurs in the XML creation.

      • getInboxMessage

        WebMessage getInboxMessage​(java.lang.String messageID)
                    throws WebObjectsException
        Get the specified inbox message.
        Parameters:
        messageID - message ID
        Returns:
        the message
        Throws:
        WebObjectsException - Thrown if an error occurs in the XML creation.

      • removeInboxMessages

        void removeInboxMessages​(java.lang.String[] messages)
                  throws WebObjectsException
        Removes the specified inbox messages. If any messages are still executing, their execution is cancelled.
        Parameters:
        messages - The list of messages to remove.
        Throws:
        WebObjectsException - Thrown if an error occurs in the XML creation.

      • setStatus

        void setStatus()
        throws WebObjectsException
        Sets the status of the inbox messages for the list of messages specified in the WebMessageStatusList.
        Throws:
        WebObjectsException - Thrown if an error occurs in the XML creation.

      • saveToInbox

        void saveToInbox​(java.lang.String strMsgID)
          throws WebObjectsException
        Saves the message to the inbox.
        Parameters:
        strMsgID - ID of the message to save.
        Throws:
        WebObjectsException - Thrown if an error occurs in the XML creation.

      • saveToInbox

        void saveToInbox​(java.lang.String strMsgID,
                 int newStateID)
          throws WebObjectsException
        Saves the message to the inbox. The state ID property defines what manipulation state to save. If no state ID is given, the last manipulation state is saved.
        Parameters:
        strMsgID - ID of the message to save.
        newStateID - the new stateID of the message to save.
        Throws:
        WebObjectsException - Thrown if an error occurs in the XML creation.

      • isSavedInInbox

        boolean isSavedInInbox​(java.lang.String strMsgID)
                throws WebObjectsException
        Specifies whether or not this message is currently saved.
        Parameters:
        strMsgID - ID of the message to check.
        Returns:
        True if the message is currently saved in the inbox.
        Throws:
        WebObjectsException - Thrown if an error occurs in the XML creation.

      • setSortBy

        void setSortBy​(int newSortField)
        Specifies the sort field that should be used to sort the WebMessages collection returned. Possible values are listed under the Enumeration interface EnumWebMessageSortByField.
        Parameters:
        newSortField - the specified sorting filed of EnumWebMessageSortByField.

      • isSortAsc

        boolean isSortAsc()
        Returns a boolean value indicating the current sorting order. The default value is true, which means sorting in ascending order.
        Returns:
        true if the sorting order is ascending.

      • setSortAsc

        void setSortAsc​(boolean ascending)
        Sets the sorting order.
        Parameters:
        ascending - true if the sorting order is ascending.

      • duplicateMessage

        java.lang.String duplicateMessage​(java.lang.String messageID,
                                  int mode)
                           throws WebObjectsException
        Duplicates a Message ID in the Inbox.
        Parameters:
        messageID - The message ID to duplicate.
        mode - Option from EnumDSSXMLMessageDuplicationMode.
        Returns:
        The new message ID.
        Throws:
        WebObjectsException
        Since:
        MicroStrategy Web 8.0.2

      • duplicateMessage

        java.lang.String duplicateMessage​(java.lang.String messageID,
                                  java.lang.String displayName,
                                  int mode)
                           throws WebObjectsException
        Duplicates a message.
        Parameters:
        messageID - message ID to duplicate.
        displayName - message alias.
        mode - from EnumDSSXMLMessageDuplicationMode
        Returns:
        the message ID of the duplicate.
        Throws:
        WebObjectsException - thrown if a problem is encountered during duplication.
        Since:
        MicroStrategy Web 9.0.0

      • setReplaceOldestIfFull

        void setReplaceOldestIfFull​(boolean replace)
        This defines whether to replace the oldest message in the user history list if it is determined that the list is full while trying to save By default this is set to false
        Parameters:
        replace -
        Since:
        MicroStrategy Web 8.0.0

      • isReplaceOldestIfFull

        boolean isReplaceOldestIfFull()
        This defines whether to replace the oldest message in the user history list if it is determined that the list is full while trying to save
        Since:
        MicroStrategy Web 8.0.0

      • setBlockBegin

        void setBlockBegin​(int blockBegin)
        Set inbox incremental fetch starting position(0-based).
        Parameters:
        blockBegin - block start position.

      • setBlockCount

        void setBlockCount​(int blockSize)
        Set inbox incremental fetch size(-1 for all)
        Parameters:
        blockSize - block size

      • getMessageFilters

        MonitorFilter getMessageFilters()
        Get message filters for editing. Will be automatically applied in getting messages.
        Returns:
        MonitorFilter

      • setOrderByField

        void setOrderByField​(int orderByField)
        Set the field to be sorted on, whose value is from EnumDSSXMLInboxMsgField
        Parameters:
        orderByField - the field to be sorted on.

      • setOrderByType

        void setOrderByType​(int orderByType)
        Set the sorting order type, ascending or descending. Value from
        Parameters:
        orderByType -

      • getOrderByField

        int getOrderByField()
        Get the field to be sorted on, whose value is from EnumDSSXMLInboxMsgField
        Returns:
        the field.

      • getOrderByType

        int getOrderByType()
        Get the sorting order type, ascending or descending. Value from
        Returns:
        the sorting order type.