IUseCase

All Superinterfaces:

IHasChildrenBaseModelElement, IModelElement, IModelElementParent
```
public interface IUseCase
extends IHasChildrenBaseModelElement
```

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`PROP_ABSTRACT`
`static java.lang.String`	`PROP_ALTERNATIVE_USE_CASE_DESCRIPTIONS`
`static java.lang.String`	`PROP_ANALYSIS_ITEM_DIAGRAM_IDS`
`static java.lang.String`	`PROP_ANALYSIS_ITEM_MODELS`
`static java.lang.String`	`PROP_BUSINESS_MODEL`
`static java.lang.String`	`PROP_CONTEXT`
`static java.lang.String`	`PROP_CONTEXT_NAME`
`static java.lang.String`	`PROP_DESC_NAME_COLUMN_WIDTH`
`static java.lang.String`	`PROP_DESC_VALUE_COLUMN_WIDTH`
`static java.lang.String`	`PROP_HUMAN_RESOURCES`
`static java.lang.String`	`PROP_JUSTIFICATION`
`static java.lang.String`	`PROP_LEAF`
`static java.lang.String`	`PROP_POST_CONDITIONS`
`static java.lang.String`	`PROP_PRE_CONDITIONS`
`static java.lang.String`	`PROP_PRIMARY_ACTORS`
`static java.lang.String`	`PROP_QUALITY_REASON`
`static java.lang.String`	`PROP_QUALITY_SCORE`
`static java.lang.String`	`PROP_REQUIREMENTS`
`static java.lang.String`	`PROP_ROOT`
`static java.lang.String`	`PROP_SCHEDULE_ROW_HEIGHT`
`static java.lang.String`	`PROP_STATUS`
`static java.lang.String`	`PROP_STEP_CONTAINERS`
`static java.lang.String`	`PROP_STEREOTYPES`
`static java.lang.String`	`PROP_SUPPORTING_ACTORS`
`static java.lang.String`	`PROP_SYNC_MAPPING_MODELS`
`static java.lang.String`	`PROP_TAGGED_VALUES`
`static java.lang.String`	`PROP_TASK_POOL_ID`
`static java.lang.String`	`PROP_TASK_POOL_NAME`
`static java.lang.String`	`PROP_TEMPLATE_NAME`
`static java.lang.String`	`PROP_TESTING_CONFIG`
`static java.lang.String`	`PROP_TESTING_SETUP`
`static java.lang.String`	`PROP_UC_RANK`
`static java.lang.String`	`PROP_USE_CASE_DESCRIPTION`
`static java.lang.String`	`PROP_USE_CASE_DESCRIPTION_DIAGRAM_ID`
`static java.lang.String`	`PROP_USE_CASE_NOTES`
`static int`	`STATUS_COMPLETE`
`static int`	`STATUS_CONSENT`
`static int`	`STATUS_DESIGN`
`static int`	`STATUS_DEVELOP`
`static int`	`STATUS_DISCUSS`
`static int`	`STATUS_ELABORATE`
`static int`	`STATUS_IDENTIFY`
`static int`	`UC_RANK_HIGH`
`static int`	`UC_RANK_LOW`
`static int`	`UC_RANK_MEDIUM`
`static int`	`UC_RANK_UNSPECIFIED`

