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

public interface

ObjectBean

implements WebBean

com.microstrategy.web.beans.ObjectBean

Known Indirect Subclasses

AppSchemaBean, AttributeBean, CustomGroupBean, DataExplorerBean, DocumentBean, EditableObjectBean, FilterBean, FolderBean, PromptAnswerBean, PromptDefinitionBean, RWBean, ReportBean, ResultSetBean, SecurityFilterBean, SecurityRoleBean, UserBean, UserEntityBean, UserGroupBean

AppSchemaBean
AttributeBean	This bean is used for browsing attribute elements.
CustomGroupBean
DataExplorerBean	The `DataExplorerBean` is intended to support data explorer browsing.
DocumentBean	This interface is used to manage the collection of document data and enable it to be rendered.
EditableObjectBean	This interface represents an editable object bean.
FilterBean
FolderBean	This interface along with its super interface `ObjectBean` supports the concept of object browsing.
PromptAnswerBean	The PromptAnswerBean is represents a single `WebPromptAnswer` object.
PromptDefinitionBean	The PromptDefinitionBean is a bean which represents a prompt definition object in metadata.
RWBean	This interface is used to manage the collection of report writing document data and enable it to be rendered.
ReportBean	This interface is used to manage the collection of report data and enable it to be rendered.
ResultSetBean
SecurityFilterBean
SecurityRoleBean
UserBean	This bean represents a single user.
UserEntityBean	This is the base interface for both `UserBean` and `UserGroupBean`.
UserGroupBean	This interface represents a group user.

Class Overview

This interface represents a generic metadata object. While it is derived from the WebBean interface, this interface includes additional services: (a) Retrieval of an object by name (with wildcard); (b) Retrieval of an object ID; (c) Access to the remaining properties; (d) Parent folder support.

Summary

[Expand]

Inherited Constants

From interface com.microstrategy.utils.serialization.EnumWebPersistableState

