| /* |
| * Copyright (c) 2005, 2015 IBM Corporation, CEA, 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 |
| * Kenn Hussey (CEA) - 327039, 418466, 451350 |
| * Christian W. Damus (CEA) - 251963 |
| * |
| */ |
| package org.eclipse.uml2.uml; |
| |
| import java.util.Map; |
| |
| import org.eclipse.emf.common.util.DiagnosticChain; |
| |
| import org.eclipse.emf.common.util.EList; |
| |
| /** |
| * <!-- begin-user-doc --> |
| * A representation of the model object '<em><b>Call Action</b></em>'. |
| * <!-- end-user-doc --> |
| * |
| * <!-- begin-model-doc --> |
| * CallAction is an abstract class for Actions that invoke a Behavior with given argument values and (if the invocation is synchronous) receive reply values. |
| * <p>From package UML::Actions.</p> |
| * <!-- end-model-doc --> |
| * |
| * <p> |
| * The following features are supported: |
| * </p> |
| * <ul> |
| * <li>{@link org.eclipse.uml2.uml.CallAction#isSynchronous <em>Is Synchronous</em>}</li> |
| * <li>{@link org.eclipse.uml2.uml.CallAction#getResults <em>Result</em>}</li> |
| * </ul> |
| * |
| * @see org.eclipse.uml2.uml.UMLPackage#getCallAction() |
| * @model abstract="true" |
| * @generated |
| */ |
| public interface CallAction |
| extends InvocationAction { |
| |
| /** |
| * Returns the value of the '<em><b>Is Synchronous</b></em>' attribute. |
| * The default value is <code>"true"</code>. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * If true, the call is synchronous and the caller waits for completion of the invoked Behavior. If false, the call is asynchronous and the caller proceeds immediately and cannot receive return values. |
| * <p>From package UML::Actions.</p> |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Is Synchronous</em>' attribute. |
| * @see #setIsSynchronous(boolean) |
| * @see org.eclipse.uml2.uml.UMLPackage#getCallAction_IsSynchronous() |
| * @model default="true" dataType="org.eclipse.uml2.types.Boolean" required="true" ordered="false" |
| * @generated |
| */ |
| boolean isSynchronous(); |
| |
| /** |
| * Sets the value of the '{@link org.eclipse.uml2.uml.CallAction#isSynchronous <em>Is Synchronous</em>}' attribute. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Is Synchronous</em>' attribute. |
| * @see #isSynchronous() |
| * @generated |
| */ |
| void setIsSynchronous(boolean value); |
| |
| /** |
| * Returns the value of the '<em><b>Result</b></em>' containment reference list. |
| * The list contents are of type {@link org.eclipse.uml2.uml.OutputPin}. |
| * <p> |
| * This feature subsets the following features: |
| * </p> |
| * <ul> |
| * <li>'{@link org.eclipse.uml2.uml.Action#getOutputs() <em>Output</em>}'</li> |
| * </ul> |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * The OutputPins on which the reply values from the invocation are placed (if the call is synchronous). |
| * <p>From package UML::Actions.</p> |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Result</em>' containment reference list. |
| * @see org.eclipse.uml2.uml.UMLPackage#getCallAction_Result() |
| * @model containment="true" resolveProxies="true" |
| * @generated |
| */ |
| EList<OutputPin> getResults(); |
| |
| /** |
| * Creates a new {@link org.eclipse.uml2.uml.OutputPin}, with the specified '<em><b>Name</b></em>', and '<em><b>Type</b></em>', and appends it to the '<em><b>Result</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.OutputPin}, or <code>null</code>. |
| * @param type The '<em><b>Type</b></em>' for the new {@link org.eclipse.uml2.uml.OutputPin}, or <code>null</code>. |
| * @return The new {@link org.eclipse.uml2.uml.OutputPin}. |
| * @see #getResults() |
| * @generated |
| */ |
| OutputPin createResult(String name, Type type); |
| |
| /** |
| * Retrieves the first {@link org.eclipse.uml2.uml.OutputPin} with the specified '<em><b>Name</b></em>', and '<em><b>Type</b></em>' from the '<em><b>Result</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.OutputPin} to retrieve, or <code>null</code>. |
| * @param type The '<em><b>Type</b></em>' of the {@link org.eclipse.uml2.uml.OutputPin} to retrieve, or <code>null</code>. |
| * @return The first {@link org.eclipse.uml2.uml.OutputPin} with the specified '<em><b>Name</b></em>', and '<em><b>Type</b></em>', or <code>null</code>. |
| * @see #getResults() |
| * @generated |
| */ |
| OutputPin getResult(String name, Type type); |
| |
| /** |
| * Retrieves the first {@link org.eclipse.uml2.uml.OutputPin} with the specified '<em><b>Name</b></em>', and '<em><b>Type</b></em>' from the '<em><b>Result</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.OutputPin} to retrieve, or <code>null</code>. |
| * @param type The '<em><b>Type</b></em>' of the {@link org.eclipse.uml2.uml.OutputPin} to retrieve, or <code>null</code>. |
| * @param ignoreCase Whether to ignore case in {@link java.lang.String} comparisons. |
| * @param createOnDemand Whether to create a {@link org.eclipse.uml2.uml.OutputPin} on demand if not found. |
| * @return The first {@link org.eclipse.uml2.uml.OutputPin} with the specified '<em><b>Name</b></em>', and '<em><b>Type</b></em>', or <code>null</code>. |
| * @see #getResults() |
| * @generated |
| */ |
| OutputPin getResult(String name, Type type, boolean ignoreCase, |
| boolean createOnDemand); |
| |
| /** |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * The number of argument InputPins must be the same as the number of input (in and inout) ownedParameters of the called Behavior or Operation. The type, ordering and multiplicity of each argument InputPin must be consistent with the corresponding input Parameter. |
| * let parameter: OrderedSet(Parameter) = self.inputParameters() in |
| * argument->size() = parameter->size() and |
| * Sequence{1..argument->size()}->forAll(i | |
| * argument->at(i).type.conformsTo(parameter->at(i).type) and |
| * argument->at(i).isOrdered = parameter->at(i).isOrdered and |
| * argument->at(i).compatibleWith(parameter->at(i))) |
| * @param diagnostics The chain of diagnostics to which problems are to be appended. |
| * @param context The cache of context-specific information. |
| * <!-- end-model-doc --> |
| * @model |
| * @generated |
| */ |
| boolean validateArgumentPins(DiagnosticChain diagnostics, |
| Map<Object, Object> context); |
| |
| /** |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * The number of result OutputPins must be the same as the number of output (inout, out and return) ownedParameters of the called Behavior or Operation. The type, ordering and multiplicity of each result OutputPin must be consistent with the corresponding input Parameter. |
| * let parameter: OrderedSet(Parameter) = self.outputParameters() in |
| * result->size() = parameter->size() and |
| * Sequence{1..result->size()}->forAll(i | |
| * parameter->at(i).type.conformsTo(result->at(i).type) and |
| * parameter->at(i).isOrdered = result->at(i).isOrdered and |
| * parameter->at(i).compatibleWith(result->at(i))) |
| * @param diagnostics The chain of diagnostics to which problems are to be appended. |
| * @param context The cache of context-specific information. |
| * <!-- end-model-doc --> |
| * @model |
| * @generated |
| */ |
| boolean validateResultPins(DiagnosticChain diagnostics, |
| Map<Object, Object> context); |
| |
| /** |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Only synchronous CallActions can have result OutputPins. |
| * result->notEmpty() implies isSynchronous |
| * @param diagnostics The chain of diagnostics to which problems are to be appended. |
| * @param context The cache of context-specific information. |
| * <!-- end-model-doc --> |
| * @model |
| * @generated |
| */ |
| boolean validateSynchronousCall(DiagnosticChain diagnostics, |
| Map<Object, Object> context); |
| |
| /** |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Return the in and inout ownedParameters of the Behavior or Operation being called. (This operation is abstract and should be overridden by subclasses of CallAction.) |
| * <p>From package UML::Actions.</p> |
| * <!-- end-model-doc --> |
| * @model |
| * @generated |
| */ |
| EList<Parameter> inputParameters(); |
| |
| /** |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Return the inout, out and return ownedParameters of the Behavior or Operation being called. (This operation is abstract and should be overridden by subclasses of CallAction.) |
| * <p>From package UML::Actions.</p> |
| * <!-- end-model-doc --> |
| * @model |
| * @generated |
| */ |
| EList<Parameter> outputParameters(); |
| |
| } // CallAction |
