| /* |
| * 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: ActivityPartition.java,v 1.13 2006/05/12 20:38:05 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 Partition</b></em>'. |
| * <!-- end-user-doc --> |
| * |
| * <!-- begin-model-doc --> |
| * An activity partition is a kind of activity group for identifying actions that have some characteristic in common. |
| * <!-- end-model-doc --> |
| * |
| * <p> |
| * The following features are supported: |
| * <ul> |
| * <li>{@link org.eclipse.uml2.uml.ActivityPartition#isDimension <em>Is Dimension</em>}</li> |
| * <li>{@link org.eclipse.uml2.uml.ActivityPartition#isExternal <em>Is External</em>}</li> |
| * <li>{@link org.eclipse.uml2.uml.ActivityPartition#getNodes <em>Node</em>}</li> |
| * <li>{@link org.eclipse.uml2.uml.ActivityPartition#getSubpartitions <em>Subpartition</em>}</li> |
| * <li>{@link org.eclipse.uml2.uml.ActivityPartition#getSuperPartition <em>Super Partition</em>}</li> |
| * <li>{@link org.eclipse.uml2.uml.ActivityPartition#getRepresents <em>Represents</em>}</li> |
| * <li>{@link org.eclipse.uml2.uml.ActivityPartition#getEdges <em>Edge</em>}</li> |
| * </ul> |
| * </p> |
| * |
| * @see org.eclipse.uml2.uml.UMLPackage#getActivityPartition() |
| * @model |
| * @generated |
| */ |
| public interface ActivityPartition |
| extends NamedElement, ActivityGroup { |
| |
| /** |
| * Returns the value of the '<em><b>Is Dimension</b></em>' attribute. |
| * The default value is <code>"false"</code>. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Tells whether the partition groups other partitions along a dimension. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Is Dimension</em>' attribute. |
| * @see #setIsDimension(boolean) |
| * @see org.eclipse.uml2.uml.UMLPackage#getActivityPartition_IsDimension() |
| * @model default="false" dataType="org.eclipse.uml2.uml.Boolean" required="true" ordered="false" |
| * @generated |
| */ |
| boolean isDimension(); |
| |
| /** |
| * Sets the value of the '{@link org.eclipse.uml2.uml.ActivityPartition#isDimension <em>Is Dimension</em>}' attribute. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Is Dimension</em>' attribute. |
| * @see #isDimension() |
| * @generated |
| */ |
| void setIsDimension(boolean value); |
| |
| /** |
| * Returns the value of the '<em><b>Is External</b></em>' attribute. |
| * The default value is <code>"false"</code>. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Tells whether the partition represents an entity to which the partitioning structure does not apply. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Is External</em>' attribute. |
| * @see #setIsExternal(boolean) |
| * @see org.eclipse.uml2.uml.UMLPackage#getActivityPartition_IsExternal() |
| * @model default="false" dataType="org.eclipse.uml2.uml.Boolean" required="true" ordered="false" |
| * @generated |
| */ |
| boolean isExternal(); |
| |
| /** |
| * Sets the value of the '{@link org.eclipse.uml2.uml.ActivityPartition#isExternal <em>Is External</em>}' attribute. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Is External</em>' attribute. |
| * @see #isExternal() |
| * @generated |
| */ |
| void setIsExternal(boolean value); |
| |
| /** |
| * Returns the value of the '<em><b>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#getInPartitions <em>In Partition</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>Edge</em>' reference list. |
| * @see org.eclipse.uml2.uml.UMLPackage#getActivityPartition_Edge() |
| * @see org.eclipse.uml2.uml.ActivityEdge#getInPartitions |
| * @model type="org.eclipse.uml2.uml.ActivityEdge" opposite="inPartition" ordered="false" |
| * @generated |
| */ |
| EList getEdges(); |
| |
| /** |
| * Retrieves the first {@link org.eclipse.uml2.uml.ActivityEdge} with the specified '<em><b>Name</b></em>' from the '<em><b>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 #getEdges() |
| * @generated |
| */ |
| ActivityEdge getEdge(String name); |
| |
| /** |
| * Retrieves the first {@link org.eclipse.uml2.uml.ActivityEdge} with the specified '<em><b>Name</b></em>' from the '<em><b>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 #getEdges() |
| * @generated |
| */ |
| ActivityEdge getEdge(String name, boolean ignoreCase, EClass eClass); |
| |
| /** |
| * Returns the value of the '<em><b>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#getInPartitions <em>In Partition</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>Node</em>' reference list. |
| * @see org.eclipse.uml2.uml.UMLPackage#getActivityPartition_Node() |
| * @see org.eclipse.uml2.uml.ActivityNode#getInPartitions |
| * @model type="org.eclipse.uml2.uml.ActivityNode" opposite="inPartition" ordered="false" |
| * @generated |
| */ |
| EList getNodes(); |
| |
| /** |
| * Retrieves the first {@link org.eclipse.uml2.uml.ActivityNode} with the specified '<em><b>Name</b></em>' from the '<em><b>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 #getNodes() |
| * @generated |
| */ |
| ActivityNode getNode(String name); |
| |
| /** |
| * Retrieves the first {@link org.eclipse.uml2.uml.ActivityNode} with the specified '<em><b>Name</b></em>' from the '<em><b>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 #getNodes() |
| * @generated |
| */ |
| ActivityNode getNode(String name, boolean ignoreCase, EClass eClass); |
| |
| /** |
| * Returns the value of the '<em><b>Subpartition</b></em>' containment reference list. |
| * The list contents are of type {@link org.eclipse.uml2.uml.ActivityPartition}. |
| * It is bidirectional and its opposite is '{@link org.eclipse.uml2.uml.ActivityPartition#getSuperPartition <em>Super Partition</em>}'. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Partitions immediately contained in the partition. Specialized from Activity-Group::subgroup. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Subpartition</em>' containment reference list. |
| * @see org.eclipse.uml2.uml.UMLPackage#getActivityPartition_Subpartition() |
| * @see org.eclipse.uml2.uml.ActivityPartition#getSuperPartition |
| * @model type="org.eclipse.uml2.uml.ActivityPartition" opposite="superPartition" containment="true" ordered="false" |
| * @generated |
| */ |
| EList getSubpartitions(); |
| |
| /** |
| * Creates a new {@link org.eclipse.uml2.uml.ActivityPartition}, with the specified '<em><b>Name</b></em>', and appends it to the '<em><b>Subpartition</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.ActivityPartition}, or <code>null</code>. |
| * @return The new {@link org.eclipse.uml2.uml.ActivityPartition}. |
| * @see #getSubpartitions() |
| * @generated |
| */ |
| ActivityPartition createSubpartition(String name); |
| |
| /** |
| * Retrieves the first {@link org.eclipse.uml2.uml.ActivityPartition} with the specified '<em><b>Name</b></em>' from the '<em><b>Subpartition</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.ActivityPartition} to retrieve, or <code>null</code>. |
| * @return The first {@link org.eclipse.uml2.uml.ActivityPartition} with the specified '<em><b>Name</b></em>', or <code>null</code>. |
| * @see #getSubpartitions() |
| * @generated |
| */ |
| ActivityPartition getSubpartition(String name); |
| |
| /** |
| * Retrieves the first {@link org.eclipse.uml2.uml.ActivityPartition} with the specified '<em><b>Name</b></em>' from the '<em><b>Subpartition</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.ActivityPartition} 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.ActivityPartition} on demand if not found. |
| * @return The first {@link org.eclipse.uml2.uml.ActivityPartition} with the specified '<em><b>Name</b></em>', or <code>null</code>. |
| * @see #getSubpartitions() |
| * @generated |
| */ |
| ActivityPartition getSubpartition(String name, boolean ignoreCase, |
| boolean createOnDemand); |
| |
| /** |
| * Returns the value of the '<em><b>Super Partition</b></em>' container reference. |
| * It is bidirectional and its opposite is '{@link org.eclipse.uml2.uml.ActivityPartition#getSubpartitions <em>Subpartition</em>}'. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Partition immediately containing the partition. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Super Partition</em>' container reference. |
| * @see #setSuperPartition(ActivityPartition) |
| * @see org.eclipse.uml2.uml.UMLPackage#getActivityPartition_SuperPartition() |
| * @see org.eclipse.uml2.uml.ActivityPartition#getSubpartitions |
| * @model opposite="subpartition" ordered="false" |
| * @generated |
| */ |
| ActivityPartition getSuperPartition(); |
| |
| /** |
| * Sets the value of the '{@link org.eclipse.uml2.uml.ActivityPartition#getSuperPartition <em>Super Partition</em>}' container reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Super Partition</em>' container reference. |
| * @see #getSuperPartition() |
| * @generated |
| */ |
| void setSuperPartition(ActivityPartition value); |
| |
| /** |
| * Returns the value of the '<em><b>Represents</b></em>' reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * An element constraining behaviors invoked by nodes in the partition. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Represents</em>' reference. |
| * @see #setRepresents(Element) |
| * @see org.eclipse.uml2.uml.UMLPackage#getActivityPartition_Represents() |
| * @model ordered="false" |
| * @generated |
| */ |
| Element getRepresents(); |
| |
| /** |
| * Sets the value of the '{@link org.eclipse.uml2.uml.ActivityPartition#getRepresents <em>Represents</em>}' reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Represents</em>' reference. |
| * @see #getRepresents() |
| * @generated |
| */ |
| void setRepresents(Element value); |
| |
| /** |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * A partition with isDimension = true may not be contained by another partition. |
| * true |
| * <!-- end-model-doc --> |
| * @model |
| * @generated |
| */ |
| boolean validateDimensionNotContained(DiagnosticChain diagnostics, |
| Map context); |
| |
| /** |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * If a partition represents a part, then all the non-external partitions in the same dimension and at the same level of nesting in that dimension must represent parts directly contained in the internal structure of the same classifier. |
| * true |
| * <!-- end-model-doc --> |
| * @model |
| * @generated |
| */ |
| boolean validateRepresentsPart(DiagnosticChain diagnostics, Map context); |
| |
| /** |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * If a non-external partition represents a classifier and is contained in another partition, then the containing partition must represent a classifier, and the classifier of the subpartition must be nested in the classifier represented by the containing partition, or be at the contained end of a strong composition association with the classifier represented by the containing partition. |
| * true |
| * <!-- end-model-doc --> |
| * @model |
| * @generated |
| */ |
| boolean validateRepresentsClassifier(DiagnosticChain diagnostics, |
| Map context); |
| |
| /** |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * If a partition represents a part and is contained by another partition, then the part must be of a classifier represented by the containing partition, or of a classifier that is the type of a part representing the containing partition. |
| * true |
| * <!-- end-model-doc --> |
| * @model |
| * @generated |
| */ |
| boolean validateRepresentsPartAndIsContained(DiagnosticChain diagnostics, |
| Map context); |
| |
| } // ActivityPartition |
