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

public interface

PromptObject

implements WebBean

com.microstrategy.web.beans.PromptObject

Known Indirect Subclasses

ConstantPromptBean, DimtyPromptBean, ElementPromptBean, ExpressionPromptBean, ObjectPromptBean, PromptBean

Class Overview

This interface represents information about a single prompt. It manages its position property and a WebPrompt object.

Summary

[Expand]

Inherited Constants

From interface com.microstrategy.utils.serialization.EnumWebPersistableState

Public Methods
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.

[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 WebDisplayHelper getDisplayHelper ()

Returns the cached WebDisplayHelper object from the current PromptObject. If the cached one is null, then return a new one from the underlying WebPrompt.

The cached WebDisplayHelper is typically set by the prompt event handler.

Returns

the WebDisplayHelper object

Throws

WebObjectsException	thrown if the `WebDisplayHelper` is unable to retrieved.

public abstract HighlightedObjects getHighlightedObjects ()

Returns a collection of highlighted objects. PromptsBean queries this collection and then tries to highlight each element in the collection in its collectData method.

Returns

a collection of HighlightedObject.

public abstract String getOriginalSearchRoot ()

Returns original search root or empty string.

Returns

original search root or empty string.

public abstract int getPromptPosition ()

Returns the position of this PromptObject in the collection of prompt objects in a PromptsBean.

Returns

the position of this object in a PromptsBean.

public abstract PromptsBean getPromptsBean ()

Returns the PromptsBean which contains this prompt object.

Returns

the PromptsBean.

public abstract PromptsSource getPromptsSource ()

Returns the PromptsSource object from which this prompt object is originated.

Returns

a PromptsSource object.

public abstract String getUserSearchPattern ()

Returns the user search pattern on a PromptObject. A search pattern is what a user types in a search box on a Web browser to perform a search. Except WebConstantPrompt, other types of WebPrompt all provide the search ability to search for a WebObjectInfo or WebElement.

Returns

the most recent user search pattern

public abstract WebBeanError getValidationInfo ()

Returns the prompt answer validation error information for this particular prompt only.

Returns

the prompt answer validation error. null if there is no error.

public abstract WebPrompt getWebPrompt ()

Returns the embedded WebPrompt object.

Returns

the WebPrompt object associated with this object.

public abstract boolean hasAnswerChanged ()

Returns true if the prompt answer has been changed since it is loaded from the Intelligence Server. Answering a prompt should reset this flag to false.

PromptsEventHandler uses this method to decide whether to open a closed prompt.

Returns

true if the prompt answer has been changed since it is loaded from the Intelligence Server.

public abstract void setAnswerChanged (boolean changed)

Sets a boolean value indicating that the prompt answer has been changed for the underlying prompt. After answering a prompt, users should reset this flag to false.

PromptsEventHandler uses this method to decide whether to open a closed prompt.

Parameters

changed	`true` if the prompt answer has been changed for the underlying prompt.

public abstract void setUserSearchPattern (String pattern)

Sets the user search pattern on a PromptObject. A search pattern is what a user types in a search box on a Web browser to perform a search. Except WebConstantPrompt, other types of WebPrompt all provide the search ability to search for a WebObjectInfo or WebElement.

Parameters

pattern	the new user search pattern a user types in

public abstract void setValidationInfo (WebBeanError wbe)

Sets a prompt answer validation error on this prompt object. Prompt event handler calls this method to pass validation error info to th caller.

Parameters

wbe	the prompt answer validation error.

Interfaces

Classes

Exceptions

PromptObject

Class Overview

Summary

Public Methods

public abstract WebDisplayHelper getDisplayHelper ()

Returns

Throws

public abstract HighlightedObjects getHighlightedObjects ()

Returns

public abstract String getOriginalSearchRoot ()

Returns

public abstract int getPromptPosition ()

Returns

public abstract PromptsBean getPromptsBean ()

Returns

public abstract PromptsSource getPromptsSource ()

Returns

public abstract String getUserSearchPattern ()

Returns

public abstract WebBeanError getValidationInfo ()

Returns

public abstract WebPrompt getWebPrompt ()

Returns

public abstract boolean hasAnswerChanged ()

Returns

public abstract void setAnswerChanged (boolean changed)

Parameters

public abstract void setUserSearchPattern (String pattern)

Parameters

public abstract void setValidationInfo (WebBeanError wbe)

Parameters