| /* |
| * 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.ecore.EClass; |
| |
| /** |
| * <!-- begin-user-doc --> |
| * A representation of the model object '<em><b>Add Variable Value Action</b></em>'. |
| * <!-- end-user-doc --> |
| * |
| * <!-- begin-model-doc --> |
| * An AddVariableValueAction is a WriteVariableAction for adding values to a Variable. |
| * <p>From package UML::Actions.</p> |
| * <!-- end-model-doc --> |
| * |
| * <p> |
| * The following features are supported: |
| * </p> |
| * <ul> |
| * <li>{@link org.eclipse.uml2.uml.AddVariableValueAction#getInsertAt <em>Insert At</em>}</li> |
| * <li>{@link org.eclipse.uml2.uml.AddVariableValueAction#isReplaceAll <em>Is Replace All</em>}</li> |
| * </ul> |
| * |
| * @see org.eclipse.uml2.uml.UMLPackage#getAddVariableValueAction() |
| * @model |
| * @generated |
| */ |
| public interface AddVariableValueAction |
| extends WriteVariableAction { |
| |
| /** |
| * Returns the value of the '<em><b>Is Replace All</b></em>' attribute. |
| * The default value is <code>"false"</code>. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Specifies whether existing values of the Variable should be removed before adding the new value. |
| * <p>From package UML::Actions.</p> |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Is Replace All</em>' attribute. |
| * @see #setIsReplaceAll(boolean) |
| * @see org.eclipse.uml2.uml.UMLPackage#getAddVariableValueAction_IsReplaceAll() |
| * @model default="false" dataType="org.eclipse.uml2.types.Boolean" required="true" ordered="false" |
| * @generated |
| */ |
| boolean isReplaceAll(); |
| |
| /** |
| * Sets the value of the '{@link org.eclipse.uml2.uml.AddVariableValueAction#isReplaceAll <em>Is Replace All</em>}' attribute. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Is Replace All</em>' attribute. |
| * @see #isReplaceAll() |
| * @generated |
| */ |
| void setIsReplaceAll(boolean value); |
| |
| /** |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * A value InputPin is required. |
| * value <> null |
| * @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 validateRequiredValue(DiagnosticChain diagnostics, |
| Map<Object, Object> context); |
| |
| /** |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * AddVariableValueActions for ordered Variables must have a single InputPin for the insertion point with type UnlimtedNatural and multiplicity of 1..1 if isReplaceAll=false, otherwise the Action has no InputPin for the insertion point. |
| * if not variable.isOrdered then insertAt = null |
| * else |
| * not isReplaceAll implies |
| * insertAt<>null and |
| * insertAt->forAll(type=UnlimitedNatural and is(1,1.oclAsType(UnlimitedNatural))) |
| * endif |
| * @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 validateInsertAtPin(DiagnosticChain diagnostics, |
| Map<Object, Object> context); |
| |
| /** |
| * Returns the value of the '<em><b>Insert At</b></em>' containment reference. |
| * <p> |
| * This feature subsets the following features: |
| * </p> |
| * <ul> |
| * <li>'{@link org.eclipse.uml2.uml.Action#getInputs() <em>Input</em>}'</li> |
| * </ul> |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * The InputPin that gives the position at which to insert a new value or move an existing value in ordered Variables. The type of the insertAt InputPin is UnlimitedNatural, but the value cannot be zero. It is omitted for unordered Variables. |
| * <p>From package UML::Actions.</p> |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Insert At</em>' containment reference. |
| * @see #setInsertAt(InputPin) |
| * @see org.eclipse.uml2.uml.UMLPackage#getAddVariableValueAction_InsertAt() |
| * @model containment="true" resolveProxies="true" ordered="false" |
| * @generated |
| */ |
| InputPin getInsertAt(); |
| |
| /** |
| * Sets the value of the '{@link org.eclipse.uml2.uml.AddVariableValueAction#getInsertAt <em>Insert At</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Insert At</em>' containment reference. |
| * @see #getInsertAt() |
| * @generated |
| */ |
| void setInsertAt(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>Insert At</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 #getInsertAt() |
| * @generated |
| */ |
| InputPin createInsertAt(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>Insert At</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 #getInsertAt() |
| * @generated |
| */ |
| InputPin createInsertAt(String name, Type type); |
| |
| } // AddVariableValueAction |