All Superinterfaces:

BehavioredClassifier, Classifier, Comparable<Object>, Element, org.eclipse.emf.ecore.EModelElement, org.eclipse.emf.ecore.EObject, MDWEObject, MDWObject, NamedElement, Namespace, org.eclipse.emf.common.notify.Notifier, PackageableElement, ParameterableElement, RedefinableElement, TemplateableElement, Type
```
public interface UseCase
extends BehavioredClassifier
```
A representation of the model object 'Use Case'. A use case is the specification of a set of actions performed by a system, which yields an observable result that is, typically, of value for one or more actors or other stakeholders of the system.
The following features are supported:
See Also:

UMLPackage.getUseCase()

Field Summary
- Fields inherited from interface com.sodius.mdw.metamodel.uml21.NamedElement
  SEPARATOR

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`MDWEList<UseCase>`	`allIncludedUseCases()`	The query allIncludedUseCases() returns the transitive closure of all use cases (directly or indirectly) included by this use case.
`Extend`	`createExtend(String name, UseCase extendedCase)`	Creates a new `Extend`, with the specified 'Name', and 'Extended Case', and appends it to the 'Extend' containment reference list.
`ExtensionPoint`	`createExtensionPoint(String name)`	Creates a new `ExtensionPoint`, with the specified 'Name', and appends it to the ' Extension Point' containment reference list.
`Include`	`createInclude(String name, UseCase addition)`	Creates a new `Include`, with the specified 'Name', and 'Addition', and appends it to the 'Include' containment reference list.
`Extend`	`getExtend(String name, UseCase extendedCase)`	Retrieves the first `Extend` with the specified 'Name', and 'Extended Case ' from the 'Extend' containment reference list.
`Extend`	`getExtend(String name, UseCase extendedCase, boolean ignoreCase, boolean createOnDemand)`	Retrieves the first `Extend` with the specified 'Name', and 'Extended Case ' from the 'Extend' containment reference list.
`MDWEList<Extend>`	`getExtends()`	Returns the value of the 'Extend' containment reference list.
`ExtensionPoint`	`getExtensionPoint(String name)`	Retrieves the first `ExtensionPoint` with the specified 'Name' from the ' Extension Point' containment reference list.
`ExtensionPoint`	`getExtensionPoint(String name, boolean ignoreCase, boolean createOnDemand)`	Retrieves the first `ExtensionPoint` with the specified 'Name' from the ' Extension Point' containment reference list.
`MDWEList<ExtensionPoint>`	`getExtensionPoints()`	Returns the value of the 'Extension Point' containment reference list.
`Include`	`getInclude(String name, UseCase addition)`	Retrieves the first `Include` with the specified 'Name', and 'Addition' from the 'Include' containment reference list.
`Include`	`getInclude(String name, UseCase addition, boolean ignoreCase, boolean createOnDemand)`	Retrieves the first `Include` with the specified 'Name', and 'Addition' from the 'Include' containment reference list.
`MDWEList<Include>`	`getIncludes()`	Returns the value of the 'Include' containment reference list.
`Classifier`	`getSubject(String name)`	Retrieves the first `Classifier` with the specified 'Name' from the ' Subject' reference list.
`Classifier`	`getSubject(String name, boolean ignoreCase, org.eclipse.emf.ecore.EClass eClass)`	Retrieves the first `Classifier` with the specified 'Name' from the ' Subject' reference list.
`MDWEList<Classifier>`	`getSubjects()`	Returns the value of the 'Subject' reference list.
`boolean`	`validateBinaryAssociations(org.eclipse.emf.common.util.DiagnosticChain diagnostics, Map context)`	UseCases can only be involved in binary Associations.
`boolean`	`validateCannotIncludeSelf(org.eclipse.emf.common.util.DiagnosticChain diagnostics, Map context)`	A use case cannot include use cases that directly or indirectly include it.
`boolean`	`validateMustHaveName(org.eclipse.emf.common.util.DiagnosticChain diagnostics, Map context)`	A UseCase must have a name.
`boolean`	`validateNoAssociationToUseCase(org.eclipse.emf.common.util.DiagnosticChain diagnostics, Map context)`	UseCases can not have Associations to UseCases specifying the same subject.

