org.eclipse.uml2.uml
Interface ActivityNode

All Superinterfaces:
Element, EModelElement, EObject, NamedElement, Notifier, RedefinableElement
All Known Subinterfaces:
AcceptCallAction, AcceptEventAction, Action, ActionInputPin, ActivityFinalNode, ActivityParameterNode, AddStructuralFeatureValueAction, AddVariableValueAction, BroadcastSignalAction, CallAction, CallBehaviorAction, CallOperationAction, CentralBufferNode, ClearAssociationAction, ClearStructuralFeatureAction, ClearVariableAction, ConditionalNode, ControlNode, CreateLinkAction, CreateLinkObjectAction, CreateObjectAction, DataStoreNode, DecisionNode, DestroyLinkAction, DestroyObjectAction, ExecutableNode, ExpansionNode, ExpansionRegion, FinalNode, FlowFinalNode, ForkNode, InitialNode, InputPin, InvocationAction, JoinNode, LinkAction, LoopNode, MergeNode, ObjectNode, OpaqueAction, OutputPin, Pin, RaiseExceptionAction, ReadExtentAction, ReadIsClassifiedObjectAction, ReadLinkAction, ReadLinkObjectEndAction, ReadLinkObjectEndQualifierAction, ReadSelfAction, ReadStructuralFeatureAction, ReadVariableAction, ReclassifyObjectAction, ReduceAction, RemoveStructuralFeatureValueAction, RemoveVariableValueAction, ReplyAction, SendObjectAction, SendSignalAction, SequenceNode, StartClassifierBehaviorAction, StructuralFeatureAction, StructuredActivityNode, TestIdentityAction, UnmarshallAction, ValuePin, ValueSpecificationAction, VariableAction, WriteLinkAction, WriteStructuralFeatureAction, WriteVariableAction

public interface ActivityNode
extends RedefinableElement

A representation of the model object 'Activity Node'. ActivityNode is an abstract class for points in the flow of an activity connected by edges.

The following features are supported:

See Also:
UMLPackage.getActivityNode()

Field Summary
 
Fields inherited from interface org.eclipse.uml2.uml.NamedElement
SEPARATOR
 
Method Summary
 Activity getActivity()
          Returns the value of the 'Activity' container reference.
 ActivityEdge getIncoming(String name)
          Retrieves the first ActivityEdge with the specified 'Name' from the 'Incoming' reference list
 ActivityEdge getIncoming(String name, boolean ignoreCase, EClass eClass)
          Retrieves the first ActivityEdge with the specified 'Name' from the 'Incoming' reference list
 EList getIncomings()
          Returns the value of the 'Incoming' reference list.
 EList getInGroups()
          Returns the value of the 'In Group' reference list.
 EList getInInterruptibleRegions()
          Returns the value of the 'In Interruptible Region' reference list.
 ActivityPartition getInPartition(String name)
          Retrieves the first ActivityPartition with the specified 'Name' from the 'In Partition' reference list
 ActivityPartition getInPartition(String name, boolean ignoreCase)
          Retrieves the first ActivityPartition with the specified 'Name' from the 'In Partition' reference list
 EList getInPartitions()
          Returns the value of the 'In Partition' reference list.
 StructuredActivityNode getInStructuredNode()
          Returns the value of the 'In Structured Node' container reference.
 ActivityEdge getOutgoing(String name)
          Retrieves the first ActivityEdge with the specified 'Name' from the 'Outgoing' reference list
 ActivityEdge getOutgoing(String name, boolean ignoreCase, EClass eClass)
          Retrieves the first ActivityEdge with the specified 'Name' from the 'Outgoing' reference list
 EList getOutgoings()
          Returns the value of the 'Outgoing' reference list.
 ActivityNode getRedefinedNode(String name)
          Retrieves the first ActivityNode with the specified 'Name' from the 'Redefined Node' reference list
 ActivityNode getRedefinedNode(String name, boolean ignoreCase, EClass eClass)
          Retrieves the first ActivityNode with the specified 'Name' from the 'Redefined Node' reference list
 EList getRedefinedNodes()
          Returns the value of the 'Redefined Node' reference list.
 void setActivity(Activity value)
          Sets the value of the 'Activity' container reference
 void setInStructuredNode(StructuredActivityNode value)
          Sets the value of the 'In Structured Node' container reference
 boolean validateOwned(DiagnosticChain diagnostics, Map context)
           Activity nodes can only be owned by activities or groups.
 boolean validateOwnedStructuredNode(DiagnosticChain diagnostics, Map context)
           Activity nodes may be owned by at most one structured node.
 
