net.jspcontrols.dialogs.actions.wizard
Interface IWizardManager

All Known Implementing Classes:

WizardForm

public interface IWizardManager

Wizard Manager interface. Used by web framework to manipulate wizard rule engine.

Author:

Michael Jouravlev

getWizardErrors

public java.util.Map getWizardErrors()

Returns errors accumulated by wizard during processing of input data.

wizardCancel

public java.lang.String wizardCancel()

Cancels wizard.

Returns:

string mapping describing the after-cancel View

wizardBack

public java.lang.String wizardBack()

Tries to go one step back. Wizard does not allow to move past first step.

Returns:

string mapping describing the after-back View. If successfully moved one step back, MAPPING_ON_BACK_SUCCESS is returned. Otherwise, MAPPING_ON_BACK_FAILURE is returned.

See Also:

WizardConstants.MAPPING_ON_BACK_SUCCESS, WizardConstants.MAPPING_ON_BACK_FAILURE

wizardNext

public java.lang.String wizardNext()

Tries to go one step forward.

Returns:

string mapping describing the after-forward View If successfully moved one step forward, and wizard is not finished yet, MAPPING_ON_NEXT_SUCCESS is returned. If wizard was finished, MAPPING_ON_DONE is returned. Otherwise, MAPPING_ON_NEXT_FAILURE is returned.

See Also:

WizardConstants.MAPPING_ON_NEXT_SUCCESS, WizardConstants.MAPPING_ON_NEXT_FAILURE, WizardConstants.MAPPING_ON_DONE

disposeWizard

public void disposeWizard()

Disposes wizard and performs housekeeping tasks like removing messages, event listeneres and other objects created by wizard.

isCompleted

public boolean isCompleted()

Returns true if wizard was completed or was never instantiated; after wizard completes, it should not be accessed anymore.

getWizardView

public java.lang.String getWizardView()

Returns string mapping of the wizard page, corresponding to current wizard state. By convention, uses the name of wizard step. Always use unique names for wizard steps.