Methods inherited from interface com.sodius.mdw.metamodel.uml21.BehavioredClassifier
createClassifierBehavior, createInterfaceRealization, createOwnedBehavior, createOwnedTrigger, getAllImplementedInterfaces, getClassifierBehavior, getImplementedInterfaces, getInterfaceRealization, getInterfaceRealization, getInterfaceRealizations, getOwnedBehavior, getOwnedBehavior, getOwnedBehaviors, getOwnedTrigger, getOwnedTrigger, getOwnedTriggers, setClassifierBehavior, validateClassBehavior

Methods inherited from interface com.sodius.mdw.metamodel.uml21.Classifier
allFeatures, allParents, conformsTo, createCollaborationUse, createGeneralization, createOwnedUseCase, createRepresentation, createSubstitution, getAllAttributes, getAllOperations, getAllUsedInterfaces, getAttribute, getAttribute, getAttributes, getCollaborationUse, getCollaborationUse, getCollaborationUses, getFeature, getFeature, getFeatures, getGeneral, getGeneral, getGeneralization, getGeneralization, getGeneralizations, getGenerals, getInheritedMember, getInheritedMember, getInheritedMembers, getOperation, getOperation, getOperations, getOwnedUseCase, getOwnedUseCase, getOwnedUseCases, getPowertypeExtent, getPowertypeExtent, getPowertypeExtents, getRedefinedClassifier, getRedefinedClassifier, getRedefinedClassifiers, getRepresentation, getSubstitution, getSubstitution, getSubstitutions, getUseCase, getUseCase, getUseCases, getUsedInterfaces, hasVisibilityOf, inherit, inheritableMembers, isAbstract, isFinalSpecialization, maySpecializeType, parents, setIsAbstract, setIsFinalSpecialization, setRepresentation, validateGeneralizationHierarchies, validateMapsToGeneralizationSet, validateNoCyclesInGeneralization, validateSpecializeType

Methods inherited from interface com.sodius.mdw.metamodel.uml21.Element
addKeyword, allOwnedElements, applyStereotype, createEAnnotation, createOwnedComment, destroy, getApplicableStereotype, getApplicableStereotypes, getAppliedStereotype, getAppliedStereotypes, getAppliedSubstereotype, getAppliedSubstereotypes, getKeywords, getModel, getNearestPackage, getOwnedComments, getOwnedElements, getOwner, getRelationships, getRelationships, getRequiredStereotype, getRequiredStereotypes, getSourceDirectedRelationships, getSourceDirectedRelationships, getStereotypeApplication, getStereotypeApplications, getTargetDirectedRelationships, getTargetDirectedRelationships, getValue, hasKeyword, hasValue, isStereotypeApplicable, isStereotypeApplied, isStereotypeRequired, mustBeOwned, removeKeyword, setValue, unapplyStereotype, validateHasOwner, validateNotOwnSelf

Methods inherited from interface org.eclipse.emf.ecore.EModelElement
getEAnnotation, getEAnnotations

Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface com.sodius.mdw.core.model.MDWObject
compareTo, eExtendedClass, eIsInstanceOf, eIsInstanceOf, eIsProfiled, eIsRemoved, eMetamodel, eMetaTypeName, eModel, eRemove, eSetUniqueID, eUniqueID, superScript, superScript, toBoolean, toBoolean, toByte, toByte, toChar, toChar, toDouble, toDouble, toFloat, toFloat, toInt, toInt, toList, toList, toList, toList, toList, toLong, toLong, toObject, toObject, toSet, toSet, toShort, toShort, toString, toString

