com.ozziefix.jlwizard.actions
Interface WizardAction

All Known Implementing Classes:
CancelAction, DemoFinishAction, ForwardAction, MaybeEmployeeAction

public interface WizardAction

A Wizard Action performs some logic on the model, when an action button is pressed on the navigation bar, and then returns a PageForward which determines which WizardPage is shown next. This allows for branching within a Wizard.

Version:
$Revision: 1.1 $
Author:
Jurgen Lust

Method Summary
 java.lang.String getDescription()
           the description of this action
 java.lang.String getTitle()
           the title of this action.
 PageForward perform(Wizard wizard, WizardModel model)
           perform the action.
 

Method Detail

getDescription

java.lang.String getDescription()

the description of this action

Returns:
the description of the action

getTitle

java.lang.String getTitle()

the title of this action. This could used for the button text on the WizardNavigator.

Returns:
the title of the action

perform

PageForward perform(Wizard wizard,
                    WizardModel model)
                    throws WizardException

perform the action. This should only be called from the perform() method of the Wizard.

Parameters:
wizard - the wizard that called this action
model - the wizard model this action will work with
Returns:
the forward to another page in the wizard
Throws:
WizardException - when something went wrong while performing the action


Copyright © 2004 - 2005 by Jurgen Lust.