Fields inherited from interface com.vp.plugin.model.IModelElement
MODEL_QUALITY_SCORE_IGNORE, MODEL_QUALITY_SCORE_RECALCULATE, PROP_NAME

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addAlternativeUseCaseDescription(IUseCaseDescriptionItemContainer alternativeUseCaseDescription)`
`void`	`addAnalysisItemModel(IModelElement analysisItemModel)`
`void`	`addContext(IUseCase context)`
`void`	`addHumanResource(ITasifierMember humanResource)`
`void`	`addPrimaryActor(IActor primaryActor)`
`void`	`addRequirement(IRequirement requirement)`
`void`	`addStepContainer(IStepContainer stepContainer)`
`void`	`addStereotype(IStereotype stereotype)` Add a stereotype `IStereotype` into this model element.
`void`	`addStereotype(java.lang.String name)` Add a stereotype into this model element.
`void`	`addStereotypes(java.lang.String name)` Deprecated. Replaced by addStereotype
`void`	`addSupportingActor(IActor supportingActor)`
`void`	`addSyncMappingModel(IModelElement syncMappingModel)`
`void`	`addUseCaseNote(IUseCaseNote useCaseNote)`
`void`	`addUserStory(IUserStory child)`
`int`	`alternativeUseCaseDescriptionCount()`
`java.util.Iterator`	`alternativeUseCaseDescriptionIterator()` Returns an iterator over the model elements `IUseCaseDescriptionItemContainer`.
`int`	`analysisItemModelCount()`
`java.util.Iterator`	`analysisItemModelIterator()` Returns an iterator over the model elements `IModelElement`.
`int`	`contextCount()`
`java.util.Iterator`	`contextIterator()` Returns an iterator over the model elements `IUseCase`.
`IUserStory`	`createUserStory()`
`int`	`fromRelationshipCount()` Number of `ISimpleRelationship` that connect from this model element.
`int`	`fromRelationshipEndCount()` Number of `IRelationshipEnd` that connect from this model element.
`java.util.Iterator`	`fromRelationshipEndIterator()` `IRelationshipEnd`s that connect from this model element.
`java.util.Iterator`	`fromRelationshipIterator()` `ISimpleRelationship`s that connect from this model element.
`IUseCaseDescriptionItemContainer`	`getAlternativeUseCaseDescriptionByIndex(int index)`
`java.lang.String[]`	`getAnalysisItemDiagramIds()`
`IModelElement`	`getAnalysisItemModelByIndex(int index)`
`IUseCase`	`getContextByIndex(int index)`
`java.lang.String`	`getContextName()`
`ITasifierMember`	`getHumanResourceByIndex(int index)`
`java.lang.String`	`getJustification()`
`java.lang.String`	`getPostConditions()`
`java.lang.String`	`getPreConditions()`
`IActor`	`getPrimaryActorByIndex(int index)`
`java.lang.String`	`getQualityReason()` Quality reason, it is non-readable value for human
`int`	`getQualityScore()` Quality score, it is non-readable value for human
`IRequirement`	`getRequirementByIndex(int index)`
`int`	`getStatus()`
`IStepContainer`	`getStepContainerByIndex(int index)`
`IActor`	`getSupportingActorByIndex(int index)`
`IModelElement`	`getSyncMappingModelByIndex(int index)`
`ITaggedValueContainer`	`getTaggedValues()`
`int`	`getTaskPoolId()`
`java.lang.String`	`getTaskPoolName()`
`java.lang.String`	`getTemplateName()`
`java.lang.String`	`getTestingConfig()`
`java.lang.String`	`getTestingSetup()`
`int`	`getUcRank()`
`IUseCaseDescriptionItemContainer`	`getUseCaseDescription()`
`java.lang.String`	`getUseCaseDescriptionDiagramId()`
`IUseCaseNote`	`getUseCaseNoteByIndex(int index)`
`IUserStory`	`getUserStoryByIndex(int index)`
`IUserStory`	`getUserStoryByName(java.lang.String name)`
`boolean`	`hasStereotype(java.lang.String name)`
`boolean`	`hasStereotypes(java.lang.String name)` Deprecated. Replaced by hasStereotype
`int`	`humanResourceCount()`
`java.util.Iterator`	`humanResourceIterator()` Returns an iterator over the model elements `ITasifierMember`.
`boolean`	`isAbstract()`
`boolean`	`isBusinessModel()`
`boolean`	`isLeaf()`
`boolean`	`isRoot()`
`int`	`primaryActorCount()`
`java.util.Iterator`	`primaryActorIterator()` Returns an iterator over the model elements `IActor`.
`void`	`removeAlternativeUseCaseDescription(IUseCaseDescriptionItemContainer alternativeUseCaseDescription)`
`void`	`removeAlternativeUseCaseDescriptionByIndex(int index)`
`void`	`removeAnalysisItemModel(IModelElement analysisItemModel)`
`void`	`removeAnalysisItemModelByIndex(int index)`
`void`	`removeContext(IUseCase context)`
`void`	`removeContextByIndex(int index)`
`void`	`removeHumanResource(ITasifierMember humanResource)`
`void`	`removeHumanResourceByIndex(int index)`
`void`	`removePrimaryActor(IActor primaryActor)`
`void`	`removePrimaryActorByIndex(int index)`
`void`	`removeRequirement(IRequirement requirement)`
`void`	`removeRequirementByIndex(int index)`
`void`	`removeStepContainer(IStepContainer stepContainer)`
`void`	`removeStepContainerByIndex(int index)`
`void`	`removeStereotype(IStereotype stereotype)` Remove a stereotype `IStereotype` from this model element.
`void`	`removeStereotype(java.lang.String name)` Remove a stereotype from this model element.
`void`	`removeStereotypes(java.lang.String name)` Deprecated. Replaced by removeStereotype
`void`	`removeSupportingActor(IActor supportingActor)`
`void`	`removeSupportingActorByIndex(int index)`
`void`	`removeSyncMappingModel(IModelElement syncMappingModel)`
`void`	`removeSyncMappingModelByIndex(int index)`
`void`	`removeUseCaseNote(IUseCaseNote useCaseNote)`
`void`	`removeUseCaseNoteByIndex(int index)`
`void`	`removeUserStory(IUserStory child)`
`void`	`removeUserStoryByIndex(int index)`
`void`	`reorderUserStory(IUserStory[] childs)`
`int`	`requirementCount()`
`java.util.Iterator`	`requirementIterator()` Returns an iterator over the model elements `IRequirement`.
`void`	`setAbstract(boolean $abstract)`
`void`	`setAnalysisItemDiagramIds(java.lang.String[] analysisItemDiagramIds)`
`void`	`setBusinessModel(boolean businessModel)`
`void`	`setContextName(java.lang.String contextName)`
`void`	`setJustification(java.lang.String justification)`
`void`	`setLeaf(boolean leaf)`
`void`	`setPostConditions(java.lang.String postConditions)`
`void`	`setPreConditions(java.lang.String preConditions)`
`void`	`setQualityReason(java.lang.String qualityReason)`
`void`	`setQualityScore(int qualityScore)`
`void`	`setRoot(boolean root)`
`void`	`setStatus(int status)`
`void`	`setTaggedValues(ITaggedValueContainer taggedValues)`
`void`	`setTaskPoolId(int taskPoolId)`
`void`	`setTaskPoolName(java.lang.String taskPoolName)`
`void`	`setTemplateName(java.lang.String templateName)`
`void`	`setTestingConfig(java.lang.String testingConfig)`
`void`	`setTestingSetup(java.lang.String testingSetup)`
`void`	`setUcRank(int ucRank)`
`void`	`setUseCaseDescription(IUseCaseDescriptionItemContainer useCaseDescription)`
`void`	`setUseCaseDescriptionDiagramId(java.lang.String useCaseDescriptionDiagramId)`
`int`	`stepContainerCount()`
`java.util.Iterator`	`stepContainerIterator()` Returns an iterator over the model elements `IStepContainer`.
`int`	`stereotypeCount()`
`java.util.Iterator`	`stereotypeIterator()` Returns an iterator over the names of the stereotypes.
`java.util.Iterator`	`stereotypeModelIterator()` Returns an iterator over the model elements `IStereotype`.
`int`	`stereotypesCount()` Deprecated. Replaced by stereotypeCount
`java.util.Iterator`	`stereotypesIterator()` Deprecated. Replaced by stereotypeIterator
`java.util.Iterator`	`stereotypesModelIterator()` Deprecated. Replaced by stereotypeModelIterator
`int`	`supportingActorCount()`
`java.util.Iterator`	`supportingActorIterator()` Returns an iterator over the model elements `IActor`.
`int`	`syncMappingModelCount()`
`java.util.Iterator`	`syncMappingModelIterator()` Returns an iterator over the model elements `IModelElement`.
`IUseCaseDescriptionItemContainer[]`	`toAlternativeUseCaseDescriptionArray()`
`IModelElement[]`	`toAnalysisItemModelArray()`
`IUseCase[]`	`toContextArray()`
`ISimpleRelationship[]`	`toFromRelationshipArray()` `ISimpleRelationship`s that connect from this model element.
`IRelationshipEnd[]`	`toFromRelationshipEndArray()` `IRelationshipEnd`s that connect from this model element.
`ITasifierMember[]`	`toHumanResourceArray()`
`IActor[]`	`toPrimaryActorArray()`
`int`	`toRelationshipCount()` Number of `ISimpleRelationship` that connect to this model element.
`int`	`toRelationshipEndCount()` Number of `IRelationshipEnd` that connect to this model element.
`java.util.Iterator`	`toRelationshipEndIterator()` `IRelationshipEnd`s that connect to this model element.
`java.util.Iterator`	`toRelationshipIterator()` `ISimpleRelationship`s that connect to this model element.
`IRequirement[]`	`toRequirementArray()`
`IStepContainer[]`	`toStepContainerArray()` Retrieves the `IStepContainer` of this Use Case.
`java.lang.String[]`	`toStereotypeArray()`
`IStereotype[]`	`toStereotypeModelArray()`
`java.lang.String[]`	`toStereotypesArray()` Deprecated. Replaced by toStereotypeArray
`IStereotype[]`	`toStereotypesModelArray()` Deprecated. Replaced by toStereotypeModelArray
`IActor[]`	`toSupportingActorArray()`
`IModelElement[]`	`toSyncMappingModelArray()`
`ISimpleRelationship[]`	`toToRelationshipArray()` `ISimpleRelationship`s that connect to this model element.
`IRelationshipEnd[]`	`toToRelationshipEndArray()` `IRelationshipEnd`s that connect to this model element.
`IUseCaseNote[]`	`toUseCaseNoteArray()`
`IUserStory[]`	`toUserStoryArray()`
`int`	`useCaseNoteCount()`
`java.util.Iterator`	`useCaseNoteIterator()` Returns an iterator over the model elements `IUseCaseNote`.
`int`	`userStoryCount()`
`java.util.Iterator`	`userStoryIterator()`

Methods inherited from interface com.vp.plugin.model.IHasChildrenBaseModelElement
addComment, addGenericValue, addReference, addVoice, commentCount, commentIterator, genericValueCount, genericValueIterator, getBacklogActivityId, getCommentByIndex, getDescription, getGenericValueByIndex, getHTMLDescription, getHTMLDescription, getPmAuthor, getPmCreateDateTime, getPmDifficulty, getPmDiscipline, getPmIteration, getPmLastModified, getPmPhase, getPmPriority, getPmStatus, getPmVersion, getReferenceByIndex, getReferencedByDiagramIds, getReferencedByModelAddresses, getTransitFrom, getTransitTo, getUserID, getUserIDLastNumericValue, getUserIDParent, getVoiceByIndex, referenceCount, referenceIterator, removeComment, removeCommentByIndex, removeGenericValue, removeGenericValueByIndex, removeReference, removeReferenceByIndex, removeVoice, removeVoiceByIndex, setBacklogActivityId, setDescription, setHTMLDescription, setPmAuthor, setPmCreateDateTime, setPmDifficulty, setPmDiscipline, setPmIteration, setPmLastModified, setPmPhase, setPmPriority, setPmStatus, setPmVersion, setReferencedByDiagramIds, setReferencedByModelAddresses, setTransitFrom, setTransitTo, setUserID, setUserIDLastNumericValue, setUserIDParent, toCommentArray, toGenericValueArray, toReferenceArray, toVoiceArray, voiceCount, voiceIterator

Methods inherited from interface com.vp.plugin.model.IModelElement
addChild, addPropertyChangeListener, addSubDiagram, canModify, childCount, childCount, childCount, childIterator, childIterator, childIterator, constraintsIterator, createChild, delete, disposeTransientModel, duplicate, fromChartRelationshipCount, fromChartRelationshipIterator, getAddress, getChildById, getChildByIndex, getChildByIndex, getChildByName, getChildByName, getDescriptionWithReferenceModels, getDiagramElements, getDisplayQualityScore, getDocumentation, getDocumentationWithReferenceModels, getHTMLDescriptionWithReferenceModels, getHTMLDescriptionWithReferenceModels, getHTMLDocumentation, getHTMLDocumentation, getHTMLDocumentationWithReferenceModels, getHTMLDocumentationWithReferenceModels, getId, getMasterView, getMirrorSource, getModelPropertyByName, getModelQualityDetails, getModelType, getName, getNickDescription, getNickDescriptionWithReferenceModels, getNickDocumentation, getNickDocumentationWithReferenceModels, getNickHTMLDescription, getNickHTMLDescription, getNickHTMLDescriptionWithReferenceModels, getNickHTMLDescriptionWithReferenceModels, getNickHTMLDocumentation, getNickHTMLDocumentation, getNickHTMLDocumentationWithReferenceModels, getNickHTMLDocumentationWithReferenceModels, getNickname, getNickPropertyValue, getParent, getProject, getReferencedBys, getReferencingModels, getSubDiagramAt, indexOfSubDiagram, isMirrorModelElement, isTransientModel, removeChild, removeChildByIndex, removePropertyChangeListener, removeSubDiagram, setDocumentation, setHTMLDocumentation, setName, setNickDescription, setNickDocumentation, setNickHTMLDescription, setNickHTMLDocumentation, setNickname, subDiagramCount, subDiagramIterator, toChartRelationshipCount, toChartRelationshipIterator, toChildArray, toChildArray, toChildArray, toFromChartRelationshipArray, toModelPropertyArray, toPropertiesString, toSubDiagramArray, toToChartRelationshipArray

- Field Detail
  - PROP_ABSTRACT
```
static final java.lang.String PROP_ABSTRACT
```
    See Also:
    Constant Field Values
  - PROP_LEAF
```
static final java.lang.String PROP_LEAF
```
    See Also:
    Constant Field Values
  - PROP_ROOT
```
static final java.lang.String PROP_ROOT
```
    See Also:
    Constant Field Values
  - PROP_STEREOTYPES
```
static final java.lang.String PROP_STEREOTYPES
```
    See Also:
    Constant Field Values
  - PROP_TAGGED_VALUES
```
static final java.lang.String PROP_TAGGED_VALUES
```
    See Also:
    Constant Field Values
  - PROP_SYNC_MAPPING_MODELS
```
static final java.lang.String PROP_SYNC_MAPPING_MODELS
```
    See Also:
    Constant Field Values
  - PROP_ANALYSIS_ITEM_MODELS
```
static final java.lang.String PROP_ANALYSIS_ITEM_MODELS
```
    See Also:
    Constant Field Values
  - PROP_ANALYSIS_ITEM_DIAGRAM_IDS
```
static final java.lang.String PROP_ANALYSIS_ITEM_DIAGRAM_IDS
```
    See Also:
    Constant Field Values
  - PROP_QUALITY_SCORE
```
static final java.lang.String PROP_QUALITY_SCORE
```
    See Also:
    Constant Field Values
  - PROP_QUALITY_REASON
```
static final java.lang.String PROP_QUALITY_REASON
```
    See Also:
    Constant Field Values
  - PROP_TASK_POOL_ID
```
static final java.lang.String PROP_TASK_POOL_ID
```
    See Also:
    Constant Field Values
  - PROP_TASK_POOL_NAME
```
static final java.lang.String PROP_TASK_POOL_NAME
```
    See Also:
    Constant Field Values
  - PROP_HUMAN_RESOURCES
```
static final java.lang.String PROP_HUMAN_RESOURCES
```
    See Also:
    Constant Field Values
  - PROP_USE_CASE_DESCRIPTION_DIAGRAM_ID
```
static final java.lang.String PROP_USE_CASE_DESCRIPTION_DIAGRAM_ID
```
    See Also:
    Constant Field Values
  - PROP_JUSTIFICATION
```
static final java.lang.String PROP_JUSTIFICATION
```
    See Also:
    Constant Field Values
  - PROP_USE_CASE_DESCRIPTION
```
static final java.lang.String PROP_USE_CASE_DESCRIPTION
```
    See Also:
    Constant Field Values
  - PROP_ALTERNATIVE_USE_CASE_DESCRIPTIONS
```
static final java.lang.String PROP_ALTERNATIVE_USE_CASE_DESCRIPTIONS
```
    See Also:
    Constant Field Values
  - PROP_DESC_NAME_COLUMN_WIDTH
```
static final java.lang.String PROP_DESC_NAME_COLUMN_WIDTH
```
    See Also:
    Constant Field Values
  - PROP_DESC_VALUE_COLUMN_WIDTH
```
static final java.lang.String PROP_DESC_VALUE_COLUMN_WIDTH
```
    See Also:
    Constant Field Values
  - PROP_SCHEDULE_ROW_HEIGHT
```
static final java.lang.String PROP_SCHEDULE_ROW_HEIGHT
```
    See Also:
    Constant Field Values
  - PROP_TEMPLATE_NAME
```
static final java.lang.String PROP_TEMPLATE_NAME
```
    See Also:
    Constant Field Values
  - PROP_BUSINESS_MODEL
```
static final java.lang.String PROP_BUSINESS_MODEL
```
    See Also:
    Constant Field Values
  - PROP_PRE_CONDITIONS
```
static final java.lang.String PROP_PRE_CONDITIONS
```
    See Also:
    Constant Field Values
  - PROP_POST_CONDITIONS
```
static final java.lang.String PROP_POST_CONDITIONS
```
    See Also:
    Constant Field Values
  - PROP_TESTING_SETUP
```
static final java.lang.String PROP_TESTING_SETUP
```
    See Also:
    Constant Field Values
  - PROP_TESTING_CONFIG
```
static final java.lang.String PROP_TESTING_CONFIG
```
    See Also:
    Constant Field Values
  - PROP_STEP_CONTAINERS
```
static final java.lang.String PROP_STEP_CONTAINERS
```
    See Also:
    Constant Field Values
  - PROP_REQUIREMENTS
```
static final java.lang.String PROP_REQUIREMENTS
```
    See Also:
    Constant Field Values
  - PROP_PRIMARY_ACTORS
```
static final java.lang.String PROP_PRIMARY_ACTORS
```
    See Also:
    Constant Field Values
  - PROP_SUPPORTING_ACTORS
```
static final java.lang.String PROP_SUPPORTING_ACTORS
```
    See Also:
    Constant Field Values
  - PROP_USE_CASE_NOTES
```
static final java.lang.String PROP_USE_CASE_NOTES
```
    See Also:
    Constant Field Values
  - PROP_STATUS
```
static final java.lang.String PROP_STATUS
```
    See Also:
    Constant Field Values
  - STATUS_IDENTIFY
```
static final int STATUS_IDENTIFY
```
    See Also:
    Constant Field Values
  - STATUS_DISCUSS
```
static final int STATUS_DISCUSS
```
    See Also:
    Constant Field Values
  - STATUS_ELABORATE
```
static final int STATUS_ELABORATE
```
    See Also:
    Constant Field Values
  - STATUS_DESIGN
```
static final int STATUS_DESIGN
```
    See Also:
    Constant Field Values
  - STATUS_CONSENT
```
static final int STATUS_CONSENT
```
    See Also:
    Constant Field Values
  - STATUS_DEVELOP
```
static final int STATUS_DEVELOP
```
    See Also:
    Constant Field Values
  - STATUS_COMPLETE
```
static final int STATUS_COMPLETE
```
    See Also:
    Constant Field Values
  - PROP_UC_RANK
```
static final java.lang.String PROP_UC_RANK
```
    See Also:
    Constant Field Values
  - UC_RANK_UNSPECIFIED
```
static final int UC_RANK_UNSPECIFIED
```
    See Also:
    Constant Field Values
  - UC_RANK_HIGH
```
static final int UC_RANK_HIGH
```
    See Also:
    Constant Field Values
  - UC_RANK_MEDIUM
```
static final int UC_RANK_MEDIUM
```
    See Also:
    Constant Field Values
  - UC_RANK_LOW
```
static final int UC_RANK_LOW
```
    See Also:
    Constant Field Values
  - PROP_CONTEXT_NAME
```
static final java.lang.String PROP_CONTEXT_NAME
```
    See Also:
    Constant Field Values
  - PROP_CONTEXT
```
static final java.lang.String PROP_CONTEXT
```
    See Also:
    Constant Field Values
- Method Detail
  - addUserStory
```
void addUserStory(IUserStory child)
```
  - removeUserStory
```
void removeUserStory(IUserStory child)
```
  - getUserStoryByIndex
```
IUserStory getUserStoryByIndex(int index)
```
  - removeUserStoryByIndex
```
void removeUserStoryByIndex(int index)
```
  - reorderUserStory
```
void reorderUserStory(IUserStory[] childs)
```
  - userStoryCount
```
int userStoryCount()
```
  - userStoryIterator
```
java.util.Iterator userStoryIterator()
```
  - toUserStoryArray
```
IUserStory[] toUserStoryArray()
```
  - createUserStory
```
IUserStory createUserStory()
```
  - getUserStoryByName
```
IUserStory getUserStoryByName(java.lang.String name)
```
  - fromRelationshipCount
```
int fromRelationshipCount()
```
    Number of ISimpleRelationship that connect from this model element. Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445
    
    Specified by:
    
    fromRelationshipCount in interface IModelElement
    
    Returns:
    Number of FROM simple relationships
  - toFromRelationshipArray
```
ISimpleRelationship[] toFromRelationshipArray()
```
    ISimpleRelationships that connect from this model element. Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445
    
    Specified by:
    
    toFromRelationshipArray in interface IModelElement
    
    Returns:
    ISimpleRelationships that connect from this model element
  - fromRelationshipIterator
```
java.util.Iterator fromRelationshipIterator()
```
    ISimpleRelationships that connect from this model element. Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445
    
    Specified by:
    
    fromRelationshipIterator in interface IModelElement
    
    Returns:
    ISimpleRelationships that connect from this model element
  - toRelationshipCount
```
int toRelationshipCount()
```
    Number of ISimpleRelationship that connect to this model element. Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445
    
    Specified by:
    
    toRelationshipCount in interface IModelElement
    
    Returns:
    Number of TO simple relationships
  - toToRelationshipArray
```
ISimpleRelationship[] toToRelationshipArray()
```
    ISimpleRelationships that connect to this model element. Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445
    
    Specified by:
    
    toToRelationshipArray in interface IModelElement
    
    Returns:
    ISimpleRelationships that connect to this model element
  - toRelationshipIterator
```
java.util.Iterator toRelationshipIterator()
```
    ISimpleRelationships that connect to this model element. Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445
    
    Specified by:
    
    toRelationshipIterator in interface IModelElement
    
    Returns:
    ISimpleRelationships that connect to this model element
  - fromRelationshipEndCount
```
int fromRelationshipEndCount()
```
    Number of IRelationshipEnd that connect from this model element. Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445
    
    Specified by:
    
    fromRelationshipEndCount in interface IModelElement
    
    Returns:
    Number of FROM relationship ends
  - toFromRelationshipEndArray
```
IRelationshipEnd[] toFromRelationshipEndArray()
```
    IRelationshipEnds that connect from this model element. Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445
    
    Specified by:
    
    toFromRelationshipEndArray in interface IModelElement
    
    Returns:
    IRelationshipEnds that connect from this model element
  - fromRelationshipEndIterator
```
java.util.Iterator fromRelationshipEndIterator()
```
    IRelationshipEnds that connect from this model element. Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445
    
    Specified by:
    
    fromRelationshipEndIterator in interface IModelElement
    
    Returns:
    IRelationshipEnds that connect from this model element
  - toRelationshipEndCount
```
int toRelationshipEndCount()
```
    Number of IRelationshipEnd that connect to this model element. Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445
    
    Specified by:
    
    toRelationshipEndCount in interface IModelElement
    
    Returns:
    Number of TO relationship ends
  - toToRelationshipEndArray
```
IRelationshipEnd[] toToRelationshipEndArray()
```
    IRelationshipEnds that connect to this model element. Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445
    
    Specified by:
    
    toToRelationshipEndArray in interface IModelElement
    
    Returns:
    IRelationshipEnds that connect to this model element
  - toRelationshipEndIterator
```
java.util.Iterator toRelationshipEndIterator()
```
    IRelationshipEnds that connect to this model element. Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445
    
    Specified by:
    
    toRelationshipEndIterator in interface IModelElement
    
    Returns:
    IRelationshipEnds that connect to this model element
  - setAbstract
```
void setAbstract(boolean $abstract)
```
  - isAbstract
```
boolean isAbstract()
```
  - setLeaf
```
void setLeaf(boolean leaf)
```
  - isLeaf
```
boolean isLeaf()
```
  - setRoot
```
void setRoot(boolean root)
```
  - isRoot
```
boolean isRoot()
```
  - addStereotype
```
void addStereotype(java.lang.String name)
```
    Description copied from interface: IModelElement
    
    Add a stereotype into this model element. If the IStereotype does not existing in current project. It will be auto created.
    
    Specified by:
    
    addStereotype in interface IModelElement
  - removeStereotype
```
void removeStereotype(java.lang.String name)
```
    Description copied from interface: IModelElement
    
    Remove a stereotype from this model element.
    
    Specified by:
    
    removeStereotype in interface IModelElement
  - addStereotype
```
void addStereotype(IStereotype stereotype)
```
    Add a stereotype IStereotype into this model element. The IStereotype may belong to current project or referenced project(s). Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2378
    
    Specified by:
    
    addStereotype in interface IModelElement
    
    Parameters:
    stereotype - the IStereotype will be added into this model element.
    The baseType of the IStereotype is required to be matched with modelType of this model element. If they are different, or stereotype is null, will cause an IllegalArgumentException.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the stereotype is null, or its baseType does not match with modelType of this model element.
  - removeStereotype
```
void removeStereotype(IStereotype stereotype)
```
    Remove a stereotype IStereotype from this model element. The IStereotype can belong to current project or referenced project(s).
    
    Specified by:
    
    removeStereotype in interface IModelElement
    
    Parameters:
    stereotype - the IStereotype will be removed from this model element.
  - hasStereotype
```
boolean hasStereotype(java.lang.String name)
```
    Specified by:
    
    hasStereotype in interface IModelElement
  - stereotypeCount
```
int stereotypeCount()
```
    Specified by:
    
    stereotypeCount in interface IModelElement
  - toStereotypeArray
```
java.lang.String[] toStereotypeArray()
```
  - stereotypeIterator
```
java.util.Iterator stereotypeIterator()
```
    Returns an iterator over the names of the stereotypes.
  - stereotypeModelIterator
```
java.util.Iterator stereotypeModelIterator()
```
    Returns an iterator over the model elements IStereotype.
    
    Specified by:
    
    stereotypeModelIterator in interface IModelElement
  - toStereotypeModelArray
```
IStereotype[] toStereotypeModelArray()
```
    Specified by:
    
    toStereotypeModelArray in interface IModelElement
  - addStereotypes
```
void addStereotypes(java.lang.String name)
```
    Deprecated. Replaced by addStereotype
  - removeStereotypes
```
void removeStereotypes(java.lang.String name)
```
    Deprecated. Replaced by removeStereotype
  - hasStereotypes
```
boolean hasStereotypes(java.lang.String name)
```
    Deprecated. Replaced by hasStereotype
  - stereotypesCount
```
int stereotypesCount()
```
    Deprecated. Replaced by stereotypeCount
  - toStereotypesArray
```
java.lang.String[] toStereotypesArray()
```
    Deprecated. Replaced by toStereotypeArray
  - stereotypesIterator
```
java.util.Iterator stereotypesIterator()
```
    Deprecated. Replaced by stereotypeIterator
  - stereotypesModelIterator
```
java.util.Iterator stereotypesModelIterator()
```
    Deprecated. Replaced by stereotypeModelIterator
  - toStereotypesModelArray
```
IStereotype[] toStereotypesModelArray()
```
    Deprecated. Replaced by toStereotypeModelArray
  - setTaggedValues
```
void setTaggedValues(ITaggedValueContainer taggedValues)
```
    Specified by:
    
    setTaggedValues in interface IModelElement
  - getTaggedValues
```
ITaggedValueContainer getTaggedValues()
```
    Specified by:
    
    getTaggedValues in interface IModelElement
  - addSyncMappingModel
```
void addSyncMappingModel(IModelElement syncMappingModel)
```
  - removeSyncMappingModel
```
void removeSyncMappingModel(IModelElement syncMappingModel)
```
  - getSyncMappingModelByIndex
```
IModelElement getSyncMappingModelByIndex(int index)
```
  - removeSyncMappingModelByIndex
```
void removeSyncMappingModelByIndex(int index)
```
  - syncMappingModelCount
```
int syncMappingModelCount()
```
  - syncMappingModelIterator
```
java.util.Iterator syncMappingModelIterator()
```
    Returns an iterator over the model elements IModelElement.
  - toSyncMappingModelArray
```
IModelElement[] toSyncMappingModelArray()
```
  - addAnalysisItemModel
```
void addAnalysisItemModel(IModelElement analysisItemModel)
```
  - removeAnalysisItemModel
```
void removeAnalysisItemModel(IModelElement analysisItemModel)
```
  - getAnalysisItemModelByIndex
```
IModelElement getAnalysisItemModelByIndex(int index)
```
  - removeAnalysisItemModelByIndex
```
void removeAnalysisItemModelByIndex(int index)
```
  - analysisItemModelCount
```
int analysisItemModelCount()
```
  - analysisItemModelIterator
```
java.util.Iterator analysisItemModelIterator()
```
    Returns an iterator over the model elements IModelElement.
  - toAnalysisItemModelArray
```
IModelElement[] toAnalysisItemModelArray()
```
  - setAnalysisItemDiagramIds
```
void setAnalysisItemDiagramIds(java.lang.String[] analysisItemDiagramIds)
```
  - getAnalysisItemDiagramIds
```
java.lang.String[] getAnalysisItemDiagramIds()
```
  - setQualityScore
```
void setQualityScore(int qualityScore)
```
  - getQualityScore
```
int getQualityScore()
```
    Description copied from interface: IModelElement
    
    Quality score, it is non-readable value for human
    
    Specified by:
    
    getQualityScore in interface IModelElement
  - setQualityReason
```
void setQualityReason(java.lang.String qualityReason)
```
  - getQualityReason
```
java.lang.String getQualityReason()
```
    Description copied from interface: IModelElement
    
    Quality reason, it is non-readable value for human
    
    Specified by:
    
    getQualityReason in interface IModelElement
  - setTaskPoolId
```
void setTaskPoolId(int taskPoolId)
```
  - getTaskPoolId
```
int getTaskPoolId()
```
  - setTaskPoolName
```
void setTaskPoolName(java.lang.String taskPoolName)
```
  - getTaskPoolName
```
java.lang.String getTaskPoolName()
```
  - addHumanResource
```
void addHumanResource(ITasifierMember humanResource)
```
  - removeHumanResource
```
void removeHumanResource(ITasifierMember humanResource)
```
  - getHumanResourceByIndex
```
ITasifierMember getHumanResourceByIndex(int index)
```
  - removeHumanResourceByIndex
```
void removeHumanResourceByIndex(int index)
```
  - humanResourceCount
```
int humanResourceCount()
```
  - humanResourceIterator
```
java.util.Iterator humanResourceIterator()
```
    Returns an iterator over the model elements ITasifierMember.
  - toHumanResourceArray
```
ITasifierMember[] toHumanResourceArray()
```
  - setUseCaseDescriptionDiagramId
```
void setUseCaseDescriptionDiagramId(java.lang.String useCaseDescriptionDiagramId)
```
  - getUseCaseDescriptionDiagramId
```
java.lang.String getUseCaseDescriptionDiagramId()
```
  - setJustification
```
void setJustification(java.lang.String justification)
```
  - getJustification
```
java.lang.String getJustification()
```
  - setUseCaseDescription
```
void setUseCaseDescription(IUseCaseDescriptionItemContainer useCaseDescription)
```
  - getUseCaseDescription
```
IUseCaseDescriptionItemContainer getUseCaseDescription()
```
  - addAlternativeUseCaseDescription
```
void addAlternativeUseCaseDescription(IUseCaseDescriptionItemContainer alternativeUseCaseDescription)
```
  - removeAlternativeUseCaseDescription
```
void removeAlternativeUseCaseDescription(IUseCaseDescriptionItemContainer alternativeUseCaseDescription)
```
  - getAlternativeUseCaseDescriptionByIndex
```
IUseCaseDescriptionItemContainer getAlternativeUseCaseDescriptionByIndex(int index)
```
  - removeAlternativeUseCaseDescriptionByIndex
```
void removeAlternativeUseCaseDescriptionByIndex(int index)
```
  - alternativeUseCaseDescriptionCount
```
int alternativeUseCaseDescriptionCount()
```
  - alternativeUseCaseDescriptionIterator
```
java.util.Iterator alternativeUseCaseDescriptionIterator()
```
    Returns an iterator over the model elements IUseCaseDescriptionItemContainer.
  - toAlternativeUseCaseDescriptionArray
```
IUseCaseDescriptionItemContainer[] toAlternativeUseCaseDescriptionArray()
```
  - setTemplateName
```
void setTemplateName(java.lang.String templateName)
```
  - getTemplateName
```
java.lang.String getTemplateName()
```
  - setBusinessModel
```
void setBusinessModel(boolean businessModel)
```
  - isBusinessModel
```
boolean isBusinessModel()
```
  - setPreConditions
```
void setPreConditions(java.lang.String preConditions)
```
  - getPreConditions
```
java.lang.String getPreConditions()
```
  - setPostConditions
```
void setPostConditions(java.lang.String postConditions)
```
  - getPostConditions
```
java.lang.String getPostConditions()
```
  - setTestingSetup
```
void setTestingSetup(java.lang.String testingSetup)
```
  - getTestingSetup
```
java.lang.String getTestingSetup()
```
  - setTestingConfig
```
void setTestingConfig(java.lang.String testingConfig)
```
  - getTestingConfig
```
java.lang.String getTestingConfig()
```
  - addStepContainer
```
void addStepContainer(IStepContainer stepContainer)
```
  - removeStepContainer
```
void removeStepContainer(IStepContainer stepContainer)
```
  - getStepContainerByIndex
```
IStepContainer getStepContainerByIndex(int index)
```
  - removeStepContainerByIndex
```
void removeStepContainerByIndex(int index)
```
  - stepContainerCount
```
int stepContainerCount()
```
  - stepContainerIterator
```
java.util.Iterator stepContainerIterator()
```
    Returns an iterator over the model elements IStepContainer.
  - toStepContainerArray
```
IStepContainer[] toStepContainerArray()
```
    Retrieves the IStepContainer of this Use Case.
    
    Returns:
    the step containers of this Use Case.
  - addRequirement
```
void addRequirement(IRequirement requirement)
```
  - removeRequirement
```
void removeRequirement(IRequirement requirement)
```
  - getRequirementByIndex
```
IRequirement getRequirementByIndex(int index)
```
  - removeRequirementByIndex
```
void removeRequirementByIndex(int index)
```
  - requirementCount
```
int requirementCount()
```
  - requirementIterator
```
java.util.Iterator requirementIterator()
```
    Returns an iterator over the model elements IRequirement.
  - toRequirementArray
```
IRequirement[] toRequirementArray()
```
  - addPrimaryActor
```
void addPrimaryActor(IActor primaryActor)
```
  - removePrimaryActor
```
void removePrimaryActor(IActor primaryActor)
```
  - getPrimaryActorByIndex
```
IActor getPrimaryActorByIndex(int index)
```
  - removePrimaryActorByIndex
```
void removePrimaryActorByIndex(int index)
```
  - primaryActorCount
```
int primaryActorCount()
```
  - primaryActorIterator
```
java.util.Iterator primaryActorIterator()
```
    Returns an iterator over the model elements IActor.
  - toPrimaryActorArray
```
IActor[] toPrimaryActorArray()
```
  - addSupportingActor
```
void addSupportingActor(IActor supportingActor)
```
  - removeSupportingActor
```
void removeSupportingActor(IActor supportingActor)
```
  - getSupportingActorByIndex
```
IActor getSupportingActorByIndex(int index)
```
  - removeSupportingActorByIndex
```
void removeSupportingActorByIndex(int index)
```
  - supportingActorCount
```
int supportingActorCount()
```
  - supportingActorIterator
```
java.util.Iterator supportingActorIterator()
```
    Returns an iterator over the model elements IActor.
  - toSupportingActorArray
```
IActor[] toSupportingActorArray()
```
  - addUseCaseNote
```
void addUseCaseNote(IUseCaseNote useCaseNote)
```
  - removeUseCaseNote
```
void removeUseCaseNote(IUseCaseNote useCaseNote)
```
  - getUseCaseNoteByIndex
```
IUseCaseNote getUseCaseNoteByIndex(int index)
```
  - removeUseCaseNoteByIndex
```
void removeUseCaseNoteByIndex(int index)
```
  - useCaseNoteCount
```
int useCaseNoteCount()
```
  - useCaseNoteIterator
```
java.util.Iterator useCaseNoteIterator()
```
    Returns an iterator over the model elements IUseCaseNote.
  - toUseCaseNoteArray
```
IUseCaseNote[] toUseCaseNoteArray()
```
  - setStatus
```
void setStatus(int status)
```
  - getStatus
```
int getStatus()
```
  - setUcRank
```
void setUcRank(int ucRank)
```
  - getUcRank
```
int getUcRank()
```
  - setContextName
```
void setContextName(java.lang.String contextName)
```
  - getContextName
```
java.lang.String getContextName()
```
  - addContext
```
void addContext(IUseCase context)
```
  - removeContext
```
void removeContext(IUseCase context)
```
  - getContextByIndex
```
IUseCase getContextByIndex(int index)
```
  - removeContextByIndex
```
void removeContextByIndex(int index)
```
  - contextCount
```
int contextCount()
```
  - contextIterator
```
java.util.Iterator contextIterator()
```
    Returns an iterator over the model elements IUseCase.
  - toContextArray
```
IUseCase[] toContextArray()
```

Interface IUseCase

Field Summary

Fields inherited from interface com.vp.plugin.model.IHasChildrenBaseModelElement

Fields inherited from interface com.vp.plugin.model.IModelElement

Method Summary

Methods inherited from interface com.vp.plugin.model.IHasChildrenBaseModelElement

Methods inherited from interface com.vp.plugin.model.IModelElement

Field Detail

PROP_ABSTRACT

PROP_LEAF

PROP_ROOT

PROP_STEREOTYPES

PROP_TAGGED_VALUES

PROP_SYNC_MAPPING_MODELS

PROP_ANALYSIS_ITEM_MODELS

PROP_ANALYSIS_ITEM_DIAGRAM_IDS

PROP_QUALITY_SCORE

PROP_QUALITY_REASON

PROP_TASK_POOL_ID

PROP_TASK_POOL_NAME

PROP_HUMAN_RESOURCES

PROP_USE_CASE_DESCRIPTION_DIAGRAM_ID

PROP_JUSTIFICATION

PROP_USE_CASE_DESCRIPTION

PROP_ALTERNATIVE_USE_CASE_DESCRIPTIONS

PROP_DESC_NAME_COLUMN_WIDTH

PROP_DESC_VALUE_COLUMN_WIDTH

PROP_SCHEDULE_ROW_HEIGHT

PROP_TEMPLATE_NAME

PROP_BUSINESS_MODEL

PROP_PRE_CONDITIONS

PROP_POST_CONDITIONS

PROP_TESTING_SETUP

PROP_TESTING_CONFIG

PROP_STEP_CONTAINERS

PROP_REQUIREMENTS

PROP_PRIMARY_ACTORS

PROP_SUPPORTING_ACTORS

PROP_USE_CASE_NOTES

PROP_STATUS

STATUS_IDENTIFY

STATUS_DISCUSS

STATUS_ELABORATE

STATUS_DESIGN

STATUS_CONSENT

STATUS_DEVELOP

STATUS_COMPLETE

PROP_UC_RANK

UC_RANK_UNSPECIFIED

UC_RANK_HIGH

UC_RANK_MEDIUM

UC_RANK_LOW

PROP_CONTEXT_NAME

PROP_CONTEXT

Method Detail

addUserStory

removeUserStory

getUserStoryByIndex

removeUserStoryByIndex

reorderUserStory

userStoryCount

userStoryIterator

toUserStoryArray

createUserStory

getUserStoryByName

fromRelationshipCount

toFromRelationshipArray

fromRelationshipIterator

toRelationshipCount

toToRelationshipArray

toRelationshipIterator

fromRelationshipEndCount

toFromRelationshipEndArray

fromRelationshipEndIterator

toRelationshipEndCount

toToRelationshipEndArray

toRelationshipEndIterator

setAbstract

isAbstract

setLeaf