Package net.anotheria.anosite.wizard.api

Class BaseWizardAPIImpl

java.lang.Object

net.anotheria.anoplass.api.AbstractAPIImpl

net.anotheria.anosite.wizard.api.BaseWizardAPIImpl

All Implemented Interfaces:

net.anotheria.anoplass.api.API, WizardAPI

public class BaseWizardAPIImpl
extends net.anotheria.anoplass.api.AbstractAPIImpl
implements WizardAPI

Base implementation of WizardAPI.

Author:

h3ll

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	BaseWizardAPIImpl.WizardData	WizardData object which represents APISessionAttribute for storing WizardStepAO.

Field Summary

Fields

Modifier and Type	Field	Description
static String	ALLOWED_WIZARD_STEP_COMMANDS_ATTRIBUTE	Attribute which holds allowed wizard step commands.
static String	WIZARD_ATTRIBUTE_SUFFIX	BaseWizardAPIImpl WIZARD_ATTRIBUTE_SUFFIX.

Fields inherited from class net.anotheria.anoplass.api.AbstractAPIImpl

DAY, HOUR, log, MINUTE

Constructor Summary

Constructors

Constructor	Description
BaseWizardAPIImpl()

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.
void	init()

Methods inherited from class net.anotheria.anoplass.api.AbstractAPIImpl

addValidationError, addValidationError, checkValidationAndThrowException, deInit, getApiConfig, getAttributeFromSession, getCallContext, getCurrentLocale, getCurrentUserId, getDefaultExpirePeriodForAttribute, getExpirePeriodForAttribute, getLoggedInUserId, getPrivateAttributeName, getSession, removeAttributeFromSession, setAttributeInSession, setAttributeInSession, setAttributeInSession, setAttributeInSession

Methods inherited from class java.lang.Object

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

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

deInit

Field Detail

WIZARD_ATTRIBUTE_SUFFIX

public static final String WIZARD_ATTRIBUTE_SUFFIX

BaseWizardAPIImpl WIZARD_ATTRIBUTE_SUFFIX.

See Also:

Constant Field Values

ALLOWED_WIZARD_STEP_COMMANDS_ATTRIBUTE

public static final String ALLOWED_WIZARD_STEP_COMMANDS_ATTRIBUTE

Attribute which holds allowed wizard step commands.

See Also:

Constant Field Values

Constructor Detail

BaseWizardAPIImpl

public BaseWizardAPIImpl()

Method Detail

init

public void init()
          throws net.anotheria.anoplass.api.APIInitException

Specified by:

init in interface net.anotheria.anoplass.api.API

Overrides:

init in class net.anotheria.anoplass.api.AbstractAPIImpl

Throws:

net.anotheria.anoplass.api.APIInitException

getWizardByName

public WizardAO getWizardByName(String wizardName)
                         throws WizardAPIException

Description copied from interface: WizardAPI

Returns wizard with selected name.

Specified by:

getWizardByName in interface WizardAPI

Parameters:

wizardName - name of wizard

Returns:

WizardAO

Throws:

WizardAPIException - on errors WizardNotFoundException - if wizard not found

getWizard

public WizardAO getWizard(String wizardId)
                   throws WizardAPIException

Description copied from interface: WizardAPI

Returns wizard with selected id.

Specified by:

getWizard in interface WizardAPI

Parameters:

wizardId - wizard id

Returns:

WizardAO

Throws:

WizardAPIException - on errors , WizardNotFoundException - if wizard not found

getCurrentStepPageId

public String getCurrentStepPageId(String wizardId)
                            throws WizardAPIException

Description copied from interface: WizardAPI

Return id of current step page.

Specified by:

getCurrentStepPageId in interface WizardAPI

Parameters:

wizardId - id of wizard

Returns:

string id of step

Throws:

WizardAPIException - on errors

getCurrentStep

public WizardStepAO getCurrentStep(String wizardId)
                            throws WizardAPIException

Description copied from interface: WizardAPI

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

Specified by:

