org.ucworkbench.model.usecase
Interface IScenario

All Superinterfaces:
IRegion, ITextModel, IUCElement
All Known Subinterfaces:
IMainScenario

public interface IScenario
extends ITextModel


Method Summary
 IStep getFirstStep()
          Returns the first step of the scenario
 IStep getLastStep()
          Returns the last step of the scenario
 IStep getNextStep(IStep currentStep)
          Returns the next step at this level in the use case after the step given as the parameter.
 IStep getPreviousStep(IStep currentStep)
          Returns the previous step at this level in the use case after the step given as the parameter.
 java.util.List<org.ucworkbench.model.usecase.impl.Step> getSteps()
          Returns a list of steps ordered the same as they are in the file
 
Methods inherited from interface org.ucworkbench.model.ITextModel
containsOffset, getAsText, getCorrespondingFileModel, getModelElementByOffset, getParent, getTextModelChildren
 
Methods inherited from interface org.ucworkbench.model.IUCElement
accept, childrenAccept, exists, getAncestor, getChildren, getCorrespondingResource, getElementName, getElementType, getPath, getUCProject, getUnderlyingResource
 
Methods inherited from interface org.ucworkbench.model.supporting.IRegion
getLength, getOffset
 

Method Detail

getSteps

java.util.List<org.ucworkbench.model.usecase.impl.Step> getSteps()
Returns a list of steps ordered the same as they are in the file

Returns:

getFirstStep

IStep getFirstStep()
Returns the first step of the scenario

Returns:
null in case scenario is empty

getLastStep

IStep getLastStep()
Returns the last step of the scenario

Returns:
null in case scenario is empty

getNextStep

IStep getNextStep(IStep currentStep)
Returns the next step at this level in the use case after the step given as the parameter.

Parameters:
currentStep -
Returns:
null if the current step is the last one in this scenario

getPreviousStep

IStep getPreviousStep(IStep currentStep)
Returns the previous step at this level in the use case after the step given as the parameter.

Parameters:
currentStep -
Returns:
null if the current step is the first one in this scenario