Public Methods
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, boolean populate) Returns a `FolderBean` representing the parent folder of the current object.
abstract FolderBean	getParentFolderBean(String name) 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`).

[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.

Public Methods

public abstract int getBlockBegin ()

Returns the blockBegin property of the embedded WebObjectSource.

Returns

the blockBegin property. The default value is 1.

public abstract int getBlockCount ()

Returns the blockCount property of the embedded WebObjectSource.

Returns

the blockCount property. The default value is -1.

public abstract String getDisplayName ()

Display name of the bean. By default, this is identical to getObjectName(), but for beans that contain an underlying WebMessage the getDisplayName() is returned, which may be aliased differently.

Returns

display name.

Throws

WebBeanException	if there is a problem retrieving the display name.

public abstract int getFlags ()

Returns the object flags from the embedded WebObjectSource. The default value is EnumDSSXMLObjectFlags.DssXmlObjectAncestors | EnumDSSXMLObjectFlags.DssXmlObjectDefn | EnumDSSXMLObjectFlags.DssXmlObjectDates | EnumDSSXMLObjectFlags.DssXmlObjectSecurity | EnumDSSXMLObjectFlags.DssXmlObjectDepnSecurity.

Returns

the object flags (EnumDSSXMLObjectFlags).

public abstract int getLevel ()

Returns the level property of the embedded WebObjectSource.

Returns

the level property. The default value is 0.

public abstract String getObjectID ()

Returns the object's unique ID in the metadata.

Returns

the object's id

Throws

WebBeanException	thrown if the object ID can not be obtained.

public abstract WebObjectInfo getObjectInfo ()

Returns the the WebObjectInfo of the object.

Returns

the WebObjectInfo of the object.

Throws

WebBeanException	thrown if the object can not be obtained.

public abstract String getObjectName ()

Returns the object's exact name in the metadata.

Returns

the name of the object.

Throws

WebBeanException	thrown if the object name can be retrieved.

public abstract int getObjectType ()

Returns the type (EnumDSSXMLObjectTypes) of the object.

Returns

the type of the object.

public abstract FolderBean getParentFolderBean (String name, boolean populate)

Returns a FolderBean representing the parent folder of the current object. Null is returned if the current object is the root folder of a project.

Parameters

name	the name set on the parent FolderBean.
populate	indicates whether the folder object shall be populated.

Returns

a FolderBean representing the parent folder of the current object.

Throws

WebBeanException	thrown if the parent folder can not be retrieved.

public abstract FolderBean getParentFolderBean (String name)

Returns a FolderBean representing the parent folder of the current object. Null is returned if the current object is the root folder of a project.

Parameters

name	the name set on the parent FolderBean.

Returns

a FolderBean representing the parent folder of the current object.

Throws

WebBeanException	thrown if the parent folder can not be retrieved.

public abstract String getParentID ()

Returns the unique ID of the parent of the object. The parent object must be a folder, and null is returned if the object itself is the root folder of a project.

Returns

the object's parent folder's ID; null if backend error occurs.

Throws

WebBeanException	thrown if the parent folder can not be retrieved.

public abstract void setBlockBegin (int blockBegin)

Sets a new blockBegin property to the embedded WebObjectSource.

Parameters

blockBegin	the blockBegin property.

public abstract void setBlockCount (int blockCount)

Sets the blockCount property of the embedded WebObjectSource.

Parameters

blockCount	the blockCount property.

public abstract void setFlags (int flags)

Sets a new object flags on the embedded WebObjectSource.

Parameters

flags	an object flags (`EnumDSSXMLObjectFlags`).

public abstract void setLevel (int level)

Sets the level property of the embedded WebObjectSource.

Parameters

level	the level property.

public abstract void setObjectID (String objectID)

Sets the object's ID. The ID must be unique, otherwise an error will be returned when the object is being lazily initialized from the metedata.

Parameters

objectID	the object's ID.

public abstract void setObjectInfo (WebObjectInfo oi)

Sets the WebObjectInfo object that refers to the object. This can be used instead of setObjectName or setObjectID to point the bean to the object it should refer to. The most common usage of this method is to use an ObjectBean with an embedded object, which does not exist in metadata as a stand-alone object.

Parameters

oi	The `WebObjectInfo` object corresponding to the object bean.

public abstract void setObjectName (String objectName)

Sets the object's name. Wildcard characters are allowed in the name. A search in the metadata will be performed and the first object found is returned to the caller.

Parameters

objectName	the name of the object.

public abstract void setObjectType (int objectType)

Sets the object' type (EnumDSSXMLObjectTypes).

Parameters

objectType	the object't type.

Interfaces

Classes

Exceptions

ObjectBean

Class Overview

Summary

Public Methods

public abstract int getBlockBegin ()

Returns

public abstract int getBlockCount ()

Returns

public abstract String getDisplayName ()

Returns

Throws

public abstract int getFlags ()

Returns

public abstract int getLevel ()

Returns

public abstract String getObjectID ()

Returns

Throws

public abstract WebObjectInfo getObjectInfo ()

Returns

Throws

public abstract String getObjectName ()

Returns

Throws

public abstract int getObjectType ()

Returns

public abstract FolderBean getParentFolderBean (String name, boolean populate)

Parameters

Returns

Throws

public abstract FolderBean getParentFolderBean (String name)

Parameters

Returns

Throws

public abstract String getParentID ()

Returns

Throws

public abstract void setBlockBegin (int blockBegin)

Parameters

public abstract void setBlockCount (int blockCount)

Parameters

public abstract void setFlags (int flags)

Parameters

public abstract void setLevel (int level)

Parameters

public abstract void setObjectID (String objectID)

Parameters

public abstract void setObjectInfo (WebObjectInfo oi)

Parameters

public abstract void setObjectName (String objectName)

Parameters

public abstract void setObjectType (int objectType)

Parameters