org.pietschy.wizard.models
Interface Path

All Known Implementing Classes:
AbstractPath, BranchingPath, SimplePath, UpdatePath

public interface Path


Method Summary
 void acceptVisitor(PathVisitor visitor)
           
 void addStep(WizardStep step)
          Adds a wizard step to this path.
 boolean contains(WizardStep step)
           
 WizardStep firstStep()
           
 java.util.ArrayList getSteps()
           
 boolean isFirstStep(WizardStep step)
          Checks if the specified step is the first step in the path.
 boolean isLastStep(WizardStep step)
          Checks if the specified step is the last step in the path.
 WizardStep lastStep()
           
 WizardStep nextStep(WizardStep currentStep)
           
 WizardStep previousStep(WizardStep currentStep)
           
 

Method Detail

addStep

void addStep(WizardStep step)
Adds a wizard step to this path. Paths must contain at least one step, and the steps will be traversed in the order they are added.

Parameters:
step - the next WizardStep in the path.

firstStep

WizardStep firstStep()

nextStep

WizardStep nextStep(WizardStep currentStep)

previousStep

WizardStep previousStep(WizardStep currentStep)

lastStep

WizardStep lastStep()

isFirstStep

boolean isFirstStep(WizardStep step)
Checks if the specified step is the first step in the path.

Parameters:
step - the step to check
Returns:
true if the step is the first in the path, false otherwise.

isLastStep

boolean isLastStep(WizardStep step)
Checks if the specified step is the last step in the path.

Parameters:
step - the step to check
Returns:
true if the step is the last in the path, false otherwise.

getSteps

java.util.ArrayList getSteps()

contains

boolean contains(WizardStep step)

acceptVisitor

void acceptVisitor(PathVisitor visitor)