Package com.nomagic.uml2.ext.magicdraw.interactions.mdbasicinteractions

Interface Message

All Superinterfaces:

BaseElement, java.lang.Cloneable, java.lang.Comparable, Element, org.eclipse.emf.ecore.EObject, MDObject, com.dassault_systemes.modeler.foundation.model.ModelElement, ModelObject, NamedElement, org.eclipse.emf.common.notify.Notifier, javax.jmi.reflect.RefBaseObject, javax.jmi.reflect.RefFeatured, javax.jmi.reflect.RefObject

public interface Message
extends NamedElement

A representation of the model object 'Message'.

A Message defines a particular communication between Lifelines of an Interaction.

The following features are supported:

• Argument
• Interaction
• Message Kind
• Message Sort
• Receive Event
• message End Of Message
• Send Event
• Signature
• Guard
• Target
• Reply Message
• message Of Reply Message
• information Flow Of Realizing Message
• Connector

See Also:

UMLPackage.getMessage()

Model:

annotation="MOF package='interactions.mdbasicinteractions'"

Generated:

Method Summary

Modifier and Type	Method	Description
java.util.Collection<InformationFlow>	get_informationFlowOfRealizingMessage()	Returns the value of the 'information Flow Of Realizing Message' reference list.
java.util.Collection<MessageEnd>	get_messageEndOfMessage()	Returns the value of the 'message End Of Message' reference list.
java.util.Collection<Message>	get_messageOfReplyMessage()	Returns the value of the 'message Of Reply Message' reference list.
java.util.List<ValueSpecification>	getArgument()	Returns the value of the 'Argument' containment reference list.
Connector	getConnector()	Returns the value of the 'Connector' reference.
Constraint	getGuard()	Returns the value of the 'Guard' containment 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.
MessageEnd	getReceiveEvent()	Returns the value of the 'Receive Event' reference.
Message	getReplyMessage()	Returns the value of the 'Reply Message' reference.
MessageEnd	getSendEvent()	Returns the value of the 'Send Event' reference.
NamedElement	getSignature()	Returns the value of the 'Signature' reference.
ValueSpecification	getTarget()	Returns the value of the 'Target' containment reference.
boolean	has_informationFlowOfRealizingMessage()
boolean	has_messageEndOfMessage()
boolean	has_messageOfReplyMessage()
boolean	hasArgument()
void	setConnector(Connector value)	Sets the value of the 'Connector' reference.
void	setGuard(Constraint value)	Sets the value of the 'Guard' containment 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	setReplyMessage(Message value)	Sets the value of the 'Reply Message' reference.
void	setSendEvent(MessageEnd value)	Sets the value of the 'Send Event' reference.
void	setSignature(NamedElement value)	Sets the value of the 'Signature' reference.
void	setTarget(ValueSpecification value)	Sets the value of the 'Target' containment reference.

Methods inherited from interface com.nomagic.magicdraw.uml.BaseElement

accept, addPropertyChangeListener, canAdd, canAdd, canAddChild, canBeDeleted, firePropertyChange, getClassType, getHumanName, getHumanType, isEditable, removePropertyChangeListener, sGetID

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element

get_activityPartitionOfRepresents, get_commentOfAnnotatedElement, get_constraintOfConstrainedElement, get_diagramOfContext, get_directedRelationshipOfSource, get_directedRelationshipOfTarget, get_elementOfSyncElement, get_elementTaggedValue, get_elementValueOfElement, get_relationshipOfRelatedElement, getAppliedStereotype, getOwnedComment, getOwnedElement, getOwner, getSyncElement, getTaggedValue, has_activityPartitionOfRepresents, has_commentOfAnnotatedElement, has_constraintOfConstrainedElement, has_diagramOfContext, has_directedRelationshipOfSource, has_directedRelationshipOfTarget, has_elementOfSyncElement, has_elementValueOfElement, has_relationshipOfRelatedElement, hasAppliedStereotype, hasElementTaggedValue, hasOwnedComment, hasOwnedElement, hasTaggedValue, setOwner, setSyncElement

Methods inherited from interface org.eclipse.emf.ecore.EObject

eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface com.nomagic.magicdraw.foundation.MDObject

getID, getMDExtension, getMdExtensions, setID

Methods inherited from interface com.dassault_systemes.modeler.foundation.model.ModelElement

canChangeElementOwner, eDynamicGet, getElementOwner, getLocalID, getObjectParent, setLocalID, sGetLocalID

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.base.ModelObject

get_representationText, ignoringRefGetValue, ignoringRefGetValue, isSet, refGetValue, refGetValue, refSetValue, refSetValue, set_representationText

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.classes.mdkernel.NamedElement

get_considerIgnoreFragmentOfMessage, get_durationObservationOfEvent, get_informationFlowOfInformationSource, get_informationFlowOfInformationTarget, get_messageOfSignature, get_namespaceOfMember, get_timeObservationOfEvent, getClientDependency, getName, getNameExpression, getNamespace, getQualifiedName, getSupplierDependency, getVisibility, has_considerIgnoreFragmentOfMessage, has_durationObservationOfEvent, has_informationFlowOfInformationSource, has_informationFlowOfInformationTarget, has_messageOfSignature, has_namespaceOfMember, has_timeObservationOfEvent, hasClientDependency, hasSupplierDependency, setName, setNameExpression, setNamespace, setVisibility

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Methods inherited from interface javax.jmi.reflect.RefBaseObject

