IUseCase

All Superinterfaces:

com.arcway.cockpit.docgen.provider.interfaces.ICockpitData, com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess, com.arcway.cockpit.docgen.provider.interfaces.IGraphic, com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData
```
public interface IUseCase
extends com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData, com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess, com.arcway.cockpit.docgen.provider.interfaces.IGraphic
```
The IUseCase object allows to read attribute values of a use case from the COCKPIT use case module. Starting with this object, you can get references to the scenarios associated with the use case and the goals to be achieved by the use case.
Item type constant: "ucm.useCase"

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAuthor()` Returns the author of the use case.
`IUseCaseCategory`	`getCategory()` Returns the category of the use case.
`java.lang.String`	`getCreationDate()` Returns the creation date of the use case.
`java.util.List<? extends IScenario>`	`getExtendedScenarios()` Returns the scenarios which are extended by this use case.
`java.util.List<? extends IScenario>`	`getExtendedScenarios(java.lang.String sortingProperty)` Returns the scenarios which are extended by this use case.
`java.util.List<? extends IExtension>`	`getExtensions()` Returns all extensions of the use case.
`java.util.List<? extends IScenario>`	`getExtensionScenarios()` Returns all extension scenarios of the use case, i.e. the immediate extensions of the main scenario.
`java.util.List<? extends IScenario>`	`getExtensionScenarios(java.lang.String sortingProperty)` Returns all extension scenarios of the use case, i.e. the immediate extensions of the main scenario.
`java.util.List<? extends IUseCase>`	`getExtensionUseCases()` Returns all extension use cases of the use case, i.e. the immediate extensions of the main scenario.
`java.util.List<? extends IUseCase>`	`getExtensionUseCases(int sortingCriterion)` Returns all extension use cases of the use case, i.e. the immediate extensions of the main scenario.
`java.util.List<? extends IUseCase>`	`getExtensionUseCases(java.lang.String sortingProperty)` Returns all extension use cases of the use case, i.e. the immediate extensions of the main scenario.
`java.util.List<IGoal>`	`getGoals()` Returns the goals to be achieved with the use case.
`java.lang.String`	`getId()` Returns the id of the use case.
`java.lang.String`	`getInitiator()` Returns the initiator of the use case, i.e. the person who first came up with the idea for the use case or who demanded the use case.
`java.lang.String`	`getLevel()` Returns the level (of abstraction) of the use case.
`java.util.List<? extends com.arcway.cockpit.docgen.provider.interfaces.IModelElement>`	`getLinkedUniqueElements()` Returns a list with the linked unique elements or an empty list if non exists.
`java.lang.String`	`getMainActor()` Returns the main actor of the use case.
`IScenario`	`getMainScenario()` Returns the main scenario of the use case.
`java.lang.String`	`getName()` Returns the name of the use case.
`java.util.List<java.lang.String>`	`getNotes()` Returns the notes recorded for the use case.
`java.lang.String`	`getPriority()` Returns the priority of the use case.
`java.util.List<java.lang.String>`	`getScope()` Returns the scope of the use case.
`java.lang.String`	`getState()` Returns the state of the use case.
`java.lang.String`	`getUniqueIdentifier()` Returns a unique identifier that uniquely identifies this object within its project.
`boolean`	`hasExtensionScenarios()` Checks whether the use case has extension scenarios.
`boolean`	`hasExtensionUseCases()` Checks whether the use case has extension use cases.
`boolean`	`isExtensionUseCase()` Checks whether the use case is an extension of one or several scenarios.
`boolean`	`isLinkedWithUniqueElements()` Returns whether the action step is linked with unique elements.
`com.arcway.cockpit.docgen.provider.interfaces.IRecord`	`toRecord()` Converts this generic module data into a record.

Methods inherited from interface com.arcway.cockpit.docgen.provider.interfaces.IGraphic
getImage, getPNGFile, getSVGFile, getWMFFile

Methods inherited from interface com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess
getCategoryID, getCategoryLabel, getDateTimeProperty_MilliSecondsSince_01_01_1970, getFileProperty, getFileProperty, getFilePropertyAsBase64StringList, getFilePropertyAsFileName, getFilePropertyAsFileName, getFilePropertyAsRawStringList, getFilePropertyAsStringList, getPropertyAsString, getPropertyAsStringArray, getPropertyAsStringList, hasCustomPropertyValues, hasDefaultCategory, hasPropertyValue, readImageInfoOfFileProperty

Methods inherited from interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitData
getCommitVersion, getCreationDate_MilliSecondsSince_01_01_1970, getCreator, getDateOfLastModification_MilliSecondsSince_01_01_1970, getDateOfLastModification, getDisplayName, getLastModifier, getModificationCount, getProjectUniqueIdentifier, getTypeID, getTypeName, toRecord

- Method Detail
  - getUniqueIdentifier
```
java.lang.String getUniqueIdentifier()
```
    Returns a unique identifier that uniquely identifies this object within its project.
    
    Specified by:
    
    getUniqueIdentifier in interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitData
    
    Returns:
    
    unique identifier
  - getAuthor
```
java.lang.String getAuthor()
```
    Returns the author of the use case.
    
    Returns:
    
    the author
  - getCreationDate
```
java.lang.String getCreationDate()
```
    Returns the creation date of the use case.
    
    Specified by:
    
    getCreationDate in interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitData
    
    Returns:
    
    the creation date
  - getId
```
java.lang.String getId()
```
    Returns the id of the use case.
    
    Returns:
    
    the id
  - getName
```
java.lang.String getName()
```
    Returns the name of the use case.
    
    Returns:
    
    the name
  - getInitiator
```
java.lang.String getInitiator()
```
    Returns the initiator of the use case, i.e. the person who first came up with the idea for the use case or who demanded the use case.
    
    Returns:
    
    the initiator
  - getPriority
```
java.lang.String getPriority()
```
    Returns the priority of the use case. The priority is a natural language word like "high"/"medium"/"low". The priority is returned in the language in which Cockpit is operating.
    
    Returns:
    
    the priority
  - getMainActor
```
java.lang.String getMainActor()
```
    Returns the main actor of the use case.
    
    Returns:
    
    the main actor
  - getScope
```
java.util.List<java.lang.String> getScope()
```
    Returns the scope of the use case. If the scope consists of multiple paragraphs (ENTER) each paragraph is represented by an element in the String array.
    
    Returns:
    
    the scope as array of paragraphs
  - getLevel
```
java.lang.String getLevel()
```
    Returns the level (of abstraction) of the use case.
    
    Returns:
    
    the level
  - getState
```
java.lang.String getState()
```
    Returns the state of the use case. The state is a natural language word like "initial"/"accepted". The state is returned in the language in which Cockpit is operating.
    
    Returns:
    
    the state
  - getNotes
```
java.util.List<java.lang.String> getNotes()
```
    Returns the notes recorded for the use case. If the notes consist of multiple paragraphs (ENTER) each paragraph is represented by an element in the String array.
    
    Returns:
    
    the notes as array of paragraphs
  - getGoals
```
java.util.List<IGoal> getGoals()
```
    Returns the goals to be achieved with the use case.
    The first goal returned is the main actors goal if it exists.
    
    Returns:
    
    an array containing all goals
  - getCategory
```
IUseCaseCategory getCategory()
```
    Returns the category of the use case.
    
    Returns:
    
    the category
  - getMainScenario
```
IScenario getMainScenario()
```
    Returns the main scenario of the use case.
    
    Returns:
    
    the main scenario
  - hasExtensionScenarios
```
boolean hasExtensionScenarios()
```
    Checks whether the use case has extension scenarios.
    
    Returns:
    
    true, if extension scenarios exist, false otherwise
  - getExtensionScenarios
```
java.util.List<? extends IScenario> getExtensionScenarios()
```
    Returns all extension scenarios of the use case, i.e. the immediate extensions of the main scenario.
    The scenarios are sorted by id.
    
    Returns:
    
    array containing the extension scenarios
  - getExtensionScenarios
```
java.util.List<? extends IScenario> getExtensionScenarios(java.lang.String sortingProperty)
```
    Returns all extension scenarios of the use case, i.e. the immediate extensions of the main scenario.
    
    Parameters:
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting.
    
    Returns:
    
    array containing the extension scenarios
  - hasExtensionUseCases
```
boolean hasExtensionUseCases()
```
    Checks whether the use case has extension use cases.
    
    Returns:
    
    true, if extension use cases exist, false otherwise
  - getExtensionUseCases
```
java.util.List<? extends IUseCase> getExtensionUseCases()
```
    Returns all extension use cases of the use case, i.e. the immediate extensions of the main scenario.
    The use cases are sorted by id.
    
    Returns:
    
    array containing the extension use cases
  - getExtensionUseCases
```
java.util.List<? extends IUseCase> getExtensionUseCases(int sortingCriterion)
```
    Returns all extension use cases of the use case, i.e. the immediate extensions of the main scenario.
    
    Parameters:
    
    sortingCriterion - specifies the criterion for sorting. Use the integer constants in IUseCaseDataProvider.
    
    Returns:
    
    array containing the extension use cases
  - getExtensionUseCases
```
java.util.List<? extends IUseCase> getExtensionUseCases(java.lang.String sortingProperty)
```
    Returns all extension use cases of the use case, i.e. the immediate extensions of the main scenario.
    
    Parameters:
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting.
    
    Returns:
    
    array containing the extension use cases
  - isExtensionUseCase
```
boolean isExtensionUseCase()
```
    Checks whether the use case is an extension of one or several scenarios.
    
    Returns:
    
    true, if the use case is an extension of one or several scenarios, false otherwise
  - getExtendedScenarios
```
java.util.List<? extends IScenario> getExtendedScenarios()
```
    Returns the scenarios which are extended by this use case.
    
    Returns:
    
    array containing the extended scenarios
  - getExtensions
```
java.util.List<? extends IExtension> getExtensions()
```
    Returns all extensions of the use case. An extension represents one occurrrence of this use case extending a scenario. An extension object encapsulates the extended scenario and the action steps at which the use case begins and ends.
    
    Returns:
    
    array containing the extensions
  - getExtendedScenarios
```
java.util.List<? extends IScenario> getExtendedScenarios(java.lang.String sortingProperty)
```
    Returns the scenarios which are extended by this use case.
    
    Parameters:
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting.
    
    Returns:
    
    array containing the extended scenarios
  - isLinkedWithUniqueElements
```
boolean isLinkedWithUniqueElements()
```
    Returns whether the action step is linked with unique elements.
    
    Returns:
    
    whether the action step is linked to unique elements
  - getLinkedUniqueElements
```
java.util.List<? extends com.arcway.cockpit.docgen.provider.interfaces.IModelElement> getLinkedUniqueElements()
```
    Returns a list with the linked unique elements or an empty list if non exists.
    
    Returns:
    
    a list with the linked unique elements
  - toRecord
```
com.arcway.cockpit.docgen.provider.interfaces.IRecord toRecord()
```
    Converts this generic module data into a record.
    In addition to all fields documented at ICustomPropertiesAccess.toRecord(), in the created record, the following fields are filled accoring to the wrapped cockpit data:
    - IRecord.NAME_KEY
    - IRecord.ID_KEY
    Specified by:
    
    toRecord in interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitData
    
    Specified by:
    
    toRecord in interface com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess
    
    Returns:
    
    converted cockpit project data

Interface IUseCase

Method Summary

Methods inherited from interface com.arcway.cockpit.docgen.provider.interfaces.IGraphic

Methods inherited from interface com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess

Methods inherited from interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitData

Method Detail

getUniqueIdentifier

getAuthor

getCreationDate

getId

getName

getInitiator

getPriority

getMainActor

getScope

getLevel

getState

getNotes

getGoals

getCategory

getMainScenario

hasExtensionScenarios

getExtensionScenarios

getExtensionScenarios

hasExtensionUseCases

getExtensionUseCases

getExtensionUseCases

getExtensionUseCases

isExtensionUseCase

getExtendedScenarios

getExtensions

getExtendedScenarios

isLinkedWithUniqueElements

getLinkedUniqueElements

toRecord