getCurrentStep in interface WizardAPI

Parameters:

wizardId - id of wizard

Returns:

WizardStepAO

Throws:

WizardAPIException - on errors

getCompletedSteps

public List<WizardStepAO> getCompletedSteps(String wizardId)
                                     throws WizardAPIException

Description copied from interface: WizardAPI

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

Specified by:

getCompletedSteps in interface WizardAPI

Parameters:

wizardId - id of wizard

Returns:

WizardStepAO collection

Throws:

WizardAPIException - on errors

adjustToNextStep

public WizardStepAO adjustToNextStep(String wizardId)
                              throws WizardAPIException

Description copied from interface: WizardAPI

Adjusting to next step.

Specified by:

adjustToNextStep in interface WizardAPI

Parameters:

wizardId - id

Returns:

WizardStepAO

Throws:

WizardAPIException - on errors

adjustToPreviousStep

public WizardStepAO adjustToPreviousStep(String wizardId)
                                  throws WizardAPIException

Description copied from interface: WizardAPI

Adjusting to previous step.

Specified by:

adjustToPreviousStep in interface WizardAPI

Parameters:

wizardId - id

Returns:

WizardStepAO

Throws:

WizardAPIException - on errors

adjustToStep

public WizardStepAO adjustToStep(String wizardId,
                                 int stepIndex)
                          throws WizardAPIException

Description copied from interface: WizardAPI

Adjusting to step.

Specified by:

adjustToStep in interface WizardAPI

Parameters:

wizardId - id of wizard

stepIndex - step of step

Returns:

WizardStepAO

Throws:

WizardAPIException - on errors

finishWizard

public boolean finishWizard(WizardAO wizard)
                     throws WizardAPIException

Description copied from interface: WizardAPI

Finish wizard.

Specified by:

finishWizard in interface WizardAPI

Parameters:

wizard - WizardAO

Returns:

true if wizard finished, false otherwise

Throws:

WizardAPIException - on errors

cancelWizard

public boolean cancelWizard(WizardAO wizard)
                     throws WizardAPIException

Description copied from interface: WizardAPI

Cancel wizard.

Specified by:

cancelWizard in interface WizardAPI

Parameters:

wizard - WizardAO

Returns:

true if wizard canceled, false otherwise

Throws:

WizardAPIException - TODO dummy comment for javadoc.

allowNextStepNavigation

public void allowNextStepNavigation(WizardAO wizard,
                                    WizardStepAO wizardStep)

Description copied from interface: WizardAPI

Allow next step.

Specified by:

allowNextStepNavigation in interface WizardAPI

Parameters:

wizard - WizardAO

wizardStep - WizardStepAO

allowPreviousStepNavigation

public void allowPreviousStepNavigation(WizardAO wizard,
                                        WizardStepAO wizardStep)

Description copied from interface: WizardAPI

Allow previous step.

Specified by:

allowPreviousStepNavigation in interface WizardAPI

Parameters:

wizard - WizardAO

wizardStep - WizardStepAO

allowWizardCancel

public void allowWizardCancel(WizardAO wizard,
                              WizardStepAO wizardStep)

Description copied from interface: WizardAPI

Allow wizard cancel step.

Specified by:

allowWizardCancel in interface WizardAPI

Parameters:

wizard - WizardAO

wizardStep - WizardStepAO

allowWizardFinish

public void allowWizardFinish(WizardAO wizard,
                              WizardStepAO wizardStep)

Description copied from interface: WizardAPI

Allow wizard finish step.

Specified by:

allowWizardFinish in interface WizardAPI

Parameters:

wizard - WizardAO

wizardStep - WizardStepAO

allowWizardNavigateTo

public void allowWizardNavigateTo(WizardAO wizard,
                                  WizardStepAO wizardStep)

Description copied from interface: WizardAPI

Allow navigate To command.

Specified by:

allowWizardNavigateTo in interface WizardAPI

Parameters:

wizard - WizardAO

wizardStep - WizardStepAO