All Superinterfaces:

KeyedObject, WebDisplayUnit

All Known Subinterfaces:

RWMessage, WebDocumentMessage, WebReportMessage
```
public interface WebMessage
extends WebDisplayUnit
```
The WebMessage object exposes the attributes of an user inbox message. 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 allow the ability to retrieve the different attributes of messages.

Since:

MicroStrategy Web 7.3.1 or earlier

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`WebMessage`	`duplicate()`	Duplicates the current message.
`WebMessage`	`duplicate(boolean bPopulate)`	Duplicates the current message.
`WebMessage`	`duplicate(boolean bPopulate, int mode)`	Duplicates the current message.
`java.lang.String`	`getCacheID()`	Returns the ID of the cache, if a cache is created for the request result.
`int`	`getClientType()`	Returns the type of client from where the request was submitted.
`java.lang.String`	`getCreationTime()`	Returns the creation time of this message, if that information is available.
`java.lang.String`	`getDeltaPropertiesXML()`	Returns the deltas applied to this message as XML.
`java.lang.String`	`getDisplayName()`	Returns the display name associated with this object.
`java.lang.String`	`getDisplayName(boolean useTitleIfEmpty)`
`int`	`getExecutionFlags()`	Returns the execution flags for the message in the inbox,
`java.lang.String`	`getFolderID()`	Returns the ID of the folder that contains the object (report or document).
`java.lang.String`	`getFolderName()`	Returns the name of the folder that contains the object (report or document).
`java.lang.String`	`getID()`	Returns the ID of a message in the inbox, it is of type GUID.
`java.lang.String`	`getLastErrorNumber()`	Returns the last error number.
`java.lang.String`	`getMessageText()`	Returns the text of a message in the inbox, if that information is available.
`java.lang.String`	`getModificationTime()`	Returns the modification time of this message, if that information is available.
`java.lang.String`	`getObjectCreator()`	Returns the name of the user who created the object (report or document).
`java.lang.String`	`getObjectDescription()`	Returns the description of the object (report or document).
`java.lang.String`	`getObjectID()`	Returns the ID of the object (report or document), it is of type GUID.
`java.lang.String`	`getOriginalMessageID()`	If this is a duplicated message, this returns the message ID of the source from which this was duplicated from.
`java.lang.String`	`getParentID()`	Returns the message ID of its parent message.
`java.lang.String`	`getProjectID()`	Returns the ID of the project (project_guid pgd).
`java.lang.String`	`getProjectName()`	Returns the name of the project.
`java.lang.String`	`getReferenceID()`	Returns the XML reference ID for the object (refid) in the msidocument's information section.
`java.lang.String`	`getReportManipulationsXML()`	Returns the report manipulations applied to this message as XML.
`java.lang.String`	`getRequestFinishTime()`	Returns the time that the request execution was finished.
`java.lang.String`	`getRequestStartTime()`	Returns the time that the request execution was started/to be started (for scheduled request).
`int`	`getRequestStatus()`	Returns the execution status of the request.
`int`	`getRequestType()`	Returns the type of request.
`int`	`getResultFlags()`	Returns the flags indicating the options of a report results.
`WebResultWindow`	`getResultWindow()`	Returns the result window of the message in the inbox.
`java.lang.String`	`getScheduleReferenceID()`	Returns the reference ID of the schedule object in the msidocument's information section.
`java.lang.String`	`getScheduleTriggerID()`	Returns the DSS ID of the Schedule Trigger for the object (report or document), it is of type GUID.
`int`	`getSequenceNumber()`	Returns the sequential number of this message (for message sorting purpose).
`int`	`getServerStateID()`	Returns the latest ID of the state that is on the Intelligence Server with the messageID of this instance
`int`	`getStateID()`	Returns the attribute of view properties to indicate a state where the manipulation is going to apply on.
`int`	`getStatus()`	Returns the status of the inbox message.
`WebSubscription`	`getSubscription()`	Returns the link to the `WebSubscription` that created the message in the inbox.
`java.lang.String`	`getTitle()`	Returns the title of a message in the inbox, if that information is available.
`int`	`getType()`	Returns the message type.
`WebViewMediaSettings`	`getViewMediaSettings()`	Returns the `WebViewMediaSettings` of the report or document instance that is contained by the message.
`int`	`getVisualizationViewMode()`
`boolean`	`isArchivedMessage()`	Specifies whether this message is archived in the Inbox.
`boolean`	`isPopulated()`	Specifies whether or not this message is currently populated.
`boolean`	`isSavedInInbox()`	Specifies whether or not this message is currently saved.
`void`	`populate()`	Populate the different attribute for this message.
`void`	`refresh()`	Refreshes the content of this message.
`void`	`removeFromInbox()`	Removes the current message from the inbox.
`void`	`saveToInbox()`	Saves the message to the inbox.
`void`	`setStatus(int newStatus)`	Sets the status for the current message.

