|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A representation of the model object 'Use Case'. A UseCase is a kind of behaviored classifier that represents a declaration of an offered behavior. Each use case specifies some behavior, possibly including variants, that the subject can perform in collaboration with one or more actors. Use cases define the offered behavior of the subject without reference to its internal structure. These behaviors, involving interactions between the actor and the subject, may result in changes to the state of the subject and communications with its environment. A use case can include possible variations of its basic behavior, including exceptional behavior and error handling. The subject of a use case could be a physical system or any other element that may have behavior, such as a component, subsystem or class. Each use case specifies a unit of useful functionality that the subject provides to its users, i.e., a specific way of interacting with the subject. This functionality, which is initiated by an actor, must always be completed for the use case to complete. It is deemed complete if, after its execution, the subject will be in a state in which no further inputs or actions are expected and the use case can be initiated again or in an error state. Use cases can be used both for specification of the (external) requirements on a subject and for the specification of the functionality offered by a subject. Moreover, the use cases also state the requirements the specified subject poses on its environment by defining how they should interact with the subject so that it will be able to perform its services. The behavior of a use case can be described by a specification that is some kind of Behavior (through its ownedBehavior relationship), such as interactions, activities, and state machines, or by pre-conditions and post-conditions as well as by natural language text where appropriate. It may also be described indirectly through a Collaboration that uses the use case and its actors as the classifiers that type its parts. Which of these techniques to use depends on the nature of the use case behavior as well as on the intended reader. These descriptions can be combined.
The following features are supported:
UML2Package.getUseCase()
Field Summary | |
---|---|
static java.lang.String |
copyright
|
Fields inherited from interface org.eclipse.uml2.NamedElement |
---|
SEPARATOR |
Method Summary | |
---|---|
Extend |
createExtend()
Creates a Extend and appends it to the 'Extend' containment reference list |
Extend |
createExtend(EClass eClass)
Deprecated. Use #createExtend() instead. |
ExtensionPoint |
createExtensionPoint()
Creates a ExtensionPoint and appends it to the 'Extension Point' containment reference list |
ExtensionPoint |
createExtensionPoint(EClass eClass)
Deprecated. Use #createExtensionPoint() instead. |
Include |
createInclude()
Creates a Include and appends it to the 'Include' containment reference list |
Include |
createInclude(EClass eClass)
Deprecated. Use #createInclude() instead. |
Extend |
getExtend(java.lang.String name)
Retrieves the Extend with the specified 'Name' from the 'Extend' containment reference list |
EList |
getExtends()
Returns the value of the 'Extend' containment reference list. |
ExtensionPoint |
getExtensionPoint(java.lang.String name)
Retrieves the ExtensionPoint with the specified 'Name' from the 'Extension Point' containment reference list |
EList |
getExtensionPoints()
Returns the value of the 'Extension Point' containment reference list. |
Include |
getInclude(java.lang.String name)
Retrieves the Include with the specified 'Name' from the 'Include' containment reference list |
EList |
getIncludes()
Returns the value of the 'Include' containment reference list. |
Classifier |
getSubject(java.lang.String name)
Retrieves the Classifier with the specified 'Name' from the 'Subject' reference list |
EList |
getSubjects()
Returns the value of the 'Subject' reference list. |
Methods inherited from interface org.eclipse.uml2.NamedElement |
---|
allNamespaces, createDependency, createNameExpression, createNameExpression, getClientDependencies, getClientDependency, getLabel, getLabel, getName, getNameExpression, getNamespace, getQualifiedName, getVisibility, isDistinguishableFrom, qualifiedName, separator, setName, setNameExpression, setVisibility, validateNoName, validateQualifiedName, validateVisibilityNeedsOwnership |
Methods inherited from interface org.eclipse.uml2.TemplateableElement |
---|
createOwnedTemplateSignature, createOwnedTemplateSignature, createTemplateBinding, createTemplateBinding, getOwnedTemplateSignature, getTemplateBindings, parameterableElements, setOwnedTemplateSignature |
Methods inherited from interface org.eclipse.uml2.Element |
---|
addKeyword, allOwnedElements, apply, createEAnnotation, createOwnedComment, createOwnedComment, destroy, getApplicableStereotype, getApplicableStereotypes, getAppliedStereotype, getAppliedStereotypes, getAppliedVersion, getKeywords, getModel, getNearestPackage, getOwnedComments, getOwnedElements, getOwner, getValue, hasKeyword, hasValue, isApplied, isRequired, mustBeOwned, removeKeyword, setValue, unapply, 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, eIsProxy, eIsSet, eResource, eSet, eUnset |
Methods inherited from interface org.eclipse.emf.common.notify.Notifier |
---|
eAdapters, eDeliver, eNotify, eSetDeliver |
Methods inherited from interface org.eclipse.uml2.Type |
---|
conformsTo, createAssociation, getPackage |
Methods inherited from interface org.eclipse.uml2.PackageableElement |
---|
getPackageableElement_visibility, setPackageableElement_visibility |
Methods inherited from interface org.eclipse.uml2.ParameterableElement |
---|
getOwningParameter, getTemplateParameter, setOwningParameter, setTemplateParameter |
Methods inherited from interface org.eclipse.uml2.RedefinableElement |
---|
getRedefinedElement, getRedefinedElements, getRedefinitionContext, getRedefinitionContexts, isConsistentWith, isLeaf, isRedefinitionContextValid, setIsLeaf, validateRedefinitionConsistent, validateRedefinitionContextValid |
Field Detail |
public static final java.lang.String copyright
Method Detail |
public EList getIncludes()
Include
.
It is bidirectional and its opposite is 'Including Case
'.
If the meaning of the 'Include' containment reference list isn't clear, there really should be more of a description here...
UML2Package.getUseCase_Include()
,
Include.getIncludingCase()
public Include getInclude(java.lang.String name)
Include
with the specified 'Name' from the 'Include' containment reference list.
name
- The 'Name' of the Include
to retrieve.
Include
with the specified 'Name', or null
.getIncludes()
public Include createInclude(EClass eClass)
Include
and appends it to the 'Include' containment reference list.
eClass
- The Ecore class of the Include
to create.
Include
.getIncludes()
public Include createInclude()
Include
and appends it to the 'Include' containment reference list.
Include
.getIncludes()
public EList getExtends()
Extend
.
It is bidirectional and its opposite is 'Extension
'.
If the meaning of the 'Extend' containment reference list isn't clear, there really should be more of a description here...
UML2Package.getUseCase_Extend()
,
Extend.getExtension()
public Extend getExtend(java.lang.String name)
Extend
with the specified 'Name' from the 'Extend' containment reference list.
name
- The 'Name' of the Extend
to retrieve.
Extend
with the specified 'Name', or null
.getExtends()
public Extend createExtend(EClass eClass)
Extend
and appends it to the 'Extend' containment reference list.
eClass
- The Ecore class of the Extend
to create.
Extend
.getExtends()
public Extend createExtend()
Extend
and appends it to the 'Extend' containment reference list.
Extend
.getExtends()
public EList getExtensionPoints()
ExtensionPoint
.
It is bidirectional and its opposite is 'Use Case
'.
If the meaning of the 'Extension Point' containment reference list isn't clear, there really should be more of a description here...
UML2Package.getUseCase_ExtensionPoint()
,
ExtensionPoint.getUseCase()
public ExtensionPoint getExtensionPoint(java.lang.String name)
ExtensionPoint
with the specified 'Name' from the 'Extension Point' containment reference list.
name
- The 'Name' of the ExtensionPoint
to retrieve.
ExtensionPoint
with the specified 'Name', or null
.getExtensionPoints()
public ExtensionPoint createExtensionPoint(EClass eClass)
ExtensionPoint
and appends it to the 'Extension Point' containment reference list.
eClass
- The Ecore class of the ExtensionPoint
to create.
ExtensionPoint
.getExtensionPoints()
public ExtensionPoint createExtensionPoint()
ExtensionPoint
and appends it to the 'Extension Point' containment reference list.
ExtensionPoint
.getExtensionPoints()
public EList getSubjects()
Classifier
.
It is bidirectional and its opposite is 'Use Case
'.
If the meaning of the 'Subject' reference list isn't clear, there really should be more of a description here...
UML2Package.getUseCase_Subject()
,
Classifier.getUseCases()
public Classifier getSubject(java.lang.String name)
Classifier
with the specified 'Name' from the 'Subject' reference list.
name
- The 'Name' of the Classifier
to retrieve.
Classifier
with the specified 'Name', or null
.getSubjects()
|
Copyright 2003, 2005 IBM Corporation and others. All Rights Reserved. |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |