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

public interface

PromptsContainerBean

implements Persistable AppComponent

com.microstrategy.web.app.beans.PromptsContainerBean

Summary

Constants
String	DEFAULT_STYLE_VALUE
String	STYLE_NAME_PROPERTY

[Expand]

Inherited Constants

From interface com.microstrategy.utils.serialization.EnumWebPersistableState

From interface com.microstrategy.web.app.beans.AppComponent

Public Methods
abstract int	getCurrentPromptAppBeanIndex() Returns the index of current prompt bean is working on.
abstract List<PromptAppBean>	getPromptAppBeans() Returns the list of Prompt Style Beans.
abstract PromptsBean	getPromptsBean() Returns the PromptsBean that is associated with the container.
abstract void	init(PromptBean bean)
abstract void	init(PromptsBean bean) Initializes the PromptsContainerBean using the PromptsBean passed in.
abstract boolean	isMobile()
abstract boolean	isShowRequiredPromptsFirst() Returns whether the required prompts should be shown before optional prompts.
abstract void	setMobile(boolean isMobile)
abstract void	setPromptsLoaded(boolean value)
abstract void	setUseWebBlocks(boolean value) Set whether the widgets style will be used for the transform.
abstract boolean	useWebBlocks() Returns whether the bean should be transformed using the widgets infrastructure.

[Expand]

Inherited Methods

From interface com.microstrategy.utils.serialization.Persistable

From interface com.microstrategy.web.app.beans.AppComponent

abstract AppContext	getAppContext() This method returns the application context object associated with this component.
abstract String	getDescriptor(String key) Retrieve the descriptor when the key is a string
abstract String	getDescriptor(int key) Retrieve the descriptor when the key is an integer value...
abstract EventManager	getEventManager() This method returns the application EventManager used to generates events.
abstract String	getExtraInput() Get any extra input form information to be used when generating form information on the transforms associated with this instance.
abstract String	getExtraUrl() Get any extra url information to be used when generating link information on the transforms associated with this instance.
abstract int	getLeft() Get the left position where the bean should be displayed by the transform if applicable
abstract int	getResultFilterMode()
abstract int	getTop() Get the top position where the bean should be displayed by the transform if applicable
abstract boolean	isDialog() Returns true if this bean should be treated as a dialog
abstract boolean	isForcedChildrenStateSaving() Return whether the state will be save despite it's open or closed state.
abstract boolean	isModal() Retrieves the modal state of the bean
abstract boolean	isModalOpen() indicates whether there is a Modal AppComponent open in the hierarchy
abstract boolean	isOpen() Retrieves the open/close state of the bean
abstract void	setExtraInput(String newValue) Set any extra input form information to be used when generating form information on the transforms associated with this instance.
abstract void	setExtraUrl(String newValue) Set any extra url information to be used when generating link information on the transforms associated with this instance.
abstract void	setForcedChildrenStateSaving(boolean value) Forces the bean state to be save despite it's open or closed state.
abstract void	setHasJustOpened(boolean value) Sets whether the component has just been opened.
abstract void	setIsDialog(boolean value) Sets the bean to its dialog mode.
abstract void	setIsModal(boolean value) Sets the bean to its modal mode.
abstract void	setIsOpen(boolean value) Sets the bean to its enabled mode, meaning the editor will be visible to the user
abstract void	setLeft(int x) Set the left position where the bean should be displayed by the transform if applicable.
abstract void	setTop(int y) Set the top position where the bean should be displayed by the transform if applicable.

From interface com.microstrategy.web.beans.Transformable

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.

Constants

public static final String DEFAULT_STYLE_VALUE

Constant Value: "DefaultPSXSL"

public static final String STYLE_NAME_PROPERTY

Constant Value: "PSXSL"

Public Methods

public abstract int getCurrentPromptAppBeanIndex ()

Returns the index of current prompt bean is working on. The index will indicate the current prompt for one prompt per page mode, will indicate the first error prompt when there is error needs to be corrected.

Returns

The index of current prompt bean in collection returns from getPromptAppBeans().

public abstract List<PromptAppBean> getPromptAppBeans ()

Returns the list of Prompt Style Beans.

Returns

- the list of style beans.

public abstract PromptsBean getPromptsBean ()

Returns the PromptsBean that is associated with the container.

Returns

PromptsBean associated with the container.

public abstract void init (PromptBean bean)

Throws

WebBeanException

public abstract void init (PromptsBean bean)

Initializes the PromptsContainerBean using the PromptsBean passed in. It creates the set of prompt style beans based on individual prompt beans.

Parameters

bean	- PromptsBean from any of the sources.

Throws

WebBeanException

public abstract boolean isMobile ()

public abstract boolean isShowRequiredPromptsFirst ()

Returns whether the required prompts should be shown before optional prompts.

public abstract void setMobile (boolean isMobile)

public abstract void setPromptsLoaded (boolean value)

public abstract void setUseWebBlocks (boolean value)

Set whether the widgets style will be used for the transform.

Parameters

value	- true to use the widgets and false to use the old style

public abstract boolean useWebBlocks ()

Returns whether the bean should be transformed using the widgets infrastructure.

Returns

true - if it uses the widgets and false if it uses the old style

Interfaces

Classes

Exceptions

PromptsContainerBean

Summary

Constants

public static final String DEFAULT_STYLE_VALUE

public static final String STYLE_NAME_PROPERTY

Public Methods

public abstract int getCurrentPromptAppBeanIndex ()

Returns

public abstract List<PromptAppBean> getPromptAppBeans ()

Returns

public abstract PromptsBean getPromptsBean ()

Returns

public abstract void init (PromptBean bean)

Throws

public abstract void init (PromptsBean bean)

Parameters

Throws

public abstract boolean isMobile ()

public abstract boolean isShowRequiredPromptsFirst ()

public abstract void setMobile (boolean isMobile)

public abstract void setPromptsLoaded (boolean value)

public abstract void setUseWebBlocks (boolean value)

Parameters

public abstract boolean useWebBlocks ()

Returns