| /* |
| * 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: BehavioralFeature.java,v 1.12 2006/06/07 21:39:13 khussey Exp $ |
| */ |
| package org.eclipse.uml2.uml; |
| |
| import org.eclipse.emf.common.util.EList; |
| |
| import org.eclipse.emf.ecore.EClass; |
| |
| /** |
| * <!-- begin-user-doc --> |
| * A representation of the model object '<em><b>Behavioral Feature</b></em>'. |
| * <!-- end-user-doc --> |
| * |
| * <!-- begin-model-doc --> |
| * A behavioral feature is a feature of a classifier that specifies an aspect of the behavior of its instances. |
| * A behavioral feature is implemented (realized) by a behavior. A behavioral feature specifies that a classifier will respond to a designated request by invoking its implementing method. |
| * A behavioral feature owns zero or more parameter sets. |
| * <!-- end-model-doc --> |
| * |
| * <p> |
| * The following features are supported: |
| * <ul> |
| * <li>{@link org.eclipse.uml2.uml.BehavioralFeature#getOwnedParameters <em>Owned Parameter</em>}</li> |
| * <li>{@link org.eclipse.uml2.uml.BehavioralFeature#isAbstract <em>Is Abstract</em>}</li> |
| * <li>{@link org.eclipse.uml2.uml.BehavioralFeature#getMethods <em>Method</em>}</li> |
| * <li>{@link org.eclipse.uml2.uml.BehavioralFeature#getConcurrency <em>Concurrency</em>}</li> |
| * <li>{@link org.eclipse.uml2.uml.BehavioralFeature#getRaisedExceptions <em>Raised Exception</em>}</li> |
| * <li>{@link org.eclipse.uml2.uml.BehavioralFeature#getOwnedParameterSets <em>Owned Parameter Set</em>}</li> |
| * </ul> |
| * </p> |
| * |
| * @see org.eclipse.uml2.uml.UMLPackage#getBehavioralFeature() |
| * @model abstract="true" |
| * @generated |
| */ |
| public interface BehavioralFeature |
| extends Namespace, Feature { |
| |
| /** |
| * Returns the value of the '<em><b>Owned Parameter</b></em>' containment reference list. |
| * The list contents are of type {@link org.eclipse.uml2.uml.Parameter}. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Specifies the ordered set of formal parameters of this BehavioralFeature. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Owned Parameter</em>' containment reference list. |
| * @see org.eclipse.uml2.uml.UMLPackage#getBehavioralFeature_OwnedParameter() |
| * @model type="org.eclipse.uml2.uml.Parameter" containment="true" resolveProxies="true" |
| * @generated |
| */ |
| EList getOwnedParameters(); |
| |
| /** |
| * Creates a new {@link org.eclipse.uml2.uml.Parameter}, with the specified '<em><b>Name</b></em>', and '<em><b>Type</b></em>', and appends it to the '<em><b>Owned Parameter</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.Parameter}, or <code>null</code>. |
| * @param type The '<em><b>Type</b></em>' for the new {@link org.eclipse.uml2.uml.Parameter}, or <code>null</code>. |
| * @return The new {@link org.eclipse.uml2.uml.Parameter}. |
| * @see #getOwnedParameters() |
| * @generated |
| */ |
| Parameter createOwnedParameter(String name, Type type); |
| |
| /** |
| * Retrieves the first {@link org.eclipse.uml2.uml.Parameter} with the specified '<em><b>Name</b></em>', and '<em><b>Type</b></em>' from the '<em><b>Owned Parameter</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.Parameter} to retrieve, or <code>null</code>. |
| * @param type The '<em><b>Type</b></em>' of the {@link org.eclipse.uml2.uml.Parameter} to retrieve, or <code>null</code>. |
| * @return The first {@link org.eclipse.uml2.uml.Parameter} with the specified '<em><b>Name</b></em>', and '<em><b>Type</b></em>', or <code>null</code>. |
| * @see #getOwnedParameters() |
| * @generated |
| */ |
| Parameter getOwnedParameter(String name, Type type); |
| |
| /** |
| * Retrieves the first {@link org.eclipse.uml2.uml.Parameter} with the specified '<em><b>Name</b></em>', and '<em><b>Type</b></em>' from the '<em><b>Owned Parameter</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.Parameter} to retrieve, or <code>null</code>. |
| * @param type The '<em><b>Type</b></em>' of the {@link org.eclipse.uml2.uml.Parameter} 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.Parameter} on demand if not found. |
| * @return The first {@link org.eclipse.uml2.uml.Parameter} with the specified '<em><b>Name</b></em>', and '<em><b>Type</b></em>', or <code>null</code>. |
| * @see #getOwnedParameters() |
| * @generated |
| */ |
| Parameter getOwnedParameter(String name, Type type, boolean ignoreCase, |
| boolean createOnDemand); |
| |
| /** |
| * Returns the value of the '<em><b>Is Abstract</b></em>' attribute. |
| * The default value is <code>"false"</code>. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * If true, then the behavioral feature does not have an implementation, and one must be supplied by a more specific element. If false, the behavioral feature must have an implementation in the classifier or one must be inherited from a more general element. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Is Abstract</em>' attribute. |
| * @see #setIsAbstract(boolean) |
| * @see org.eclipse.uml2.uml.UMLPackage#getBehavioralFeature_IsAbstract() |
| * @model default="false" dataType="org.eclipse.uml2.uml.Boolean" required="true" ordered="false" |
| * @generated |
| */ |
| boolean isAbstract(); |
| |
| /** |
| * Sets the value of the '{@link org.eclipse.uml2.uml.BehavioralFeature#isAbstract <em>Is Abstract</em>}' attribute. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Is Abstract</em>' attribute. |
| * @see #isAbstract() |
| * @generated |
| */ |
| void setIsAbstract(boolean value); |
| |
| /** |
| * Returns the value of the '<em><b>Method</b></em>' reference list. |
| * The list contents are of type {@link org.eclipse.uml2.uml.Behavior}. |
| * It is bidirectional and its opposite is '{@link org.eclipse.uml2.uml.Behavior#getSpecification <em>Specification</em>}'. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * A behavioral description that implements the behavioral feature. There may be at most one behavior for a particular pairing of a classifier (as owner of the behavior) and a behavioral feature (as specification of the behavior). |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Method</em>' reference list. |
| * @see org.eclipse.uml2.uml.UMLPackage#getBehavioralFeature_Method() |
| * @see org.eclipse.uml2.uml.Behavior#getSpecification |
| * @model type="org.eclipse.uml2.uml.Behavior" opposite="specification" ordered="false" |
| * @generated |
| */ |
| EList getMethods(); |
| |
| /** |
| * Retrieves the first {@link org.eclipse.uml2.uml.Behavior} with the specified '<em><b>Name</b></em>' from the '<em><b>Method</b></em>' reference list. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param name The '<em><b>Name</b></em>' of the {@link org.eclipse.uml2.uml.Behavior} to retrieve, or <code>null</code>. |
| * @return The first {@link org.eclipse.uml2.uml.Behavior} with the specified '<em><b>Name</b></em>', or <code>null</code>. |
| * @see #getMethods() |
| * @generated |
| */ |
| Behavior getMethod(String name); |
| |
| /** |
| * Retrieves the first {@link org.eclipse.uml2.uml.Behavior} with the specified '<em><b>Name</b></em>' from the '<em><b>Method</b></em>' reference list. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param name The '<em><b>Name</b></em>' of the {@link org.eclipse.uml2.uml.Behavior} 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.Behavior} to retrieve, or <code>null</code>. |
| * @return The first {@link org.eclipse.uml2.uml.Behavior} with the specified '<em><b>Name</b></em>', or <code>null</code>. |
| * @see #getMethods() |
| * @generated |
| */ |
| Behavior getMethod(String name, boolean ignoreCase, EClass eClass); |
| |
| /** |
| * Returns the value of the '<em><b>Concurrency</b></em>' attribute. |
| * The default value is <code>"sequential"</code>. |
| * The literals are from the enumeration {@link org.eclipse.uml2.uml.CallConcurrencyKind}. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Specifies the semantics of concurrent calls to the same passive instance (i.e., an instance originating from a class with isActive being false). Active instances control access to their own behavioral features. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Concurrency</em>' attribute. |
| * @see org.eclipse.uml2.uml.CallConcurrencyKind |
| * @see #setConcurrency(CallConcurrencyKind) |
| * @see org.eclipse.uml2.uml.UMLPackage#getBehavioralFeature_Concurrency() |
| * @model default="sequential" required="true" ordered="false" |
| * @generated |
| */ |
| CallConcurrencyKind getConcurrency(); |
| |
| /** |
| * Sets the value of the '{@link org.eclipse.uml2.uml.BehavioralFeature#getConcurrency <em>Concurrency</em>}' attribute. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Concurrency</em>' attribute. |
| * @see org.eclipse.uml2.uml.CallConcurrencyKind |
| * @see #getConcurrency() |
| * @generated |
| */ |
| void setConcurrency(CallConcurrencyKind value); |
| |
| /** |
| * Returns the value of the '<em><b>Raised Exception</b></em>' reference list. |
| * The list contents are of type {@link org.eclipse.uml2.uml.Type}. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * References the Types representing exceptions that may be raised during an invocation of this feature. |
| * The signals that the behavioral feature raises as exceptions. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Raised Exception</em>' reference list. |
| * @see org.eclipse.uml2.uml.UMLPackage#getBehavioralFeature_RaisedException() |
| * @model type="org.eclipse.uml2.uml.Type" ordered="false" |
| * @generated |
| */ |
| EList getRaisedExceptions(); |
| |
| /** |
| * Retrieves the first {@link org.eclipse.uml2.uml.Type} with the specified '<em><b>Name</b></em>' from the '<em><b>Raised Exception</b></em>' reference list. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param name The '<em><b>Name</b></em>' of the {@link org.eclipse.uml2.uml.Type} to retrieve, or <code>null</code>. |
| * @return The first {@link org.eclipse.uml2.uml.Type} with the specified '<em><b>Name</b></em>', or <code>null</code>. |
| * @see #getRaisedExceptions() |
| * @generated |
| */ |
| Type getRaisedException(String name); |
| |
| /** |
| * Retrieves the first {@link org.eclipse.uml2.uml.Type} with the specified '<em><b>Name</b></em>' from the '<em><b>Raised Exception</b></em>' reference list. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param name The '<em><b>Name</b></em>' of the {@link org.eclipse.uml2.uml.Type} 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.Type} to retrieve, or <code>null</code>. |
| * @return The first {@link org.eclipse.uml2.uml.Type} with the specified '<em><b>Name</b></em>', or <code>null</code>. |
| * @see #getRaisedExceptions() |
| * @generated |
| */ |
| Type getRaisedException(String name, boolean ignoreCase, EClass eClass); |
| |
| /** |
| * Returns the value of the '<em><b>Owned Parameter Set</b></em>' containment reference list. |
| * The list contents are of type {@link org.eclipse.uml2.uml.ParameterSet}. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * The ParameterSets owned by this BehavioralFeature. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Owned Parameter Set</em>' containment reference list. |
| * @see org.eclipse.uml2.uml.UMLPackage#getBehavioralFeature_OwnedParameterSet() |
| * @model type="org.eclipse.uml2.uml.ParameterSet" containment="true" resolveProxies="true" ordered="false" |
| * @generated |
| */ |
| EList getOwnedParameterSets(); |
| |
| /** |
| * Creates a new {@link org.eclipse.uml2.uml.ParameterSet}, with the specified '<em><b>Name</b></em>', and appends it to the '<em><b>Owned Parameter Set</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.ParameterSet}, or <code>null</code>. |
| * @return The new {@link org.eclipse.uml2.uml.ParameterSet}. |
| * @see #getOwnedParameterSets() |
| * @generated |
| */ |
| ParameterSet createOwnedParameterSet(String name); |
| |
| /** |
| * Retrieves the first {@link org.eclipse.uml2.uml.ParameterSet} with the specified '<em><b>Name</b></em>' from the '<em><b>Owned Parameter Set</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.ParameterSet} to retrieve, or <code>null</code>. |
| * @return The first {@link org.eclipse.uml2.uml.ParameterSet} with the specified '<em><b>Name</b></em>', or <code>null</code>. |
| * @see #getOwnedParameterSets() |
| * @generated |
| */ |
| ParameterSet getOwnedParameterSet(String name); |
| |
| /** |
| * Retrieves the first {@link org.eclipse.uml2.uml.ParameterSet} with the specified '<em><b>Name</b></em>' from the '<em><b>Owned Parameter Set</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.ParameterSet} 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.ParameterSet} on demand if not found. |
| * @return The first {@link org.eclipse.uml2.uml.ParameterSet} with the specified '<em><b>Name</b></em>', or <code>null</code>. |
| * @see #getOwnedParameterSets() |
| * @generated |
| */ |
| ParameterSet getOwnedParameterSet(String name, boolean ignoreCase, |
| boolean createOnDemand); |
| |
| /** |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Creates a return result parameter with the specified name and type. |
| * <!-- end-model-doc --> |
| * @model required="true" ordered="false" nameDataType="org.eclipse.uml2.uml.String" nameOrdered="false" typeOrdered="false" |
| * @generated |
| */ |
| Parameter createReturnResult(String name, Type type); |
| |
| } // BehavioralFeature |