equals, hashCode, refImmediatePackage, refMetaObject, refMofId, refOutermostPackage, refVerifyConstraints

Methods inherited from interface javax.jmi.reflect.RefFeatured

refGetValue, refInvokeOperation, refInvokeOperation, refSetValue

Methods inherited from interface javax.jmi.reflect.RefObject

refClass, refDelete, refImmediateComposite, refIsInstanceOf, refOutermostComposite

Method Detail

getMessageKind

@CheckForNull
MessageKind getMessageKind()

Returns the value of the 'Message Kind' attribute. The literals are from the enumeration MessageKind. The derived kind of the Message (complete, lost, found, or unknown).

Returns:

the value of the 'Message Kind' attribute.

See Also:

MessageKind, UMLPackage.getMessage_MessageKind()

Model:

required="true" transient="true" changeable="false" volatile="true" derived="true" ordered="false"

Generated:

getMessageSort

@CheckForNull
MessageSort getMessageSort()

Returns the value of the 'Message Sort' attribute. The default value is "synchCall". The literals are from the enumeration MessageSort. The sort of communication reflected by the Message.

Returns:

the value of the 'Message Sort' attribute.

See Also:

MessageSort, setMessageSort(MessageSort), UMLPackage.getMessage_MessageSort()

Model:

default="synchCall" required="true" ordered="false"

Generated:

setMessageSort

void setMessageSort(@CheckForNull
                    MessageSort value)

Sets the value of the 'Message Sort' attribute.

Parameters:

value - the new value of the 'Message Sort' attribute.

See Also:

MessageSort, getMessageSort()

Generated:

getReceiveEvent

@CheckForNull
MessageEnd getReceiveEvent()

Returns the value of the 'Receive Event' reference. It is bidirectional and its opposite is 'message Of Receive Event'. References the Receiving of the Message.

Returns:

the value of the 'Receive Event' reference.

See Also:

setReceiveEvent(MessageEnd), UMLPackage.getMessage_ReceiveEvent(), MessageEnd.get_messageOfReceiveEvent()

Model:

opposite="_messageOfReceiveEvent" ordered="false"

Generated:

setReceiveEvent

void setReceiveEvent(@CheckForNull
                     MessageEnd value)

Sets the value of the 'Receive Event' reference.

Parameters:

value - the new value of the 'Receive Event' reference.

See Also:

getReceiveEvent()

Generated:

get_messageEndOfMessage

java.util.Collection<MessageEnd> get_messageEndOfMessage()

Returns the value of the 'message End Of Message' reference list. The list contents are of type MessageEnd. It is bidirectional and its opposite is 'Message'.

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

Returns:

the value of the 'message End Of Message' reference list.

See Also:

UMLPackage.getMessage__messageEndOfMessage(), MessageEnd.getMessage()

Model:

opposite="message" upper="2" ordered="false"

Generated:

getSendEvent

@CheckForNull
MessageEnd getSendEvent()

Returns the value of the 'Send Event' reference. It is bidirectional and its opposite is 'message Of Send Event'. References the Sending of the Message.

Returns:

the value of the 'Send Event' reference.

See Also:

setSendEvent(MessageEnd), UMLPackage.getMessage_SendEvent(), MessageEnd.get_messageOfSendEvent()

Model:

opposite="_messageOfSendEvent" ordered="false"

Generated:

setSendEvent

void setSendEvent(@CheckForNull
                  MessageEnd value)

Sets the value of the 'Send Event' reference.

Parameters:

value - the new value of the 'Send Event' reference.

See Also:

getSendEvent()

Generated:

getConnector

@CheckForNull
Connector getConnector()

Returns the value of the 'Connector' reference. It is bidirectional and its opposite is 'message Of Connector'. The Connector on which this Message is sent.

Returns:

the value of the 'Connector' reference.

See Also:

setConnector(Connector), UMLPackage.getMessage_Connector(), Connector.get_messageOfConnector()

Model:

opposite="_messageOfConnector" ordered="false"

Generated:

setConnector

void setConnector(@CheckForNull
                  Connector value)

Sets the value of the 'Connector' reference.

Parameters:

value - the new value of the 'Connector' reference.

See Also:

getConnector()

Generated:

getArgument

java.util.List<ValueSpecification> getArgument()

Returns the value of the 'Argument' containment reference list. The list contents are of type ValueSpecification. It is bidirectional and its opposite is 'message Of Argument'. The arguments of the Message.

Returns:

the value of the 'Argument' containment reference list.

See Also:

UMLPackage.getMessage_Argument(), ValueSpecification.get_messageOfArgument()

Model:

opposite="_messageOfArgument" containment="true" resolveProxies="true"

Generated:

getSignature

@CheckForNull
NamedElement getSignature()

