Package com.microstrategy.web.app.beans
Interface WizardBean
-
- All Superinterfaces:
AppComponent
,EnumWebPersistableState
,Persistable
,RequestPersistable
,Transformable
,WebComponent
public interface WizardBean extends AppComponent, RequestPersistable
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.
- 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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.Enumeration
getAllWizardSteps()
Returns enumeration of all steps in this Wizards.int
getCurrentPosition()
Returns current step index or position.WizardStepBean
getCurrentStep()
Returns instance of current step bean.java.lang.String
getFinishEventArgs()
Returns a string consisted of all arguments to be set in Finish event.int
getFinishEventID()
Returns event ID associated to Finishing Wizard flow.java.lang.String
getFinishPage()
Returns name of page where to redirect after processing finish event.WizardStepBean
getNextStep()
Returns instance of next step bean.WizardStepBean
getPreviousStep()
Returns instance of previous step bean.int
getRequiredStep()
Returns the number of the step must be completed before finishing the wizardjava.lang.String
getTargetState()
Returns the stored state of the target beanint
getTotalSteps()
Returns total number of steps in Wizard.void
setCurrentPosition(int currentPos)
Sets current step index or position.void
setFinishEventArgs(java.lang.String value)
Specifies all arguments of finish Event.void
setFinishEventID(int value)
Specifies which event to trigger when Wizard is finished.void
setFinishPage(java.lang.String pageName)
Specifies name of page where to redirect after processing finish event.void
setRequiredStep(int value)
Sets the number of the step must be completed before finishing the wizardvoid
setTargetState(java.lang.String value)
Used to store the current state of the target bean.-
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.RequestPersistable
restoreStateFromRequest, restoreStateFromRequest
-
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
-
-
-
-
Method Detail
-
getAllWizardSteps
java.util.Enumeration getAllWizardSteps()
Returns enumeration of all steps in this Wizards.- Returns:
Enumeration
instance with all the steps
-
getCurrentStep
WizardStepBean getCurrentStep()
Returns instance of current step bean.- Returns:
WizardStepBean
instance of the current step
-
getCurrentPosition
int getCurrentPosition()
Returns current step index or position.- Returns:
- int index position of the current step.
-
setCurrentPosition
void setCurrentPosition(int currentPos)
Sets current step index or position.- Parameters:
currentPos
- indicating the current index step position.
-
getNextStep
WizardStepBean getNextStep()
Returns instance of next step bean.- Returns:
WizardStepBean
instance representing the next step
-
getPreviousStep
WizardStepBean getPreviousStep()
Returns instance of previous step bean.- Returns:
WizardStepBean
instance representing the previous step
-
getTotalSteps
int getTotalSteps()
Returns total number of steps in Wizard.- Returns:
- int number of total steps in wizard.
-
getFinishPage
java.lang.String getFinishPage()
Returns name of page where to redirect after processing finish event.- Returns:
- String page where to go to after finishing the wizard
-
setFinishEventID
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.
-
getFinishEventID
int getFinishEventID()
Returns event ID associated to Finishing Wizard flow.- Returns:
- int identifier of the event ID to process when the wizard is finished.
-
setFinishEventArgs
void setFinishEventArgs(java.lang.String value)
Specifies all arguments of finish Event.- Parameters:
value
- String representing the different arguments of the finish event (specified by thegetFinishEventID()
method). This value will have following format: argId1=val1;arg2=val2
-
getFinishEventArgs
java.lang.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
-
setFinishPage
void setFinishPage(java.lang.String pageName)
Specifies name of page where to redirect after processing finish event.- Parameters:
pageName
- String page name
-
setTargetState
void setTargetState(java.lang.String value)
Used to store the current state of the target bean.- Parameters:
value
- a String containing the state of the target bean
-
getTargetState
java.lang.String getTargetState()
Returns the stored state of the target bean- Returns:
- the stored state of the target bean
-
setRequiredStep
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
-
getRequiredStep
int getRequiredStep()
Returns the number of the step must be completed before finishing the wizard- Returns:
- the required step number
-
-