public interface

WizardBean

implements AppComponent RequestPersistable
com.microstrategy.web.app.beans.WizardBean

Class Overview

Description: This application bean can be used to present the user with a series of steps or pages that must be answered in a predetermined order.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.app.beans.AppComponent
Public Methods
abstract Enumeration getAllWizardSteps()
Returns enumeration of all steps in this Wizards.
abstract int getCurrentPosition()
Returns current step index or position.
abstract WizardStepBean getCurrentStep()
Returns instance of current step bean.
abstract String getFinishEventArgs()
Returns a string consisted of all arguments to be set in Finish event.
abstract int getFinishEventID()
Returns event ID associated to Finishing Wizard flow.
abstract String getFinishPage()
Returns name of page where to redirect after processing finish event.
abstract WizardStepBean getNextStep()
Returns instance of next step bean.
abstract WizardStepBean getPreviousStep()
Returns instance of previous step bean.
abstract int getRequiredStep()
Returns the number of the step must be completed before finishing the wizard
abstract String getTargetState()
Returns the stored state of the target bean
abstract int getTotalSteps()
Returns total number of steps in Wizard.
abstract void setCurrentPosition(int currentPos)
Sets current step index or position.
abstract void setFinishEventArgs(String value)
Specifies all arguments of finish Event.
abstract void setFinishEventID(int value)
Specifies which event to trigger when Wizard is finished.
abstract void setFinishPage(String pageName)
Specifies name of page where to redirect after processing finish event.
abstract void setRequiredStep(int value)
Sets the number of the step must be completed before finishing the wizard
abstract void setTargetState(String value)
Used to store the current state of the target bean.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent

Public Methods

public abstract Enumeration getAllWizardSteps ()

Returns enumeration of all steps in this Wizards.

Returns
  • Enumeration instance with all the steps

public abstract int getCurrentPosition ()

Returns current step index or position.

Returns
  • int index position of the current step.

public abstract WizardStepBean getCurrentStep ()

Returns instance of current step bean.

Returns

public abstract String getFinishEventArgs ()

Returns a string consisted of all arguments to be set in Finish event.

Returns
  • String list of arguments on a string with format like: argId1=val1;arg2=val2

public abstract int getFinishEventID ()

Returns event ID associated to Finishing Wizard flow.

Returns
  • int identifier of the event ID to process when the wizard is finished.

public abstract String getFinishPage ()

Returns name of page where to redirect after processing finish event.

Returns
  • String page where to go to after finishing the wizard

public abstract WizardStepBean getNextStep ()

Returns instance of next step bean.

Returns

public abstract WizardStepBean getPreviousStep ()

Returns instance of previous step bean.

Returns

public abstract int getRequiredStep ()

Returns the number of the step must be completed before finishing the wizard

Returns
  • the required step number

public abstract String getTargetState ()

Returns the stored state of the target bean

Returns
  • the stored state of the target bean

public abstract int getTotalSteps ()

Returns total number of steps in Wizard.

Returns
  • int number of total steps in wizard.

public abstract void setCurrentPosition (int currentPos)

Sets current step index or position.

Parameters
currentPos indicating the current index step position.

public abstract void setFinishEventArgs (String value)

Specifies all arguments of finish Event.

Parameters
value String representing the different arguments of the finish event (specified by the getFinishEventID() method). This value will have following format: argId1=val1;arg2=val2

public abstract void setFinishEventID (int value)

Specifies which event to trigger when Wizard is finished.

Parameters
value identifier of the event ID to process when the wizard is finished.

public abstract void setFinishPage (String pageName)

Specifies name of page where to redirect after processing finish event.

Parameters
pageName String page name

public abstract void setRequiredStep (int value)

Sets the number of the step must be completed before finishing the wizard

Parameters
value an int with the required step number

public abstract void setTargetState (String value)

Used to store the current state of the target bean.

Parameters
value a String containing the state of the target bean