org.eclipse.uml2
Interface Include

All Superinterfaces:
DirectedRelationship, Element, EModelElement, EObject, NamedElement, Notifier, Relationship, TemplateableElement

public interface Include
extends NamedElement, DirectedRelationship

A representation of the model object 'Include'. Include is a DirectedRelationship between two use cases, implying that the behavior of the included use case is inserted into the behavior of the including use case. It is also a kind of NamedElement so that it can have a name in the context of its owning use case. The including use case may only depend on the result (value) of the included use case. This value is obtained as a result of the execution of the included use case. Note that the included use case is not optional, and is always required for the including use case to execute correctly.

The following features are supported:

See Also:
UML2Package.getInclude()

Field Summary
static String copyright
           
 
Fields inherited from interface org.eclipse.uml2.NamedElement
SEPARATOR
 
Method Summary
 UseCase getAddition()
          Returns the value of the 'Addition' reference
 UseCase getIncludingCase()
          Returns the value of the 'Including Case' container reference.
 EList getSources()
           
 EList getTargets()
           
 void setAddition(UseCase value)
          Sets the value of the 'Addition' reference
 void setIncludingCase(UseCase value)
          Sets the value of the 'Including Case' container reference
 
Methods inherited from interface org.eclipse.uml2.NamedElement
allNamespaces, createNameExpression, getClientDependencies, getClientDependency, getName, getNameExpression, getNamespace, getOwnedElements, getOwner, getQualifiedName, getVisibility, isDistinguishableFrom, qualifiedName, separator, setName, setNameExpression, setVisibility, validateNoName, validateQualifiedName, validateVisibilityNeedsOwnership
 
Methods inherited from interface org.eclipse.uml2.TemplateableElement
createOwnedTemplateSignature, createTemplateBinding, getOwnedTemplateSignature, getTemplateBindings, parameterableElements, setOwnedTemplateSignature
 
Methods inherited from interface org.eclipse.uml2.Element
addKeyword, allOwnedElements, apply, createEAnnotation, createOwnedComment, destroy, getApplicableStereotype, getApplicableStereotypes, getAppliedStereotype, getAppliedStereotypes, getAppliedVersion, getKeywords, getModel, getNearestPackage, getOwnedComments, getValue, hasKeyword, 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.DirectedRelationship
getRelatedElements
 

Field Detail

copyright

public static final String copyright

See Also:
Constant Field Values
Method Detail

getIncludingCase

public UseCase getIncludingCase()
Returns the value of the 'Including Case' container reference. It is bidirectional and its opposite is 'Include'.

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

References the use case which will include the addition and owns the include relationship. (Specializes DirectedRelationship.source.)

Returns:
the value of the 'Including Case' container reference.
See Also:
setIncludingCase(UseCase), UML2Package.getInclude_IncludingCase(), UseCase.getIncludes()

setIncludingCase

public void setIncludingCase(UseCase value)
Sets the value of the 'Including Case' container reference.

Parameters:
value - the new value of the 'Including Case' container reference.
See Also:
getIncludingCase()

getAddition

public UseCase getAddition()
Returns the value of the 'Addition' reference.

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

References the use case that is to be included. (Specializes DirectedRelationship.target.)

Returns:
the value of the 'Addition' reference.
See Also:
setAddition(UseCase), UML2Package.getInclude_Addition()

setAddition

public void setAddition(UseCase value)
Sets the value of the 'Addition' reference.

Parameters:
value - the new value of the 'Addition' reference.
See Also:
getAddition()

getSources

public EList getSources()

Specified by:
getSources in interface DirectedRelationship
Returns:
the value of the 'Source' reference list.
See Also:
UML2Package.getDirectedRelationship_Source()

getTargets

public EList getTargets()

Specified by:
getTargets in interface DirectedRelationship
Returns:
the value of the 'Target' reference list.
See Also:
UML2Package.getDirectedRelationship_Target()

Copyright 2003, 2004 IBM Corporation and others.
All Rights Reserved.