public interface

WebBean

implements RequestPersistable Transformable WebComponent
com.microstrategy.web.beans.WebBean
Known Indirect Subclasses

Class Overview

This interface represents a generic WebBean. It provides a common set of services for any of the Web Beans. Some of the main features of this interface includes:

  • Session Information: Each Web Bean is supplied a WebSessionInfo object which defines how the Web Bean interacts with backend servers.
  • Error Information: The top-level error from a Web Bean request is stored in the WebBeanError object that is accessible from the getErrorInfo method of a Web Bean.
This interface also inherits some features from its superinterfaces, mainly:
  • Presentation management: Callers can add transforms to a bean using Transformable interface and identify which transform should be executed.
  • XML content management: As all Web Beans are backed by an XML representation (which may involve one or more calls to the backend server), users of the bean can know the state of the XML content by calling the method getXMLStatus
  • State management: Each Web Bean offers the ability to save and restore its state from a string representation.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
Public Methods
abstract Document getDocument()
Returns a org.w3c.dom.Document parsed from the XML representation of this bean.
abstract WebBeanError getErrorInfo()
Returns a WebBeanError object indicating processing error during the collectData method call.
abstract WebSessionInfo getSessionInfo()
Returns the WebSessionInfo instance from this bean.
abstract boolean isStale()
Returns a boolean value indicating whether the content of this bean is stale.
abstract void setSessionInfo(WebSessionInfo sessionInfo)
Sets a new WebSessionInfo instance on this bean.
abstract void setStale(boolean stale)
Sets a flag indicating whether this bean is stale or fresh.
[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.WebComponent

Public Methods

public abstract Document getDocument ()

Returns a org.w3c.dom.Document parsed from the XML representation of this bean.

Returns
  • the XML representation of this bean.
Throws
WebBeanException thrown if there is error when collecting data for this bean.

public abstract WebBeanError getErrorInfo ()

Returns a WebBeanError object indicating processing error during the collectData method call. Null is returned if there is no error.

Returns
  • a WebBeanError object; null if there is no error.

public abstract WebSessionInfo getSessionInfo ()

Returns the WebSessionInfo instance from this bean. A WebSessionInfo object is where you can get or set the session ID to the intelligence server, user credentials and localization, etc.

Returns
  • a WebSessionInfo instance.

public abstract boolean isStale ()

Returns a boolean value indicating whether the content of this bean is stale.

Returns
  • true if this bean is stale.

public abstract void setSessionInfo (WebSessionInfo sessionInfo)

Sets a new WebSessionInfo instance on this bean. A WebSessionInfo object is where you can get or set the session ID to the intelligence server, user credentials and localization, etc.

Parameters
sessionInfo a WebSessionInfo instance.

public abstract void setStale (boolean stale)

Sets a flag indicating whether this bean is stale or fresh.

Parameters
stale true if this bean is stale.