org.ucworkbench.model.usecase
Interface IUseCase

All Superinterfaces:
IFileModel, IIdentifiable, IRegion, IScenarioable, ITextModel, IUCElement, IUseCaseElement

public interface IUseCase
extends IFileModel, IScenarioable, IUseCaseElement, IIdentifiable


Field Summary
static java.lang.String FILE_EXTENSION
           
static java.lang.String LEVEL_BUSINESS
           
static java.lang.String LEVEL_SUBFUNCTION
           
static java.lang.String LEVEL_USER
           
 
Method Summary
 void connectTestCase(TestCase tc)
          Connects the given test case to the use case, ie. adds the test case to the buffer of all test cases containing steps from the use case.
 void disconnectTestCase(TestCase tc)
          Disconnects the given test case from the use case, ie. removes the test case from the buffer of all test cases containing steps from the use case.
 IStepAdornmentRepository getAdornmentsRepository()
          Returns the adornments repository connected to this use case.
 java.util.Set<TestCase> getCorrespondingTestCases()
          Returns all test cases, which contains steps of this use case.
 java.util.List<IExtension> getExtensions()
          Returns a list of all extensions in this use case.
 java.lang.String getLevel()
          Returns the level of current use case.
 IMainScenario getMainScenario()
          Returns an object representing main scenario.
 IActor getPrimaryActor()
          Returns the model object for primary actor declared in the use case.
 java.lang.String getPrimaryActorName()
          Returns the name of the primary actor.
 IScenarioItem getScenarioItemByNumber(java.lang.String number)
          Returns a step, by given number (also returns extensions by number)
 IScenarioItem getScenarioItemByUUID(java.util.UUID uuid)
          Returns the step in the use case, having uuid equal to the given uuid
 java.util.Collection<IScenarioItem> getScenarioItems()
          Returns the flat collection of all steps in the scenario (including all substeps, and extensions).
 java.util.List<java.lang.String> getSecondaryActorNames()
          Returns a list of names for secondary actors.
 java.util.List<IActor> getSecondaryActors()
          Returns a set of model objects representing secondary actors declared in the use case.
 IScenarioItem getStepByNumber(java.lang.String number)
          Returns
 ITextWithReferences getSummary()
          Returns the summary object for this use case.
 java.lang.String getTitle()
          Returns the title of the use case.
 
Methods inherited from interface org.ucworkbench.model.IFileModel
getAliases, getContentAssistantPropositions, getPropertiesSection, getPropertyValue
 
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
 
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.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.usecase.IUseCaseElement
getUseCase
 

Field Detail

LEVEL_SUBFUNCTION

static final java.lang.String LEVEL_SUBFUNCTION
See Also:
Constant Field Values

LEVEL_USER

static final java.lang.String LEVEL_USER
See Also:
Constant Field Values

LEVEL_BUSINESS

static final java.lang.String LEVEL_BUSINESS
See Also:
Constant Field Values

FILE_EXTENSION

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

getLevel

java.lang.String getLevel()
Returns the level of current use case. See constants in this interface.

Returns:

getPrimaryActor

IActor getPrimaryActor()
Returns the model object for primary actor declared in the use case.

Returns:

getPrimaryActorName

java.lang.String getPrimaryActorName()
Returns the name of the primary actor.

Returns:

getSecondaryActors

java.util.List<IActor> getSecondaryActors()
Returns a set of model objects representing secondary actors declared in the use case.

Returns:

getSecondaryActorNames

java.util.List<java.lang.String> getSecondaryActorNames()
Returns a list of names for secondary actors.

Returns:

getTitle

java.lang.String getTitle()
Returns the title of the use case.

Returns:

getScenarioItems

java.util.Collection<IScenarioItem> getScenarioItems()
Returns the flat collection of all steps in the scenario (including all substeps, and extensions). If you want to get hierarchical access to steps, check

Returns:

getScenarioItemByNumber

IScenarioItem getScenarioItemByNumber(java.lang.String number)
Returns a step, by given number (also returns extensions by number)

Parameters:
number -
Returns:
null if there is no step with given number

getExtensions

java.util.List<IExtension> getExtensions()
Returns a list of all extensions in this use case.

Returns:

getMainScenario

IMainScenario getMainScenario()
Returns an object representing main scenario.

Returns:

getSummary

ITextWithReferences getSummary()
Returns the summary object for this use case.

Returns:

getAdornmentsRepository

IStepAdornmentRepository getAdornmentsRepository()
Returns the adornments repository connected to this use case. It holds additional data for each steps.

Returns:

getStepByNumber

IScenarioItem getStepByNumber(java.lang.String number)
Returns

Parameters:
number -
Returns:

getScenarioItemByUUID

IScenarioItem getScenarioItemByUUID(java.util.UUID uuid)
Returns the step in the use case, having uuid equal to the given uuid

Parameters:
uuid -
Returns:

getCorrespondingTestCases

java.util.Set<TestCase> getCorrespondingTestCases()
Returns all test cases, which contains steps of this use case.

Returns:

connectTestCase

void connectTestCase(TestCase tc)
Connects the given test case to the use case, ie. adds the test case to the buffer of all test cases containing steps from the use case.

Parameters:
tc -

disconnectTestCase

void disconnectTestCase(TestCase tc)
Disconnects the given test case from the use case, ie. removes the test case from the buffer of all test cases containing steps from the use case.

Parameters:
tc -