Returns the value of the 'Signature' reference. It is bidirectional and its opposite is 'message Of Signature'. The signature of the Message is the specification of its content. It refers either an Operation or a Signal.

Returns:

the value of the 'Signature' reference.

See Also:

setSignature(NamedElement), UMLPackage.getMessage_Signature(), NamedElement.get_messageOfSignature()

Model:

opposite="_messageOfSignature" ordered="false"

Generated:

setSignature

void setSignature(@CheckForNull
                  NamedElement value)

Sets the value of the 'Signature' reference.

Parameters:

value - the new value of the 'Signature' reference.

See Also:

getSignature()

Generated:

get_informationFlowOfRealizingMessage

java.util.Collection<InformationFlow> get_informationFlowOfRealizingMessage()

Returns the value of the 'information Flow Of Realizing Message' reference list. The list contents are of type InformationFlow. It is bidirectional and its opposite is 'Realizing Message'.

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

Returns:

the value of the 'information Flow Of Realizing Message' reference list.

See Also:

UMLPackage.getMessage__informationFlowOfRealizingMessage(), InformationFlow.getRealizingMessage()

Model:

opposite="realizingMessage" ordered="false"

Generated:

getReplyMessage

@CheckForNull
Message getReplyMessage()

Returns the value of the 'Reply Message' reference. It is bidirectional and its opposite is 'message Of Reply Message'.

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

Returns:

the value of the 'Reply Message' reference.

See Also:

setReplyMessage(Message), UMLPackage.getMessage_ReplyMessage(), get_messageOfReplyMessage()

Model:

opposite="_messageOfReplyMessage" ordered="false"

Generated:

setReplyMessage

void setReplyMessage(@CheckForNull
                     Message value)

Sets the value of the 'Reply Message' reference.

Parameters:

value - the new value of the 'Reply Message' reference.

See Also:

getReplyMessage()

Generated:

get_messageOfReplyMessage

java.util.Collection<Message> get_messageOfReplyMessage()

Returns the value of the 'message Of Reply Message' reference list. The list contents are of type Message. It is bidirectional and its opposite is 'Reply Message'.

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

Returns:

the value of the 'message Of Reply Message' reference list.

See Also:

UMLPackage.getMessage__messageOfReplyMessage(), getReplyMessage()

Model:

opposite="replyMessage" ordered="false"

Generated:

getGuard

@CheckForNull
Constraint getGuard()

Returns the value of the 'Guard' containment reference. It is bidirectional and its opposite is 'message Of Guard'.

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

Returns:

the value of the 'Guard' containment reference.

See Also:

setGuard(Constraint), UMLPackage.getMessage_Guard(), Constraint.get_messageOfGuard()

Model:

opposite="_messageOfGuard" containment="true" resolveProxies="true" ordered="false"

Generated:

setGuard

void setGuard(@CheckForNull
              Constraint value)

Sets the value of the 'Guard' containment reference.

Parameters:

value - the new value of the 'Guard' containment reference.

See Also:

getGuard()

Generated:

getTarget

@CheckForNull
ValueSpecification getTarget()

Returns the value of the 'Target' containment reference. It is bidirectional and its opposite is 'message Of Target'.

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

Returns:

the value of the 'Target' containment reference.

See Also:

setTarget(ValueSpecification), UMLPackage.getMessage_Target(), ValueSpecification.get_messageOfTarget()

Model:

opposite="_messageOfTarget" containment="true" resolveProxies="true" ordered="false"

Generated:

setTarget

void setTarget(@CheckForNull
               ValueSpecification value)

Sets the value of the 'Target' containment reference.

Parameters:

value - the new value of the 'Target' containment reference.

See Also:

getTarget()

Generated:

getInteraction

@CheckForNull
Interaction getInteraction()

Returns the value of the 'Interaction' container reference. It is bidirectional and its opposite is 'Message'. The enclosing Interaction owning the Message.

Returns:

the value of the 'Interaction' container reference.

See Also:

setInteraction(Interaction), UMLPackage.getMessage_Interaction(), Interaction.getMessage()

Model:

opposite="message" required="true" transient="false" ordered="false"

Generated:

setInteraction

void setInteraction(@CheckForNull
                    Interaction value)

Sets the value of the 'Interaction' container reference.

Parameters:

value - the new value of the 'Interaction' container reference.

See Also:

getInteraction()

Generated:

has_messageEndOfMessage

boolean has_messageEndOfMessage()
                         throws javax.jmi.reflect.JmiException

Throws:

javax.jmi.reflect.JmiException

Generated:

hasArgument

boolean hasArgument()
             throws javax.jmi.reflect.JmiException

Throws:

javax.jmi.reflect.JmiException

Generated:

has_messageOfReplyMessage

boolean has_messageOfReplyMessage()
                           throws javax.jmi.reflect.JmiException

Throws:

javax.jmi.reflect.JmiException

Generated:

has_informationFlowOfRealizingMessage

boolean has_informationFlowOfRealizingMessage()
                                       throws javax.jmi.reflect.JmiException

Throws:

javax.jmi.reflect.JmiException

Generated: