org.ucworkbench.model.usecase
Interface IScenarioItem

All Superinterfaces:
IIdentifiable, INumberable, INumberableScenarioable, IRegion, IScenarioable, ITextModel, ITitleable, IUCElement, IUseCaseElement
All Known Subinterfaces:
IExtension, IStep

public interface IScenarioItem
extends IUseCaseElement, ITitleable, INumberableScenarioable, IIdentifiable

This is a general interface for elements belonging to scenario. Each scenario item consists of a number and title. Each item can also have assigned adornments, that keep some item properties outside the text (e.g. UID, screen name)


Field Summary
static java.lang.String SCREEN
           
 
Method Summary
 org.ucworkbench.model.usecase.adornments.StepAdornments getAdornments()
          Returns adornments for this step.
 IScenarioItem getParentScenarioItem()
          Returns parent scenario item.
 IScreen getScreen()
          Returns the screen object.
 java.util.UUID getUUID()
          Returns a globally unique identifier of the step.
 IWhitespace getWhitespaceBeforeNumber()
          Returns whitespace that occurs before number.
 void saveAdornments()
          Saves the changes to the adornments
 
Methods inherited from interface org.ucworkbench.model.usecase.IUseCaseElement
getUseCase
 
Methods inherited from interface org.ucworkbench.model.usecase.supporting.ITitleable
getTitle, setTitle
 
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
 
Methods inherited from interface org.ucworkbench.model.usecase.supporting.INumberable
getNumber, setNumber
 
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
 
Methods inherited from interface org.ucworkbench.model.usecase.supporting.IScenarioable
getScenario, setScenario
 
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
 
Methods inherited from interface org.ucworkbench.model.IIdentifiable
getID
 

Field Detail

SCREEN

static final java.lang.String SCREEN
See Also:
Constant Field Values
Method Detail

getAdornments

org.ucworkbench.model.usecase.adornments.StepAdornments getAdornments()
Returns adornments for this step.

Returns:

saveAdornments

void saveAdornments()
Saves the changes to the adornments


getWhitespaceBeforeNumber

IWhitespace getWhitespaceBeforeNumber()
Returns whitespace that occurs before number.

Returns:

getParentScenarioItem

IScenarioItem getParentScenarioItem()
Returns parent scenario item.

Returns:
null if parent is not an object of IScenarioItem type.

getScreen

IScreen getScreen()
Returns the screen object. The name is relative to Screens folder in UCProject.

Returns:

getUUID

java.util.UUID getUUID()
Returns a globally unique identifier of the step.

Returns: