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

public interface

PromptsBean

implements WebBean

com.microstrategy.web.beans.PromptsBean

Class Overview

This interface acts as a controller to orchestrate the collection and assembly of prompt questions. There are two different modes of operation:

Traditional Report-centric Mode: An application selects a report to execute. If it contains prompts that need to be answered, the Prompts Bean is responsible for managing those questions.
Prompts-centric Mode: An application creates a Prompts Bean object and supplies some number of prompt sources.

An instance of the PromptsBean can be retrieved from the ReportBean, DocumentBean, RWBean, SubscriptionBean, ScheduleBean

Summary

[Expand]

Inherited Constants

From interface com.microstrategy.utils.serialization.EnumWebPersistableState

Public Methods
abstract PromptsSource	addPromptsSource(int promptSourceType) Creates and adds a new `PromptsSource` object to this bean.
abstract int	getCount(int typeOfPrompt) Returns the count of prompts of a specific type from all the sources.
abstract int	getCurrentPromptPosition() Returns the position of the current prompt object the caller is working on.
abstract int	getNextPromptPosition(int type, int startPos) Returns the position of the prompt object of the specified type, next to the `startPos`.
abstract int	getNextPromptPosition() Returns the position of the next prompt object of the same type as the current prompt, starting search from the current prompt.
abstract int	getNextPromptPosition(int type) Returns the position of the prompt object of the specified type, next to the current prompt.
abstract int	getPreviousPromptPosition(int type, int startPos) Returns the position of the prompt object of the specified type, previous to the `startPos`.
abstract int	getPreviousPromptPosition(int type) Returns the position of the prompt object of the specified type, previous to the current prompt.
abstract int	getPreviousPromptPosition() Returns the position of the previous prompt object of the same type as the current prompt, starting search from the current prompt.
abstract PromptBean	getPromptBean(int position) Returns the `PromptBean` at the specific position.
abstract PromptBean	getPromptBean() Returns the `PromptBean` at the current position.
abstract Iterator<PromptBean>	getPromptBeans(int typeOfPrompt) Returns a read-only `java.util.Iterator` over all the contained `PromptBean`, each of which has the specified type.
abstract PromptObject	getPromptObject(int position) Returns the `PromptObject` at a specific position.
abstract PromptObject	getPromptObject() Returns the `PromptObject` at the current position.
abstract Iterator	getPromptObjects(int typeOfPrompt) Returns a read-only `java.util.Iterator` over all the contained `PromptObject`, each of which has the specified type.
abstract WebPrompts	getPrompts() Returns prompts
abstract Iterator	getPromptsSources() Returns an `java.util.Iterator` over all the `PromptsSource` contained within this bean.
abstract void	setCurrentPromptPosition(int position) Sets the prompt object at a new position as the current working prompt object.

