public interface

WizardStepBean

implements Persistable AppComponent
com.microstrategy.web.app.beans.WizardStepBean

Class Overview

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

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.app.beans.AppComponent
Public Methods
abstract String getBodyMessage()
The body message is a String that can be used by a Transform.
abstract int getExecutionEventID()
Returns the event to be triggered by the client when the wizars is closed
abstract int getPosition()
Returns step position it represents.
abstract int getPreviousEventID()
Returns the event to be triggered by the client when the Previous button is clicked.
abstract String getPromptEvent()
Returns the event to be triggered by the client when the status has been changed to WaitingForUser Input
abstract WebComponent getTargetBean()
Returns target bean available to all steps in Wizard.
abstract String getValidationErrorMessage()
Return generic error message text.
abstract int getXMLStatus()
Indicates which XML bean request status this step can be executed
abstract boolean isCompleted()
Informs whether this step has been completed or not.
abstract boolean isFinal()
Indicates the step is final and no more steps will be displayed by the wizard.
abstract boolean isRequired()
Informs whether this step is required to be completed.
abstract boolean renderOnAnyStatus()
Checks whether to render the step regardless of the status of the target bean.
abstract void setBodyMessage(String value)
Sets the the step's body message.
abstract void setCompleted(boolean value)
Specifies completion for this step.
abstract void setExecutionEventID(int value)
Sets the event to be triggered by the client when the wizars is closed
abstract void setFinal(boolean value)
Specifies whether given step is final.
abstract void setIsRequired(boolean value)
Specifies whether this step is required to proceed through.
abstract void setPosition(int position)
Sets step position it represents.
abstract void setPreviousEventID(int value)
Sets the event to be triggered by the client when the Previous button is cliked.
abstract void setPromptEvent(String value)
Sets the event to be triggered by the client when the status has been changed to WaitingForUser Input
abstract void setRenderOnAnyStatus(boolean value)
Specify the wizard to render the step regardless of the status of the target bean.
abstract void setTargetBean(WebComponent targetBean)
Assigns a target bean to be manipulate by the step.
abstract void setXMLStatus(int value)
Specifies in which XML bean request status this step can be executed
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent

Public Methods

public abstract 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.

public abstract int getExecutionEventID ()

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

Returns
  • int an event id.

public abstract int getPosition ()

Returns step position it represents.

Returns
  • int

public abstract int getPreviousEventID ()

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

Returns
  • an event id

public abstract String getPromptEvent ()

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

Returns
  • an event id

public abstract WebComponent getTargetBean ()

Returns target bean available to all steps in Wizard.

Returns
  • AppComponent

public abstract String getValidationErrorMessage ()

Return generic error message text.

Returns
  • String

public abstract int getXMLStatus ()

Indicates which XML bean request status this step can be executed

Returns
  • int EnumRequestStatus value

public abstract boolean isCompleted ()

Informs whether this step has been completed or not.

Returns
  • true if completed.

public abstract boolean isFinal ()

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

Returns
  • true if final.

public abstract boolean isRequired ()

Informs whether this step is required to be completed.

Returns
  • true if required.

public abstract boolean renderOnAnyStatus ()

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

Returns
  • true if to be rendered.

public abstract void setBodyMessage (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.

public abstract void setCompleted (boolean value)

Specifies completion for this step.

Parameters
value boolean value true if completed.

public abstract void setExecutionEventID (int value)

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

Parameters
value an event id

public abstract void setFinal (boolean value)

Specifies whether given step is final.

Parameters
value boolean value, true if final.

public abstract void setIsRequired (boolean value)

Specifies whether this step is required to proceed through.

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

public abstract void setPosition (int position)

Sets step position it represents.

Parameters
position integer value indicating step position on the wizard

public abstract void setPreviousEventID (int value)

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

Parameters
value an event id

public abstract void setPromptEvent (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

public abstract 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.

public abstract void setTargetBean (WebComponent targetBean)

Assigns a target bean to be manipulate by the step.

Parameters
targetBean bean instance.

public abstract void setXMLStatus (int value)

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

Parameters
value value obtained from EnumRequestStatus