Methods inherited from interface com.microstrategy.utils.KeyedObject
_getObKey

Methods inherited from interface com.microstrategy.web.objects.WebDisplayUnit
addDetails, applyVisitor, canHighlight, getChildUnits, getDisplayUnitType, hasDetails, highlightUnit, highlightUnit, isHighlighted, isObjectInfo, isSelected, setDisplayName, setSelected

- Method Detail
  - getID
```
java.lang.String getID()
```
    Returns the ID of a message in the inbox, it is of type GUID.
    
    Specified by:
    
    getID in interface WebDisplayUnit
    
    Returns:
    
    the ID of a message in the inbox, it is of type GUID.
  - getTitle
```
java.lang.String getTitle()
```
    Returns the title of a message in the inbox, if that information is available. Typically it is the object (report or document) name, or a short description for general inbox message
    
    Returns:
    
    the title of a message in the inbox.
  - getStateID
```
int getStateID()
```
    Returns the attribute of view properties to indicate a state where the manipulation is going to apply on.
    
    Returns:
    
    the attribute of view properties to indicate a state where the manipulation is going to apply on.
  - getServerStateID
```
int getServerStateID()
```
    Returns the latest ID of the state that is on the Intelligence Server with the messageID of this instance
    
    Returns:
    
    the latest ID of the state that is on the Intelligence Server
  - getType
```
int getType()
```
    Returns the message type. This value is from EnumDSSXMLMessageTypes.
    
    Returns:
    
    The type of the message, from EnumDSSXMLMessageTypes.
  - getCreationTime
```
java.lang.String getCreationTime()
```
    Returns the creation time of this message, if that information is available.
    
    Returns:
    
    A string representing the creation time of this message.
  - getModificationTime
```
java.lang.String getModificationTime()
```
    Returns the modification time of this message, if that information is available.
    
    Returns:
    
    A string representing the modification time of this message.
  - getStatus
```
int getStatus()
```
    Returns the status of the inbox message. This value is from EnumDSSXMLMessageStatus.
    
    Returns:
    
    The status of the message, whether it is a read message, unread message or deleted message, etc.. The value is from EnumDSSXMLMessageStatus.
  - getSequenceNumber
```
int getSequenceNumber()
```
    Returns the sequential number of this message (for message sorting purpose).
    
    Returns:
    
    The sequential number of this message.
  - getParentID
```
java.lang.String getParentID()
```
    Returns the message ID of its parent message. This is only meaningful to a child report message. For other types of messages, its value is -1.
    
    Returns:
    
    the message ID of its parent message.
  - getClientType
```
int getClientType()
```
    Returns the type of client from where the request was submitted. This value is from EnumDSSXMLClientTypes.
    
    Returns:
    
    The type of client from where the request was submitted, from EnumDSSXMLClientTypes.
  - getRequestType
```
int getRequestType()
```
    Returns the type of request. This value is from EnumDSSXMLRequestTypes.
    
    Returns:
    
    The type of request, from EnumDSSXMLRequestTypes.
  - getRequestStatus
```
int getRequestStatus()
```
    Returns the execution status of the request. This value is from EnumDSSXMLStatus.
    
    Returns:
    
    The execution status of request, from EnumDSSXMLStatus.
  - getRequestStartTime
```
java.lang.String getRequestStartTime()
```
    Returns the time that the request execution was started/to be started (for scheduled request).
    
    Returns:
    
    A string representing the time that the request execution was started/to be started (for scheduled request).
  - getRequestFinishTime
```
java.lang.String getRequestFinishTime()
```
    Returns the time that the request execution was finished.
    
    Returns:
    
    A string representing the time that the request execution was finished.
  - getObjectID
```
java.lang.String getObjectID()
```
    Returns the ID of the object (report or document), it is of type GUID.
    
    Returns:
    
    The ID of the object (report or document), it is of type GUID.
  - getObjectDescription
```
java.lang.String getObjectDescription()
```
    Returns the description of the object (report or document).
    
    Returns:
    
    The description of the object (report or document).
  - getObjectCreator
```
java.lang.String getObjectCreator()
```
    Returns the name of the user who created the object (report or document).
    
    Returns:
    
    The name of the user who created the object (report or document).
  - getFolderID
```
java.lang.String getFolderID()
```
    Returns the ID of the folder that contains the object (report or document).
    
    Returns:
    
    The ID of the folder that contains the object (report or document).
  - getFolderName
