Summary: Constants | Inherited Constants | Methods | Inherited Methods | [Expand All]

public interface

DocumentBean

implements ResultSetBean

com.microstrategy.web.beans.DocumentBean

Class Overview

This interface is used to manage the collection of document data and enable it to be rendered. It leverages many of the features of the WebBean and ObjectBean interfaces. It reuses the ObjectBean interface to allow a document to: (a) be retrieved by name (and with wildcard) (b) retrieve its parent folder bean.

The main methods it provides in this interface are:

Document execution settings: Users can set the message ID, state ID and synchronous nature of the request. Users can also have the document directly saved in the Inbox and control whether server-side caches are used and updated or not used at all.
In-memory HTML caching: If the application builder wants to hold a Document Bean in the user's session or the application context, it may do so as a way of caching the results. If done in this manner, the document data need not be transformed with every request to transform, but only when the document is retrieved from the Intelligence Server. In this way, the Document Bean may be instructed on when to release its XML and re-execute the document. This is done using a simple expiration time period, in hours.
Access the underlying reports of the document

Summary

Constants
int	GRAPH_REPORTS	Identifies those underlying reports whose view mode is set to Graph
int	GRID_REPORTS	Identifies those underlying reports whose view mode is set to Grid

[Expand]

Inherited Constants

From interface com.microstrategy.utils.serialization.EnumWebPersistableState

Public Methods
abstract boolean	cancelRequest() Cancels the current request.
abstract void	collectData(boolean populateReportInstances) Triggers execution to the back end no matter whether it is synchronous or asynchronous.
abstract int	getCount() Returns the number of reports in the document
abstract int	getCount(int typeOfReports) Returns the number of reports in the document of the type passed.
abstract WebDocumentInstance	getDocumentInstance() Returns the Document Instance set.
abstract int	getExecutionFlags() Returns the execution flag as of `EnumDSSXMLExecutionFlags` when running the `WebDocument` contained in this bean.
abstract ReportBean	getReport(int index, int typeOfReports) Returns the `ReportBean` at the given index among the list of reports of the type passed.
abstract ReportBean	getReport(int index) Returns the `ReportBean` at a given index.
abstract Iterator	getReports() Returns an Iterator that contains the `ReportBean` objects within the document.
abstract Iterator	getReports(int typeOfReports) Returns an Iterator that contains the `ReportBean` objects within the document of the type passed.
abstract String	getResult() Returns the result of a document execution.
abstract int	getViewMode() Returns the view mode.
abstract void	setExecutionFlags(int executionFlags) Sets the execution flags as of `EnumDSSXMLExecutionFlags` to this bean.
abstract void	setViewMode(int viewMode) Sets the view mode (Possible values : `EnumWebDocumentViewMode`)

[Expand]

Inherited Methods

From interface com.microstrategy.utils.serialization.Persistable

From interface com.microstrategy.web.beans.ObjectBean

abstract int	getBlockBegin() Returns the blockBegin property of the embedded `WebObjectSource`.
abstract int	getBlockCount() Returns the blockCount property of the embedded `WebObjectSource`.
abstract String	getDisplayName() Display name of the bean.
abstract int	getFlags() Returns the object flags from the embedded `WebObjectSource`.
abstract int	getLevel() Returns the level property of the embedded `WebObjectSource`.
abstract String	getObjectID() Returns the object's unique ID in the metadata.
abstract WebObjectInfo	getObjectInfo() Returns the the `WebObjectInfo` of the object.
abstract String	getObjectName() Returns the object's exact name in the metadata.
abstract int	getObjectType() Returns the type (`EnumDSSXMLObjectTypes`) of the object.
abstract FolderBean	getParentFolderBean(String name) Returns a `FolderBean` representing the parent folder of the current object.
abstract FolderBean	getParentFolderBean(String name, boolean populate) Returns a `FolderBean` representing the parent folder of the current object.
abstract String	getParentID() Returns the unique ID of the parent of the object.
abstract void	setBlockBegin(int blockBegin) Sets a new blockBegin property to the embedded `WebObjectSource`.
abstract void	setBlockCount(int blockCount) Sets the blockCount property of the embedded `WebObjectSource`.
abstract void	setFlags(int flags) Sets a new object flags on the embedded `WebObjectSource`.
abstract void	setLevel(int level) Sets the level property of the embedded `WebObjectSource`.
abstract void	setObjectID(String objectID) Sets the object's ID.
abstract void	setObjectInfo(WebObjectInfo oi) Sets the WebObjectInfo object that refers to the object.
abstract void	setObjectName(String objectName) Sets the object's name.
abstract void	setObjectType(int objectType) Sets the object' type (`EnumDSSXMLObjectTypes`).

