Package com.microstrategy.web.objects
Interface WebDocumentInstance
-
- All Superinterfaces:
EnumWebPersistableState
,Persistable
,WebResultSetInstance
public interface WebDocumentInstance extends WebResultSetInstance
The WebDocumentInstance interface represents an instance of a document. A document instance is identified by its message ID. This interface can be used to retrieve the results of a document and to access its inbox records. A WebDocumentInstance can only be obtained from theWebDocumentSource
interface.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Field Summary
-
Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState
BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description WebDocReportInstances
getDocReportInstances()
Returns aWebDocReportInstances
object through will the reports within this document can be accessed.WebDocumentMessage
getMessage()
Returns aWebDocumentMessage
object for the current document.WebDocumentMessage
getMessage(boolean populate)
Returns aWebDocumentMessage
object for the current document.byte[]
getPDFData()
Returns the PDF Data.java.lang.String
getResults()
Attempts to obtain the document results from the Intelligence Server, and return those results.int
getViewMode()
Returns the view mode.void
setViewMode(int viewMode)
Sets the view mode.-
Methods inherited from interface com.microstrategy.utils.serialization.Persistable
restoreState, restoreState, saveState, saveState, saveState, saveState
-
Methods inherited from interface com.microstrategy.web.objects.WebResultSetInstance
CancelReprompt, createNewSchedule, createNewSubscription, getCacheID, getCacheLastUpdate, getCacheType, getIconPath, getIsPVPartialExecution, getMaxWait, getMessageID, getPollingFrequency, getPrompts, getPrompts, getStateID, getStatus, getViewMediaSettings, isAsync, isModified, isPrompted, isPromptStatus, isPromptStatus, isReprompted, isResolved, isResultOrPromptStatus, isResultStatus, isResultStatus, pollStatus, pollStatusOnly, schedule, schedule, setAsync, setIconPath, setIsPVPartialExecution, setMaxWait, setPollingFrequency
-
-
-
-
Method Detail
-
getResults
java.lang.String getResults() throws WebObjectsException
Attempts to obtain the document results from the Intelligence Server, and return those results.- Returns:
- The document Execution Results String.
- Throws:
WebObjectsException
- Thrown if the method has difficulty in contacting the Intelligence Server.
-
getDocReportInstances
WebDocReportInstances getDocReportInstances() throws WebObjectsException, java.lang.IllegalArgumentException
Returns aWebDocReportInstances
object through will the reports within this document can be accessed.- Returns:
WebDocReportInstances
object that contains the reports.- Throws:
WebObjectsException
- if any error was encountered while retrieving the inbox XML. IllegalArgumentException if the inbox XML retrieved could not be parsed.java.lang.IllegalArgumentException
-
getMessage
WebDocumentMessage getMessage() throws WebObjectsException
Returns aWebDocumentMessage
object for the current document. No attempt is made to ensure that the document message returned is populated. Thus, unless the document message was already existing and populated, this call returns an unpopulated document message object.- Returns:
WebDocumentMessage
for the current document.- Throws:
WebObjectsException
- indicates an inability to obtain the message information from the Intelligence Server.
-
getMessage
WebDocumentMessage getMessage(boolean populate) throws WebObjectsException
Returns aWebDocumentMessage
object for the current document. If populate is true, it is ensured that theWebDocumentMessage
object is populated from Intelligence Server.- Returns:
WebDocumentMessage
for the current document.- Throws:
WebObjectsException
- indicates an inability to obtain the message information from the Intelligence Server.
-
getPDFData
byte[] getPDFData() throws WebObjectsException
Returns the PDF Data.- Returns:
- byte[] the pdf PDF
- Throws:
WebObjectsException
- if an error was encountered on IServer.- Since:
- MicroStrategy Web 7.5.0
-
setViewMode
void setViewMode(int viewMode)
Sets the view mode. View mode should be a value fromEnumWebDocumentViewMode
- Parameters:
viewMode
- the desired view mode.- Since:
- MicroStrategy Web 7.5.4
-
getViewMode
int getViewMode()
Returns the view mode. Possbile View mode values are listed inEnumWebDocumentViewMode
- Returns:
- int the view mode.
- Since:
- MicroStrategy Web 7.5.4
-
-