Summary: Inherited Constants | Methods | Inherited Methods | [Expand All]

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

abstract AppContext	getAppContext() This method returns the application context object associated with this component.
abstract String	getDescriptor(String key) Retrieve the descriptor when the key is a string
abstract String	getDescriptor(int key) Retrieve the descriptor when the key is an integer value...
abstract EventManager	getEventManager() This method returns the application EventManager used to generates events.
abstract String	getExtraInput() Get any extra input form information to be used when generating form information on the transforms associated with this instance.
abstract String	getExtraUrl() Get any extra url information to be used when generating link information on the transforms associated with this instance.
abstract int	getLeft() Get the left position where the bean should be displayed by the transform if applicable
abstract int	getResultFilterMode()
abstract int	getTop() Get the top position where the bean should be displayed by the transform if applicable
abstract boolean	isDialog() Returns true if this bean should be treated as a dialog
abstract boolean	isForcedChildrenStateSaving() Return whether the state will be save despite it's open or closed state.
abstract boolean	isModal() Retrieves the modal state of the bean
abstract boolean	isModalOpen() indicates whether there is a Modal AppComponent open in the hierarchy
abstract boolean	isOpen() Retrieves the open/close state of the bean
abstract void	setExtraInput(String newValue) Set any extra input form information to be used when generating form information on the transforms associated with this instance.
abstract void	setExtraUrl(String newValue) Set any extra url information to be used when generating link information on the transforms associated with this instance.
abstract void	setForcedChildrenStateSaving(boolean value) Forces the bean state to be save despite it's open or closed state.
abstract void	setHasJustOpened(boolean value) Sets whether the component has just been opened.
abstract void	setIsDialog(boolean value) Sets the bean to its dialog mode.
abstract void	setIsModal(boolean value) Sets the bean to its modal mode.
abstract void	setIsOpen(boolean value) Sets the bean to its enabled mode, meaning the editor will be visible to the user
abstract void	setLeft(int x) Set the left position where the bean should be displayed by the transform if applicable.
abstract void	setTop(int y) Set the top position where the bean should be displayed by the transform if applicable.

From interface com.microstrategy.web.beans.RequestPersistable

From interface com.microstrategy.web.beans.Transformable

From interface com.microstrategy.web.beans.WebComponent

