org.eclipse.uml2
Interface Interaction

All Superinterfaces:

Behavior, BehavioredClassifier, Class, Classifier, Element, EModelElement, EncapsulatedClassifier, EObject, InteractionFragment, NamedElement, Namespace, Notifier, PackageableElement, ParameterableElement, RedefinableElement, StructuredClassifier, TemplateableElement, Type

public interface Interaction

extends Behavior, InteractionFragment

A representation of the model object 'Interaction'. The point is that the InteractionConstraint "received" from StructuralArchitecture will consist of a set of such units described by sequence diagrams (or collaboration diagrams).

The following features are supported:

• Lifeline
• Message
• Fragment
• Formal Gate

See Also:

UML2Package.getInteraction()

Field Summary

static java.lang.String

copyright

Fields inherited from interface org.eclipse.uml2.NamedElement

SEPARATOR

Method Summary

Gate	createFormalGate() Creates a Gate and appends it to the 'Formal Gate' containment reference list
Gate	createFormalGate(EClass eClass) Deprecated. Use #createFormalGate() instead.
InteractionFragment	createFragment(EClass eClass) Creates a InteractionFragment and appends it to the 'Fragment' containment reference list
Lifeline	createLifeline() Creates a Lifeline and appends it to the 'Lifeline' containment reference list
Lifeline	createLifeline(EClass eClass) Deprecated. Use #createLifeline() instead.
Message	createMessage() Creates a Message and appends it to the 'Message' containment reference list
Message	createMessage(EClass eClass) Deprecated. Use #createMessage() instead.
Gate	getFormalGate(java.lang.String name) Retrieves the Gate with the specified 'Name' from the 'Formal Gate' containment reference list
EList	getFormalGates() Returns the value of the 'Formal Gate' containment reference list.
InteractionFragment	getFragment(java.lang.String name) Retrieves the InteractionFragment with the specified 'Name' from the 'Fragment' containment reference list
EList	getFragments() Returns the value of the 'Fragment' containment reference list.
Lifeline	getLifeline(java.lang.String name) Retrieves the Lifeline with the specified 'Name' from the 'Lifeline' containment reference list
EList	getLifelines() Returns the value of the 'Lifeline' containment reference list.
Message	getMessage(java.lang.String name) Retrieves the Message with the specified 'Name' from the 'Message' containment reference list
EList	getMessages() Returns the value of the 'Message' containment reference list.

Methods inherited from interface org.eclipse.uml2.Behavior

createOwnedParameterSet, createOwnedParameterSet, createParameter, createParameter, getContext, getFormalParameter, getFormalParameters, getOwnedParameterSet, getOwnedParameterSets, getParameter, getParameters, getPostcondition, getPostconditions, getPrecondition, getPreconditions, getRedefinedBehavior, getRedefinedBehaviors, getReturnResult, getReturnResults, getSpecification, isReentrant, setContext, setIsReentrant, setSpecification

Methods inherited from interface org.eclipse.uml2.Class

createNestedClassifier, createOwnedAttribute, createOwnedOperation, createOwnedOperation, createOwnedOperation, createOwnedReception, createOwnedReception, getExtension, getExtensions, getNestedClassifier, getNestedClassifiers, getOwnedOperation, getOwnedOperations, getOwnedReception, getOwnedReceptions, getSuperClass, getSuperClasses, isActive, isMetaclass, setIsActive

Methods inherited from interface org.eclipse.uml2.BehavioredClassifier

createImplementation, createImplementation, createImplementation, createOwnedBehavior, createOwnedStateMachine, createOwnedStateMachine, createOwnedTrigger, getAllImplementedInterfaces, getClassifierBehavior, getImplementation, getImplementations, getImplementedInterfaces, getOwnedBehavior, getOwnedBehaviors, getOwnedStateMachine, getOwnedStateMachines, getOwnedTrigger, getOwnedTriggers, setClassifierBehavior

Methods inherited from interface org.eclipse.uml2.Classifier

allFeatures, allParents, conformsTo, createGeneralization, createGeneralization, createGeneralization, createOccurrence, createOccurrence, createOwnedUseCase, createOwnedUseCase, createSubstitution, createSubstitution, general, getAttribute, getAttributes, getFeature, getFeatures, getGeneral, getGeneralizations, getGenerals, getInheritedMember, getInheritedMembers, getOccurrence, getOccurrences, getOwnedUseCase, getOwnedUseCases, getPowertypeExtent, getPowertypeExtents, getRedefinedClassifier, getRedefinedClassifiers, getRepresentation, getSubstitution, getSubstitutions, getUseCase, getUseCases, getUsedInterfaces, hasVisibilityOf, inherit, inheritableMembers, inheritedMember, isAbstract, maySpecializeType, parents, setIsAbstract, setRepresentation, validateGeneralEqualsParents, validateInheritedMember, validateNoCyclesInGeneralization, validateSpecializeType

Methods inherited from interface org.eclipse.uml2.Namespace

createElementImport, createElementImport, createOwnedRule, createOwnedRule, createPackageImport, createPackageImport, excludeCollisions, getElementImports, getImportedMember, getImportedMembers, getImportedPackages, getMember, getMembers, getNamesOfMember, getOwnedMember, getOwnedMembers, getOwnedRule, getOwnedRules, getPackageImports, importedMember, importElement, importMembers, importPackage, membersAreDistinguishable, validateImportedMemberDerived, validateMembersAreDistinguishable

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

