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 Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
duplicateMessage(java.lang.String messageID)
Duplicates a message.java.lang.String
duplicateMessage(java.lang.String messageID, int mode)
Duplicates a Message ID in the Inbox.java.lang.String
duplicateMessage(java.lang.String messageID, java.lang.String displayName, int mode)
Duplicates a message.int
getDeleteFlags()
Default value isEnumDSSXMLInboxDeleteFlags.DssXmlInboxDeleteKeepInWorkingSet
.int
getInboxFlags()
Returns the current inbox flags.WebMessages
getInboxMessages()
Returns a collection objectWebMessages
containing the current inbox messages.java.lang.String
getInboxMessagesAsXML()
Returns the current inbox messages.WebMessageStatusList
getMessageStatusList()
Returns a collection objectWebMessageStatusList
containing a list of message IDs and their status.int
getSortBy()
Returns the current sorting field.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 saveboolean
isSavedInInbox(java.lang.String strMsgID)
Specifies whether or not this message is currently saved.boolean
isSortAsc()
Returns a boolean value indicating the current sorting order.void
removeInboxMessage(java.lang.String messageID)
Removes the specified inbox message.void
removeInboxMessages(java.lang.String[] messages)
Removes the specified inbox messages.void
rename(java.lang.String messageID, java.lang.String newName)
void
saveToInbox(java.lang.String strMsgID)
Saves the message to the inbox.void
saveToInbox(java.lang.String strMsgID, int newStateID)
Saves the message to the inbox.void
setDeleteFlags(int flags)
void
setInboxFlags(int newValue)
Defines the inbox flags which are a set of flags describing what information to retrieve when returning the inbox.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 falsevoid
setSortAsc(boolean ascending)
Sets the sorting order.void
setSortBy(int newSortField)
Specifies the sort field that should be used to sort theWebMessages
collection returned.void
setStatus()
Sets the status of the inbox messages for the list of messages specified in the WebMessageStatusList.
-
-
-
Method Detail
-
getInboxFlags
int getInboxFlags()
Returns the current inbox flags. Flags are specified as a bit-wise OR of theEnumDSSXMLInboxFlags
enumeration.The default value of the flags property is
EnumDSSXMLInboxFlags.DssXmlInboxBrowsingInfo
.- Returns:
- An bit-wise OR of the
EnumDSSXMLInboxFlags
enumeration.
-
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.
-
getInboxMessages
WebMessages getInboxMessages() throws WebObjectsException
Returns a collection objectWebMessages
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 theWebMessages
returned can only haveWebMessage
objects in it.
-
getMessageStatusList
WebMessageStatusList getMessageStatusList()
Returns a collection objectWebMessageStatusList
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.
-
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.
-
setInboxFlags
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 theEnumDSSXMLInboxFlags
enumeration. The default isEnumDSSXMLInboxFlags.DssXmlInboxBrowsingInfo
.- Parameters:
newValue
- Bit-Wise OR of theEnumDSSXMLInboxFlags
enumeration.
-
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.
-
getSortBy
int getSortBy()
Returns the current sorting field. Possible values are listed in the Enumeration interface ofEnumWebMessageSortByField
The default value isEnumWebMessageSortByField.WebMessageSortByCreationTime
.- Returns:
- the current sorting type of
EnumWebMessageSortByField
.
-
setSortBy
void setSortBy(int newSortField)
Specifies the sort field that should be used to sort theWebMessages
collection returned. Possible values are listed under the Enumeration interfaceEnumWebMessageSortByField
.- Parameters:
newSortField
- the specified sorting filed ofEnumWebMessageSortByField
.
-
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) throws WebObjectsException
Duplicates a message. This is equivalent to invokingduplicateMessage(String, int)
with mode toEnumDSSXMLMessageDuplicationMode.DSSXMLMessageDuplicateModeDerived
.- Parameters:
messageID
- The message ID to duplicate.- Returns:
- The new message ID.
- Throws:
WebObjectsException
- Since:
- MicroStrategy Web 7.5.0
-
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 fromEnumDSSXMLMessageDuplicationMode
.- 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
- fromEnumDSSXMLMessageDuplicationMode
- 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
-
rename
void rename(java.lang.String messageID, java.lang.String newName) throws WebObjectsException
- Throws:
WebObjectsException
- Since:
- MicroStrategy Web 9.0.0
-
setDeleteFlags
void setDeleteFlags(int flags)
- See Also:
EnumDSSXMLInboxDeleteFlags
-
getDeleteFlags
int getDeleteFlags()
Default value isEnumDSSXMLInboxDeleteFlags.DssXmlInboxDeleteKeepInWorkingSet
.- See Also:
EnumDSSXMLInboxDeleteFlags
-
-