Methods inherited from interface com.sodius.mdw.metamodel.uml21.NamedElement
allNamespaces, allOwningPackages, createDependency, createNameExpression, getClientDependencies, getClientDependency, getClientDependency, getLabel, getLabel, getName, getNameExpression, getNamespace, getQualifiedName, getVisibility, isDistinguishableFrom, isSetName, isSetVisibility, separator, setName, setNameExpression, setVisibility, unsetName, unsetVisibility, validateHasNoQualifiedName, validateHasQualifiedName, validateVisibilityNeedsOwnership

Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver

Methods inherited from interface com.sodius.mdw.metamodel.uml21.ParameterableElement
getOwningTemplateParameter, getTemplateParameter, isCompatibleWith, isTemplateParameter, setOwningTemplateParameter, setTemplateParameter

Methods inherited from interface com.sodius.mdw.metamodel.uml21.RedefinableElement
getRedefinedElement, getRedefinedElement, getRedefinedElements, getRedefinitionContext, getRedefinitionContext, getRedefinitionContexts, isConsistentWith, isLeaf, isRedefinitionContextValid, setIsLeaf, validateRedefinitionConsistent, validateRedefinitionContextValid

Methods inherited from interface com.sodius.mdw.metamodel.uml21.TemplateableElement
createOwnedTemplateSignature, createOwnedTemplateSignature, createTemplateBinding, getOwnedTemplateSignature, getTemplateBinding, getTemplateBinding, getTemplateBindings, isTemplate, parameterableElements, setOwnedTemplateSignature

Methods inherited from interface com.sodius.mdw.metamodel.uml21.Type
conformsTo, createAssociation, getAssociations, getPackage, setPackage

- Method Detail
  - getIncludes
```
MDWEList<Include> getIncludes()
```
    Returns the value of the 'Include' containment reference list. The list contents are of type Include. It is bidirectional and its opposite is 'Including Case'. References the Include relationships owned by this use case.
    
    Returns:
    
    the value of the 'Include' containment reference list.
    
    See Also:
    
    UMLPackage.getUseCase_Include(), Include.getIncludingCase()
  - createInclude
```
Include createInclude(String name,
                      UseCase addition)
```
    Creates a new Include, with the specified 'Name', and 'Addition', and appends it to the 'Include' containment reference list.
    
    Parameters:
    
    name - The 'Name' for the new Include, or null.
    
    addition - The 'Addition' for the new Include, or null.
    
    Returns:
    
    The new Include.
    
    See Also:
    
    getIncludes()
  - getInclude
```
Include getInclude(String name,
                   UseCase addition)
```
    Retrieves the first Include with the specified 'Name', and 'Addition' from the 'Include' containment reference list.
    
    Parameters:
    
    name - The 'Name' of the Include to retrieve, or null.
    
    addition - The 'Addition' of the Include to retrieve, or null.
    
    Returns:
    
    The first Include with the specified 'Name', and 'Addition', or null.
    
    See Also:
    
    getIncludes()
  - getInclude
```
Include getInclude(String name,
                   UseCase addition,
                   boolean ignoreCase,
                   boolean createOnDemand)
```
    Retrieves the first Include with the specified 'Name', and 'Addition' from the 'Include' containment reference list.
    
    Parameters:
    
    name - The 'Name' of the Include to retrieve, or null.
    
    addition - The 'Addition' of the Include to retrieve, or null.
    
    ignoreCase - Whether to ignore case in String comparisons.
    
    createOnDemand - Whether to create a Include on demand if not found.
    
    Returns:
    
    The first Include with the specified 'Name', and 'Addition', or null.
    
    See Also:
    
    getIncludes()
  - getExtends
```
MDWEList<Extend> getExtends()
```
    Returns the value of the 'Extend' containment reference list. The list contents are of type Extend. It is bidirectional and its opposite is 'Extension'. References the Extend relationships owned by this use case.
    
    Returns:
    
    the value of the 'Extend' containment reference list.
    
    See Also:
    
    UMLPackage.getUseCase_Extend(), Extend.getExtension()
  - createExtend