[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 PromptsSource addPromptsSource (int promptSourceType)

Creates and adds a new PromptsSource object to this bean.

Parameters

promptSourceType	a flag from `EnumPromptsSourceTypes` indicating the source type.

Returns

an instantiated PromptsSource.

Throws

UnsupportedOperationException	thrown if the prompts source collection is read-only.

public abstract int getCount (int typeOfPrompt)

Returns the count of prompts of a specific type from all the sources. The type could be a combination of two or more types.

Parameters

typeOfPrompt	a bitwise flag from `EnumPromptsBeanTypes`.

Returns

the total count of prompts of the specified type from this PromptsBean.

Throws

WebBeanException	thrown if the count is unable to obtain.

public abstract int getCurrentPromptPosition ()

Returns the position of the current prompt object the caller is working on.

Returns

The position of the current prompt.

public abstract int getNextPromptPosition (int type, int startPos)

Returns the position of the prompt object of the specified type, next to the startPos. Returns -1 if it is not found.

Parameters

type	a flag from `EnumPromptsBeanTypes`.
startPos	the starting position to search.

Returns

the position of the next prompt object of the specified type.

Throws

IndexOutOfBoundsException	thrown if startPos is out of range.
WebBeanException	thrown if error occurs when loading prompts

public abstract int getNextPromptPosition ()

Returns the position of the next prompt object of the same type as the current prompt, starting search from the current prompt. Returns -1 if it is not found.

Returns

the position of the next prompt object of the specified type.

Throws

WebBeanException	thrown if error occurs when loading prompts

public abstract int getNextPromptPosition (int type)

Returns the position of the prompt object of the specified type, next to the current prompt. Returns -1 if it is not found.

Parameters

type	a flag from `EnumPromptsBeanTypes`.

Returns

the position of the next prompt object of the specified type.

Throws

WebBeanException	thrown if error occurs when loading prompts

public abstract int getPreviousPromptPosition (int type, int startPos)

Returns the position of the prompt object of the specified type, previous to the startPos. Returns -1 if it is not found.

Parameters

type	a flag from `EnumPromptsBeanTypes`.
startPos	the starting position to search.

Returns

the position of the previous prompt object of the specified type.

Throws

IndexOutOfBoundsException	thrown if startPos is out of range.
WebBeanException	thrown if error occurs when loading prompts

public abstract int getPreviousPromptPosition (int type)

Returns the position of the prompt object of the specified type, previous to the current prompt. Returns -1 if it is not found.

Parameters

type	a flag from `EnumPromptsBeanTypes`.

Returns

the position of the previous prompt object of the specified type.

Throws

WebBeanException	thrown if error occurs when loading prompts

public abstract int getPreviousPromptPosition ()

Returns the position of the previous prompt object of the same type as the current prompt, starting search from the current prompt. Returns -1 if it is not found.

Returns

the position of the previous prompt object of the specified type.

Throws

WebBeanException	thrown if error occurs when loading prompts

public abstract PromptBean getPromptBean (int position)

Returns the PromptBean at the specific position.

Parameters

position	the position of a `PromptObject`.

Returns

the PromptBean at the specified position.

Throws

WebBeanException	thrown if error occurs when loading prompts

public abstract PromptBean getPromptBean ()

Returns the PromptBean at the current position.

Returns

the current PromptBean.

Throws

WebBeanException	thrown if error occurs when loading prompts

public abstract Iterator<PromptBean> getPromptBeans (int typeOfPrompt)

Returns a read-only java.util.Iterator over all the contained PromptBean, each of which has the specified type.

Parameters

typeOfPrompt	a flag from `EnumPromptsBeanTypes`.

Returns

an java.util.Iterator over all the PromptBean with the specified type.

Throws

WebBeanException	thrown if error occurs when loading prompts

public abstract PromptObject getPromptObject (int position)

Returns the PromptObject at a specific position.

Parameters

position	the position of a `PromptObject`.

Returns

the PromptObject at the specified position.

Throws

WebBeanException	thrown if error occurs when loading prompts

public abstract PromptObject getPromptObject ()

Returns the PromptObject at the current position.

Returns

the current PromptObject.

Throws

WebBeanException	thrown if error occurs when loading prompts

public abstract Iterator getPromptObjects (int typeOfPrompt)

Returns a read-only java.util.Iterator over all the contained PromptObject, each of which has the specified type.

Parameters

typeOfPrompt	a flag from `EnumPromptsBeanTypes`.

Returns

an java.util.Iterator over all the PromptObject with the specified type.

Throws

WebBeanException	thrown if error occurs when loading prompts

public abstract WebPrompts getPrompts ()

Returns prompts

public abstract Iterator getPromptsSources ()

Returns an java.util.Iterator over all the PromptsSource contained within this bean.

Returns

an iterator over all the PromptsSource.

public abstract void setCurrentPromptPosition (int position)

Sets the prompt object at a new position as the current working prompt object.

Parameters

position	a new position in this PromptsBean.

Throws

IndexOutOfBoundsException	thrown if the position is out of range.
WebBeanException	thrown if error occurs when loading prompts

Interfaces

Classes

Exceptions

PromptsBean

Class Overview

Summary

Public Methods

public abstract PromptsSource addPromptsSource (int promptSourceType)

Parameters

Returns

Throws

public abstract int getCount (int typeOfPrompt)

Parameters

Returns

Throws

public abstract int getCurrentPromptPosition ()

Returns

public abstract int getNextPromptPosition (int type, int startPos)

Parameters

Returns

Throws

public abstract int getNextPromptPosition ()

Returns

Throws

public abstract int getNextPromptPosition (int type)

Parameters

Returns

Throws

public abstract int getPreviousPromptPosition (int type, int startPos)

Parameters

Returns

Throws

public abstract int getPreviousPromptPosition (int type)

Parameters

Returns

Throws

public abstract int getPreviousPromptPosition ()

Returns

Throws

public abstract PromptBean getPromptBean (int position)

Parameters

Returns

Throws

public abstract PromptBean getPromptBean ()

Returns

Throws

public abstract Iterator<PromptBean> getPromptBeans (int typeOfPrompt)

Parameters

Returns

Throws

public abstract PromptObject getPromptObject (int position)

Parameters

Returns

Throws

public abstract PromptObject getPromptObject ()

Returns

Throws

public abstract Iterator getPromptObjects (int typeOfPrompt)

Parameters

Returns

Throws

public abstract WebPrompts getPrompts ()

public abstract Iterator getPromptsSources ()

Returns

public abstract void setCurrentPromptPosition (int position)

Parameters

Throws