public interface

WebMessage

implements WebDisplayUnit
com.microstrategy.web.objects.WebMessage
Known Indirect Subclasses

Class Overview

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.

Summary

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

Public Methods

public abstract WebMessage duplicate (boolean bPopulate)

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.

public abstract WebMessage duplicate ()

Duplicates the current message. The new message is returned. This invokes duplicate(boolean, int) with bPopulated to false, and mode to DSSXMLMessageDuplicateModeDerived.

Returns
  • The WebMessage object representing the new message ID.
Throws
WebObjectsException Thrown if an error occurs in the XML creation.

public abstract WebMessage duplicate (boolean bPopulate, int mode)

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.

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

public abstract int getClientType ()

Returns the type of client from where the request was submitted. This value is from EnumDSSXMLClientTypes.

Returns

public abstract String getCreationTime ()

Returns the creation time of this message, if that information is available.

Returns
  • A string representing the creation time of this message.

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

public abstract String getDisplayName (boolean useTitleIfEmpty)

Parameters
useTitleIfEmpty flag to indicate whether to return getTitle() if underlying display name is empty
Returns
  • resolved display name

public abstract String getDisplayName ()

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.

Returns
  • The display name associated with the display unit object.

public abstract int getExecutionFlags ()

Returns the execution flags for the message in the inbox,

Returns
  • the execution flags for the message.

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

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

public abstract String getID ()

Returns the ID of a message in the inbox, it is of type GUID.

Returns
  • the ID of a message in the inbox, it is of type GUID.

public abstract String getLastErrorNumber ()

Returns the last error number.

Returns
  • The last error number.

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

public abstract String getModificationTime ()

Returns the modification time of this message, if that information is available.

Returns
  • A string representing the modification time of this message.

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

public abstract String getObjectDescription ()

Returns the description of the object (report or document).

Returns
  • The description of the object (report or document).

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

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

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

public abstract String getProjectID ()

Returns the ID of the project (project_guid pgd).

Returns
  • The ID of the project.

public abstract String getProjectName ()

Returns the name of the project.

Returns
  • The name of the project.

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

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

public abstract String getRequestFinishTime ()

Returns the time that the request execution was finished.

Returns
  • A string representing the time that the request execution was finished.

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

public abstract int getRequestStatus ()

Returns the execution status of the request. This value is from EnumDSSXMLStatus.

Returns

public abstract int getRequestType ()

Returns the type of request. This value is from EnumDSSXMLRequestTypes.

Returns
  • The type of request, from EnumDSSXMLRequestTypes.

public abstract int getResultFlags ()

Returns the flags indicating the options of a report results. This value is from EnumDSSXMLResultFlags.

Returns

public abstract WebResultWindow getResultWindow ()

Returns the result window of the message in the inbox.

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

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

public abstract int getSequenceNumber ()

Returns the sequential number of this message (for message sorting purpose).

Returns
  • The sequential number of this message.

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

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

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

public abstract WebSubscription getSubscription ()

Returns the link to the WebSubscription that created the message in the inbox.

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

public abstract int getType ()

Returns the message type. This value is from EnumDSSXMLMessageTypes.

Returns

public abstract WebViewMediaSettings getViewMediaSettings ()

Returns the WebViewMediaSettings of the report or document instance that is contained by the message.

public abstract int getVisualizationViewMode ()

public abstract boolean isArchivedMessage ()

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.

public abstract boolean isPopulated ()

Specifies whether or not this message is currently populated.

Returns
  • True if the message is currently populated.

public abstract boolean isSavedInInbox ()

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.

public abstract void populate ()

Populate the different attribute for this message.

Throws
WebObjectsException Thrown if an error occurs in the XML creation.

public abstract void refresh ()

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.

public abstract void removeFromInbox ()

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.

public abstract void saveToInbox ()

Saves the message to the inbox.

Throws
WebObjectsException Thrown if an error occurs in the XML creation.

public abstract void setStatus (int newStatus)

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.