From interface com.microstrategy.web.beans.RequestPersistable

From interface com.microstrategy.web.beans.ResultSetBean

abstract boolean	cancelRequest() Cancels the current request.
abstract int	getExpiration() This method is deprecated. As of WU 8.0.
abstract String	getLastPromptMessageID() Whenever `refresh(boolean)` with the reprompt argument set to true, a duplicate message is made in order to answer all the new prompts, i.e.
abstract int	getMaxWait() Returns the maximum amount of time, in milliseconds.
abstract String	getMessageID() Returns the message ID associated with the result set instance contained in this `ResultSetBean`.
abstract int	getPollingFrequency() Returns the polling frequency, in milliseconds, which will be used when retrieving the results synchronously.
abstract PromptsBean	getPromptsBean() Returns the embedded `PromptsBean`.
abstract WebEventHandler	getPromptsEventHandler() Returns the prompts event handler associated with the `PromptsBean`.
abstract WebResultSetInstance	getResultSetInstance() Returns the result set instance.
abstract boolean	getSaveToInbox() Returns the flag indicating whether to save the result into user's Inbox.
abstract int	getStateID() Returns the current state ID set on the result set instance `ResultSetBean`.
abstract void	initializeFromSchedule(WebSchedule s) This method is deprecated. Starting with version 9.0 and the advent of Distribution Services, all schedule objects are replaced by subscriptions. Hence please use `initializeFromSubscription(WebSubscription)` instead.
abstract void	initializeFromSubscription(WebSubscription s) Initializes the bean using a `WebSubscription` object.
abstract boolean	isPrompted() Returns a boolean value indicating whether the result set instance contains any prompt questions.
abstract boolean	isReady() Indicates whether the result set is in a "ready" state where results can be retrieved.
abstract void	refresh(boolean rePrompt) Refreshes the underlying objects encapsulated by this bean with the option to reopen the prompt.
abstract void	refresh() Refreshes the underlying `WebResultSetInstance`.
abstract void	setDisplayName(String displayName) Set display name of the bean.
abstract void	setExpiration(int hoursExpire) This method is deprecated. As of WU 8.0.
abstract void	setMaxWait(int millis) Sets the maximum amount of time, in milliseconds.
abstract void	setMessageID(String msgID) Sets the message ID to the result set instance contained in this `ResultSetBean`.
abstract void	setPollingFrequency(int millis) Sets the polling frequency, in milliseconds, which will be used when retrieving the results synchronously.
abstract void	setPromptsEventHandler(WebEventHandler promptsEventHandler) Sets the prompt event handler on this bean, which the `ResultSetBean` applies to the embedded `PromptsBean`.
abstract void	setSaveToInbox(boolean saveToInbox) Sets the boolean value indicating whether to save the result into user's Inbox.
abstract void	setStateID(int stateID) Sets a state ID on the result set instance contained in this `ResultSetBean`.

From interface com.microstrategy.web.beans.Transformable

From interface com.microstrategy.web.beans.WebBean

From interface com.microstrategy.web.beans.WebComponent

