Package com.nomagic.uml2.ext.magicdraw.mdusecases

Interface UseCase

All Superinterfaces:

BaseElement, BehavioredClassifier, Classifier, java.lang.Cloneable, java.lang.Comparable, Element, org.eclipse.emf.ecore.EObject, MDObject, ModelObject, NamedElement, Namespace, org.eclipse.emf.common.notify.Notifier, PackageableElement, ParameterableElement, RedefinableElement, javax.jmi.reflect.RefBaseObject, javax.jmi.reflect.RefFeatured, javax.jmi.reflect.RefObject, TemplateableElement, Type

public interface UseCase
extends BehavioredClassifier

A representation of the model object 'Use Case'.

A UseCase specifies a set of actions performed by its subjects, which yields an observable result that is of value for one or more Actors or other stakeholders of each subject.

The following features are supported:

• Extend
• Extension Point
• Include
• include Of Addition
• Subject
• classifier Of Owned Use Case
• extend Of Extended Case

See Also:

UMLPackage.getUseCase()

Model:

annotation="MOF package='mdusecases'"

Generated:

Method Summary

Modifier and Type	Method	Description
Classifier	get_classifierOfOwnedUseCase()	Returns the value of the 'classifier Of Owned Use Case' container reference.
java.util.Collection<Extend>	get_extendOfExtendedCase()	Returns the value of the 'extend Of Extended Case' reference list.
java.util.Collection<Include>	get_includeOfAddition()	Returns the value of the 'include Of Addition' reference list.
java.util.Collection<Extend>	getExtend()	Returns the value of the 'Extend' containment reference list.
java.util.Collection<ExtensionPoint>	getExtensionPoint()	Returns the value of the 'Extension Point' containment reference list.
java.util.Collection<Include>	getInclude()	Returns the value of the 'Include' containment reference list.
java.util.Collection<Classifier>	getSubject()	Returns the value of the 'Subject' reference list.
boolean	has_extendOfExtendedCase()
boolean	has_includeOfAddition()
boolean	hasExtend()
boolean	hasExtensionPoint()
boolean	hasInclude()
boolean	hasSubject()
void	set_classifierOfOwnedUseCase(Classifier value)	Sets the value of the 'classifier Of Owned Use Case' container reference.

Methods inherited from interface com.nomagic.magicdraw.uml.BaseElement

accept, addPropertyChangeListener, canAdd, canAdd, canAddChild, canBeDeleted, firePropertyChange, getClassType, getHumanName, getHumanType, getObjectParent, isEditable, removePropertyChangeListener, sGetID

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.commonbehaviors.mdbasicbehaviors.BehavioredClassifier

getClassifierBehavior, getInterfaceRealization, getOwnedBehavior, hasInterfaceRealization, hasOwnedBehavior, setClassifierBehavior

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Classifier

get_classifierOfRedefinedClassifier, get_classifierTemplateParameterOfConstrainingClassifier, get_componentRealizationOfRealizingClassifier, get_createObjectActionOfClassifier, get_exceptionHandlerOfExceptionType, get_generalizationOfGeneral, get_informationFlowOfConveyed, get_informationItemOfRepresented, get_instanceSpecificationOfClassifier, get_interfaceOfNestedClassifier, get_readExtentActionOfClassifier, get_readIsClassifiedObjectActionOfClassifier, get_reclassifyObjectActionOfNewClassifier, get_reclassifyObjectActionOfOldClassifier, get_redefinableElementOfRedefinitionContext, get_substitutionOfContract, get_unmarshallActionOfUnmarshallType, getAttribute, getCollaborationUse, getFeature, getGeneral, getGeneralization, getInheritedMember, getOwnedTemplateSignature, getOwnedUseCase, getPowertypeExtent, getRedefinedClassifier, getRepresentation, getSubstitution, getTemplateParameter, getUMLClass, getUseCase, has_classifierOfRedefinedClassifier, has_classifierTemplateParameterOfConstrainingClassifier, has_componentRealizationOfRealizingClassifier, has_createObjectActionOfClassifier, has_exceptionHandlerOfExceptionType, has_generalizationOfGeneral, has_informationFlowOfConveyed, has_informationItemOfRepresented, has_instanceSpecificationOfClassifier, has_readExtentActionOfClassifier, has_readIsClassifiedObjectActionOfClassifier, has_reclassifyObjectActionOfNewClassifier, has_reclassifyObjectActionOfOldClassifier, has_redefinableElementOfRedefinitionContext, has_substitutionOfContract, has_unmarshallActionOfUnmarshallType, hasAttribute, hasCollaborationUse, hasFeature, hasGeneral, hasGeneralization, hasInheritedMember, hasOwnedUseCase, hasPowertypeExtent, hasRedefinedClassifier, hasSubstitution, hasUseCase, isAbstract, isFinalSpecialization, set_interfaceOfNestedClassifier, setAbstract, setFinalSpecialization, setOwnedTemplateSignature, setRepresentation, setTemplateParameter, setUMLClass

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element

