com.ozziefix.jlwizard.actions
Class ForwardAction

java.lang.Object
  com.ozziefix.jlwizard.actions.ForwardAction

All Implemented Interfaces:

WizardAction

public class ForwardAction
extends java.lang.Object
implements WizardAction

The ForwardAction just returns a PageForward to the specified page, without performing any logic.

Version:

$Revision: 1.1 $

Author:

Jurgen Lust

Constructor Summary

ForwardAction()
Creates a new ForwardAction

ForwardAction(java.lang.String forwardName)
Creates a new ForwardAction.

Method Summary

java.lang.String	getDescription() the description of this action
java.lang.String	getForwardName() the identifier of the page that should be shown.
java.lang.String	getTitle() the title of this action.
PageForward	perform(Wizard wizard, WizardModel model) perform the action.
void	setDescription(java.lang.String description) The description of this action.
void	setForwardName(java.lang.String forwardName) the identifier of the page that should be shown.
void	setTitle(java.lang.String title) the title of this action.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ForwardAction

public ForwardAction()

Creates a new ForwardAction

ForwardAction

public ForwardAction(java.lang.String forwardName)

Creates a new ForwardAction.

Parameters:

forwardName - the identifier of the page that should be shown

Method Detail

setDescription

public void setDescription(java.lang.String description)

The description of this action.

Parameters:

description - The description to set.

getDescription

public java.lang.String getDescription()

Description copied from interface: WizardAction

the description of this action

Specified by:

getDescription in interface WizardAction

Returns:

the description of the action

See Also:

WizardAction.getDescription()

setForwardName

public void setForwardName(java.lang.String forwardName)

the identifier of the page that should be shown.

Parameters:

forwardName - The forwardName to set.

getForwardName

public java.lang.String getForwardName()

the identifier of the page that should be shown.

Returns:

Returns the forwardName.

setTitle

public void setTitle(java.lang.String title)

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

Parameters:

title - The title to set.

getTitle

public java.lang.String getTitle()

Description copied from interface: WizardAction

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

Specified by:

getTitle in interface WizardAction

Returns:

the title of the action

See Also:

WizardAction.getTitle()

perform

public PageForward perform(Wizard wizard,
                           WizardModel model)
                    throws WizardException

Description copied from interface: WizardAction

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

Specified by:

perform in interface WizardAction

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

See Also:

WizardAction.perform(com.ozziefix.jlwizard.Wizard, com.ozziefix.jlwizard.WizardModel)