| /* |
| * 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: ActivityGroup.java,v 1.8 2006/03/15 19:33:48 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>Activity Group</b></em>'. |
| * <!-- end-user-doc --> |
| * |
| * <!-- begin-model-doc --> |
| * Activity groups are a generic grouping construct for nodes and edges. Nodes and edges can belong to more than one group. |
| * |
| * They have no inherent semantics and can be used for various purposes. Subclasses of ActivityGroup may add semantics. |
| * |
| * |
| * <!-- end-model-doc --> |
| * |
| * <p> |
| * The following features are supported: |
| * <ul> |
| * <li>{@link org.eclipse.uml2.uml.ActivityGroup#getSubgroups <em>Subgroup</em>}</li> |
| * <li>{@link org.eclipse.uml2.uml.ActivityGroup#getSuperGroup <em>Super Group</em>}</li> |
| * <li>{@link org.eclipse.uml2.uml.ActivityGroup#getInActivity <em>In Activity</em>}</li> |
| * <li>{@link org.eclipse.uml2.uml.ActivityGroup#getContainedEdges <em>Contained Edge</em>}</li> |
| * <li>{@link org.eclipse.uml2.uml.ActivityGroup#getContainedNodes <em>Contained Node</em>}</li> |
| * </ul> |
| * </p> |
| * |
| * @see org.eclipse.uml2.uml.UMLPackage#getActivityGroup() |
| * @model abstract="true" |
| * @generated |
| */ |
| public interface ActivityGroup |
| extends Element { |
| |
| /** |
| * Returns the value of the '<em><b>Subgroup</b></em>' reference list. |
| * The list contents are of type {@link org.eclipse.uml2.uml.ActivityGroup}. |
| * It is bidirectional and its opposite is '{@link org.eclipse.uml2.uml.ActivityGroup#getSuperGroup <em>Super Group</em>}'. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Groups immediately contained in the group. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Subgroup</em>' reference list. |
| * @see org.eclipse.uml2.uml.UMLPackage#getActivityGroup_Subgroup() |
| * @see org.eclipse.uml2.uml.ActivityGroup#getSuperGroup |
| * @model type="org.eclipse.uml2.uml.ActivityGroup" opposite="superGroup" transient="true" changeable="false" derived="true" ordered="false" |
| * @generated |
| */ |
| EList getSubgroups(); |
| |
| /** |
| * Returns the value of the '<em><b>Super Group</b></em>' reference. |
| * It is bidirectional and its opposite is '{@link org.eclipse.uml2.uml.ActivityGroup#getSubgroups <em>Subgroup</em>}'. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Group immediately containing the group. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Super Group</em>' reference. |
| * @see org.eclipse.uml2.uml.UMLPackage#getActivityGroup_SuperGroup() |
| * @see org.eclipse.uml2.uml.ActivityGroup#getSubgroups |
| * @model opposite="subgroup" transient="true" changeable="false" derived="true" ordered="false" |
| * @generated |
| */ |
| ActivityGroup getSuperGroup(); |
| |
| /** |
| * Returns the value of the '<em><b>Contained Node</b></em>' reference list. |
| * The list contents are of type {@link org.eclipse.uml2.uml.ActivityNode}. |
| * It is bidirectional and its opposite is '{@link org.eclipse.uml2.uml.ActivityNode#getInGroups <em>In Group</em>}'. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Nodes immediately contained in the group. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Contained Node</em>' reference list. |
| * @see org.eclipse.uml2.uml.UMLPackage#getActivityGroup_ContainedNode() |
| * @see org.eclipse.uml2.uml.ActivityNode#getInGroups |
| * @model type="org.eclipse.uml2.uml.ActivityNode" opposite="inGroup" transient="true" changeable="false" derived="true" ordered="false" |
| * @generated |
| */ |
| EList getContainedNodes(); |
| |
| /** |
| * Retrieves the first {@link org.eclipse.uml2.uml.ActivityNode} with the specified '<em><b>Name</b></em>' from the '<em><b>Contained Node</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.ActivityNode} to retrieve, or <code>null</code>. |
| * @return The first {@link org.eclipse.uml2.uml.ActivityNode} with the specified '<em><b>Name</b></em>', or <code>null</code>. |
| * @see #getContainedNodes() |
| * @generated |
| */ |
| ActivityNode getContainedNode(String name); |
| |
| /** |
| * Retrieves the first {@link org.eclipse.uml2.uml.ActivityNode} with the specified '<em><b>Name</b></em>' from the '<em><b>Contained Node</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.ActivityNode} 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.ActivityNode} to retrieve, or <code>null</code>. |
| * @return The first {@link org.eclipse.uml2.uml.ActivityNode} with the specified '<em><b>Name</b></em>', or <code>null</code>. |
| * @see #getContainedNodes() |
| * @generated |
| */ |
| ActivityNode getContainedNode(String name, boolean ignoreCase, EClass eClass); |
| |
| /** |
| * Returns the value of the '<em><b>In Activity</b></em>' container reference. |
| * It is bidirectional and its opposite is '{@link org.eclipse.uml2.uml.Activity#getGroups <em>Group</em>}'. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Activity containing the group. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>In Activity</em>' container reference. |
| * @see #setInActivity(Activity) |
| * @see org.eclipse.uml2.uml.UMLPackage#getActivityGroup_InActivity() |
| * @see org.eclipse.uml2.uml.Activity#getGroups |
| * @model opposite="group" ordered="false" |
| * @generated |
| */ |
| Activity getInActivity(); |
| |
| /** |
| * Sets the value of the '{@link org.eclipse.uml2.uml.ActivityGroup#getInActivity <em>In Activity</em>}' container reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>In Activity</em>' container reference. |
| * @see #getInActivity() |
| * @generated |
| */ |
| void setInActivity(Activity value); |
| |
| /** |
| * Returns the value of the '<em><b>Contained Edge</b></em>' reference list. |
| * The list contents are of type {@link org.eclipse.uml2.uml.ActivityEdge}. |
| * It is bidirectional and its opposite is '{@link org.eclipse.uml2.uml.ActivityEdge#getInGroups <em>In Group</em>}'. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Edges immediately contained in the group. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Contained Edge</em>' reference list. |
| * @see org.eclipse.uml2.uml.UMLPackage#getActivityGroup_ContainedEdge() |
| * @see org.eclipse.uml2.uml.ActivityEdge#getInGroups |
| * @model type="org.eclipse.uml2.uml.ActivityEdge" opposite="inGroup" transient="true" changeable="false" derived="true" ordered="false" |
| * @generated |
| */ |
| EList getContainedEdges(); |
| |
| /** |
| * Retrieves the first {@link org.eclipse.uml2.uml.ActivityEdge} with the specified '<em><b>Name</b></em>' from the '<em><b>Contained Edge</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.ActivityEdge} to retrieve, or <code>null</code>. |
| * @return The first {@link org.eclipse.uml2.uml.ActivityEdge} with the specified '<em><b>Name</b></em>', or <code>null</code>. |
| * @see #getContainedEdges() |
| * @generated |
| */ |
| ActivityEdge getContainedEdge(String name); |
| |
| /** |
| * Retrieves the first {@link org.eclipse.uml2.uml.ActivityEdge} with the specified '<em><b>Name</b></em>' from the '<em><b>Contained Edge</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.ActivityEdge} 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.ActivityEdge} to retrieve, or <code>null</code>. |
| * @return The first {@link org.eclipse.uml2.uml.ActivityEdge} with the specified '<em><b>Name</b></em>', or <code>null</code>. |
| * @see #getContainedEdges() |
| * @generated |
| */ |
| ActivityEdge getContainedEdge(String name, boolean ignoreCase, EClass eClass); |
| |
| /** |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * All nodes and edges of the group must be in the same activity as the group. |
| * true |
| * <!-- end-model-doc --> |
| * @model |
| * @generated |
| */ |
| boolean validateNodesAndEdges(DiagnosticChain diagnostics, Map context); |
| |
| /** |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * No node or edge in a group may be contained by its subgroups or its containing groups, transitively. |
| * true |
| * <!-- end-model-doc --> |
| * @model |
| * @generated |
| */ |
| boolean validateNotContained(DiagnosticChain diagnostics, Map context); |
| |
| /** |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Groups may only be owned by activities or groups. |
| * true |
| * <!-- end-model-doc --> |
| * @model |
| * @generated |
| */ |
| boolean validateGroupOwned(DiagnosticChain diagnostics, Map context); |
| |
| } // ActivityGroup |