Package com.microstrategy.web.beans

Interface WebBean

All Superinterfaces:

EnumWebPersistableState, Persistable, RequestPersistable, Transformable, WebComponent

All Known Subinterfaces:

AddressListBean, AnnotationBean, AppSchemaBean, AssociatedSchedulesBean, AttributeBean, ConstantPromptBean, CustomGroupBean, DataExplorerBean, DerivedElementBean, DimtyPromptBean, DocumentBean, EditableObjectBean, ElementPromptBean, ExpressionBean, ExpressionDisplayBean, ExpressionPromptBean, FilterBean, FolderBean, GraphBean, ImportWizardBean, InboxBean, LimitExpressionBean, ObjectBean, ObjectPromptBean, PerformanceMonitorBean, PromptAnswerBean, PromptBean, PromptDefinitionBean, PromptObject, PromptsBean, ReportBean, ResultSetBean, RWBean, RWViewBean, RWViewExpressionBean, ScheduleBean, SecurityFilterBean, SecurityRoleBean, SubscriptionBean, SubscriptionFolderBean, SubsetUnitLimitBean, ThresholdExpressionBean, UserBean, UserEntitiesBean, UserEntityBean, UserGroupBean, UserSearchBean, ViewBean

All Known Implementing Classes:

AbstractLimitExpressionBean, AssociatedSchedulesBeanImpl, DerivedElementBeanImpl, ThresholdExpressionBeanImpl

public interface WebBean
extends RequestPersistable, WebComponent, Transformable

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.

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

Modifier and Type	Method	Description
org.w3c.dom.Document	getDocument()	Returns a org.w3c.dom.Document parsed from the XML representation of this bean.
WebBeanError	getErrorInfo()	Returns a WebBeanError object indicating processing error during the collectData method call.
WebSessionInfo	getSessionInfo()	Returns the WebSessionInfo instance from this bean.
boolean	isStale()	Returns a boolean value indicating whether the content of this bean is stale.
void	setSessionInfo(WebSessionInfo sessionInfo)	Sets a new WebSessionInfo instance on this bean.
void	setStale(boolean stale)	Sets a flag indicating whether this bean is stale or fresh.

Methods inherited from interface com.microstrategy.utils.serialization.Persistable

restoreState, restoreState, saveState, saveState, saveState, saveState

Methods inherited from interface com.microstrategy.web.beans.RequestPersistable

restoreStateFromRequest, restoreStateFromRequest

Methods inherited from interface com.microstrategy.web.beans.Transformable

addTransform, addTransformByClass, addTransformByStyle, addTransformByStyle, clearTransforms, getBeanContext, getMessageString, getMyTransformInstances, getTransformInstance, getTransformInstance, getTransformInstances, getType, hasTransform, hasTransform, invalidateTransformCache, setBeanContext, transform, transform

Methods inherited from interface com.microstrategy.web.beans.WebComponent

addChild, addChildStateInfo, addChildStateInfo, collectData, collectMinimalData, generateOutput, getBeanContext, getChild, getChild, getChildByClass, getChildByType, getChildCount, getChildrenByClass, getDefaultStateLevel, getFeaturesManager, getMaximumStateLevel, getName, getOutputFormat, getParent, getPath, getPersistMode, getRenderingFilter, getRoot, getTargetBean, getTargetBeanPath, getWebEvent, getWebEvent, getWebEventHandler, getXMLStatus, handleRequest, hasChanged, hasJustOpened, initBean, invalidateChildrenState, isBeanContextEmpty, isFeatureAvailable, prepareForReuse, removeChild, removeChild, searchChild, setBeanContext, setBeanContext, setChanged, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setOutputFormat, setParent, setPersistMode, setRenderingFilter, setTargetBean, setTargetBeanPath, setWebEventHandler

Method Detail

getSessionInfo

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.

setSessionInfo

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.

getErrorInfo

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.

getDocument

org.w3c.dom.Document getDocument()
                          throws WebBeanException

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.

isStale

boolean isStale()

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

Returns:

true if this bean is stale.

setStale

void setStale(boolean stale)

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

Parameters:

stale - true if this bean is stale.