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

public interface

DimtyPromptBean

implements PromptBean

com.microstrategy.web.beans.DimtyPromptBean

Class Overview

Interface of the Dimty Prompt Bean.

Summary

[Expand]

Inherited Constants

From interface com.microstrategy.utils.serialization.EnumWebPersistableState

Public Methods
abstract WebDimtyUnit	addDimtyUnit(WebObjectInfo objInfo) Add a dimty unit to the answer based on `WebObjectInfo`.
abstract WebDimtyUnit	addDimtyUnit(int dimtyType) Add a dimty unit to the answer based on dimty type.
abstract void	clearAnswer() Clears the prompt answer.
abstract WebDimty	getAnswer() Returns the answer of the dimty prompt.
abstract FolderBean	getAvailableItemsAsFolder() Return the available list defined by search or predefined list.
abstract WebDimtyUnit	getReportLevelDimtyUnit() Return the dimty unit which represents the "Report Level" (`DssXmlDimtyUnitTypeReportBaseLevel`).
abstract WebSearch	getSearchObject() Returns the search object associated with the prompt.
abstract void	removeDimtyUnit(int key) Removes a dimty unit from the answer based on the key.

[Expand]

Inherited Methods

From interface com.microstrategy.utils.serialization.Persistable

From interface com.microstrategy.web.beans.PromptBean

From interface com.microstrategy.web.beans.PromptObject

abstract WebDisplayHelper	getDisplayHelper() Returns the cached `WebDisplayHelper` object from the current PromptObject.
abstract HighlightedObjects	getHighlightedObjects() Returns a collection of highlighted objects.
abstract String	getOriginalSearchRoot() Returns original search root or empty string.
abstract int	getPromptPosition() Returns the position of this PromptObject in the collection of prompt objects in a `PromptsBean`.
abstract PromptsBean	getPromptsBean() Returns the `PromptsBean` which contains this prompt object.
abstract PromptsSource	getPromptsSource() Returns the `PromptsSource` object from which this prompt object is originated.
abstract String	getUserSearchPattern() Returns the user search pattern on a PromptObject.
abstract WebBeanError	getValidationInfo() Returns the prompt answer validation error information for this particular prompt only.
abstract WebPrompt	getWebPrompt() Returns the embedded `WebPrompt` object.
abstract boolean	hasAnswerChanged() Returns `true` if the prompt answer has been changed since it is loaded from the Intelligence Server.
abstract void	setAnswerChanged(boolean changed) Sets a boolean value indicating that the prompt answer has been changed for the underlying prompt.
abstract void	setUserSearchPattern(String pattern) Sets the user search pattern on a PromptObject.
abstract void	setValidationInfo(WebBeanError wbe) Sets a prompt answer validation error on this prompt object.

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 WebDimtyUnit addDimtyUnit (WebObjectInfo objInfo)

Add a dimty unit to the answer based on WebObjectInfo.

Parameters

objInfo	`WebObjectInfo` to add.

Returns

- added WebDimtyUnit

public abstract WebDimtyUnit addDimtyUnit (int dimtyType)

Add a dimty unit to the answer based on dimty type.

Parameters

dimtyType	- type of dimty unit.

Returns

- added WebDimtyUnit.

public abstract void clearAnswer ()

Clears the prompt answer.

public abstract WebDimty getAnswer ()

Returns the answer of the dimty prompt.

Returns

WebDimty collection.

public abstract FolderBean getAvailableItemsAsFolder ()

Return the available list defined by search or predefined list. This list does not include the "Report Level" dimty unit, which should be also part of available for dimty prompt. You can get the "Report Level" dimty unit by calling getReportLevelDimtyUnit().

Returns

A folder bean, which may include attribute and Hierarchy.

public abstract WebDimtyUnit getReportLevelDimtyUnit ()

Return the dimty unit which represents the "Report Level" (DssXmlDimtyUnitTypeReportBaseLevel).

Returns

A dimty unit represents the "Report Level".

public abstract WebSearch getSearchObject ()

Returns the search object associated with the prompt.

Returns

WebSearch associated with the prompt.

public abstract void removeDimtyUnit (int key)

Removes a dimty unit from the answer based on the key.

Parameters

key	- key of the dimty unit to be removed.

Interfaces

Classes

Exceptions

DimtyPromptBean

Class Overview

Summary

Public Methods

public abstract WebDimtyUnit addDimtyUnit (WebObjectInfo objInfo)

Parameters

Returns

public abstract WebDimtyUnit addDimtyUnit (int dimtyType)

Parameters

Returns

public abstract void clearAnswer ()

public abstract WebDimty getAnswer ()

Returns

public abstract FolderBean getAvailableItemsAsFolder ()

Returns

public abstract WebDimtyUnit getReportLevelDimtyUnit ()

Returns

public abstract WebSearch getSearchObject ()

Returns

public abstract void removeDimtyUnit (int key)

Parameters