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.APIWizardAPI interface.- Author:
- h3ll
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description WizardStepAOadjustToNextStep(String wizardId)Adjusting to next step.WizardStepAOadjustToPreviousStep(String wizardId)Adjusting to previous step.WizardStepAOadjustToStep(String wizardId, int stepIndex)Adjusting to step.voidallowNextStepNavigation(WizardAO wizard, WizardStepAO wizardStep)Allow next step.voidallowPreviousStepNavigation(WizardAO wizard, WizardStepAO wizardStep)Allow previous step.voidallowWizardCancel(WizardAO wizard, WizardStepAO wizardStep)Allow wizard cancel step.voidallowWizardFinish(WizardAO wizard, WizardStepAO wizardStep)Allow wizard finish step.voidallowWizardNavigateTo(WizardAO wizard, WizardStepAO wizardStep)Allow navigate To command.booleancancelWizard(WizardAO wizard)Cancel wizard.booleanfinishWizard(WizardAO wizard)Finish wizard.List<WizardStepAO>getCompletedSteps(String wizardId)Returns collection off steps which were already completed (passed).WizardStepAOgetCurrentStep(String wizardId)Returns current step for wizard.StringgetCurrentStepPageId(String wizardId)Return id of current step page.WizardAOgetWizard(String wizardId)Returns wizard with selected id.WizardAOgetWizardByName(String wizardName)Returns wizard with selected name.
-
-
-
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:
WizardStepAOcollection- 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 wizardstepIndex- 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-WizardAOwizardStep-WizardStepAO
-
allowPreviousStepNavigation
void allowPreviousStepNavigation(WizardAO wizard, WizardStepAO wizardStep)
Allow previous step.- Parameters:
wizard-WizardAOwizardStep-WizardStepAO
-
allowWizardCancel
void allowWizardCancel(WizardAO wizard, WizardStepAO wizardStep)
Allow wizard cancel step.- Parameters:
wizard-WizardAOwizardStep-WizardStepAO
-
allowWizardFinish
void allowWizardFinish(WizardAO wizard, WizardStepAO wizardStep)
Allow wizard finish step.- Parameters:
wizard-WizardAOwizardStep-WizardStepAO
-
allowWizardNavigateTo
void allowWizardNavigateTo(WizardAO wizard, WizardStepAO wizardStep)
Allow navigate To command.- Parameters:
wizard-WizardAOwizardStep-WizardStepAO
-
-