| /* |
| * Copyright (c) 2005, 2006 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: ReplyAction.java,v 1.7 2006/12/14 15:49:28 khussey Exp $ |
| */ |
| package org.eclipse.uml2.uml; |
| |
| import java.util.Map; |
| |
| import org.eclipse.emf.common.util.DiagnosticChain; |
| |
| import org.eclipse.emf.common.util.EList; |
| |
| import org.eclipse.emf.ecore.EClass; |
| |
| /** |
| * <!-- begin-user-doc --> |
| * A representation of the model object '<em><b>Reply Action</b></em>'. |
| * <!-- end-user-doc --> |
| * |
| * <!-- begin-model-doc --> |
| * A reply action is an action that accepts a set of return values and a value containing return information produced by a previous accept call action. The reply action returns the values to the caller of the previous call, completing execution of the call. |
| * <!-- end-model-doc --> |
| * |
| * <p> |
| * The following features are supported: |
| * <ul> |
| * <li>{@link org.eclipse.uml2.uml.ReplyAction#getReplyToCall <em>Reply To Call</em>}</li> |
| * <li>{@link org.eclipse.uml2.uml.ReplyAction#getReturnInformation <em>Return Information</em>}</li> |
| * <li>{@link org.eclipse.uml2.uml.ReplyAction#getReplyValues <em>Reply Value</em>}</li> |
| * </ul> |
| * </p> |
| * |
| * @see org.eclipse.uml2.uml.UMLPackage#getReplyAction() |
| * @model |
| * @generated |
| */ |
| public interface ReplyAction |
| extends Action { |
| |
| /** |
| * Returns the value of the '<em><b>Reply To Call</b></em>' reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * The trigger specifying the operation whose call is being replied to. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Reply To Call</em>' reference. |
| * @see #setReplyToCall(Trigger) |
| * @see org.eclipse.uml2.uml.UMLPackage#getReplyAction_ReplyToCall() |
| * @model required="true" ordered="false" |
| * @generated |
| */ |
| Trigger getReplyToCall(); |
| |
| /** |
| * Sets the value of the '{@link org.eclipse.uml2.uml.ReplyAction#getReplyToCall <em>Reply To Call</em>}' reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Reply To Call</em>' reference. |
| * @see #getReplyToCall() |
| * @generated |
| */ |
| void setReplyToCall(Trigger value); |
| |
| /** |
| * Returns the value of the '<em><b>Return Information</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * A pin containing the return information value produced by an earlier AcceptCallAction. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Return Information</em>' containment reference. |
| * @see #setReturnInformation(InputPin) |
| * @see org.eclipse.uml2.uml.UMLPackage#getReplyAction_ReturnInformation() |
| * @model containment="true" resolveProxies="true" required="true" ordered="false" |
| * @generated |
| */ |
| InputPin getReturnInformation(); |
| |
| /** |
| * Sets the value of the '{@link org.eclipse.uml2.uml.ReplyAction#getReturnInformation <em>Return Information</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Return Information</em>' containment reference. |
| * @see #getReturnInformation() |
| * @generated |
| */ |
| void setReturnInformation(InputPin value); |
| |
| /** |
| * Creates a new {@link org.eclipse.uml2.uml.InputPin}, with the specified '<em><b>Name</b></em>', and '<em><b>Type</b></em>', and sets the '<em><b>Return Information</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param name The '<em><b>Name</b></em>' for the new {@link org.eclipse.uml2.uml.InputPin}, or <code>null</code>. |
| * @param type The '<em><b>Type</b></em>' for the new {@link org.eclipse.uml2.uml.InputPin}, or <code>null</code>. |
| * @param eClass The Ecore class of the {@link org.eclipse.uml2.uml.InputPin} to create. |
| * @return The new {@link org.eclipse.uml2.uml.InputPin}. |
| * @see #getReturnInformation() |
| * @generated |
| */ |
| InputPin createReturnInformation(String name, Type type, EClass eClass); |
| |
| /** |
| * Creates a new {@link org.eclipse.uml2.uml.InputPin},with the specified '<em><b>Name</b></em>', and '<em><b>Type</b></em>', and sets the '<em><b>Return Information</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param name The '<em><b>Name</b></em>' for the new {@link org.eclipse.uml2.uml.InputPin}, or <code>null</code>. |
| * @param type The '<em><b>Type</b></em>' for the new {@link org.eclipse.uml2.uml.InputPin}, or <code>null</code>. |
| * @return The new {@link org.eclipse.uml2.uml.InputPin}. |
| * @see #getReturnInformation() |
| * @generated |
| */ |
| InputPin createReturnInformation(String name, Type type); |
| |
| /** |
| * Returns the value of the '<em><b>Reply Value</b></em>' containment reference list. |
| * The list contents are of type {@link org.eclipse.uml2.uml.InputPin}. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * A list of pins containing the reply values of the operation. These values are returned to the caller. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Reply Value</em>' containment reference list. |
| * @see org.eclipse.uml2.uml.UMLPackage#getReplyAction_ReplyValue() |
| * @model type="org.eclipse.uml2.uml.InputPin" containment="true" resolveProxies="true" ordered="false" |
| * @generated |
| */ |
| EList<InputPin> getReplyValues(); |
| |
| /** |
| * Creates a new {@link org.eclipse.uml2.uml.InputPin}, with the specified '<em><b>Name</b></em>', and '<em><b>Type</b></em>', and appends it to the '<em><b>Reply Value</b></em>' containment reference list. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param name The '<em><b>Name</b></em>' for the new {@link org.eclipse.uml2.uml.InputPin}, or <code>null</code>. |
| * @param type The '<em><b>Type</b></em>' for the new {@link org.eclipse.uml2.uml.InputPin}, or <code>null</code>. |
| * @param eClass The Ecore class of the {@link org.eclipse.uml2.uml.InputPin} to create. |
| * @return The new {@link org.eclipse.uml2.uml.InputPin}. |
| * @see #getReplyValues() |
| * @generated |
| */ |
| InputPin createReplyValue(String name, Type type, EClass eClass); |
| |
| /** |
| * Creates a new {@link org.eclipse.uml2.uml.InputPin}, with the specified '<em><b>Name</b></em>', and '<em><b>Type</b></em>', and appends it to the '<em><b>Reply Value</b></em>' containment reference list. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param name The '<em><b>Name</b></em>' for the new {@link org.eclipse.uml2.uml.InputPin}, or <code>null</code>. |
| * @param type The '<em><b>Type</b></em>' for the new {@link org.eclipse.uml2.uml.InputPin}, or <code>null</code>. |
| * @return The new {@link org.eclipse.uml2.uml.InputPin}. |
| * @see #getReplyValues() |
| * @generated |
| */ |
| InputPin createReplyValue(String name, Type type); |
| |
| /** |
| * Retrieves the first {@link org.eclipse.uml2.uml.InputPin} with the specified '<em><b>Name</b></em>', and '<em><b>Type</b></em>' from the '<em><b>Reply Value</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.uml.InputPin} to retrieve, or <code>null</code>. |
| * @param type The '<em><b>Type</b></em>' of the {@link org.eclipse.uml2.uml.InputPin} to retrieve, or <code>null</code>. |
| * @return The first {@link org.eclipse.uml2.uml.InputPin} with the specified '<em><b>Name</b></em>', and '<em><b>Type</b></em>', or <code>null</code>. |
| * @see #getReplyValues() |
| * @generated |
| */ |
| InputPin getReplyValue(String name, Type type); |
| |
| /** |
| * Retrieves the first {@link org.eclipse.uml2.uml.InputPin} with the specified '<em><b>Name</b></em>', and '<em><b>Type</b></em>' from the '<em><b>Reply Value</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.uml.InputPin} to retrieve, or <code>null</code>. |
| * @param type The '<em><b>Type</b></em>' of the {@link org.eclipse.uml2.uml.InputPin} to retrieve, or <code>null</code>. |
| * @param ignoreCase Whether to ignore case in {@link java.lang.String} comparisons. |
| * @param eClass The Ecore class of the {@link org.eclipse.uml2.uml.InputPin} to retrieve, or <code>null</code>. |
| * @param createOnDemand Whether to create a {@link org.eclipse.uml2.uml.InputPin} on demand if not found. |
| * @return The first {@link org.eclipse.uml2.uml.InputPin} with the specified '<em><b>Name</b></em>', and '<em><b>Type</b></em>', or <code>null</code>. |
| * @see #getReplyValues() |
| * @generated |
| */ |
| InputPin getReplyValue(String name, Type type, boolean ignoreCase, |
| EClass eClass, boolean createOnDemand); |
| |
| /** |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * The reply value pins must match the return, out, and inout parameters of the operation on the event on the trigger in number, type, and order. |
| * true |
| * <!-- end-model-doc --> |
| * @model |
| * @generated |
| */ |
| boolean validatePinsMatchParameter(DiagnosticChain diagnostics, |
| Map<Object, Object> context); |
| |
| /** |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * The event on replyToCall trigger must be a CallEvent replyToCallEvent.oclIsKindOf(CallEvent) |
| * replyToCallEvent.oclIsKindOf(CallEvent) |
| * <!-- end-model-doc --> |
| * @model |
| * @generated |
| */ |
| boolean validateEventOnReplyToCallTrigger(DiagnosticChain diagnostics, |
| Map<Object, Object> context); |
| |
| } // ReplyAction |
