Package com.microstrategy.web.app.beans

Interface WizardStepBean

All Superinterfaces:

AppComponent, EnumWebPersistableState, Persistable, Transformable, WebComponent

public interface WizardStepBean
extends AppComponent, Persistable

This application bean represents a single step on a wizard represented by a WizardBean instance.

Since:

MicroStrategy Web 8.0.0

Field Summary

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
java.lang.String	getBodyMessage()	The body message is a String that can be used by a Transform.
int	getExecutionEventID()	Returns the event to be triggered by the client when the wizars is closed
int	getPosition()	Returns step position it represents.
int	getPreviousEventID()	Returns the event to be triggered by the client when the Previous button is clicked.
java.lang.String	getPromptEvent()	Returns the event to be triggered by the client when the status has been changed to WaitingForUser Input
WebComponent	getTargetBean()	Returns target bean available to all steps in Wizard.
java.lang.String	getValidationErrorMessage()	Return generic error message text.
int	getXMLStatus()	Indicates which XML bean request status this step can be executed
boolean	isCompleted()	Informs whether this step has been completed or not.
boolean	isFinal()	Indicates the step is final and no more steps will be displayed by the wizard.
boolean	isRequired()	Informs whether this step is required to be completed.
boolean	renderOnAnyStatus()	Checks whether to render the step regardless of the status of the target bean.
void	setBodyMessage(java.lang.String value)	Sets the the step's body message. The body message is a String that can be used by a Transform.
void	setCompleted(boolean value)	Specifies completion for this step.
void	setExecutionEventID(int value)	Sets the event to be triggered by the client when the wizars is closed
void	setFinal(boolean value)	Specifies whether given step is final.
void	setIsRequired(boolean value)	Specifies whether this step is required to proceed through.
void	setPosition(int position)	Sets step position it represents.
void	setPreviousEventID(int value)	Sets the event to be triggered by the client when the Previous button is cliked.
void	setPromptEvent(java.lang.String value)	Sets the event to be triggered by the client when the status has been changed to WaitingForUser Input
void	setRenderOnAnyStatus(boolean value)	Specify the wizard to render the step regardless of the status of the target bean.
void	setTargetBean(WebComponent targetBean)	Assigns a target bean to be manipulate by the step.
void	setXMLStatus(int value)	Specifies in which XML bean request status this step can be executed

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, getTargetBeanPath, getWebEvent, getWebEvent, getWebEventHandler, handleRequest, hasChanged, hasJustOpened, initBean, invalidateChildrenState, isBeanContextEmpty, isFeatureAvailable, prepareForReuse, removeChild, removeChild, searchChild, setBeanContext, setBeanContext, setChanged, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setOutputFormat, setParent, setPersistMode, setRenderingFilter, setTargetBeanPath, setWebEventHandler

Method Detail

getPosition

int getPosition()

Returns step position it represents.

Returns:

int

setPosition

void setPosition(int position)

Sets step position it represents.

Parameters:

position - integer value indicating step position on the wizard

getValidationErrorMessage

java.lang.String getValidationErrorMessage()

Return generic error message text.

Returns:

String

isRequired

boolean isRequired()

Informs whether this step is required to be completed.

Returns:

true if required.

setIsRequired

void setIsRequired(boolean value)

Specifies whether this step is required to proceed through.

Parameters:

value - boolean indicating if it's required or not.

isCompleted

boolean isCompleted()

Informs whether this step has been completed or not.

Returns:

true if completed.

setCompleted

void setCompleted(boolean value)

Specifies completion for this step.

Parameters:

value - boolean value true if completed.

renderOnAnyStatus

boolean renderOnAnyStatus()

Checks whether to render the step regardless of the status of the target bean.

Returns:

true if to be rendered.

setRenderOnAnyStatus

void setRenderOnAnyStatus(boolean value)

Specify the wizard to render the step regardless of the status of the target bean.

Parameters:

value - boolean value true if to be rendered.

isFinal

boolean isFinal()

Indicates the step is final and no more steps will be displayed by the wizard.

Returns:

true if final.

setFinal

void setFinal(boolean value)

Specifies whether given step is final.

Parameters:

value - boolean value, true if final.

getTargetBean

WebComponent getTargetBean()

Returns target bean available to all steps in Wizard.

Specified by:

getTargetBean in interface WebComponent

Returns:

AppComponent

setTargetBean

void setTargetBean(WebComponent targetBean)

Assigns a target bean to be manipulate by the step.

Specified by:

setTargetBean in interface WebComponent

Parameters:

targetBean - bean instance.

setExecutionEventID

void setExecutionEventID(int value)

Sets the event to be triggered by the client when the wizars is closed

Parameters:

value - an event id

getPromptEvent

java.lang.String getPromptEvent()

Returns the event to be triggered by the client when the status has been changed to WaitingForUser Input

Returns:

an event id

setPromptEvent

void setPromptEvent(java.lang.String value)

Sets the event to be triggered by the client when the status has been changed to WaitingForUser Input

Parameters:

value - an event id

getPreviousEventID

int getPreviousEventID()

Returns the event to be triggered by the client when the Previous button is clicked.

Returns:

an event id

setPreviousEventID

void setPreviousEventID(int value)

Sets the event to be triggered by the client when the Previous button is cliked.

Parameters:

value - an event id

getExecutionEventID

int getExecutionEventID()

Returns the event to be triggered by the client when the wizars is closed

Returns:

int an event id.

setBodyMessage

void setBodyMessage(java.lang.String value)

Sets the the step's body message.
The body message is a String that can be used by a Transform. It's a piece of text that can be placed anywhere on the step's body.

Parameters:

value - the step's body message.

getBodyMessage

java.lang.String getBodyMessage()

The body message is a String that can be used by a Transform. It's a piece of text that can be placed anywhere on the step's body.

Returns:

String the step's body message.

getXMLStatus

int getXMLStatus()

Indicates which XML bean request status this step can be executed

Specified by:

getXMLStatus in interface WebComponent

Returns:

int EnumRequestStatus value

setXMLStatus

void setXMLStatus(int value)

Specifies in which XML bean request status this step can be executed

Parameters:

value - value obtained from EnumRequestStatus