Methods inherited from interface org.eclipse.uml2.uml.RedefinableElement
getRedefinedElement, getRedefinedElement, getRedefinedElements, getRedefinitionContext, getRedefinitionContext, getRedefinitionContexts, isConsistentWith, isLeaf, isRedefinitionContextValid, setIsLeaf, validateRedefinitionConsistent, validateRedefinitionContextValid
 
Methods inherited from interface org.eclipse.uml2.uml.NamedElement
allNamespaces, allOwningPackages, createDependency, createNameExpression, getClientDependencies, getClientDependency, getClientDependency, getLabel, getLabel, getName, getNameExpression, getNamespace, getQualifiedName, getVisibility, isDistinguishableFrom, isSetName, isSetVisibility, separator, setName, setNameExpression, setVisibility, unsetName, unsetVisibility, validateHasNoQualifiedName, validateHasQualifiedName, validateVisibilityNeedsOwnership
 
Methods inherited from interface org.eclipse.uml2.uml.Element
addKeyword, allOwnedElements, applyStereotype, createEAnnotation, createOwnedComment, destroy, getApplicableStereotype, getApplicableStereotypes, getAppliedStereotype, getAppliedStereotypes, getAppliedSubstereotype, getAppliedSubstereotypes, getKeywords, getModel, getNearestPackage, getOwnedComments, getOwnedElements, getOwner, getRelationships, getRelationships, getRequiredStereotype, getRequiredStereotypes, getSourceDirectedRelationships, getSourceDirectedRelationships, getStereotypeApplication, getStereotypeApplications, getTargetDirectedRelationships, getTargetDirectedRelationships, getValue, hasKeyword, hasValue, isStereotypeApplicable, isStereotypeApplied, isStereotypeRequired, mustBeOwned, removeKeyword, setValue, unapplyStereotype, validateHasOwner, validateNotOwnSelf
 
Methods inherited from interface org.eclipse.emf.ecore.EModelElement
getEAnnotation, getEAnnotations
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 

Method Detail

getOutgoings

public EList getOutgoings()
Returns the value of the 'Outgoing' reference list. The list contents are of type ActivityEdge. It is bidirectional and its opposite is 'Source'. Edges that have the node as source.

Returns:
the value of the 'Outgoing' reference list.
See Also:
UMLPackage.getActivityNode_Outgoing(), ActivityEdge.getSource()

getOutgoing

public ActivityEdge getOutgoing(String name)
Retrieves the first ActivityEdge with the specified 'Name' from the 'Outgoing' reference list.

Parameters:
name - The 'Name' of the ActivityEdge to retrieve, or null.
Returns:
The first ActivityEdge with the specified 'Name', or null.
See Also:
ActivityNode.getOutgoings()

getOutgoing

public ActivityEdge getOutgoing(String name,
                                boolean ignoreCase,
                                EClass eClass)
Retrieves the first ActivityEdge with the specified 'Name' from the 'Outgoing' reference list.

Parameters:
name - The 'Name' of the ActivityEdge to retrieve, or null.
ignoreCase - Whether to ignore case in String comparisons.
eClass - The Ecore class of the ActivityEdge to retrieve, or null.
Returns:
The first ActivityEdge with the specified 'Name', or null.
See Also:
ActivityNode.getOutgoings()

getInGroups

public EList getInGroups()
Returns the value of the 'In Group' reference list. The list contents are of type ActivityGroup. It is bidirectional and its opposite is 'Contained Node'. Groups containing the node.

Returns:
the value of the 'In Group' reference list.
See Also:
UMLPackage.getActivityNode_InGroup(), ActivityGroup.getContainedNodes()

getInPartitions

public EList getInPartitions()
Returns the value of the 'In Partition' reference list. The list contents are of type ActivityPartition. It is bidirectional and its opposite is 'Node'. Partitions containing the node.

Returns:
the value of the 'In Partition' reference list.
See Also:
UMLPackage.getActivityNode_InPartition(), ActivityPartition.getNodes()

getInPartition

public ActivityPartition getInPartition(String name)
Retrieves the first ActivityPartition with the specified 'Name' from the 'In Partition' reference list.

Parameters:
name - The 'Name' of the ActivityPartition to retrieve, or null.
Returns:
The first ActivityPartition with the specified 'Name', or null.
See Also:
ActivityNode.getInPartitions()

getInPartition

public ActivityPartition getInPartition(String name,
                                        boolean ignoreCase)
Retrieves the first ActivityPartition with the specified 'Name' from the 'In Partition' reference list.

Parameters:
name - The 'Name' of the ActivityPartition to retrieve, or null.
ignoreCase - Whether to ignore case in String comparisons.
Returns:
The first ActivityPartition with the specified 'Name', or null.
See Also:
ActivityNode.getInPartitions()

