WebDocumentMessage

Class Overview

The WebDocumentMessage object is a WebMessage that corresponds to a document. It represents the attributes of a user inbox message for a document. Unlike Report Message, a Document Message contains child messages each of which correspond to a WebReportMessage.

Summary

[Expand] Inherited Methods
From interface com.microstrategy.utils.KeyedObject abstract Object _getObKey()
From interface com.microstrategy.web.objects.WebDisplayUnit abstract void addDetails(boolean details) This method will add or remove details from the display unit. abstract void applyVisitor(DisplayUnitsVisitor visitor, boolean deep) abstract boolean canHighlight() abstract WebDisplayUnits getChildUnits() Returns the collection of child display units, or null if the object is not a collection. abstract String getDisplayName() Returns the display name associated with this object. abstract int getDisplayUnitType() Returns the type of display unit that this object represents. abstract String getID() Returns the DSS ID of the display unit. abstract boolean hasDetails() Returns whether this display unit currently has details enabled. abstract void highlightUnit() Sets this display unit to be highlighted. abstract void highlightUnit(boolean details) Sets this display unit to be highlighted. abstract boolean isHighlighted() Returns whether this unit is highlighted. abstract boolean isObjectInfo() Returns true if underlying Web Object can be cast to WebObjectInfo. abstract boolean isSelected() Returns whether this display unit is selected. abstract void setDisplayName(String displayName) This method will set the value of the display name. abstract void setSelected(boolean selected) Sets the current unit's selection status.
From interface com.microstrategy.web.objects.WebMessage 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.