```
java.lang.String getFolderName()
```
    Returns the name of the folder that contains the object (report or document).
    
    Returns:
    
    The name of the folder that contains the object (report or document).
  - getProjectID
```
java.lang.String getProjectID()
```
    Returns the ID of the project (project_guid pgd).
    
    Returns:
    
    The ID of the project.
  - getProjectName
```
java.lang.String getProjectName()
```
    Returns the name of the project.
    
    Returns:
    
    The name of the project.
  - getResultFlags
```
int getResultFlags()
```
    Returns the flags indicating the options of a report results. This value is from EnumDSSXMLResultFlags.
    
    Returns:
    
    The flags indicating the options of a report results, from EnumDSSXMLResultFlags.
  - getReferenceID
```
java.lang.String getReferenceID()
```
    Returns the XML reference ID for the object (refid) in the msidocument's information section.
    
    Returns:
    
    The XML reference ID for the object (refid) in the msidocument's information section.
  - getLastErrorNumber
```
java.lang.String getLastErrorNumber()
```
    Returns the last error number.
    
    Returns:
    
    The last error number.
  - getCacheID
```
java.lang.String getCacheID()
```
    Returns the ID of the cache, if a cache is created for the request result.
    
    Returns:
    
    The ID of the cache, if a cache is created for the request result.
  - getScheduleReferenceID
```
java.lang.String getScheduleReferenceID()
```
    Returns the reference ID of the schedule object in the msidocument's information section.
    
    Returns:
    
    The reference ID of the schedule object in the msidocument's information section.
  - getScheduleTriggerID
```
java.lang.String getScheduleTriggerID()
```
    Returns the DSS ID of the Schedule Trigger for the object (report or document), it is of type GUID.
    
    Returns:
    
    The DSS ID of the Schedule Trigger for the object (report or document), it is of type GUID.
  - getDeltaPropertiesXML
```
java.lang.String getDeltaPropertiesXML()
```
    Returns the deltas applied to this message as XML. See the MSTR definition of XML node .
    
    Returns:
    
    The deltas applied to this message as XML.
  - getReportManipulationsXML
```
java.lang.String getReportManipulationsXML()
```
    Returns the report manipulations applied to this message as XML. See the MSTR definition of XML node .
    
    Returns:
    
    The report manipulations applied to this message as XML.
  - getMessageText
```
java.lang.String getMessageText()
```
    Returns the text of a message in the inbox, if that information is available. Typically it contains the error message for reports/documents that have errors in execution
    
    Returns:
    
    the text of a message in the inbox.
  - getExecutionFlags
```
int getExecutionFlags()
```
    Returns the execution flags for the message in the inbox,
    
    Returns:
    
    the execution flags for the message.
    
    Since:
    
    MicroStrategy Web 8.0.1
  - getResultWindow
```
WebResultWindow getResultWindow()
```
    Returns the result window of the message in the inbox.
    
    Returns:
  - duplicate
```
WebMessage duplicate()
              throws WebObjectsException
```
    Duplicates the current message. The new message is returned. This invokes duplicate(boolean, int) with bPopulated to false, and mode to EnumDSSXMLMessageDuplicationMode.DSSXMLMessageDuplicateModeDerived.
    
    Returns:
    
    The WebMessage object representing the new message ID.
    
    Throws:
    
    WebObjectsException - Thrown if an error occurs in the XML creation.
  - duplicate
```
WebMessage duplicate(boolean bPopulate,
                     int mode)
              throws WebObjectsException
```
    Duplicates the current message. The new message is returned. The contents of the new message are not populated.
    
    Parameters:
    
    bPopulate - If bPopulate is true then the new message is populated.
    
    mode - Mode value from EnumDSSXMLMessageDuplicationMode.
    
    Returns:
    
    The WebMessage object representing the new message ID.
    
    Throws:
    
    WebObjectsException - Thrown if an error occurs in the XML creation.
    
    Since:
    
    MicroStrategy Web 8.0.2
  - duplicate
```
WebMessage duplicate(boolean bPopulate)
              throws WebObjectsException
```
    Duplicates the current message. The new message is returned.
    
    Parameters:
    
    bPopulate - If bPopulate is true then the new message is populated
    
    Returns:
    
    The WebMessage object representing the new message ID.
    
    Throws:
    
    WebObjectsException - Thrown if an error occurs in the XML creation.
  - removeFromInbox
