org.eclipse.uml2
Interface Extend

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

public interface Extend
extends NamedElement, DirectedRelationship

A representation of the model object 'Extend'. This relationship specifies that the behavior of a use case may be extended by the behavior of another (usually supplementary) use case. The extension takes place at one or more specific extension points defined in the extended use case. Note, however, that the extended use case is defined independently of the extending use case and is meaningful independently of the extending use case. On the other hand, the extending use case typically defines behavior that may not necessarily be meaningful by itself. Instead, the extending use case defines a set of modular behavior increments that augment an execution of the extended use case under specific conditions. Note that the same extending use case can extend more than one use case. Furthermore, an extending use case may itself be extended. It is a kind of DirectedRelationship, such that the source is the extending use case and the destination is the extended 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 extend relationship itself is owned by the extending use case.

The following features are supported:

See Also:
UML2Package.getExtend()

Field Summary
static String copyright
           
 
Fields inherited from interface org.eclipse.uml2.NamedElement
SEPARATOR
 
Method Summary
 Constraint createCondition(EClass eClass)
          Creates a Constraint and sets the 'Condition' containment reference
 Constraint getCondition()
          Returns the value of the 'Condition' containment reference
 UseCase getExtendedCase()
          Returns the value of the 'Extended Case' reference
 UseCase getExtension()
          Returns the value of the 'Extension' container reference.
 ExtensionPoint getExtensionLocation(String unqualifiedName)
          Retrieves the ExtensionPoint with the specified name from the 'Extension Location' reference list
 EList getExtensionLocations()
          Returns the value of the 'Extension Location' reference list.
 EList getOwnedElements()
           
 EList getSources()
           
 EList getTargets()
           
 void setCondition(Constraint value)
          Sets the value of the 'Condition' containment reference
 void setExtendedCase(UseCase value)
          Sets the value of the 'Extended Case' reference
 void setExtension(UseCase value)
          Sets the value of the 'Extension' container reference
 
Methods inherited from interface org.eclipse.uml2.NamedElement
allNamespaces, createNameExpression, getClientDependencies, getClientDependency, getName, getNameExpression, getNamespace, 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

getExtendedCase

public UseCase getExtendedCase()
Returns the value of the 'Extended Case' reference.

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

References the use case that is being extended. (Specializes DirectedRelationship.target.)

Returns:
the value of the 'Extended Case' reference.
See Also:
setExtendedCase(UseCase), UML2Package.getExtend_ExtendedCase()

setExtendedCase

public void setExtendedCase(UseCase value)
Sets the value of the 'Extended Case' reference.

Parameters:
value - the new value of the 'Extended Case' reference.
See Also:
getExtendedCase()

getExtension

public UseCase getExtension()
Returns the value of the 'Extension' container reference. It is bidirectional and its opposite is 'Extend'.

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

Returns:
the value of the 'Extension' container reference.
See Also:
setExtension(UseCase), UML2Package.getExtend_Extension(), UseCase.getExtends()

setExtension

public void setExtension(UseCase value)
Sets the value of the 'Extension' container reference.

Parameters:
value - the new value of the 'Extension' container reference.
See Also:
getExtension()

getCondition

public Constraint getCondition()
Returns the value of the 'Condition' containment reference.

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

Returns:
the value of the 'Condition' containment reference.
See Also:
setCondition(Constraint), UML2Package.getExtend_Condition()

setCondition

public void setCondition(Constraint value)
Sets the value of the 'Condition' containment reference.

Parameters:
value - the new value of the 'Condition' containment reference.
See Also:
getCondition()

createCondition

public Constraint createCondition(EClass eClass)
Creates a Constraint and sets the 'Condition' containment reference.

Parameters:
eClass - The Ecore class of the Constraint to create.
Returns:
The new Constraint.
See Also:
getCondition()

getExtensionLocations

public EList getExtensionLocations()
Returns the value of the 'Extension Location' reference list. The list contents are of type ExtensionPoint.

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

Returns:
the value of the 'Extension Location' reference list.
See Also:
UML2Package.getExtend_ExtensionLocation()

getExtensionLocation

public ExtensionPoint getExtensionLocation(String unqualifiedName)
Retrieves the ExtensionPoint with the specified name from the 'Extension Location' reference list.

Parameters:
unqualifiedName - The unqualified name of the ExtensionPoint to retrieve.
Returns:
The ExtensionPoint with the specified name, or null.
See Also:
getExtensionLocations()

getTargets

public EList getTargets()

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

getSources

public EList getSources()

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

getOwnedElements

public EList getOwnedElements()

Specified by:
getOwnedElements in interface NamedElement

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