getInStructuredNode

public StructuredActivityNode getInStructuredNode()
Returns the value of the 'In Structured Node' container reference. It is bidirectional and its opposite is 'Node'. Structured activity node containing the node.

Returns:
the value of the 'In Structured Node' container reference.
See Also:
ActivityNode.setInStructuredNode(StructuredActivityNode), UMLPackage.getActivityNode_InStructuredNode(), StructuredActivityNode.getNodes()

setInStructuredNode

public void setInStructuredNode(StructuredActivityNode value)
Sets the value of the 'In Structured Node' container reference.

Parameters:
value - the new value of the 'In Structured Node' container reference.
See Also:
ActivityNode.getInStructuredNode()

getActivity

public Activity getActivity()
Returns the value of the 'Activity' container reference. It is bidirectional and its opposite is 'Node'. Activity containing the node.

Returns:
the value of the 'Activity' container reference.
See Also:
ActivityNode.setActivity(Activity), UMLPackage.getActivityNode_Activity(), Activity.getNodes()

setActivity

public void setActivity(Activity value)
Sets the value of the 'Activity' container reference.

Parameters:
value - the new value of the 'Activity' container reference.
See Also:
ActivityNode.getActivity()

getIncomings

public EList getIncomings()
Returns the value of the 'Incoming' reference list. The list contents are of type ActivityEdge. It is bidirectional and its opposite is 'Target'. Edges that have the node as target.

Returns:
the value of the 'Incoming' reference list.
See Also:
UMLPackage.getActivityNode_Incoming(), ActivityEdge.getTarget()

getIncoming

public ActivityEdge getIncoming(String name)
Retrieves the first ActivityEdge with the specified 'Name' from the 'Incoming' reference list.

Parameters:
name - The 'Name' of the ActivityEdge to retrieve, or null.
Returns:
The first ActivityEdge with the specified 'Name', or null.
See Also:
ActivityNode.getIncomings()

getIncoming

public ActivityEdge getIncoming(String name,
                                boolean ignoreCase,
                                EClass eClass)
Retrieves the first ActivityEdge with the specified 'Name' from the 'Incoming' reference list.

Parameters:
name - The 'Name' of the ActivityEdge to retrieve, or null.
ignoreCase - Whether to ignore case in String comparisons.
eClass - The Ecore class of the ActivityEdge to retrieve, or null.
Returns:
The first ActivityEdge with the specified 'Name', or null.
See Also:
ActivityNode.getIncomings()

getInInterruptibleRegions

public EList getInInterruptibleRegions()
Returns the value of the 'In Interruptible Region' reference list. The list contents are of type InterruptibleActivityRegion. It is bidirectional and its opposite is 'Node'. Interruptible regions containing the node.

Returns:
the value of the 'In Interruptible Region' reference list.
See Also:
UMLPackage.getActivityNode_InInterruptibleRegion(), InterruptibleActivityRegion.getNodes()

getRedefinedNodes

public EList getRedefinedNodes()
Returns the value of the 'Redefined Node' reference list. The list contents are of type ActivityNode. Inherited nodes replaced by this node in a specialization of the activity.

Returns:
the value of the 'Redefined Node' reference list.
See Also:
UMLPackage.getActivityNode_RedefinedNode()

getRedefinedNode

public ActivityNode getRedefinedNode(String name)
Retrieves the first ActivityNode with the specified 'Name' from the 'Redefined Node' reference list.

Parameters:
name - The 'Name' of the ActivityNode to retrieve, or null.
Returns:
The first ActivityNode with the specified 'Name', or null.
See Also:
ActivityNode.getRedefinedNodes()

getRedefinedNode

public ActivityNode getRedefinedNode(String name,
                                     boolean ignoreCase,
                                     EClass eClass)
Retrieves the first ActivityNode with the specified 'Name' from the 'Redefined Node' reference list.

Parameters:
name - The 'Name' of the ActivityNode to retrieve, or null.
ignoreCase - Whether to ignore case in String comparisons.
eClass - The Ecore class of the ActivityNode to retrieve, or null.
Returns:
The first ActivityNode with the specified 'Name', or null.
See Also:
ActivityNode.getRedefinedNodes()

validateOwned

public boolean validateOwned(DiagnosticChain diagnostics,
                             Map context)
Activity nodes can only be owned by activities or groups. true


validateOwnedStructuredNode

public boolean validateOwnedStructuredNode(DiagnosticChain diagnostics,
                                           Map context)
Activity nodes may be owned by at most one structured node. true


Copyright 2003, 2006 IBM Corporation and others.
All Rights Reserved.