public interface

WebDocumentInstance

implements WebResultSetInstance
com.microstrategy.web.objects.WebDocumentInstance

Class Overview

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 the WebDocumentSource interface.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
Public Methods
abstract WebDocReportInstances getDocReportInstances()
Returns a WebDocReportInstances object through will the reports within this document can be accessed.
abstract WebDocumentMessage getMessage(boolean populate)
Returns a WebDocumentMessage object for the current document.
abstract WebDocumentMessage getMessage()
Returns a WebDocumentMessage object for the current document.
abstract byte[] getPDFData()
Returns the PDF Data.
abstract String getResults()
Attempts to obtain the document results from the Intelligence Server, and return those results.
abstract int getViewMode()
Returns the view mode.
abstract void setViewMode(int viewMode)
Sets the view mode.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.objects.WebResultSetInstance

Public Methods

public abstract WebDocReportInstances getDocReportInstances ()

Returns a WebDocReportInstances object through will the reports within this document can be accessed.

Returns
Throws
WebObjectsException if any error was encountered while retrieving the inbox XML. IllegalArgumentException if the inbox XML retrieved could not be parsed.
IllegalArgumentException

public abstract WebDocumentMessage getMessage (boolean populate)

Returns a WebDocumentMessage object for the current document. If populate is true, it is ensured that the WebDocumentMessage object is populated from Intelligence Server.

Returns
Throws
WebObjectsException indicates an inability to obtain the message information from the Intelligence Server.

public abstract WebDocumentMessage getMessage ()

Returns a WebDocumentMessage 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
Throws
WebObjectsException indicates an inability to obtain the message information from the Intelligence Server.

public abstract byte[] getPDFData ()

Returns the PDF Data.

Returns
  • byte[] the pdf PDF
Throws
WebObjectsException if an error was encountered on IServer.

public abstract String getResults ()

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.

public abstract int getViewMode ()

Returns the view mode. Possbile View mode values are listed in EnumWebDocumentViewMode

Returns
  • int the view mode.

public abstract void setViewMode (int viewMode)

Sets the view mode. View mode should be a value from EnumWebDocumentViewMode

Parameters
viewMode the desired view mode.