Package net.anotheria.anosite.wizard.api

Interface WizardAPI

All Superinterfaces:

net.anotheria.anoplass.api.API

All Known Implementing Classes:

BaseWizardAPIImpl

public interface WizardAPI
extends net.anotheria.anoplass.api.API

WizardAPI interface.

Author:

h3ll

Method Summary

Modifier and Type	Method	Description
WizardStepAO	adjustToNextStep(String wizardId)	Adjusting to next step.
WizardStepAO	adjustToPreviousStep(String wizardId)	Adjusting to previous step.
WizardStepAO	adjustToStep(String wizardId, int stepIndex)	Adjusting to step.
void	allowNextStepNavigation(WizardAO wizard, WizardStepAO wizardStep)	Allow next step.
void	allowPreviousStepNavigation(WizardAO wizard, WizardStepAO wizardStep)	Allow previous step.
void	allowWizardCancel(WizardAO wizard, WizardStepAO wizardStep)	Allow wizard cancel step.
void	allowWizardFinish(WizardAO wizard, WizardStepAO wizardStep)	Allow wizard finish step.
void	allowWizardNavigateTo(WizardAO wizard, WizardStepAO wizardStep)	Allow navigate To command.
boolean	cancelWizard(WizardAO wizard)	Cancel wizard.
boolean	finishWizard(WizardAO wizard)	Finish wizard.
List<WizardStepAO>	getCompletedSteps(String wizardId)	Returns collection off steps which were already completed (passed).
WizardStepAO	getCurrentStep(String wizardId)	Returns current step for wizard.
String	getCurrentStepPageId(String wizardId)	Return id of current step page.
WizardAO	getWizard(String wizardId)	Returns wizard with selected id.
WizardAO	getWizardByName(String wizardName)	Returns wizard with selected name.

Methods inherited from interface net.anotheria.anoplass.api.API

deInit, init

Method Detail

getWizardByName

WizardAO getWizardByName(String wizardName)
                  throws WizardAPIException

Returns wizard with selected name.

Parameters:

wizardName - name of wizard

Returns:

WizardAO

Throws:

WizardAPIException - on errors WizardNotFoundException - if wizard not found

getWizard

WizardAO getWizard(String wizardId)
            throws WizardAPIException

Returns wizard with selected id.

Parameters:

wizardId - wizard id

Returns:

WizardAO

Throws:

WizardAPIException - on errors , WizardNotFoundException - if wizard not found

getCurrentStepPageId

String getCurrentStepPageId(String wizardId)
                     throws WizardAPIException

Return id of current step page.

Parameters:

wizardId - id of wizard

Returns:

string id of step

Throws:

WizardAPIException - on errors

getCurrentStep

WizardStepAO getCurrentStep(String wizardId)
                     throws WizardAPIException

Returns current step for wizard. If step does not exist, then new one will be created.

Parameters:

wizardId - id of wizard

Returns:

WizardStepAO

Throws:

WizardAPIException - on errors

getCompletedSteps

List<WizardStepAO> getCompletedSteps(String wizardId)
                              throws WizardAPIException

Returns collection off steps which were already completed (passed).

Parameters:

wizardId - id of wizard

Returns:

WizardStepAO collection

Throws:

WizardAPIException - on errors

adjustToNextStep

WizardStepAO adjustToNextStep(String wizardId)
                       throws WizardAPIException

Adjusting to next step.

Parameters:

wizardId - id

Returns:

WizardStepAO

Throws:

WizardAPIException - on errors

adjustToPreviousStep

WizardStepAO adjustToPreviousStep(String wizardId)
                           throws WizardAPIException

Adjusting to previous step.

Parameters:

wizardId - id

Returns:

WizardStepAO

Throws:

WizardAPIException - on errors

adjustToStep

WizardStepAO adjustToStep(String wizardId,
                          int stepIndex)
                   throws WizardAPIException

Adjusting to step.

Parameters:

wizardId - id of wizard

stepIndex - step of step

Returns:

WizardStepAO

Throws:

WizardAPIException - on errors

finishWizard

boolean finishWizard(WizardAO wizard)
              throws WizardAPIException

Finish wizard.

Parameters:

wizard - WizardAO

Returns:

true if wizard finished, false otherwise

Throws:

WizardAPIException - on errors

cancelWizard

boolean cancelWizard(WizardAO wizard)
              throws WizardAPIException

Cancel wizard.

Parameters:

wizard - WizardAO

Returns:

true if wizard canceled, false otherwise

Throws:

WizardAPIException - TODO dummy comment for javadoc.

allowNextStepNavigation

void allowNextStepNavigation(WizardAO wizard,
                             WizardStepAO wizardStep)

Allow next step.

Parameters:

wizard - WizardAO

wizardStep - WizardStepAO

allowPreviousStepNavigation

void allowPreviousStepNavigation(WizardAO wizard,
                                 WizardStepAO wizardStep)

Allow previous step.

Parameters:

wizard - WizardAO

wizardStep - WizardStepAO

allowWizardCancel

void allowWizardCancel(WizardAO wizard,
                       WizardStepAO wizardStep)

Allow wizard cancel step.

Parameters:

wizard - WizardAO

wizardStep - WizardStepAO

allowWizardFinish

void allowWizardFinish(WizardAO wizard,
                       WizardStepAO wizardStep)

Allow wizard finish step.

Parameters:

wizard - WizardAO

wizardStep - WizardStepAO

allowWizardNavigateTo

void allowWizardNavigateTo(WizardAO wizard,
                           WizardStepAO wizardStep)

Allow navigate To command.

Parameters:

wizard - WizardAO

wizardStep - WizardStepAO