```
Extend createExtend(String name,
                    UseCase extendedCase)
```
    Creates a new Extend, with the specified 'Name', and 'Extended Case', and appends it to the 'Extend' containment reference list.
    
    Parameters:
    
    name - The 'Name' for the new Extend, or null.
    
    extendedCase - The 'Extended Case' for the new Extend, or null.
    
    Returns:
    
    The new Extend.
    
    See Also:
    
    getExtends()
  - getExtend
```
Extend getExtend(String name,
                 UseCase extendedCase)
```
    Retrieves the first Extend with the specified 'Name', and 'Extended Case ' from the 'Extend' containment reference list.
    
    Parameters:
    
    name - The 'Name' of the Extend to retrieve, or null.
    
    extendedCase - The 'Extended Case' of the Extend to retrieve, or null.
    
    Returns:
    
    The first Extend with the specified 'Name', and 'Extended Case', or null.
    
    See Also:
    
    getExtends()
  - getExtend
```
Extend getExtend(String name,
                 UseCase extendedCase,
                 boolean ignoreCase,
                 boolean createOnDemand)
```
    Retrieves the first Extend with the specified 'Name', and 'Extended Case ' from the 'Extend' containment reference list.
    
    Parameters:
    
    name - The 'Name' of the Extend to retrieve, or null.
    
    extendedCase - The 'Extended Case' of the Extend to retrieve, or null.
    
    ignoreCase - Whether to ignore case in String comparisons.
    
    createOnDemand - Whether to create a Extend on demand if not found.
    
    Returns:
    
    The first Extend with the specified 'Name', and 'Extended Case', or null.
    
    See Also:
    
    getExtends()
  - getExtensionPoints
```
MDWEList<ExtensionPoint> getExtensionPoints()
```
    Returns the value of the 'Extension Point' containment reference list. The list contents are of type ExtensionPoint. It is bidirectional and its opposite is 'Use Case'. References the ExtensionPoints owned by the use case.
    
    Returns:
    
    the value of the 'Extension Point' containment reference list.
    
    See Also:
    
    UMLPackage.getUseCase_ExtensionPoint(), ExtensionPoint.getUseCase()
  - createExtensionPoint
```
ExtensionPoint createExtensionPoint(String name)
```
    Creates a new ExtensionPoint, with the specified 'Name', and appends it to the ' Extension Point' containment reference list.
    
    Parameters:
    
    name - The 'Name' for the new ExtensionPoint, or null.
    
    Returns:
    
    The new ExtensionPoint.
    
    See Also:
    
    getExtensionPoints()
  - getExtensionPoint
```
ExtensionPoint getExtensionPoint(String name)
```
    Retrieves the first ExtensionPoint with the specified 'Name' from the ' Extension Point' containment reference list.
    
    Parameters:
    
    name - The 'Name' of the ExtensionPoint to retrieve, or null.
    
    Returns:
    
    The first ExtensionPoint with the specified 'Name', or null.
    
    See Also:
    
    getExtensionPoints()
  - getExtensionPoint
```
ExtensionPoint getExtensionPoint(String name,
                                 boolean ignoreCase,
                                 boolean createOnDemand)
```
    Retrieves the first ExtensionPoint with the specified 'Name' from the ' Extension Point' containment reference list.
    
    Parameters:
    
    name - The 'Name' of the ExtensionPoint to retrieve, or null.
    
    ignoreCase - Whether to ignore case in String comparisons.
    
    createOnDemand - Whether to create a ExtensionPoint on demand if not found.
    
    Returns:
    
    The first ExtensionPoint with the specified 'Name', or null.
    
    See Also:
    
    getExtensionPoints()
  - getSubjects
