org.eclipse.uml2.uml.OpaqueAction Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of uml Show documentation
UML2 UML Model
The newest version!
/*
 * Copyright (c) 2005, 2014 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
 *   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;

import org.eclipse.emf.ecore.EClass;

/**
 * 
 * A representation of the model object 'Opaque Action'.
 * @extends BodyOwner
 * 
 *
 * 
 * An OpaqueAction is an Action whose functionality is not specified within UML.
 * From package UML::Actions.
 * 
 *
 * 
 * The following features are supported:
 * 

 *   {@link org.eclipse.uml2.uml.OpaqueAction#getBodies Body}
 *   {@link org.eclipse.uml2.uml.OpaqueAction#getInputValues Input Value}
 *   {@link org.eclipse.uml2.uml.OpaqueAction#getLanguages Language}
 *   {@link org.eclipse.uml2.uml.OpaqueAction#getOutputValues Output Value}
 * 
 * 
 *
 * @see org.eclipse.uml2.uml.UMLPackage#getOpaqueAction()
 * @model
 * @generated
 */
public interface OpaqueAction
		extends Action, BodyOwner {

	/**
	 * Returns the value of the 'Body' attribute list.
	 * The list contents are of type {@link java.lang.String}.
	 * 
	 * 
	 * 
	 * Provides a textual specification of the functionality of the Action, in one or more languages other than UML.
	 * From package UML::Actions.
	 * 
	 * @return the value of the 'Body' attribute list.
	 * @see #isSetBodies()
	 * @see #unsetBodies()
	 * @see org.eclipse.uml2.uml.UMLPackage#getOpaqueAction_Body()
	 * @model unique="false" unsettable="true" dataType="org.eclipse.uml2.types.String"
	 *        extendedMetaData="kind='element'"
	 * @generated
	 */
	EList getBodies();

	/**
	 * Unsets the value of the '{@link org.eclipse.uml2.uml.OpaqueAction#getBodies Body}' attribute list.
	 * 
	 * 
	 * @see #isSetBodies()
	 * @see #getBodies()
	 * @generated
	 */
	void unsetBodies();

	/**
	 * Returns whether the value of the '{@link org.eclipse.uml2.uml.OpaqueAction#getBodies Body}' attribute list is set.
	 * 
	 * 
	 * @return whether the value of the 'Body' attribute list is set.
	 * @see #unsetBodies()
	 * @see #getBodies()
	 * @generated
	 */
	boolean isSetBodies();

	/**
	 * Returns the value of the 'Language' attribute list.
	 * The list contents are of type {@link java.lang.String}.
	 * 
	 * 
	 * 
	 * If provided, a specification of the language used for each of the body Strings.
	 * From package UML::Actions.
	 * 
	 * @return the value of the 'Language' attribute list.
	 * @see #isSetLanguages()
	 * @see #unsetLanguages()
	 * @see org.eclipse.uml2.uml.UMLPackage#getOpaqueAction_Language()
	 * @model unsettable="true" dataType="org.eclipse.uml2.types.String"
	 * @generated
	 */
	EList getLanguages();

	/**
	 * Unsets the value of the '{@link org.eclipse.uml2.uml.OpaqueAction#getLanguages Language}' attribute list.
	 * 
	 * 
	 * @see #isSetLanguages()
	 * @see #getLanguages()
	 * @generated
	 */
	void unsetLanguages();

	/**
	 * Returns whether the value of the '{@link org.eclipse.uml2.uml.OpaqueAction#getLanguages Language}' attribute list is set.
	 * 
	 * 
	 * @return whether the value of the 'Language' attribute list is set.
	 * @see #unsetLanguages()
	 * @see #getLanguages()
	 * @generated
	 */
	boolean isSetLanguages();

	/**
	 * Returns the value of the 'Input Value' containment reference list.
	 * The list contents are of type {@link org.eclipse.uml2.uml.InputPin}.
	 * 
	 * This feature subsets the following features:
	 * 

	 *   '{@link org.eclipse.uml2.uml.Action#getInputs() Input}'
	 * 
	 * 
	 * 
	 * 
	 * 
	 * The InputPins providing inputs to the OpaqueAction.
	 * From package UML::Actions.
	 * 
	 * @return the value of the 'Input Value' containment reference list.
	 * @see org.eclipse.uml2.uml.UMLPackage#getOpaqueAction_InputValue()
	 * @model containment="true" resolveProxies="true" ordered="false"
	 * @generated
	 */
	EList getInputValues();

	/**
	 * Creates a new {@link org.eclipse.uml2.uml.InputPin}, with the specified 'Name', and 'Type', and appends it to the 'Input Value' containment reference list.
	 * 
	 * 
	 * @param name The 'Name' for the new {@link org.eclipse.uml2.uml.InputPin}, or null.
	 * @param type The 'Type' for the new {@link org.eclipse.uml2.uml.InputPin}, or null.
	 * @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 #getInputValues()
	 * @generated
	 */
	InputPin createInputValue(String name, Type type, EClass eClass);

	/**
	 * Creates a new {@link org.eclipse.uml2.uml.InputPin}, with the specified 'Name', and 'Type', and appends it to the 'Input Value' containment reference list.
	 * 
	 * 
	 * @param name The 'Name' for the new {@link org.eclipse.uml2.uml.InputPin}, or null.
	 * @param type The 'Type' for the new {@link org.eclipse.uml2.uml.InputPin}, or null.
	 * @return The new {@link org.eclipse.uml2.uml.InputPin}.
	 * @see #getInputValues()
	 * @generated
	 */
	InputPin createInputValue(String name, Type type);

	/**
	 * Retrieves the first {@link org.eclipse.uml2.uml.InputPin} with the specified 'Name', and 'Type' from the 'Input Value' containment reference list.
	 * 
	 * 
	 * @param name The 'Name' of the {@link org.eclipse.uml2.uml.InputPin} to retrieve, or null.
	 * @param type The 'Type' of the {@link org.eclipse.uml2.uml.InputPin} to retrieve, or null.
	 * @return The first {@link org.eclipse.uml2.uml.InputPin} with the specified 'Name', and 'Type', or null.
	 * @see #getInputValues()
	 * @generated
	 */
	InputPin getInputValue(String name, Type type);

	/**
	 * Retrieves the first {@link org.eclipse.uml2.uml.InputPin} with the specified 'Name', and 'Type' from the 'Input Value' containment reference list.
	 * 
	 * 
	 * @param name The 'Name' of the {@link org.eclipse.uml2.uml.InputPin} to retrieve, or null.
	 * @param type The 'Type' of the {@link org.eclipse.uml2.uml.InputPin} to retrieve, or null.
	 * @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 null.
	 * @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 'Name', and 'Type', or null.
	 * @see #getInputValues()
	 * @generated
	 */
	InputPin getInputValue(String name, Type type, boolean ignoreCase,
			EClass eClass, boolean createOnDemand);

	/**
	 * Retrieves the first {@link org.eclipse.uml2.uml.InputPin} with the specified 'Name', and 'Type' from the 'Input Value' reference list.
	 * 
	 * 
	 * @param name The 'Name' of the {@link org.eclipse.uml2.uml.InputPin} to retrieve, or null.
	 * @param type The 'Type' of the {@link org.eclipse.uml2.uml.InputPin} to retrieve, or null.
	 * @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 null.
	 * @return The first {@link org.eclipse.uml2.uml.InputPin} with the specified 'Name', and 'Type', or null.
	 * @see #getInputValues()
	 * @generated NOT
	 */
	InputPin getInputValue(String name, Type type, boolean ignoreCase,
			EClass eClass);

	/**
	 * Returns the value of the 'Output Value' containment reference list.
	 * The list contents are of type {@link org.eclipse.uml2.uml.OutputPin}.
	 * 
	 * This feature subsets the following features:
	 * 

	 *   '{@link org.eclipse.uml2.uml.Action#getOutputs() Output}'
	 * 
	 * 
	 * 
	 * 
	 * 
	 * The OutputPins on which the OpaqueAction provides outputs.
	 * From package UML::Actions.
	 * 
	 * @return the value of the 'Output Value' containment reference list.
	 * @see org.eclipse.uml2.uml.UMLPackage#getOpaqueAction_OutputValue()
	 * @model containment="true" resolveProxies="true" ordered="false"
	 * @generated
	 */
	EList getOutputValues();

	/**
	 * Creates a new {@link org.eclipse.uml2.uml.OutputPin}, with the specified 'Name', and 'Type', and appends it to the 'Output Value' containment reference list.
	 * 
	 * 
	 * @param name The 'Name' for the new {@link org.eclipse.uml2.uml.OutputPin}, or null.
	 * @param type The 'Type' for the new {@link org.eclipse.uml2.uml.OutputPin}, or null.
	 * @return The new {@link org.eclipse.uml2.uml.OutputPin}.
	 * @see #getOutputValues()
	 * @generated
	 */
	OutputPin createOutputValue(String name, Type type);

	/**
	 * Retrieves the first {@link org.eclipse.uml2.uml.OutputPin} with the specified 'Name', and 'Type' from the 'Output Value' containment reference list.
	 * 
	 * 
	 * @param name The 'Name' of the {@link org.eclipse.uml2.uml.OutputPin} to retrieve, or null.
	 * @param type The 'Type' of the {@link org.eclipse.uml2.uml.OutputPin} to retrieve, or null.
	 * @return The first {@link org.eclipse.uml2.uml.OutputPin} with the specified 'Name', and 'Type', or null.
	 * @see #getOutputValues()
	 * @generated
	 */
	OutputPin getOutputValue(String name, Type type);

	/**
	 * Retrieves the first {@link org.eclipse.uml2.uml.OutputPin} with the specified 'Name', and 'Type' from the 'Output Value' containment reference list.
	 * 
	 * 
	 * @param name The 'Name' of the {@link org.eclipse.uml2.uml.OutputPin} to retrieve, or null.
	 * @param type The 'Type' of the {@link org.eclipse.uml2.uml.OutputPin} to retrieve, or null.
	 * @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 'Name', and 'Type', or null.
	 * @see #getOutputValues()
	 * @generated
	 */
	OutputPin getOutputValue(String name, Type type, boolean ignoreCase,
			boolean createOnDemand);

	/**
	 * 
	 * 
	 * 
	 * If the language attribute is not empty, then the size of the body and language lists must be the same.
	 * language->notEmpty() implies (_'body'->size() = language->size())
	 * @param diagnostics The chain of diagnostics to which problems are to be appended.
	 * @param context The cache of context-specific information.
	 * 
	 * @model
	 * @generated
	 */
	boolean validateLanguageBodySize(DiagnosticChain diagnostics,
			Map context);

	/**
	 * Retrieves the first {@link org.eclipse.uml2.uml.OutputPin} with the specified 'Name', and 'Type' from the 'Output Value' reference list.
	 * 
	 * 
	 * @param name The 'Name' of the {@link org.eclipse.uml2.uml.OutputPin} to retrieve, or null.
	 * @param type The 'Type' of the {@link org.eclipse.uml2.uml.OutputPin} to retrieve, or null.
	 * @param ignoreCase Whether to ignore case in {@link java.lang.String} comparisons.
	 * @return The first {@link org.eclipse.uml2.uml.OutputPin} with the specified 'Name', and 'Type', or null.
	 * @see #getOutputValues()
	 * @generated NOT
	 */
	OutputPin getOutputValue(String name, Type type, boolean ignoreCase);

} // OpaqueAction