abstract void	addChild(String key, WebComponent child) adds a child WebComponent instance on the current WebComponent.
abstract void	addChildStateInfo(ParameterBuilder paramBldr) Adds children state information into an existing `ParameterBuilder` instance.
abstract void	addChildStateInfo(ParameterBuilder paramBldr, int howMuchState) Adds children state information into an existing `ParameterBuilder` instance.
abstract void	collectData() Triggers execution to the back end no matter whether it is synchronous or asynchronous.
abstract void	collectMinimalData() This is similar to `collectData()` except data collected is minimal.
abstract MarkupOutput	generateOutput() This is the generic method to ask the WebComponent to generate some output for the client.
abstract BeanContext	getBeanContext() Returns an instance of `BeanContext`.
abstract WebComponent	getChild(String key) Returns the child WebComponent instance specified by the key.
abstract WebComponent	getChild(int index) Returns the child WebComponent instance specified by the index.
abstract WebComponent	getChildByClass(Class className) Returns the child WebComponent instance specified by the class.
abstract WebComponent	getChildByType(int childType) Returns the child WebComponent instance specified by the component type(`EnumWebTransformableType`).
abstract int	getChildCount() Returns the total number of children on the current WebComponent.
abstract void	getChildrenByClass(Class className, HashList retList, boolean recursive) Returns a collection of children specified by the class name
abstract int	getDefaultStateLevel() Returns the default state level for the WebComponent.
abstract WebFeatures	getFeaturesManager() Return the WebFeatures implementation associated with this WebComponent
abstract int	getMaximumStateLevel() Returns the maximum state level that is supported by the WebComponent.
abstract String	getName() Returns the name of the current WebComponent.
abstract int	getOutputFormat() Returns the output format of `EnumBeanOutputFormat` of the current WebComponent.
abstract WebComponent	getParent() Returns the parent WebComponent of the current WebComponent.
abstract String	getPath() Returns the path from the root WebComponent to the current WebComponent.
abstract int	getPersistMode() Returns the persist flag (`EnumBeanPersistMode`) of the current WebComponent.
abstract Set	getRenderingFilter() returns the rendering filter.
abstract WebComponent	getRoot() Returns the root of the current WebComponent.
abstract WebComponent	getTargetBean() Get the target bean associated with this instance
abstract String	getTargetBeanPath()
abstract WebEvent	getWebEvent(int event, boolean recurse) Returns the `WebEvent` instance with the specified event ID.
abstract WebEvent	getWebEvent(int event) Returns the `WebEvent` instance with the specified event ID.
abstract WebEventHandler	getWebEventHandler() Returns the `WebEventHandler` instance associated with the current WebComponent.
abstract int	getXMLStatus() This method returns the `EnumRequestStatus` status of the current Component.
abstract boolean	handleRequest(RequestKeys keys) Handles a request.
abstract boolean	hasChanged() Verifies the state of the component has changed
abstract boolean	hasJustOpened() Verifies if the component has just been opened.
abstract void	initBean() Initialize the component after it's created and its properties initialized
abstract void	invalidateChildrenState() Invalidates the cached URL and hidden INPUT states of all the components, including the current component, along the path to the root component.
abstract boolean	isBeanContextEmpty() Verifies if a bean context exists for the current WebComponent.
abstract boolean	isFeatureAvailable(String featureID) Verifies the feature provided is accesible based on the properties of this WebComponent
abstract void	prepareForReuse() If a Web Component instance is going to be reused across different requests, this API serves as a notifier to the component to do the necessary cleanup.
abstract WebComponent	removeChild(String key) removes a child WebComponent instance on the current WebComponent.
abstract WebComponent	removeChild(WebComponent component) removes a child WebComponent instance on the current WebComponent.
abstract WebComponent	searchChild(String key) Returns the child WebComponent instance specified by the key.
abstract void	setBeanContext(BeanContext beanContext, boolean propagate) Sets an instance of `BeanContext` on the current WebBean.
abstract void	setBeanContext(BeanContext beanContext) Sets an instance of `BeanContext` on the current WebBean.
abstract void	setChanged(boolean value) Sets the changed state of the component.
abstract void	setChanged(boolean value, boolean forceRecurse) Sets the changed state of the component
abstract void	setDefaultStateLevel(int stateLevel) Sets the default state level for the WebComponent.
abstract void	setFeaturesManager(WebFeatures featuresManager) Associate a WebFeatures implementation with this WebComponent
abstract void	setName(String name) Sets the name on the current WebComponent.
abstract void	setOutputFormat(int outputFormat) Sets the output format of `EnumBeanOutputFormat` of the current WebComponent.
abstract void	setParent(WebComponent parent) Sets the parent WebComponent of the current WebComponent.
abstract void	setPersistMode(int persistFlag) Sets the persist flag (`EnumBeanPersistMode`) of the current WebComponent.
abstract void	setRenderingFilter(Set renderingFilter) Sets the list of beans to render.
abstract void	setTargetBean(WebComponent bean) Set the target bean that will be associated with this instance.
abstract void	setTargetBeanPath(String beanName) Define the base bean for this instance.
abstract void	setWebEventHandler(WebEventHandler handler) Sets a `WebEventHandler` on this component.

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

WizardStepBean instance of the current step

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

WizardStepBean instance representing the next step

public abstract WizardStepBean getPreviousStep ()

Returns instance of previous step bean.

Returns

WizardStepBean instance representing the previous step

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

Interfaces

Classes

Exceptions

WizardBean

Class Overview

Summary

Public Methods

public abstract Enumeration getAllWizardSteps ()

Returns

public abstract int getCurrentPosition ()

Returns

public abstract WizardStepBean getCurrentStep ()

Returns

public abstract String getFinishEventArgs ()

Returns

public abstract int getFinishEventID ()

Returns

public abstract String getFinishPage ()

Returns

public abstract WizardStepBean getNextStep ()

Returns

public abstract WizardStepBean getPreviousStep ()

Returns

public abstract int getRequiredStep ()

Returns

public abstract String getTargetState ()

Returns

public abstract int getTotalSteps ()

Returns

public abstract void setCurrentPosition (int currentPos)

Parameters

public abstract void setFinishEventArgs (String value)

Parameters

public abstract void setFinishEventID (int value)

Parameters

public abstract void setFinishPage (String pageName)

Parameters

public abstract void setRequiredStep (int value)

Parameters

public abstract void setTargetState (String value)

Parameters