get_activityPartitionOfRepresents, get_commentOfAnnotatedElement, get_constraintOfConstrainedElement, get_diagramOfContext, get_directedRelationshipOfSource, get_directedRelationshipOfTarget, get_elementOfSyncElement, get_elementTaggedValue, get_elementValueOfElement, get_relationshipOfRelatedElement, getAppliedStereotype, getOwnedComment, getOwnedElement, getOwner, getSyncElement, getTaggedValue, has_activityPartitionOfRepresents, has_commentOfAnnotatedElement, has_constraintOfConstrainedElement, has_diagramOfContext, has_directedRelationshipOfSource, has_directedRelationshipOfTarget, has_elementOfSyncElement, has_elementValueOfElement, has_relationshipOfRelatedElement, hasAppliedStereotype, hasElementTaggedValue, hasOwnedComment, hasOwnedElement, hasTaggedValue, setOwner, setSyncElement

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.nomagic.magicdraw.foundation.MDObject

getID, getMDExtension, getMdExtensions, setID

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.base.ModelObject

get_representationText, getLocalID, ignoringRefGetValue, ignoringRefGetValue, isInvalid, isSet, refGetValue, refGetValue, refSetValue, refSetValue, set_representationText, setLocalID, sGetLocalID

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.classes.mdkernel.NamedElement

get_considerIgnoreFragmentOfMessage, get_durationObservationOfEvent, get_informationFlowOfInformationSource, get_informationFlowOfInformationTarget, get_messageOfSignature, get_namespaceOfMember, get_timeObservationOfEvent, getClientDependency, getName, getNameExpression, getNamespace, getQualifiedName, getSupplierDependency, has_considerIgnoreFragmentOfMessage, has_durationObservationOfEvent, has_informationFlowOfInformationSource, has_informationFlowOfInformationTarget, has_messageOfSignature, has_namespaceOfMember, has_timeObservationOfEvent, hasClientDependency, hasSupplierDependency, setName, setNameExpression, setNamespace

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Namespace

getElementImport, getImportedMember, getMember, getOwnedDiagram, getOwnedMember, getOwnedRule, getPackageImport, hasElementImport, hasImportedMember, hasMember, hasOwnedDiagram, hasOwnedMember, hasOwnedRule, hasPackageImport

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

eAdapters, eDeliver, eNotify, eSetDeliver

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.classes.mdkernel.PackageableElement

get_componentOfPackagedElement, get_elementImportOfImportedElement, get_manifestationOfUtilizedElement, getOwningPackage, getVisibility, has_elementImportOfImportedElement, has_manifestationOfUtilizedElement, set_componentOfPackagedElement, setOwningPackage, setVisibility

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.auxiliaryconstructs.mdtemplates.ParameterableElement

get_templateParameterOfDefault, get_templateParameterOfOwnedDefault, get_templateParameterSubstitutionOfActual, get_templateParameterSubstitutionOfOwnedActual, getOwningTemplateParameter, has_templateParameterOfDefault, has_templateParameterSubstitutionOfActual, set_templateParameterOfOwnedDefault, set_templateParameterSubstitutionOfOwnedActual, setOwningTemplateParameter, setTemplateParameter

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.classes.mdkernel.RedefinableElement

get_redefinableElementOfRedefinedElement, getRedefinedElement, getRedefinitionContext, has_redefinableElementOfRedefinedElement, hasRedefinedElement, hasRedefinitionContext, isLeaf, setLeaf

Methods inherited from interface javax.jmi.reflect.RefBaseObject

equals, hashCode, refImmediatePackage, refMetaObject, refMofId, refOutermostPackage, refVerifyConstraints

Methods inherited from interface javax.jmi.reflect.RefFeatured

refGetValue, refInvokeOperation, refInvokeOperation, refSetValue

Methods inherited from interface javax.jmi.reflect.RefObject

refClass, refDelete, refImmediateComposite, refIsInstanceOf, refOutermostComposite

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.auxiliaryconstructs.mdtemplates.TemplateableElement

getTemplateBinding, hasTemplateBinding, setOwnedTemplateSignature

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Type

get_associationOfEndType, get_behavioralFeatureOfRaisedException, get_operationOfRaisedException, get_typedElementOfType, getPackage, has_associationOfEndType, has_behavioralFeatureOfRaisedException, has_operationOfRaisedException, has_typedElementOfType, setPackage

