| /* |
| * 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: ActivityEdge.java,v 1.14 2006/12/14 15:49:27 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 Edge</b></em>'. |
| * <!-- end-user-doc --> |
| * |
| * <!-- begin-model-doc --> |
| * An activity edge is an abstract class for directed connections between two activity nodes. |
| * Activity edges can be contained in interruptible regions. |
| * <!-- end-model-doc --> |
| * |
| * <p> |
| * The following features are supported: |
| * <ul> |
| * <li>{@link org.eclipse.uml2.uml.ActivityEdge#getSource <em>Source</em>}</li> |
| * <li>{@link org.eclipse.uml2.uml.ActivityEdge#getTarget <em>Target</em>}</li> |
| * <li>{@link org.eclipse.uml2.uml.ActivityEdge#getRedefinedEdges <em>Redefined Edge</em>}</li> |
| * <li>{@link org.eclipse.uml2.uml.ActivityEdge#getInPartitions <em>In Partition</em>}</li> |
| * <li>{@link org.eclipse.uml2.uml.ActivityEdge#getGuard <em>Guard</em>}</li> |
| * <li>{@link org.eclipse.uml2.uml.ActivityEdge#getWeight <em>Weight</em>}</li> |
| * <li>{@link org.eclipse.uml2.uml.ActivityEdge#getInterrupts <em>Interrupts</em>}</li> |
| * <li>{@link org.eclipse.uml2.uml.ActivityEdge#getInStructuredNode <em>In Structured Node</em>}</li> |
| * <li>{@link org.eclipse.uml2.uml.ActivityEdge#getInGroups <em>In Group</em>}</li> |
| * <li>{@link org.eclipse.uml2.uml.ActivityEdge#getActivity <em>Activity</em>}</li> |
| * </ul> |
| * </p> |
| * |
| * @see org.eclipse.uml2.uml.UMLPackage#getActivityEdge() |
| * @model abstract="true" |
| * @generated |
| */ |
| public interface ActivityEdge |
| extends RedefinableElement { |
| |
| /** |
| * Returns the value of the '<em><b>Activity</b></em>' container reference. |
| * It is bidirectional and its opposite is '{@link org.eclipse.uml2.uml.Activity#getEdges <em>Edge</em>}'. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Activity containing the edge. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Activity</em>' container reference. |
| * @see #setActivity(Activity) |
| * @see org.eclipse.uml2.uml.UMLPackage#getActivityEdge_Activity() |
| * @see org.eclipse.uml2.uml.Activity#getEdges |
| * @model opposite="edge" ordered="false" |
| * @generated |
| */ |
| Activity getActivity(); |
| |
| /** |
| * Sets the value of the '{@link org.eclipse.uml2.uml.ActivityEdge#getActivity <em>Activity</em>}' container reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Activity</em>' container reference. |
| * @see #getActivity() |
| * @generated |
| */ |
| void setActivity(Activity value); |
| |
| /** |
| * Returns the value of the '<em><b>In Group</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#getContainedEdges <em>Contained Edge</em>}'. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Groups containing the edge. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>In Group</em>' reference list. |
| * @see org.eclipse.uml2.uml.UMLPackage#getActivityEdge_InGroup() |
| * @see org.eclipse.uml2.uml.ActivityGroup#getContainedEdges |
| * @model type="org.eclipse.uml2.uml.ActivityGroup" opposite="containedEdge" transient="true" changeable="false" volatile="true" derived="true" ordered="false" |
| * @generated |
| */ |
| EList<ActivityGroup> getInGroups(); |
| |
| /** |
| * Returns the value of the '<em><b>In Partition</b></em>' 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#getEdges <em>Edge</em>}'. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Partitions containing the edge. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>In Partition</em>' reference list. |
| * @see org.eclipse.uml2.uml.UMLPackage#getActivityEdge_InPartition() |
| * @see org.eclipse.uml2.uml.ActivityPartition#getEdges |
| * @model type="org.eclipse.uml2.uml.ActivityPartition" opposite="edge" ordered="false" |
| * @generated |
| */ |
| EList<ActivityPartition> getInPartitions(); |
| |
| /** |
| * Retrieves the first {@link org.eclipse.uml2.uml.ActivityPartition} with the specified '<em><b>Name</b></em>' from the '<em><b>In Partition</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.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 #getInPartitions() |
| * @generated |
| */ |
| ActivityPartition getInPartition(String name); |
| |
| /** |
| * Retrieves the first {@link org.eclipse.uml2.uml.ActivityPartition} with the specified '<em><b>Name</b></em>' from the '<em><b>In Partition</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.ActivityPartition} to retrieve, or <code>null</code>. |
| * @param ignoreCase Whether to ignore case in {@link java.lang.String} comparisons. |
| * @return The first {@link org.eclipse.uml2.uml.ActivityPartition} with the specified '<em><b>Name</b></em>', or <code>null</code>. |
| * @see #getInPartitions() |
| * @generated |
| */ |
| ActivityPartition getInPartition(String name, boolean ignoreCase); |
| |
| /** |
| * Returns the value of the '<em><b>In Structured Node</b></em>' container reference. |
| * It is bidirectional and its opposite is '{@link org.eclipse.uml2.uml.StructuredActivityNode#getEdges <em>Edge</em>}'. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Structured activity node containing the edge. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>In Structured Node</em>' container reference. |
| * @see #setInStructuredNode(StructuredActivityNode) |
| * @see org.eclipse.uml2.uml.UMLPackage#getActivityEdge_InStructuredNode() |
| * @see org.eclipse.uml2.uml.StructuredActivityNode#getEdges |
| * @model opposite="edge" ordered="false" |
| * @generated |
| */ |
| StructuredActivityNode getInStructuredNode(); |
| |
| /** |
| * Sets the value of the '{@link org.eclipse.uml2.uml.ActivityEdge#getInStructuredNode <em>In Structured Node</em>}' container reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>In Structured Node</em>' container reference. |
| * @see #getInStructuredNode() |
| * @generated |
| */ |
| void setInStructuredNode(StructuredActivityNode value); |
| |
| /** |
| * Returns the value of the '<em><b>Target</b></em>' reference. |
| * It is bidirectional and its opposite is '{@link org.eclipse.uml2.uml.ActivityNode#getIncomings <em>Incoming</em>}'. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Node to which tokens are put when they traverse the edge. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Target</em>' reference. |
| * @see #setTarget(ActivityNode) |
| * @see org.eclipse.uml2.uml.UMLPackage#getActivityEdge_Target() |
| * @see org.eclipse.uml2.uml.ActivityNode#getIncomings |
| * @model opposite="incoming" required="true" ordered="false" |
| * @generated |
| */ |
| ActivityNode getTarget(); |
| |
| /** |
| * Sets the value of the '{@link org.eclipse.uml2.uml.ActivityEdge#getTarget <em>Target</em>}' reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Target</em>' reference. |
| * @see #getTarget() |
| * @generated |
| */ |
| void setTarget(ActivityNode value); |
| |
| /** |
| * Returns the value of the '<em><b>Redefined Edge</b></em>' reference list. |
| * The list contents are of type {@link org.eclipse.uml2.uml.ActivityEdge}. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Inherited edges replaced by this edge in a specialization of the activity. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Redefined Edge</em>' reference list. |
| * @see org.eclipse.uml2.uml.UMLPackage#getActivityEdge_RedefinedEdge() |
| * @model type="org.eclipse.uml2.uml.ActivityEdge" ordered="false" |
| * @generated |
| */ |
| EList<ActivityEdge> getRedefinedEdges(); |
| |
| /** |
| * Retrieves the first {@link org.eclipse.uml2.uml.ActivityEdge} with the specified '<em><b>Name</b></em>' from the '<em><b>Redefined 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 #getRedefinedEdges() |
| * @generated |
| */ |
| ActivityEdge getRedefinedEdge(String name); |
| |
| /** |
| * Retrieves the first {@link org.eclipse.uml2.uml.ActivityEdge} with the specified '<em><b>Name</b></em>' from the '<em><b>Redefined 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 #getRedefinedEdges() |
| * @generated |
| */ |
| ActivityEdge getRedefinedEdge(String name, boolean ignoreCase, EClass eClass); |
| |
| /** |
| * Returns the value of the '<em><b>Guard</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Specification evaluated at runtime to determine if the edge can be traversed. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Guard</em>' containment reference. |
| * @see #setGuard(ValueSpecification) |
| * @see org.eclipse.uml2.uml.UMLPackage#getActivityEdge_Guard() |
| * @model containment="true" resolveProxies="true" required="true" ordered="false" |
| * @generated |
| */ |
| ValueSpecification getGuard(); |
| |
| /** |
| * Sets the value of the '{@link org.eclipse.uml2.uml.ActivityEdge#getGuard <em>Guard</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Guard</em>' containment reference. |
| * @see #getGuard() |
| * @generated |
| */ |
| void setGuard(ValueSpecification value); |
| |
| /** |
| * Creates a new {@link org.eclipse.uml2.uml.ValueSpecification}, with the specified '<em><b>Name</b></em>', and '<em><b>Type</b></em>', and sets the '<em><b>Guard</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.ValueSpecification}, or <code>null</code>. |
| * @param type The '<em><b>Type</b></em>' for the new {@link org.eclipse.uml2.uml.ValueSpecification}, or <code>null</code>. |
| * @param eClass The Ecore class of the {@link org.eclipse.uml2.uml.ValueSpecification} to create. |
| * @return The new {@link org.eclipse.uml2.uml.ValueSpecification}. |
| * @see #getGuard() |
| * @generated |
| */ |
| ValueSpecification createGuard(String name, Type type, EClass eClass); |
| |
| /** |
| * Returns the value of the '<em><b>Weight</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Number of tokens consumed from the source node on each traversal. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Weight</em>' containment reference. |
| * @see #setWeight(ValueSpecification) |
| * @see org.eclipse.uml2.uml.UMLPackage#getActivityEdge_Weight() |
| * @model containment="true" resolveProxies="true" required="true" ordered="false" |
| * @generated |
| */ |
| ValueSpecification getWeight(); |
| |
| /** |
| * Sets the value of the '{@link org.eclipse.uml2.uml.ActivityEdge#getWeight <em>Weight</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Weight</em>' containment reference. |
| * @see #getWeight() |
| * @generated |
| */ |
| void setWeight(ValueSpecification value); |
| |
| /** |
| * Creates a new {@link org.eclipse.uml2.uml.ValueSpecification}, with the specified '<em><b>Name</b></em>', and '<em><b>Type</b></em>', and sets the '<em><b>Weight</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.ValueSpecification}, or <code>null</code>. |
| * @param type The '<em><b>Type</b></em>' for the new {@link org.eclipse.uml2.uml.ValueSpecification}, or <code>null</code>. |
| * @param eClass The Ecore class of the {@link org.eclipse.uml2.uml.ValueSpecification} to create. |
| * @return The new {@link org.eclipse.uml2.uml.ValueSpecification}. |
| * @see #getWeight() |
| * @generated |
| */ |
| ValueSpecification createWeight(String name, Type type, EClass eClass); |
| |
| /** |
| * Returns the value of the '<em><b>Interrupts</b></em>' reference. |
| * It is bidirectional and its opposite is '{@link org.eclipse.uml2.uml.InterruptibleActivityRegion#getInterruptingEdges <em>Interrupting Edge</em>}'. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Region that the edge can interrupt. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Interrupts</em>' reference. |
| * @see #setInterrupts(InterruptibleActivityRegion) |
| * @see org.eclipse.uml2.uml.UMLPackage#getActivityEdge_Interrupts() |
| * @see org.eclipse.uml2.uml.InterruptibleActivityRegion#getInterruptingEdges |
| * @model opposite="interruptingEdge" ordered="false" |
| * @generated |
| */ |
| InterruptibleActivityRegion getInterrupts(); |
| |
| /** |
| * Sets the value of the '{@link org.eclipse.uml2.uml.ActivityEdge#getInterrupts <em>Interrupts</em>}' reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Interrupts</em>' reference. |
| * @see #getInterrupts() |
| * @generated |
| */ |
| void setInterrupts(InterruptibleActivityRegion value); |
| |
| /** |
| * Returns the value of the '<em><b>Source</b></em>' reference. |
| * It is bidirectional and its opposite is '{@link org.eclipse.uml2.uml.ActivityNode#getOutgoings <em>Outgoing</em>}'. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Node from which tokens are taken when they traverse the edge. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Source</em>' reference. |
| * @see #setSource(ActivityNode) |
| * @see org.eclipse.uml2.uml.UMLPackage#getActivityEdge_Source() |
| * @see org.eclipse.uml2.uml.ActivityNode#getOutgoings |
| * @model opposite="outgoing" required="true" ordered="false" |
| * @generated |
| */ |
| ActivityNode getSource(); |
| |
| /** |
| * Sets the value of the '{@link org.eclipse.uml2.uml.ActivityEdge#getSource <em>Source</em>}' reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Source</em>' reference. |
| * @see #getSource() |
| * @generated |
| */ |
| void setSource(ActivityNode value); |
| |
| /** |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * The source and target of an edge must be in the same activity as the edge. |
| * true |
| * <!-- end-model-doc --> |
| * @model |
| * @generated |
| */ |
| boolean validateSourceAndTarget(DiagnosticChain diagnostics, |
| Map<Object, Object> context); |
| |
| /** |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Activity edges may be owned only by activities or groups. |
| * true |
| * <!-- end-model-doc --> |
| * @model |
| * @generated |
| */ |
| boolean validateOwned(DiagnosticChain diagnostics, |
| Map<Object, Object> context); |
| |
| /** |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Activity edges may be owned by at most one structured node. |
| * true |
| * <!-- end-model-doc --> |
| * @model |
| * @generated |
| */ |
| boolean validateStructuredNode(DiagnosticChain diagnostics, |
| Map<Object, Object> context); |
| |
| } // ActivityEdge |