```
void removeFromInbox()
              throws WebObjectsException
```
    Removes the current message from the inbox. The message may be specified through the message ID property. If the message ID represents a report instance that is currently executing, then the execution is cancelled.
    
    Throws:
    
    WebObjectsException - Thrown if an error occurs in the XML creation.
  - saveToInbox
```
void saveToInbox()
          throws WebObjectsException
```
    Saves the message to the inbox.
    
    Throws:
    
    WebObjectsException - Thrown if an error occurs in the XML creation.
  - setStatus
```
void setStatus(int newStatus)
        throws WebObjectsException
```
    Sets the status for the current message.
    
    Parameters:
    
    newStatus - The new status to apply to this message.
    
    Throws:
    
    WebObjectsException - Thrown if an error occurs in the XML creation.
  - isSavedInInbox
```
boolean isSavedInInbox()
                throws WebObjectsException
```
    Specifies whether or not this message is currently saved.
    
    Returns:
    
    True if the message is currently saved in the inbox.
    
    Throws:
    
    WebObjectsException - Thrown if an error occurs in the XML creation.
  - isArchivedMessage
```
boolean isArchivedMessage()
                   throws WebObjectsException
```
    Specifies whether this message is archived in the Inbox. For such a message only the snapshot of the last state of the report is saved in the Inbox and certain report manipulations are not possible on retrieving the report from Inbox.
    
    Returns:
    
    True if the message is archived in the Inbox.
    
    Throws:
    
    WebObjectsException - Thrown if an error occurs in the XML creation.
  - isPopulated
```
boolean isPopulated()
```
    Specifies whether or not this message is currently populated.
    
    Returns:
    
    True if the message is currently populated.
  - populate
```
void populate()
       throws WebObjectsException
```
    Populate the different attribute for this message.
    
    Throws:
    
    WebObjectsException - Thrown if an error occurs in the XML creation.
  - refresh
```
void refresh()
      throws WebObjectsException
```
    Refreshes the content of this message. This can be used to get new information about the message.
    
    Throws:
    
    WebObjectsException - Thrown if an error occurs in the XML creation.
  - getVisualizationViewMode
```
int getVisualizationViewMode()
```
    Since:
    
    MicroStrategy Web 8.0.2
  - getViewMediaSettings
```
WebViewMediaSettings getViewMediaSettings()
```
    Returns the WebViewMediaSettings of the report or document instance that is contained by the message.
    
    Since:
    
    MicroStrategy Web 9.0.0
  - getSubscription
```
WebSubscription getSubscription()
```
    Returns the link to the WebSubscription that created the message in the inbox.
    
    Since:
    
    MicroStrategy Web 9.0.0
  - getDisplayName
```
java.lang.String getDisplayName()
```
    Description copied from interface: WebDisplayUnit
    
    Returns the display name associated with this object. If this was not set by the user or found in the object XML, then this will be equivalent to the name property of the underlying object.
    
    Specified by:
    
    getDisplayName in interface WebDisplayUnit
    
    Returns:
    
    The display name associated with the display unit object.
    
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    WebDisplayUnit.setDisplayName(java.lang.String), WebObjectInfo.getName()
  - getDisplayName
```
java.lang.String getDisplayName(boolean useTitleIfEmpty)
```
    Parameters:
    
    useTitleIfEmpty - flag to indicate whether to return getTitle() if underlying display name is empty
    
    Returns:
    
    resolved display name
    
    Since:
    
    MicroStrategy Web 9.0.0
  - getOriginalMessageID
```
java.lang.String getOriginalMessageID()
```
    If this is a duplicated message, this returns the message ID of the source from which this was duplicated from. Returns null otherwise.

Interface WebMessage

Method Summary

Methods inherited from interface com.microstrategy.utils.KeyedObject

Methods inherited from interface com.microstrategy.web.objects.WebDisplayUnit

Method Detail

getID

getTitle

getStateID

getServerStateID

getType

getCreationTime

getModificationTime

getStatus

getSequenceNumber

getParentID

getClientType

getRequestType

getRequestStatus

getRequestStartTime

getRequestFinishTime

getObjectID

getObjectDescription

getObjectCreator

getFolderID

getFolderName

getProjectID

getProjectName

getResultFlags

getReferenceID

getLastErrorNumber

getCacheID

getScheduleReferenceID

getScheduleTriggerID

getDeltaPropertiesXML

getReportManipulationsXML

getMessageText

getExecutionFlags

getResultWindow

duplicate

duplicate

duplicate

removeFromInbox

saveToInbox

setStatus

isSavedInInbox

isArchivedMessage

isPopulated

populate

refresh

getVisualizationViewMode

getViewMediaSettings

getSubscription

getDisplayName

getDisplayName

getOriginalMessageID