public interface

WebInboxSource

com.microstrategy.web.objects.WebInboxSource

Class Overview

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.

Summary

Public Methods
abstract String duplicateMessage(String messageID, String displayName, int mode)
Duplicates a message.
abstract String duplicateMessage(String messageID)
Duplicates a message.
abstract String duplicateMessage(String messageID, int mode)
Duplicates a Message ID in the Inbox.
abstract int getDeleteFlags()
abstract int getInboxFlags()
Returns the current inbox flags.
abstract WebMessages getInboxMessages()
Returns a collection object WebMessages containing the current inbox messages.
abstract String getInboxMessagesAsXML()
Returns the current inbox messages.
abstract WebMessageStatusList getMessageStatusList()
Returns a collection object WebMessageStatusList containing a list of message IDs and their status.
abstract int getSortBy()
Returns the current sorting field.
abstract 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
abstract boolean isSavedInInbox(String strMsgID)
Specifies whether or not this message is currently saved.
abstract boolean isSortAsc()
Returns a boolean value indicating the current sorting order.
abstract void removeInboxMessage(String messageID)
Removes the specified inbox message.
abstract void removeInboxMessages(String[] messages)
Removes the specified inbox messages.
abstract void rename(String messageID, String newName)
abstract void saveToInbox(String strMsgID, int newStateID)
Saves the message to the inbox.
abstract void saveToInbox(String strMsgID)
Saves the message to the inbox.
abstract void setDeleteFlags(int flags)
abstract void setInboxFlags(int newValue)
Defines the inbox flags which are a set of flags describing what information to retrieve when returning the inbox.
abstract 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
abstract void setSortAsc(boolean ascending)
Sets the sorting order.
abstract void setSortBy(int newSortField)
Specifies the sort field that should be used to sort the WebMessages collection returned.
abstract void setStatus()
Sets the status of the inbox messages for the list of messages specified in the WebMessageStatusList.

Public Methods

public abstract String duplicateMessage (String messageID, String displayName, int mode)

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.

public abstract String duplicateMessage (String messageID)

Duplicates a message. This is equivalent to invoking duplicateMessage(String, int) with mode to DSSXMLMessageDuplicateModeDerived.

Parameters
messageID The message ID to duplicate.
Returns
  • The new message ID.

public abstract String duplicateMessage (String messageID, int mode)

Duplicates a Message ID in the Inbox.

Parameters
messageID The message ID to duplicate.
mode Option from EnumDSSXMLMessageDuplicationMode.
Returns
  • The new message ID.

public abstract int getDeleteFlags ()

public abstract int getInboxFlags ()

Returns the current inbox flags. Flags are specified as a bit-wise OR of the EnumDSSXMLInboxFlags enumeration.

The default value of the flags property is DssXmlInboxBrowsingInfo.

Returns

public abstract WebMessages getInboxMessages ()

Returns a collection object WebMessages containing the current inbox messages.

Returns
  • A collection object WebMessages containing the current inbox messages.
Throws
WebObjectsException Thrown if an error occurs in the XML creation. Note that the WebMessages returned can only have WebMessage objects in it.

public abstract String getInboxMessagesAsXML ()

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.

public abstract 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

public abstract int getSortBy ()

Returns the current sorting field. Possible values are listed in the Enumeration interface of EnumWebMessageSortByField The default value is WebMessageSortByCreationTime.

Returns

public abstract 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

public abstract boolean isSavedInInbox (String strMsgID)

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.

public abstract 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.

public abstract void removeInboxMessage (String messageID)

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.

public abstract void removeInboxMessages (String[] messages)

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.

public abstract void rename (String messageID, String newName)

public abstract void saveToInbox (String strMsgID, int newStateID)

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.

public abstract void saveToInbox (String strMsgID)

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.

public abstract void setDeleteFlags (int flags)

public abstract void setInboxFlags (int newValue)

Defines the inbox flags which are a set of flags describing what information to retrieve when returning the inbox. The flags are specified as a bit-wise OR of the EnumDSSXMLInboxFlags enumeration. The default is DssXmlInboxBrowsingInfo.

Parameters
newValue Bit-Wise OR of the EnumDSSXMLInboxFlags enumeration.

public abstract 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

public abstract void setSortAsc (boolean ascending)

Sets the sorting order.

Parameters
ascending true if the sorting order is ascending.

public abstract 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.

public abstract void setStatus ()

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.