Methods inherited from interface org.eclipse.uml2.EncapsulatedClassifier

createOwnedPort, createOwnedPort, getOwnedPort, getOwnedPorts

Methods inherited from interface org.eclipse.uml2.StructuredClassifier

createOwnedAttribute, createOwnedAttribute, createOwnedConnector, createOwnedConnector, getOwnedAttribute, getOwnedAttributes, getOwnedConnector, getOwnedConnectors, getPart, getParts, getRole, getRoles

Methods inherited from interface org.eclipse.uml2.InteractionFragment

createGeneralOrdering, createGeneralOrdering, getCovered, getCovereds, getEnclosingInteraction, getEnclosingOperand, getGeneralOrdering, getGeneralOrderings, setEnclosingInteraction, setEnclosingOperand

Field Detail

copyright

public static final java.lang.String copyright

See Also:

Constant Field Values

Method Detail

getLifelines

public EList getLifelines()

Returns the value of the 'Lifeline' containment reference list. The list contents are of type Lifeline. It is bidirectional and its opposite is 'Interaction'.

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

Returns:

the value of the 'Lifeline' containment reference list.

See Also:

UML2Package.getInteraction_Lifeline(), Lifeline.getInteraction()

getLifeline

public Lifeline getLifeline(java.lang.String name)

Retrieves the Lifeline with the specified 'Name' from the 'Lifeline' containment reference list.

Parameters:

name - The 'Name' of the Lifeline to retrieve.

Returns:

The Lifeline with the specified 'Name', or null.

See Also:

getLifelines()

createLifeline

public Lifeline createLifeline(EClass eClass)

Deprecated. Use #createLifeline() instead.

Creates a Lifeline and appends it to the 'Lifeline' containment reference list.

Parameters:

eClass - The Ecore class of the Lifeline to create.

Returns:

The new Lifeline.

See Also:

getLifelines()

createLifeline

public Lifeline createLifeline()

Creates a Lifeline and appends it to the 'Lifeline' containment reference list.

Returns:

The new Lifeline.

See Also:

getLifelines()

getMessages

public EList getMessages()

Returns the value of the 'Message' containment reference list. The list contents are of type Message. It is bidirectional and its opposite is 'Interaction'.

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

Returns:

the value of the 'Message' containment reference list.

See Also:

UML2Package.getInteraction_Message(), Message.getInteraction()

getMessage

public Message getMessage(java.lang.String name)

Retrieves the Message with the specified 'Name' from the 'Message' containment reference list.

Parameters:

name - The 'Name' of the Message to retrieve.

Returns:

The Message with the specified 'Name', or null.

See Also:

getMessages()

createMessage

public Message createMessage(EClass eClass)

Deprecated. Use #createMessage() instead.

Creates a Message and appends it to the 'Message' containment reference list.

Parameters:

eClass - The Ecore class of the Message to create.

Returns:

The new Message.

See Also:

getMessages()

createMessage

public Message createMessage()

Creates a Message and appends it to the 'Message' containment reference list.

Returns:

The new Message.

See Also:

getMessages()

getFragments

public EList getFragments()

Returns the value of the 'Fragment' containment reference list. The list contents are of type InteractionFragment. It is bidirectional and its opposite is 'Enclosing Interaction'.

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

Returns:

the value of the 'Fragment' containment reference list.

See Also:

UML2Package.getInteraction_Fragment(), InteractionFragment.getEnclosingInteraction()

getFragment

public InteractionFragment getFragment(java.lang.String name)

Retrieves the InteractionFragment with the specified 'Name' from the 'Fragment' containment reference list.

Parameters:

name - The 'Name' of the InteractionFragment to retrieve.

Returns:

The InteractionFragment with the specified 'Name', or null.

See Also:

getFragments()

createFragment

public InteractionFragment createFragment(EClass eClass)

Creates a InteractionFragment and appends it to the 'Fragment' containment reference list.

Parameters:

eClass - The Ecore class of the InteractionFragment to create.

Returns:

The new InteractionFragment.

See Also:

getFragments()

getFormalGates

public EList getFormalGates()

Returns the value of the 'Formal Gate' containment reference list. The list contents are of type Gate.

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

Specifies the gates that form the message interface between this Interaction and any InteractionOccurrences which reference it.

Returns:

the value of the 'Formal Gate' containment reference list.

See Also:

UML2Package.getInteraction_FormalGate()

getFormalGate

public Gate getFormalGate(java.lang.String name)

Retrieves the Gate with the specified 'Name' from the 'Formal Gate' containment reference list.

Parameters:

name - The 'Name' of the Gate to retrieve.

Returns:

The Gate with the specified 'Name', or null.

See Also:

getFormalGates()

createFormalGate

public Gate createFormalGate(EClass eClass)

Deprecated. Use #createFormalGate() instead.

Creates a Gate and appends it to the 'Formal Gate' containment reference list.

Parameters:

eClass - The Ecore class of the Gate to create.

Returns:

The new Gate.

See Also:

getFormalGates()

createFormalGate

public Gate createFormalGate()

Creates a Gate and appends it to the 'Formal Gate' containment reference list.

Returns:

The new Gate.

See Also:

getFormalGates()