org.eclipse.uml2
Interface InteractionFragment

All Superinterfaces:
Element, EModelElement, EObject, NamedElement, Notifier, TemplateableElement
All Known Subinterfaces:
CombinedFragment, Continuation, EventOccurrence, ExecutionOccurrence, Interaction, InteractionOccurrence, InteractionOperand, PartDecomposition, StateInvariant, Stop

public interface InteractionFragment
extends NamedElement

A representation of the model object 'Interaction Fragment'. An InteractionFragment is a general class that holds the common parts of CompositeFragment, AtomicFragment and InteractionExpressionOperand. Conceptually it is very much the same as a full sequence diagram, but a fragment is not named and must be referred then through structure.

The following features are supported:

See Also:
UML2Package.getInteractionFragment()

Field Summary
static String copyright
           
 
Fields inherited from interface org.eclipse.uml2.NamedElement
SEPARATOR
 
Method Summary
 GeneralOrdering createGeneralOrdering(EClass eClass)
          Creates a GeneralOrdering and appends it to the 'General Ordering' containment reference list
 Lifeline getCovered(String unqualifiedName)
          Retrieves the Lifeline with the specified name from the 'Covered' reference list
 EList getCovereds()
          Returns the value of the 'Covered' reference list.
 Interaction getEnclosingInteraction()
          Returns the value of the 'Enclosing Interaction' container reference.
 InteractionOperand getEnclosingOperand()
          Returns the value of the 'Enclosing Operand' container reference.
 GeneralOrdering getGeneralOrdering(String unqualifiedName)
          Retrieves the GeneralOrdering with the specified name from the 'General Ordering' containment reference list
 EList getGeneralOrderings()
          Returns the value of the 'General Ordering' containment reference list.
 Namespace getNamespace()
           
 EList getOwnedElements()
           
 void setEnclosingInteraction(Interaction value)
          Sets the value of the 'Enclosing Interaction' container reference
 void setEnclosingOperand(InteractionOperand value)
          Sets the value of the 'Enclosing Operand' container reference
 
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

getCovereds

public EList getCovereds()
Returns the value of the 'Covered' reference list. The list contents are of type Lifeline. It is bidirectional and its opposite is 'Covered By'.

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

Returns:
the value of the 'Covered' reference list.
See Also:
UML2Package.getInteractionFragment_Covered(), Lifeline.getCoveredBys()

getCovered

public Lifeline getCovered(String unqualifiedName)
Retrieves the Lifeline with the specified name from the 'Covered' reference list.

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

getGeneralOrderings

public EList getGeneralOrderings()
Returns the value of the 'General Ordering' containment reference list. The list contents are of type GeneralOrdering.

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

Returns:
the value of the 'General Ordering' containment reference list.
See Also:
UML2Package.getInteractionFragment_GeneralOrdering()

getGeneralOrdering

public GeneralOrdering getGeneralOrdering(String unqualifiedName)
Retrieves the GeneralOrdering with the specified name from the 'General Ordering' containment reference list.

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

createGeneralOrdering

public GeneralOrdering createGeneralOrdering(EClass eClass)
Creates a GeneralOrdering and appends it to the 'General Ordering' containment reference list.

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

getEnclosingInteraction

public Interaction getEnclosingInteraction()
Returns the value of the 'Enclosing Interaction' container reference. It is bidirectional and its opposite is 'Fragment'.

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

Returns:
the value of the 'Enclosing Interaction' container reference.
See Also:
setEnclosingInteraction(Interaction), UML2Package.getInteractionFragment_EnclosingInteraction(), Interaction.getFragments()

setEnclosingInteraction

public void setEnclosingInteraction(Interaction value)
Sets the value of the 'Enclosing Interaction' container reference.

Parameters:
value - the new value of the 'Enclosing Interaction' container reference.
See Also:
getEnclosingInteraction()

getEnclosingOperand

public InteractionOperand getEnclosingOperand()
Returns the value of the 'Enclosing Operand' container reference. It is bidirectional and its opposite is 'Fragment'.

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

operand enclosing this InteractionFragment (they may nest recursively)

Returns:
the value of the 'Enclosing Operand' container reference.
See Also:
setEnclosingOperand(InteractionOperand), UML2Package.getInteractionFragment_EnclosingOperand(), InteractionOperand.getFragments()

setEnclosingOperand

public void setEnclosingOperand(InteractionOperand value)
Sets the value of the 'Enclosing Operand' container reference.

Parameters:
value - the new value of the 'Enclosing Operand' container reference.
See Also:
getEnclosingOperand()

getOwnedElements

public EList getOwnedElements()

Specified by:
getOwnedElements in interface NamedElement

getNamespace

public Namespace getNamespace()

Specified by:
getNamespace in interface NamedElement

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