Method Detail

getInclude

java.util.Collection<Include> getInclude()

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'. The Include relationships owned by this UseCase.

Returns:

the value of the 'Include' containment reference list.

See Also:

UMLPackage.getUseCase_Include(), Include.getIncludingCase()

Model:

opposite="includingCase" containment="true" resolveProxies="true" ordered="false"

Generated:

get_includeOfAddition

java.util.Collection<Include> get_includeOfAddition()

Returns the value of the 'include Of Addition' reference list. The list contents are of type Include. It is bidirectional and its opposite is 'Addition'.

If the meaning of the 'include Of Addition' reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'include Of Addition' reference list.

See Also:

UMLPackage.getUseCase__includeOfAddition(), Include.getAddition()

Model:

opposite="addition" ordered="false"

Generated:

getExtensionPoint

java.util.Collection<ExtensionPoint> getExtensionPoint()

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'. The ExtensionPoints owned by this UseCase.

Returns:

the value of the 'Extension Point' containment reference list.

See Also:

UMLPackage.getUseCase_ExtensionPoint(), ExtensionPoint.getUseCase()

Model:

opposite="useCase" containment="true" resolveProxies="true" ordered="false"

Generated:

get_extendOfExtendedCase

java.util.Collection<Extend> get_extendOfExtendedCase()

Returns the value of the 'extend Of Extended Case' reference list. The list contents are of type Extend. It is bidirectional and its opposite is 'Extended Case'.

If the meaning of the 'extend Of Extended Case' reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'extend Of Extended Case' reference list.

See Also:

UMLPackage.getUseCase__extendOfExtendedCase(), Extend.getExtendedCase()

Model:

opposite="extendedCase" ordered="false"

Generated:

getExtend

java.util.Collection<Extend> getExtend()

Returns the value of the 'Extend' containment reference list. The list contents are of type Extend. It is bidirectional and its opposite is 'Extension'. The Extend relationships owned by this UseCase.

Returns:

the value of the 'Extend' containment reference list.

See Also:

UMLPackage.getUseCase_Extend(), Extend.getExtension()

Model:

opposite="extension" containment="true" resolveProxies="true" ordered="false"

Generated:

getSubject

java.util.Collection<Classifier> getSubject()

Returns the value of the 'Subject' reference list. The list contents are of type Classifier. It is bidirectional and its opposite is 'Use Case'. The subjects to which this UseCase applies. Each subject or its parts realize all the UseCases that apply to it.

Returns:

the value of the 'Subject' reference list.

See Also:

UMLPackage.getUseCase_Subject(), Classifier.getUseCase()

Model:

opposite="useCase" ordered="false"

Generated:

get_classifierOfOwnedUseCase

@CheckForNull
Classifier get_classifierOfOwnedUseCase()

Returns the value of the 'classifier Of Owned Use Case' container reference. It is bidirectional and its opposite is 'Owned Use Case'.

If the meaning of the 'classifier Of Owned Use Case' container reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'classifier Of Owned Use Case' container reference.

See Also:

set_classifierOfOwnedUseCase(Classifier), UMLPackage.getUseCase__classifierOfOwnedUseCase(), Classifier.getOwnedUseCase()

Model:

opposite="ownedUseCase" transient="false" ordered="false"

Generated:

set_classifierOfOwnedUseCase

void set_classifierOfOwnedUseCase(@CheckForNull
                                  Classifier value)

Sets the value of the 'classifier Of Owned Use Case' container reference.

Parameters:

value - the new value of the 'classifier Of Owned Use Case' container reference.

See Also:

get_classifierOfOwnedUseCase()

Generated:

hasInclude

boolean hasInclude()
            throws javax.jmi.reflect.JmiException

Throws:

javax.jmi.reflect.JmiException

Generated:

has_includeOfAddition

boolean has_includeOfAddition()
                       throws javax.jmi.reflect.JmiException

Throws:

javax.jmi.reflect.JmiException

Generated:

hasExtensionPoint

boolean hasExtensionPoint()
                   throws javax.jmi.reflect.JmiException

Throws:

javax.jmi.reflect.JmiException

Generated:

has_extendOfExtendedCase

boolean has_extendOfExtendedCase()
                          throws javax.jmi.reflect.JmiException

Throws:

javax.jmi.reflect.JmiException

Generated:

hasExtend

boolean hasExtend()
           throws javax.jmi.reflect.JmiException

Throws:

javax.jmi.reflect.JmiException

Generated:

hasSubject

boolean hasSubject()
            throws javax.jmi.reflect.JmiException

Throws:

javax.jmi.reflect.JmiException

Generated: