Package com.microstrategy.web.app.beans

Interface PromptsContainerBean

All Superinterfaces:

AppComponent, EnumWebPersistableState, Persistable, Transformable, WebComponent

public interface PromptsContainerBean
extends AppComponent, Persistable

Since:

MicroStrategy Web 9.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_STYLE_VALUE
static java.lang.String	STYLE_NAME_PROPERTY

Fields inherited from interface com.microstrategy.web.app.beans.AppComponent

COMPONENT_POSITION_NOT_INITIALIZED

Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState

BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO

Method Summary

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

Methods inherited from interface com.microstrategy.web.app.beans.AppComponent

getAppContext, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getLeft, getResultFilterMode, getTop, isDialog, isForcedChildrenStateSaving, isModal, isModalOpen, isOpen, setExtraInput, setExtraUrl, setForcedChildrenStateSaving, setHasJustOpened, setIsDialog, setIsModal, setIsOpen, setLeft, setTop

Methods inherited from interface com.microstrategy.utils.serialization.Persistable

restoreState, restoreState, saveState, saveState, saveState, saveState

Methods inherited from interface com.microstrategy.web.beans.Transformable

addTransform, addTransformByClass, addTransformByStyle, addTransformByStyle, clearTransforms, getBeanContext, getMessageString, getMyTransformInstances, getTransformInstance, getTransformInstance, getTransformInstances, getType, hasTransform, hasTransform, invalidateTransformCache, setBeanContext, transform, transform

Methods inherited from interface com.microstrategy.web.beans.WebComponent

addChild, addChildStateInfo, addChildStateInfo, collectData, collectMinimalData, generateOutput, getBeanContext, getChild, getChild, getChildByClass, getChildByType, getChildCount, getChildrenByClass, getDefaultStateLevel, getFeaturesManager, getMaximumStateLevel, getName, getOutputFormat, getParent, getPath, getPersistMode, getRenderingFilter, getRoot, getTargetBean, getTargetBeanPath, getWebEvent, getWebEvent, getWebEventHandler, getXMLStatus, handleRequest, hasChanged, hasJustOpened, initBean, invalidateChildrenState, isBeanContextEmpty, isFeatureAvailable, prepareForReuse, removeChild, removeChild, searchChild, setBeanContext, setBeanContext, setChanged, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setOutputFormat, setParent, setPersistMode, setRenderingFilter, setTargetBean, setTargetBeanPath, setWebEventHandler

Field Detail

DEFAULT_STYLE_VALUE

static final java.lang.String DEFAULT_STYLE_VALUE

See Also:

Constant Field Values

STYLE_NAME_PROPERTY

static final java.lang.String STYLE_NAME_PROPERTY

See Also:

Constant Field Values

Method Detail

init

void init(PromptsBean bean)
   throws WebBeanException

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

init

void init(PromptBean bean)
   throws WebBeanException

Throws:

WebBeanException

getPromptsBean

PromptsBean getPromptsBean()

Returns the PromptsBean that is associated with the container.

Returns:

PromptsBean associated with the container.

getPromptAppBeans

java.util.List<PromptAppBean> getPromptAppBeans()

Returns the list of Prompt Style Beans.

Returns:

- the list of style beans.

setPromptsLoaded

void setPromptsLoaded(boolean value)

isShowRequiredPromptsFirst

boolean isShowRequiredPromptsFirst()

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

useWebBlocks

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

setUseWebBlocks

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

getCurrentPromptAppBeanIndex

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().

setMobile

void setMobile(boolean isMobile)

Since:

MicroStrategy Web 9.0.1

isMobile

boolean isMobile()

Since:

MicroStrategy Web 9.0.1