org.eclipse.uml2
Interface InteractionOccurrence

All Superinterfaces:
Element, EModelElement, EObject, InteractionFragment, NamedElement, Notifier, TemplateableElement
All Known Subinterfaces:
PartDecomposition

public interface InteractionOccurrence
extends InteractionFragment

A representation of the model object 'Interaction Occurrence'. InteractionOccurrence is a specialization of InteractionFragment. An InteractionOccurrence has a set of actual gates that must match the formal gates of the referenced Interaction.

The following features are supported:

See Also:
UML2Package.getInteractionOccurrence()

Field Summary
static String copyright
           
 
Fields inherited from interface org.eclipse.uml2.NamedElement
SEPARATOR
 
Method Summary
 Gate createActualGate(EClass eClass)
          Creates a Gate and appends it to the 'Actual Gate' containment reference list
 InputPin createArgument(EClass eClass)
          Creates a InputPin and appends it to the 'Argument' containment reference list
 Gate getActualGate(String unqualifiedName)
          Retrieves the Gate with the specified name from the 'Actual Gate' containment reference list
 EList getActualGates()
          Returns the value of the 'Actual Gate' containment reference list.
 InputPin getArgument(String unqualifiedName)
          Retrieves the InputPin with the specified name from the 'Argument' containment reference list
 EList getArguments()
          Returns the value of the 'Argument' containment reference list.
 EList getOwnedElements()
           
 Interaction getRefersTo()
          Returns the value of the 'Refers To' reference
 void setRefersTo(Interaction value)
          Sets the value of the 'Refers To' reference
 
Methods inherited from interface org.eclipse.uml2.InteractionFragment
createGeneralOrdering, getCovered, getCovereds, getEnclosingInteraction, getEnclosingOperand, getGeneralOrdering, getGeneralOrderings, getNamespace, setEnclosingInteraction, setEnclosingOperand
 
Methods inherited from interface org.eclipse.uml2.NamedElement
allNamespaces, createNameExpression, getClientDependencies, getClientDependency, getName, getNameExpression, 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
 

Field Detail

copyright

public static final String copyright

See Also:
Constant Field Values
Method Detail

getRefersTo

public Interaction getRefersTo()
Returns the value of the 'Refers To' reference.

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

Refers to the Interaction that defines its meaning

Returns:
the value of the 'Refers To' reference.
See Also:
setRefersTo(Interaction), UML2Package.getInteractionOccurrence_RefersTo()

setRefersTo

public void setRefersTo(Interaction value)
Sets the value of the 'Refers To' reference.

Parameters:
value - the new value of the 'Refers To' reference.
See Also:
getRefersTo()

getActualGates

public EList getActualGates()
Returns the value of the 'Actual Gate' containment reference list. The list contents are of type Gate.

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

The actual gates of the InteractionOccurrence

Returns:
the value of the 'Actual Gate' containment reference list.
See Also:
UML2Package.getInteractionOccurrence_ActualGate()

getActualGate

public Gate getActualGate(String unqualifiedName)
Retrieves the Gate with the specified name from the 'Actual Gate' containment reference list.

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

createActualGate

public Gate createActualGate(EClass eClass)
Creates a Gate and appends it to the 'Actual Gate' containment reference list.

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

getArguments

public EList getArguments()
Returns the value of the 'Argument' containment reference list. The list contents are of type InputPin.

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

The actual arguments of the Interaction

Returns:
the value of the 'Argument' containment reference list.
See Also:
UML2Package.getInteractionOccurrence_Argument()

getArgument

public InputPin getArgument(String unqualifiedName)
Retrieves the InputPin with the specified name from the 'Argument' containment reference list.

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

createArgument

public InputPin createArgument(EClass eClass)
Creates a InputPin and appends it to the 'Argument' containment reference list.

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

getOwnedElements

public EList getOwnedElements()

Specified by:
getOwnedElements in interface InteractionFragment

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