org.eclipse.uml2
Interface Message

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

public interface Message
extends NamedElement

A representation of the model object 'Message'. A Message defines a particular communication between Lifelines of an Interaction. A Message is a NamedElement that defines one specific kind of communication in an Interaction. A communication can be e.g. raising a signal, invoking an Operation, creating or destroying an Instance. The Message specifies not only the kind of communication given by the dispatching ExecutionOccurrence, but also the sender and the receiver. A Message associates normally two EventOccurrences - one sending EventOccurrence and one receiving EventOccurrence.

The following features are supported:

See Also:
UML2Package.getMessage()

Field Summary
static String copyright
           
 
Fields inherited from interface org.eclipse.uml2.NamedElement
SEPARATOR
 
Method Summary
 ValueSpecification createArgument(EClass eClass)
          Creates a ValueSpecification and appends it to the 'Argument' containment reference list
 ValueSpecification getArgument(String unqualifiedName)
          Retrieves the ValueSpecification with the specified name from the 'Argument' containment reference list
 EList getArguments()
          Returns the value of the 'Argument' containment reference list.
 Connector getConnector()
          Returns the value of the 'Connector' reference
 Interaction getInteraction()
          Returns the value of the 'Interaction' container reference.
 MessageKind getMessageKind()
          Returns the value of the 'Message Kind' attribute.
 MessageSort getMessageSort()
          Returns the value of the 'Message Sort' attribute.
 Namespace getNamespace()
           
 EList getOwnedElements()
           
 MessageEnd getReceiveEvent()
          Returns the value of the 'Receive Event' reference.
 MessageEnd getSendEvent()
          Returns the value of the 'Send Event' reference.
 NamedElement getSignature()
          Returns the value of the 'Signature' reference
 void setConnector(Connector value)
          Sets the value of the 'Connector' reference
 void setInteraction(Interaction value)
          Sets the value of the 'Interaction' container reference
 void setMessageSort(MessageSort value)
          Sets the value of the 'Message Sort' attribute
 void setReceiveEvent(MessageEnd value)
          Sets the value of the 'Receive Event' reference
 void setSendEvent(MessageEnd value)
          Sets the value of the 'Send Event' reference
 void setSignature(NamedElement value)
          Sets the value of the 'Signature' 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

getMessageKind

public MessageKind getMessageKind()
Returns the value of the 'Message Kind' attribute. The literals are from the enumeration MessageKind.

If the meaning of the 'Message Kind' attribute isn't clear, there really should be more of a description here...

The derived kind of the Message (complete, lost, found or unknown) complete = sendEvent and receiveEvent are present lost = sendEvent present and receiveEvent absent found = sendEvent absent and receiveEvent present unknown = sendEvent and receiveEvent absent (should not appear)

Returns:
the value of the 'Message Kind' attribute.
See Also:
MessageKind, UML2Package.getMessage_MessageKind()

getMessageSort

public MessageSort getMessageSort()
Returns the value of the 'Message Sort' attribute. The literals are from the enumeration MessageSort.

If the meaning of the 'Message Sort' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Message Sort' attribute.
See Also:
MessageSort, setMessageSort(MessageSort), UML2Package.getMessage_MessageSort()

setMessageSort

public void setMessageSort(MessageSort value)
Sets the value of the 'Message Sort' attribute.

Parameters:
value - the new value of the 'Message Sort' attribute.
See Also:
MessageSort, getMessageSort()

getReceiveEvent

public MessageEnd getReceiveEvent()
Returns the value of the 'Receive Event' reference. It is bidirectional and its opposite is 'Receive Message'.

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

the Receiving of the Message

Returns:
the value of the 'Receive Event' reference.
See Also:
setReceiveEvent(MessageEnd), UML2Package.getMessage_ReceiveEvent(), MessageEnd.getReceiveMessage()

setReceiveEvent

public void setReceiveEvent(MessageEnd value)
Sets the value of the 'Receive Event' reference.

Parameters:
value - the new value of the 'Receive Event' reference.
See Also:
getReceiveEvent()

getSendEvent

public MessageEnd getSendEvent()
Returns the value of the 'Send Event' reference. It is bidirectional and its opposite is 'Send Message'.

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

References the Sending of the Message.

Returns:
the value of the 'Send Event' reference.
See Also:
setSendEvent(MessageEnd), UML2Package.getMessage_SendEvent(), MessageEnd.getSendMessage()

setSendEvent

public void setSendEvent(MessageEnd value)
Sets the value of the 'Send Event' reference.

Parameters:
value - the new value of the 'Send Event' reference.
See Also:
getSendEvent()

getConnector

public Connector getConnector()
Returns the value of the 'Connector' reference.

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

The Connector on which this Message is sent.

Returns:
the value of the 'Connector' reference.
See Also:
setConnector(Connector), UML2Package.getMessage_Connector()

setConnector

public void setConnector(Connector value)
Sets the value of the 'Connector' reference.

Parameters:
value - the new value of the 'Connector' reference.
See Also:
getConnector()

getInteraction

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

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

The enclosing Interaction owning the Message

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

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()

getSignature

public NamedElement getSignature()
Returns the value of the 'Signature' reference.

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

The definition of the type or signature of the Message (depending on its kind)

Returns:
the value of the 'Signature' reference.
See Also:
setSignature(NamedElement), UML2Package.getMessage_Signature()

setSignature

public void setSignature(NamedElement value)
Sets the value of the 'Signature' reference.

Parameters:
value - the new value of the 'Signature' reference.
See Also:
getSignature()

getArguments

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

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

arguments of the Message

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

getArgument

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

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

createArgument

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

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

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.