abstract void	addChild(String key, WebComponent child) adds a child WebComponent instance on the current WebComponent.
abstract void	addChildStateInfo(ParameterBuilder paramBldr, int howMuchState) Adds children state information into an existing `ParameterBuilder` instance.
abstract void	addChildStateInfo(ParameterBuilder paramBldr) Adds children state information into an existing `ParameterBuilder` instance.
abstract void	collectData() Triggers execution to the back end no matter whether it is synchronous or asynchronous.
abstract void	collectMinimalData() This is similar to `collectData()` except data collected is minimal.
abstract MarkupOutput	generateOutput() This is the generic method to ask the WebComponent to generate some output for the client.
abstract BeanContext	getBeanContext() Returns an instance of `BeanContext`.
abstract WebComponent	getChild(int index) Returns the child WebComponent instance specified by the index.
abstract WebComponent	getChild(String key) Returns the child WebComponent instance specified by the key.
abstract WebComponent	getChildByClass(Class className) Returns the child WebComponent instance specified by the class.
abstract WebComponent	getChildByType(int childType) Returns the child WebComponent instance specified by the component type(`EnumWebTransformableType`).
abstract int	getChildCount() Returns the total number of children on the current WebComponent.
abstract void	getChildrenByClass(Class className, HashList retList, boolean recursive) Returns a collection of children specified by the class name
abstract int	getDefaultStateLevel() Returns the default state level for the WebComponent.
abstract WebFeatures	getFeaturesManager() Return the WebFeatures implementation associated with this WebComponent
abstract int	getMaximumStateLevel() Returns the maximum state level that is supported by the WebComponent.
abstract String	getName() Returns the name of the current WebComponent.
abstract int	getOutputFormat() Returns the output format of `EnumBeanOutputFormat` of the current WebComponent.
abstract WebComponent	getParent() Returns the parent WebComponent of the current WebComponent.
abstract String	getPath() Returns the path from the root WebComponent to the current WebComponent.
abstract int	getPersistMode() Returns the persist flag (`EnumBeanPersistMode`) of the current WebComponent.
abstract Set	getRenderingFilter() returns the rendering filter.
abstract WebComponent	getRoot() Returns the root of the current WebComponent.
abstract WebComponent	getTargetBean() Get the target bean associated with this instance
abstract String	getTargetBeanPath()
abstract WebEvent	getWebEvent(int event, boolean recurse) Returns the `WebEvent` instance with the specified event ID.
abstract WebEvent	getWebEvent(int event) Returns the `WebEvent` instance with the specified event ID.
abstract WebEventHandler	getWebEventHandler() Returns the `WebEventHandler` instance associated with the current WebComponent.
abstract int	getXMLStatus() This method returns the `EnumRequestStatus` status of the current Component.
abstract boolean	handleRequest(RequestKeys keys) Handles a request.
abstract boolean	hasChanged() Verifies the state of the component has changed
abstract boolean	hasJustOpened() Verifies if the component has just been opened.
abstract void	initBean() Initialize the component after it's created and its properties initialized
abstract void	invalidateChildrenState() Invalidates the cached URL and hidden INPUT states of all the components, including the current component, along the path to the root component.
abstract boolean	isBeanContextEmpty() Verifies if a bean context exists for the current WebComponent.
abstract boolean	isFeatureAvailable(String featureID) Verifies the feature provided is accesible based on the properties of this WebComponent
abstract void	prepareForReuse() If a Web Component instance is going to be reused across different requests, this API serves as a notifier to the component to do the necessary cleanup.
abstract WebComponent	removeChild(WebComponent component) removes a child WebComponent instance on the current WebComponent.
abstract WebComponent	removeChild(String key) removes a child WebComponent instance on the current WebComponent.
abstract WebComponent	searchChild(String key) Returns the child WebComponent instance specified by the key.
abstract void	setBeanContext(BeanContext beanContext, boolean propagate) Sets an instance of `BeanContext` on the current WebBean.
abstract void	setBeanContext(BeanContext beanContext) Sets an instance of `BeanContext` on the current WebBean.
abstract void	setChanged(boolean value, boolean forceRecurse) Sets the changed state of the component
abstract void	setChanged(boolean value) Sets the changed state of the component.
abstract void	setDefaultStateLevel(int stateLevel) Sets the default state level for the WebComponent.
abstract void	setFeaturesManager(WebFeatures featuresManager) Associate a WebFeatures implementation with this WebComponent
abstract void	setName(String name) Sets the name on the current WebComponent.
abstract void	setOutputFormat(int outputFormat) Sets the output format of `EnumBeanOutputFormat` of the current WebComponent.
abstract void	setParent(WebComponent parent) Sets the parent WebComponent of the current WebComponent.
abstract void	setPersistMode(int persistFlag) Sets the persist flag (`EnumBeanPersistMode`) of the current WebComponent.
abstract void	setRenderingFilter(Set renderingFilter) Sets the list of beans to render.
abstract void	setTargetBean(WebComponent bean) Set the target bean that will be associated with this instance.
abstract void	setTargetBeanPath(String beanName) Define the base bean for this instance.
abstract void	setWebEventHandler(WebEventHandler handler) Sets a `WebEventHandler` on this component.

Constants

public static final int GRAPH_REPORTS

Identifies those underlying reports whose view mode is set to Graph

Constant Value: 2 (0x00000002)

public static final int GRID_REPORTS

Identifies those underlying reports whose view mode is set to Grid

Constant Value: 1 (0x00000001)

Public Methods

public abstract boolean cancelRequest ()

Cancels the current request.

Returns

true if successfully cancelled.

public abstract void collectData (boolean populateReportInstances)

Triggers execution to the back end no matter whether it is synchronous or asynchronous. If this method fails to collect data, an exception is raised and saved in a WebBeanError instance.

Parameters

populateReportInstances	If set to true, the document execution retrieves the report instances for the document too.

