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

public interface

ViewBean

implements WebBean

com.microstrategy.web.beans.ViewBean

Known Indirect Subclasses

RWViewBean

Class Overview

This interface provides a unified concept of the WebTemplate encapsulated by corresponding WebViewInstance along with its associated events for both the report, and report writing document. Custom ViewBean transforms and event handlers will work with traditional reports and the newer report writing document.

It is used to manage and render grid data defined by the underlying template in the WebViewInstance, and graph data encapsulated by the GraphBean. It also provides methods to track user states (e.g. view mode).

The ViewBean cannot exist on its own accord - only as part of the following:

getViewBean(). The ReportBean always encapsulates a template.
getDataWebBeans(String) (tentative, and subject to changes). Embedded ViewBean in report writing documents may be rendered as grid, graphs or both.
getDefinitionWebBean(String) (tentative, and subject to changes). The corresponding WebViewInstance instances here only contain template information, but no data. Useful representation in design mode.

The ViewBean cannot be saved and restored on its own. It cannot be instantiated from the WebBeanFactory.

Summary

[Expand]

Inherited Constants

From interface com.microstrategy.utils.serialization.EnumWebPersistableState

Fields
public static final ThreadLocal<WebHeaders>	expandedRow

Public Methods
abstract WebDerivedElements	getDerivedElements(WebAttribute attr) Returns the derived elements associated with the specified attribute.
abstract WebFormat	getFormat(int formatType) Returns a format object for the given format type.
abstract GraphBean	getGraphBean() Returns a `GraphBean` for retrieving graph data.
abstract int	getSliceID() Returns the sliced window ID of the grid graph object.
abstract WebViewInstance	getViewInstance() Returns the underling `WebViewInstance` containing the grid data.
abstract int	getViewMode() Returns whether whether the bean is currently displaying a grid, graph or both.
abstract String	getViewName() Returns the view name.
abstract int	getVisualizationViewMode() Returns visualization view mode
abstract boolean	isTemplateEmpty() Returns true if template is empty
abstract void	populateObject(WebObjectInfo oi) Populates object
abstract void	setPartialUpdate() Indicates that the grid and all related units must be partial updated.
abstract void	setRedisplay() Indicates that the grid must be redisplayed.
abstract void	setViewMode(int viewMode) The view mode is a state variable indicating what the bean is currently displaying (i.e. grid, graph or both).
abstract void	setVisualizationViewMode(int mode) Sets visualization view mode
abstract boolean	usePageAxisForGrandTotal() Whether to use Page axis for Grand Total in Percent to Total.

[Expand]

Inherited Methods

From interface com.microstrategy.utils.serialization.Persistable

From interface com.microstrategy.web.beans.RequestPersistable

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) Adds children state information into an existing `ParameterBuilder` instance.
abstract void	addChildStateInfo(ParameterBuilder paramBldr, int howMuchState) 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(String key) Returns the child WebComponent instance specified by the key.
abstract WebComponent	getChild(int index) Returns the child WebComponent instance specified by the index.
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(String key) removes a child WebComponent instance on the current WebComponent.
abstract WebComponent	removeChild(WebComponent component) 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) Sets the changed state of the component.
abstract void	setChanged(boolean value, boolean forceRecurse) 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.

Fields

public static final ThreadLocal<WebHeaders> expandedRow

Public Methods

public abstract WebDerivedElements getDerivedElements (WebAttribute attr)

Returns the derived elements associated with the specified attribute. For view report and RWGridGraph the Derived Elements are defined in view template, while for other type report the Derived Elements are defined in Data template.

Parameters

attr	the attribute with Derived Elements

Returns

WebDerivedElements

Throws

	WebObjectsException}, {@link WebBeanException)
WebBeanException
WebObjectsException

public abstract WebFormat getFormat (int formatType)

Returns a format object for the given format type. Note: returns null for reports

Parameters

formatType	format type (a value from @link com.microstrategy.web.objects.rw.EnumRWFormatTypes)

Returns

WebFormat

public abstract GraphBean getGraphBean ()

Returns a GraphBean for retrieving graph data. Note that this functions independently of the view mode. Although it's possible to obtain a GraphObject from the WebViewInstance, a GraphBean may be saved and restored unlike the former.

Returns

the associated GraphBean

public abstract int getSliceID ()

Returns the sliced window ID of the grid graph object.

Returns

the sliced window ID.

public abstract WebViewInstance getViewInstance ()

Returns the underling WebViewInstance containing the grid data.

Returns

the underlying WebViewInstance

Throws

WebBeanException	if there is a problem obtaining the data from the Intelligence Server, or a problem with the data itself

public abstract int getViewMode ()

Returns whether whether the bean is currently displaying a grid, graph or both.

Returns

the view mode in the definition

public abstract String getViewName ()

Returns the view name.

Returns

the name of the View. It returns the display name for the view bean in case of RW documents or the report name for the case for reports.

Throws

WebBeanException	thrown if the object name can be retrieved.

public abstract int getVisualizationViewMode ()

Returns visualization view mode

Returns

visualization view mode (see EnumWebVisualizationViewModes)

Throws

	WebBeanException
WebBeanException

public abstract boolean isTemplateEmpty ()

Returns true if template is empty

Returns

true if template is empty

public abstract void populateObject (WebObjectInfo oi)

Populates object

Parameters

oi	web object

Throws

	WebBeanException
WebBeanException

public abstract void setPartialUpdate ()

Indicates that the grid and all related units must be partial updated.

public abstract void setRedisplay ()

Indicates that the grid must be redisplayed. This method is meant to be used for grids iside RS documents.

public abstract void setViewMode (int viewMode)

The view mode is a state variable indicating what the bean is currently displaying (i.e. grid, graph or both). It is intended for book-keeping purposes, and does not actually affect data retrieval.

Parameters

viewMode	the new view mode

public abstract void setVisualizationViewMode (int mode)

Sets visualization view mode

Parameters

mode	visualization view mode

Throws

	WebBeanException
WebBeanException

public abstract boolean usePageAxisForGrandTotal ()

Whether to use Page axis for Grand Total in Percent to Total.

Returns

boolean

Interfaces

Classes

Exceptions

ViewBean

Class Overview

See Also

Summary

Fields

public static final ThreadLocal<WebHeaders> expandedRow

Public Methods

public abstract WebDerivedElements getDerivedElements (WebAttribute attr)

Parameters

Returns

Throws

public abstract WebFormat getFormat (int formatType)

Parameters

Returns

public abstract GraphBean getGraphBean ()

Returns

public abstract int getSliceID ()

Returns

public abstract WebViewInstance getViewInstance ()

Returns

Throws

public abstract int getViewMode ()

Returns

See Also

public abstract String getViewName ()

Returns

Throws

public abstract int getVisualizationViewMode ()

Returns

Throws

public abstract boolean isTemplateEmpty ()

Returns

public abstract void populateObject (WebObjectInfo oi)

Parameters

Throws

public abstract void setPartialUpdate ()

public abstract void setRedisplay ()

public abstract void setViewMode (int viewMode)

Parameters

See Also

public abstract void setVisualizationViewMode (int mode)

Parameters

Throws

public abstract boolean usePageAxisForGrandTotal ()

Returns