| /* |
| * Copyright (c) 2003, 2004 IBM Corporation and others. |
| * All rights reserved. This program and the accompanying materials |
| * are made available under the terms of the Eclipse Public License v1.0 |
| * which accompanies this distribution, and is available at |
| * http://www.eclipse.org/legal/epl-v10.html |
| * |
| * Contributors: |
| * IBM - initial API and implementation |
| * |
| * $Id: Message.java,v 1.8 2005/06/15 20:06:01 khussey Exp $ |
| */ |
| package org.eclipse.uml2; |
| |
| import org.eclipse.emf.common.util.EList; |
| |
| import org.eclipse.emf.ecore.EClass; |
| |
| /** |
| * <!-- begin-user-doc --> |
| * A representation of the model object '<em><b>Message</b></em>'. |
| * <!-- end-user-doc --> |
| * |
| * <!-- begin-model-doc --> |
| * 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. |
| * <!-- end-model-doc --> |
| * |
| * <p> |
| * The following features are supported: |
| * <ul> |
| * <li>{@link org.eclipse.uml2.Message#getMessageKind <em>Message Kind</em>}</li> |
| * <li>{@link org.eclipse.uml2.Message#getMessageSort <em>Message Sort</em>}</li> |
| * <li>{@link org.eclipse.uml2.Message#getReceiveEvent <em>Receive Event</em>}</li> |
| * <li>{@link org.eclipse.uml2.Message#getSendEvent <em>Send Event</em>}</li> |
| * <li>{@link org.eclipse.uml2.Message#getConnector <em>Connector</em>}</li> |
| * <li>{@link org.eclipse.uml2.Message#getInteraction <em>Interaction</em>}</li> |
| * <li>{@link org.eclipse.uml2.Message#getSignature <em>Signature</em>}</li> |
| * <li>{@link org.eclipse.uml2.Message#getArguments <em>Argument</em>}</li> |
| * </ul> |
| * </p> |
| * |
| * @see org.eclipse.uml2.UML2Package#getMessage() |
| * @model |
| * @generated |
| */ |
| public interface Message extends NamedElement{ |
| /** |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @generated |
| */ |
| String copyright = "Copyright (c) IBM Corporation and others."; //$NON-NLS-1$ |
| |
| /** |
| * Returns the value of the '<em><b>Message Kind</b></em>' attribute. |
| * The literals are from the enumeration {@link org.eclipse.uml2.MessageKind}. |
| * <!-- begin-user-doc --> |
| * <p> |
| * If the meaning of the '<em>Message Kind</em>' attribute isn't clear, |
| * there really should be more of a description here... |
| * </p> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * 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) |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Message Kind</em>' attribute. |
| * @see org.eclipse.uml2.MessageKind |
| * @see org.eclipse.uml2.UML2Package#getMessage_MessageKind() |
| * @model transient="true" changeable="false" volatile="true" derived="true" |
| * @generated |
| */ |
| MessageKind getMessageKind(); |
| |
| |
| /** |
| * Returns the value of the '<em><b>Message Sort</b></em>' attribute. |
| * The literals are from the enumeration {@link org.eclipse.uml2.MessageSort}. |
| * <!-- begin-user-doc --> |
| * <p> |
| * If the meaning of the '<em>Message Sort</em>' attribute isn't clear, |
| * there really should be more of a description here... |
| * </p> |
| * <!-- end-user-doc --> |
| * @return the value of the '<em>Message Sort</em>' attribute. |
| * @see org.eclipse.uml2.MessageSort |
| * @see #setMessageSort(MessageSort) |
| * @see org.eclipse.uml2.UML2Package#getMessage_MessageSort() |
| * @model |
| * @generated |
| */ |
| MessageSort getMessageSort(); |
| |
| /** |
| * Sets the value of the '{@link org.eclipse.uml2.Message#getMessageSort <em>Message Sort</em>}' attribute. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Message Sort</em>' attribute. |
| * @see org.eclipse.uml2.MessageSort |
| * @see #getMessageSort() |
| * @generated |
| */ |
| void setMessageSort(MessageSort value); |
| |
| |
| /** |
| * Returns the value of the '<em><b>Receive Event</b></em>' reference. |
| * It is bidirectional and its opposite is '{@link org.eclipse.uml2.MessageEnd#getReceiveMessage <em>Receive Message</em>}'. |
| * <!-- begin-user-doc --> |
| * <p> |
| * If the meaning of the '<em>Receive Event</em>' reference isn't clear, |
| * there really should be more of a description here... |
| * </p> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * the Receiving of the Message |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Receive Event</em>' reference. |
| * @see #setReceiveEvent(MessageEnd) |
| * @see org.eclipse.uml2.UML2Package#getMessage_ReceiveEvent() |
| * @see org.eclipse.uml2.MessageEnd#getReceiveMessage |
| * @model opposite="receiveMessage" |
| * @generated |
| */ |
| MessageEnd getReceiveEvent(); |
| |
| /** |
| * Sets the value of the '{@link org.eclipse.uml2.Message#getReceiveEvent <em>Receive Event</em>}' reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Receive Event</em>' reference. |
| * @see #getReceiveEvent() |
| * @generated |
| */ |
| void setReceiveEvent(MessageEnd value); |
| |
| |
| /** |
| * Returns the value of the '<em><b>Send Event</b></em>' reference. |
| * It is bidirectional and its opposite is '{@link org.eclipse.uml2.MessageEnd#getSendMessage <em>Send Message</em>}'. |
| * <!-- begin-user-doc --> |
| * <p> |
| * If the meaning of the '<em>Send Event</em>' reference isn't clear, |
| * there really should be more of a description here... |
| * </p> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * References the Sending of the Message. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Send Event</em>' reference. |
| * @see #setSendEvent(MessageEnd) |
| * @see org.eclipse.uml2.UML2Package#getMessage_SendEvent() |
| * @see org.eclipse.uml2.MessageEnd#getSendMessage |
| * @model opposite="sendMessage" |
| * @generated |
| */ |
| MessageEnd getSendEvent(); |
| |
| /** |
| * Sets the value of the '{@link org.eclipse.uml2.Message#getSendEvent <em>Send Event</em>}' reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Send Event</em>' reference. |
| * @see #getSendEvent() |
| * @generated |
| */ |
| void setSendEvent(MessageEnd value); |
| |
| |
| /** |
| * Returns the value of the '<em><b>Connector</b></em>' reference. |
| * <!-- begin-user-doc --> |
| * <p> |
| * If the meaning of the '<em>Connector</em>' reference isn't clear, |
| * there really should be more of a description here... |
| * </p> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * The Connector on which this Message is sent. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Connector</em>' reference. |
| * @see #setConnector(Connector) |
| * @see org.eclipse.uml2.UML2Package#getMessage_Connector() |
| * @model |
| * @generated |
| */ |
| Connector getConnector(); |
| |
| /** |
| * Sets the value of the '{@link org.eclipse.uml2.Message#getConnector <em>Connector</em>}' reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Connector</em>' reference. |
| * @see #getConnector() |
| * @generated |
| */ |
| void setConnector(Connector value); |
| |
| |
| /** |
| * Returns the value of the '<em><b>Interaction</b></em>' container reference. |
| * It is bidirectional and its opposite is '{@link org.eclipse.uml2.Interaction#getMessages <em>Message</em>}'. |
| * <!-- begin-user-doc --> |
| * <p> |
| * If the meaning of the '<em>Interaction</em>' container reference isn't clear, |
| * there really should be more of a description here... |
| * </p> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * The enclosing Interaction owning the Message |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Interaction</em>' container reference. |
| * @see #setInteraction(Interaction) |
| * @see org.eclipse.uml2.UML2Package#getMessage_Interaction() |
| * @see org.eclipse.uml2.Interaction#getMessages |
| * @model opposite="message" required="true" |
| * @generated |
| */ |
| Interaction getInteraction(); |
| |
| /** |
| * Sets the value of the '{@link org.eclipse.uml2.Message#getInteraction <em>Interaction</em>}' container reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Interaction</em>' container reference. |
| * @see #getInteraction() |
| * @generated |
| */ |
| void setInteraction(Interaction value); |
| |
| |
| /** |
| * Returns the value of the '<em><b>Signature</b></em>' reference. |
| * <!-- begin-user-doc --> |
| * <p> |
| * If the meaning of the '<em>Signature</em>' reference isn't clear, |
| * there really should be more of a description here... |
| * </p> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * The definition of the type or signature of the Message (depending on its kind) |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Signature</em>' reference. |
| * @see #setSignature(NamedElement) |
| * @see org.eclipse.uml2.UML2Package#getMessage_Signature() |
| * @model |
| * @generated |
| */ |
| NamedElement getSignature(); |
| |
| /** |
| * Sets the value of the '{@link org.eclipse.uml2.Message#getSignature <em>Signature</em>}' reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Signature</em>' reference. |
| * @see #getSignature() |
| * @generated |
| */ |
| void setSignature(NamedElement value); |
| |
| |
| /** |
| * Returns the value of the '<em><b>Argument</b></em>' containment reference list. |
| * The list contents are of type {@link org.eclipse.uml2.ValueSpecification}. |
| * <!-- begin-user-doc --> |
| * <p> |
| * If the meaning of the '<em>Argument</em>' containment reference list isn't clear, |
| * there really should be more of a description here... |
| * </p> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * arguments of the Message |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Argument</em>' containment reference list. |
| * @see org.eclipse.uml2.UML2Package#getMessage_Argument() |
| * @model type="org.eclipse.uml2.ValueSpecification" containment="true" ordered="false" |
| * @generated |
| */ |
| EList getArguments(); |
| |
| |
| /** |
| * Retrieves the {@link org.eclipse.uml2.ValueSpecification} with the specified '<em><b>Name</b></em>' from the '<em><b>Argument</b></em>' containment reference list. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param name The '<em><b>Name</b></em>' of the {@link org.eclipse.uml2.ValueSpecification} to retrieve. |
| * @return The {@link org.eclipse.uml2.ValueSpecification} with the specified '<em><b>Name</b></em>', or <code>null</code>. |
| * @see #getArguments() |
| * @generated |
| */ |
| ValueSpecification getArgument(String name); |
| |
| /** |
| * Creates a {@link org.eclipse.uml2.ValueSpecification} and appends it to the '<em><b>Argument</b></em>' containment reference list. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param eClass The Ecore class of the {@link org.eclipse.uml2.ValueSpecification} to create. |
| * @return The new {@link org.eclipse.uml2.ValueSpecification}. |
| * @see #getArguments() |
| * @generated |
| */ |
| ValueSpecification createArgument(EClass eClass); |
| |
| } // Message |