Throws

WebBeanException	thrown if there is any backend error

public abstract int getCount ()

Returns the number of reports in the document

Returns

The number of reports in the document

Throws

WebBeanException	thrown if the count can be obtained

public abstract int getCount (int typeOfReports)

Returns the number of reports in the document of the type passed. The types that can be passed are GRAPH_REPORTS, GRID_REPORTS & their combination.

Parameters

typeOfReports	The type of report to be considered within the reports in the document.

Returns

The number of reports in the document (of type passed)

Throws

IllegalArgumentException	if the typeOfReports passed is invalid.
WebBeanException	thrown if the count is unable to get

public abstract WebDocumentInstance getDocumentInstance ()

Returns the Document Instance set.

Returns

The WebDocumentInstance set on the bean.

Throws

WebBeanException	thrown if there is any backend error

public abstract int getExecutionFlags ()

Returns the execution flag as of EnumDSSXMLExecutionFlags when running the WebDocument contained in this bean.

Returns

the WebDocument execution flag.

public abstract ReportBean getReport (int index, int typeOfReports)

Returns the ReportBean at the given index among the list of reports of the type passed. Possible report types that can be passed are GRAPH_REPORTS, GRID_REPORTS and their combination.

Parameters

index	the index of the Report in the Document. The index begins from 0.
typeOfReports	The list of Reports to be scanned

Returns

the ReportBean at specified position.

Throws

IllegalArgumentException	if the typeOfReports passed is invalid.
IndexOutOfBoundsException	if the no report exists at index passed i.e. the index is out of range.
WebBeanException	thrown if there is backend error when retrieving the contained report.

public abstract ReportBean getReport (int index)

Returns the ReportBean at a given index. The index begins from 0.

Parameters

index	The index of the report to be retrieved from the Document.

Returns

the ReportBean at the specified position.

Throws

IndexOutOfBoundsException	if the no report exists at index passed i.e. the index is out of range.
WebBeanException	thrown if there is any backend error when retrieving the contained report.

public abstract Iterator getReports ()

Returns an Iterator that contains the ReportBean objects within the document.

Returns

An Iterator over the Reports in the Document

Throws

WebBeanException	thrown if there is backend error when retrieving reports.

public abstract Iterator getReports (int typeOfReports)

Returns an Iterator that contains the ReportBean objects within the document of the type passed. Possible report types that can be passed are GRAPH_REPORTS, GRID_REPORTS and their combination.

Parameters

typeOfReports	The type of reports to be considered while scanning the document and building the iterator.

Returns

An Iterator over the Reports in the Document of type passed.

Throws

IllegalArgumentException	if the typeOfReports passed is invalid.
WebBeanException	thrown if there is backend error when retrieving reports of the specified type.

public abstract String getResult ()

Returns the result of a document execution.

Returns

The result of a document execution. The result might be HTML or XML based on the execution flag set.

Throws

WebBeanException	thrown if there is backend error when retriving the document result.

public abstract int getViewMode ()

Returns the view mode. Possible values are listed in EnumWebDocumentViewMode.

Returns

the view mode.

public abstract void setExecutionFlags (int executionFlags)

Sets the execution flags as of EnumDSSXMLExecutionFlags to this bean.

Parameters

executionFlags	the `WebDocument` execution flag.

public abstract void setViewMode (int viewMode)

Sets the view mode (Possible values : EnumWebDocumentViewMode)

Parameters

viewMode	a new view mode.

Interfaces

Classes

Exceptions

DocumentBean

Class Overview

Summary

Constants

public static final int GRAPH_REPORTS

public static final int GRID_REPORTS

Public Methods

public abstract boolean cancelRequest ()

Returns

public abstract void collectData (boolean populateReportInstances)

Parameters

Throws

public abstract int getCount ()

Returns

Throws

public abstract int getCount (int typeOfReports)

Parameters

Returns

Throws

public abstract WebDocumentInstance getDocumentInstance ()

Returns

Throws

public abstract int getExecutionFlags ()

Returns

public abstract ReportBean getReport (int index, int typeOfReports)

Parameters

Returns

Throws

public abstract ReportBean getReport (int index)

Parameters

Returns

Throws

public abstract Iterator getReports ()

Returns

Throws

public abstract Iterator getReports (int typeOfReports)

Parameters

Returns

Throws

public abstract String getResult ()

Returns

Throws

public abstract int getViewMode ()

Returns

public abstract void setExecutionFlags (int executionFlags)

Parameters

public abstract void setViewMode (int viewMode)

Parameters