```
MDWEList<Classifier> getSubjects()
```
    Returns the value of the 'Subject' reference list. The list contents are of type Classifier. It is bidirectional and its opposite is 'Use Case'. References the subjects to which this use case applies. The subject or its parts realize all the use cases that apply to this subject. Use cases need not be attached to any specific subject, however. The subject may, but need not, own the use cases that apply to it.
    
    Returns:
    
    the value of the 'Subject' reference list.
    
    See Also:
    
    UMLPackage.getUseCase_Subject(), Classifier.getUseCases()
  - getSubject
```
Classifier getSubject(String name)
```
    Retrieves the first Classifier with the specified 'Name' from the ' Subject' reference list.
    
    Parameters:
    
    name - The 'Name' of the Classifier to retrieve, or null.
    
    Returns:
    
    The first Classifier with the specified 'Name', or null.
    
    See Also:
    
    getSubjects()
  - getSubject
```
Classifier getSubject(String name,
                      boolean ignoreCase,
                      org.eclipse.emf.ecore.EClass eClass)
```
    Retrieves the first Classifier with the specified 'Name' from the ' Subject' reference list.
    
    Parameters:
    
    name - The 'Name' of the Classifier to retrieve, or null.
    
    ignoreCase - Whether to ignore case in String comparisons.
    
    eClass - The Ecore class of the Classifier to retrieve, or null.
    
    Returns:
    
    The first Classifier with the specified 'Name', or null.
    
    See Also:
    
    getSubjects()
  - validateMustHaveName
```
boolean validateMustHaveName(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
                             Map context)
```
    A UseCase must have a name. self.name -> notEmpty ()
  - validateBinaryAssociations
```
boolean validateBinaryAssociations(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
                                   Map context)
```
    UseCases can only be involved in binary Associations. true
  - validateNoAssociationToUseCase
```
boolean validateNoAssociationToUseCase(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
                                       Map context)
```
    UseCases can not have Associations to UseCases specifying the same subject. true
  - validateCannotIncludeSelf
```
boolean validateCannotIncludeSelf(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
                                  Map context)
```
    A use case cannot include use cases that directly or indirectly include it. not self.allIncludedUseCases()->includes(self)
  - allIncludedUseCases
```
MDWEList<UseCase> allIncludedUseCases()
```
    The query allIncludedUseCases() returns the transitive closure of all use cases (directly or indirectly) included by this use case. result = self.include->union(self.include->collect(in | in.allIncludedUseCases()))

Interface UseCase

Field Summary

Fields inherited from interface com.sodius.mdw.metamodel.uml21.NamedElement

Method Summary

Methods inherited from interface com.sodius.mdw.metamodel.uml21.BehavioredClassifier

Methods inherited from interface com.sodius.mdw.metamodel.uml21.Classifier

Methods inherited from interface com.sodius.mdw.metamodel.uml21.Element

Methods inherited from interface org.eclipse.emf.ecore.EModelElement

Methods inherited from interface org.eclipse.emf.ecore.EObject

Methods inherited from interface com.sodius.mdw.core.model.MDWObject

Methods inherited from interface com.sodius.mdw.metamodel.uml21.NamedElement

Methods inherited from interface com.sodius.mdw.metamodel.uml21.Namespace

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

Methods inherited from interface com.sodius.mdw.metamodel.uml21.ParameterableElement

Methods inherited from interface com.sodius.mdw.metamodel.uml21.RedefinableElement

Methods inherited from interface com.sodius.mdw.metamodel.uml21.TemplateableElement

Methods inherited from interface com.sodius.mdw.metamodel.uml21.Type

Method Detail

getIncludes

createInclude

getInclude

getInclude

getExtends

createExtend

getExtend

getExtend

getExtensionPoints

createExtensionPoint

getExtensionPoint

getExtensionPoint

getSubjects

getSubject

getSubject

validateMustHaveName

validateBinaryAssociations

validateNoAssociationToUseCase

validateCannotIncludeSelf

allIncludedUseCases