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

public interface

FolderBean

implements ObjectBean

com.microstrategy.web.beans.FolderBean

Class Overview

This interface along with its super interface ObjectBean supports the concept of object browsing. It specializes the ObjectBean in the following ways:

Specify a system-defined folder. This includes the standard folders such as the Reports Folder or My Reports.
Retrieve the WebFolder interface. To walk through the list of child nodes in a folder, the transform code may operate directly on the org.w3c.dom.Document or use the WebFolder interface.
Specify a restriction on the type of objects returned in the folder. The getTypeRestrictions() method returns a SimpleList collection interface that allows the caller to specify a set of object types.

This interface also allows users to carry out search on objects. The default setting on the WebSearch object is in synchronized mode. The search result could be acquired through the method call getFolderObject.

Summary

[Expand]

Inherited Constants

From interface com.microstrategy.utils.serialization.EnumWebPersistableState

Public Methods
abstract boolean	cancelRequest() Cancels the current search request.
abstract boolean	getDereferenceShortcuts() This method returns false if Shortcut objects are not to be dereferenced.
abstract WebObjectFilter	getFilter()
abstract WebFolder	getFolderObject() Returns a `WebFolder` object representing this bean.
abstract WebSearch	getSearchObject()
abstract int	getSysFolder() Returns the system folder name as defined in `EnumDSSXMLFolderNames`.
abstract SimpleList	getTypeRestrictions() Returns a collection of object types (`EnumDSSXMLObjectTypes`).
abstract boolean	isSearchDefined() Returns true if the search object was previously created using `getSearchObject()` call This method is useful when the intention is to just check for the existense of a search object without actually forcing the creation of one.
abstract void	setDereferenceShortcuts(boolean dereferenceShortcuts) This method sets the flag for whether to dereference shortcuts.
abstract void	setFilter(WebObjectFilter value)
abstract void	setIgnoreAccessDenialError(boolean ignoreAccessDenialError) aggregationByValue
abstract void	setSysFolder(int sysFolder) Sets a new system folder name on this folder.

[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, 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`).

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 boolean cancelRequest ()

Cancels the current search request. This call purges the search object if possible.

Returns

true if successfully cancelled.

public abstract boolean getDereferenceShortcuts ()

This method returns false if Shortcut objects are not to be dereferenced. Or else, it returns true if shortcuts are dereferenced (i.e. converted to their targets). If not set, the default value is false.

Returns

a boolean value.

public abstract WebObjectFilter getFilter ()

public abstract WebFolder getFolderObject ()

Returns a WebFolder object representing this bean. The contents of the folder are restricted by a SimpleList collection returned from the method getTypeRestrictions.

Returns

a WebFolder representing this bean.

Throws

WebBeanException	thrown if error occurs while retrieving the folder contents.

public abstract WebSearch getSearchObject ()

public abstract int getSysFolder ()

Returns the system folder name as defined in EnumDSSXMLFolderNames. If this folder is not a predefined system folder, returns 0.

Returns

the system folder name of this folder.

Throws

WebBeanException	thrown if the system folder name can not be retrieved.

public abstract SimpleList getTypeRestrictions ()

Returns a collection of object types (EnumDSSXMLObjectTypes). The elements in the collection is non-repeating. This collection restricts the folder bean content to contain only those objects whose types are contained in the collection.

With respect to Shortcut objects, a shortcut is included in the output if the shortcut's target object meets the type restrictions specified here.

Returns

A SimpleList, containing a restricted collection of object types.

public abstract boolean isSearchDefined ()

Returns true if the search object was previously created using getSearchObject() call This method is useful when the intention is to just check for the existense of a search object without actually forcing the creation of one.

Returns

whether the search is defined.

public abstract void setDereferenceShortcuts (boolean dereferenceShortcuts)

This method sets the flag for whether to dereference shortcuts. Set the dereferenceShortcuts argument to be true, and shortcuts in the folder will be dereferenced. Or else, shortcuts in the folder will not be dereferenced.

public abstract void setFilter (WebObjectFilter value)

public abstract void setIgnoreAccessDenialError (boolean ignoreAccessDenialError)

aggregationByValue

public abstract void setSysFolder (int sysFolder)

Sets a new system folder name on this folder. System folder names are defined in EnumDSSXMLFolderNames and can uniquely identify a WebFolder object in a project.

Parameters

sysFolder	a new system folder name.

Interfaces

Classes

Exceptions

FolderBean

Class Overview

Summary

Public Methods

public abstract boolean cancelRequest ()

Returns

public abstract boolean getDereferenceShortcuts ()

Returns

See Also

public abstract WebObjectFilter getFilter ()

public abstract WebFolder getFolderObject ()

Returns

Throws

public abstract WebSearch getSearchObject ()

public abstract int getSysFolder ()

Returns

Throws

public abstract SimpleList getTypeRestrictions ()

Returns

public abstract boolean isSearchDefined ()

Returns

public abstract void setDereferenceShortcuts (boolean dereferenceShortcuts)

See Also

public abstract void setFilter (WebObjectFilter value)

public abstract void setIgnoreAccessDenialError (boolean ignoreAccessDenialError)

public abstract void setSysFolder (int sysFolder)

Parameters