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

public interface

PromptDefinitionBean

implements EditableObjectBean

com.microstrategy.web.beans.PromptDefinitionBean

Class Overview

The PromptDefinitionBean is a bean which represents a prompt definition object in metadata. This interface contains methods that will allow the user to load, manipulate, and save prompt objects in metadata, and eventually, as embedded objects.

Summary

[Expand]

Inherited Constants

From interface com.microstrategy.utils.serialization.EnumWebPersistableState

Public Methods
abstract PromptBean	getAvailableListPromptBean() Returns a `PromptBean` that can be used to display and modify the available list of a prompt.
abstract int	getConstantPromptDataType() Returns the datatype for a constant prompt.
abstract PromptBean	getDefaultAnswerPromptBean() Returns a `PromptBean` that can be used to display and modify the default answer of prompt.
abstract int	getExpressionPromptExpressionType() Returns the expression type for the expression prompt.
abstract int	getPromptType() Returns the current prompt type, from `EnumWebPromptType`.
abstract WebPrompt	getWebPrompt() Returns the WebPrompt object that is associated with the PromptDefinitionBean.
abstract void	setConstantPromptDataType(int dataType) Sets the datatype for a constant prompt.
abstract void	setExpressionPromptExpressionType(int dataType) Sets the expression type for a expression prompt.
abstract void	setPromptType(int promptType) Sets the type of prompt that the bean refers to.

[Expand]

Inherited Methods

From interface com.microstrategy.utils.serialization.Persistable

From interface com.microstrategy.web.beans.EditableBean

From interface com.microstrategy.web.beans.EditableObjectBean

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

Returns a PromptBean that can be used to display and modify the available list of a prompt. Note that this will only work for certain types of prompts - in particular, elements prompt is currently the only type supported, since the other types are fairly different in their semantics from the standard answer case. This PromptBean will expose the available list as the "answer" of the bean, and will modify the available list exposed by the bean appropriately in order to ensure that code which renders the regular answer can also render the available list with minimal changes.

Returns

A PromptBean tied to the available list.

Throws

WebBeanException

public abstract int getConstantPromptDataType ()

Returns the datatype for a constant prompt.

Returns

The currently set datatype for the constant prompt, from EnumDSSXMLDataType.

public abstract PromptBean getDefaultAnswerPromptBean ()

Returns a PromptBean that can be used to display and modify the default answer of prompt. This PromptBean will expose the default answer on its getAnswer method, so that the bean can be used by any code which normally deals with regular answers to provide default answers as well.

Returns

A PromptBean tied to the default answer.

Throws

WebBeanException

public abstract int getExpressionPromptExpressionType ()

Returns the expression type for the expression prompt.

Returns

The currently set expression type for the expression prompt, from EnumDSSXMLExpressionType.

public abstract int getPromptType ()

Returns the current prompt type, from EnumWebPromptType.

Returns

The current prompt type of the WebPrompt object, a value from EnumWebPromptType.

public abstract WebPrompt getWebPrompt ()

Returns the WebPrompt object that is associated with the PromptDefinitionBean.

Returns

a WebPrompt object corresponding to the definition of the prompt.

Throws

WebBeanException

public abstract void setConstantPromptDataType (int dataType)

Sets the datatype for a constant prompt.

Parameters

dataType	A value from `EnumDSSXMLDataType`, representing the datatype of the prompt.

public abstract void setExpressionPromptExpressionType (int dataType)

Sets the expression type for a expression prompt.

Parameters

dataType	A value from `EnumDSSXMLExpressionType`, representing the expressiontype of the prompt. The currently supported values are `DssXmlFilterAttributeIDQual` - Attribute Qualification Prompt `DssXmlFilterSingleMetricQual` - Metric Qualification Prompt `DssXmlFilterAllAttributeQual` - Hierarchy Qualification Prompt

public abstract void setPromptType (int promptType)

Sets the type of prompt that the bean refers to. If the prompt type changes, generally whatever state has been built up so far will be discarded, similar to calling setObjectID. After calling this method, you should generally call collectData to update the bean.

Parameters

promptType	The type of prompt that this bean will represent, from `EnumWebPromptType`.

Interfaces

Classes

Exceptions

PromptDefinitionBean

Class Overview

Summary

Public Methods

public abstract PromptBean getAvailableListPromptBean ()

Returns

Throws

public abstract int getConstantPromptDataType ()

Returns

public abstract PromptBean getDefaultAnswerPromptBean ()

Returns

Throws

public abstract int getExpressionPromptExpressionType ()

Returns

public abstract int getPromptType ()

Returns

public abstract WebPrompt getWebPrompt ()

Returns

Throws

public abstract void setConstantPromptDataType (int dataType)

Parameters

public abstract void setExpressionPromptExpressionType (int dataType)

Parameters

public abstract void setPromptType (int promptType)

Parameters