org.eclipse.uml2
Interface Lifeline

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

public interface Lifeline
extends NamedElement

A representation of the model object 'Lifeline'. A lifeline represents an individual participant in the Interaction. While Parts and StructuralFeatures may have multiplicity greater than 1, Lifelines represent only one interacting entity. Lifeline is a specialization of NamedElement. If the referenced ConnectableElement is multivalued (i.e. has a multiplicity > 1), then the Lifeline may have an expression (the �selector�) that specifies which particular part is represented by this Lifeline. If the selector is omitted this means that an arbitrary representative of the multivalued ConnectableElement is chosen.

The following features are supported:

See Also:
UML2Package.getLifeline()

Field Summary
static String copyright
           
 
Fields inherited from interface org.eclipse.uml2.NamedElement
SEPARATOR
 
Method Summary
 OpaqueExpression createSelector(EClass eClass)
          Creates a OpaqueExpression and sets the 'Selector' containment reference
 InteractionFragment getCoveredBy(String unqualifiedName)
          Retrieves the InteractionFragment with the specified name from the 'Covered By' reference list
 EList getCoveredBys()
          Returns the value of the 'Covered By' reference list.
 PartDecomposition getDecomposedAs()
          Returns the value of the 'Decomposed As' reference
 Interaction getInteraction()
          Returns the value of the 'Interaction' container reference.
 Namespace getNamespace()
           
 EList getOwnedElements()
           
 ConnectableElement getRepresents()
          Returns the value of the 'Represents' reference
 OpaqueExpression getSelector()
          Returns the value of the 'Selector' containment reference
 void setDecomposedAs(PartDecomposition value)
          Sets the value of the 'Decomposed As' reference
 void setInteraction(Interaction value)
          Sets the value of the 'Interaction' container reference
 void setRepresents(ConnectableElement value)
          Sets the value of the 'Represents' reference
 void setSelector(OpaqueExpression value)
          Sets the value of the 'Selector' containment 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

getCoveredBys

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

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

Returns:
the value of the 'Covered By' reference list.
See Also:
UML2Package.getLifeline_CoveredBy(), InteractionFragment.getCovereds()

getCoveredBy

public InteractionFragment getCoveredBy(String unqualifiedName)
Retrieves the InteractionFragment with the specified name from the 'Covered By' reference list.

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

getRepresents

public ConnectableElement getRepresents()
Returns the value of the 'Represents' reference.

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

the ConnectableElement within the classifier that contains the enclosing interaction.

Returns:
the value of the 'Represents' reference.
See Also:
setRepresents(ConnectableElement), UML2Package.getLifeline_Represents()

setRepresents

public void setRepresents(ConnectableElement value)
Sets the value of the 'Represents' reference.

Parameters:
value - the new value of the 'Represents' reference.
See Also:
getRepresents()

getInteraction

public Interaction getInteraction()
Returns the value of the 'Interaction' container reference. It is bidirectional and its opposite is 'Lifeline'.

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

References the Interaction enclosing this Lifeline.

Returns:
the value of the 'Interaction' container reference.
See Also:
setInteraction(Interaction), UML2Package.getLifeline_Interaction(), Interaction.getLifelines()

setInteraction

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

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

getSelector

public OpaqueExpression getSelector()
Returns the value of the 'Selector' containment reference.

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

If the referenced ConnectableElement is multivalued, then this specifies the specific individual part within that set.

Returns:
the value of the 'Selector' containment reference.
See Also:
setSelector(OpaqueExpression), UML2Package.getLifeline_Selector()

setSelector

public void setSelector(OpaqueExpression value)
Sets the value of the 'Selector' containment reference.

Parameters:
value - the new value of the 'Selector' containment reference.
See Also:
getSelector()

createSelector

public OpaqueExpression createSelector(EClass eClass)
Creates a OpaqueExpression and sets the 'Selector' containment reference.

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

getDecomposedAs

public PartDecomposition getDecomposedAs()
Returns the value of the 'Decomposed As' reference.

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

Returns:
the value of the 'Decomposed As' reference.
See Also:
setDecomposedAs(PartDecomposition), UML2Package.getLifeline_DecomposedAs()

setDecomposedAs

public void setDecomposedAs(PartDecomposition value)
Sets the value of the 'Decomposed As' reference.

Parameters:
value - the new value of the 'Decomposed As' reference.
See Also:
getDecomposedAs()

getNamespace

public Namespace getNamespace()

Specified by:
getNamespace in interface NamedElement

getOwnedElements

public EList getOwnedElements()

Specified by:
getOwnedElements in interface NamedElement

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