Package com.microstrategy.web.objects
Interface WebDocumentMessage
-
- All Superinterfaces:
KeyedObject
,WebDisplayUnit
,WebMessage
public interface WebDocumentMessage extends WebMessage
The WebDocumentMessage object is aWebMessage
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 aWebReportMessage
.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description WebMessages
getChildMessages()
Returns the collection of child messages for this document message.WebDocumentInstance
getDocumentInstance()
Returns the document instance corresponding to this document 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
-
Methods inherited from interface com.microstrategy.web.objects.WebMessage
duplicate, duplicate, duplicate, getCacheID, getClientType, getCreationTime, getDeltaPropertiesXML, getDisplayName, getDisplayName, getExecutionFlags, getFolderID, getFolderName, getID, getLastErrorNumber, getMessageText, getModificationTime, getObjectCreator, getObjectDescription, getObjectID, getOriginalMessageID, getParentID, getProjectID, getProjectName, getReferenceID, getReportManipulationsXML, getRequestFinishTime, getRequestStartTime, getRequestStatus, getRequestType, getResultFlags, getResultWindow, getScheduleReferenceID, getScheduleTriggerID, getSequenceNumber, getServerStateID, getStateID, getStatus, getSubscription, getTitle, getType, getViewMediaSettings, getVisualizationViewMode, isArchivedMessage, isPopulated, isSavedInInbox, populate, refresh, removeFromInbox, saveToInbox, setStatus
-
-
-
-
Method Detail
-
getDocumentInstance
WebDocumentInstance getDocumentInstance() throws WebObjectsException
Returns the document instance corresponding to this document message.- Returns:
- the
WebDocumentInstance
corresponding to this document message. - Throws:
WebObjectsException
-
getChildMessages
WebMessages getChildMessages() throws WebObjectsException
Returns the collection of child messages for this document message.- Returns:
- The child
WebMessages
for this document message. - Throws:
WebObjectsException
- if there is any error retrieving child messages from IServer.
-
-