StructuredActivityNode

All Superinterfaces:

Action, ActivityGroup, ActivityNode, Comparable<Object>, Element, EModelElement, EObject, ExecutableNode, MDWEObject, MDWObject, NamedElement, Namespace, Notifier, RedefinableElement

All Known Subinterfaces:

ConditionalNode, ExpansionRegion, LoopNode, SequenceNode
```
public interface StructuredActivityNode
extends Action, Namespace, ActivityGroup
```
A representation of the model object 'Structured Activity Node'. A structured activity node is an executable activity node that may have an expansion into subordinate nodes as an activity group. The subordinate nodes must belong to only one structured activity node, although they may be nested. Because of the concurrent nature of the execution of actions within and across activities, it can be difficult to guarantee the consistent access and modification of object memory. In order to avoid race conditions or other concurrency-related problems, it is sometimes necessary to isolate the effects of a group of actions from the effects of actions outside the group. This may be indicated by setting the mustIsolate attribute to true on a structured activity node. If a structured activity node is "isolated," then any object used by an action within the node cannot be accessed by any action outside the node until the structured activity node as a whole completes. Any concurrent actions that would result in accessing such objects are required to have their execution deferred until the completion of the node.
The following features are supported:
See Also:

UMLPackage.getStructuredActivityNode()

Field Summary
- Fields inherited from interface com.sodius.mdw.metamodel.uml21.NamedElement
  SEPARATOR

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ActivityEdge`	`createEdge(String name, EClass eClass)` Creates a new `ActivityEdge`, with the specified 'Name', and appends it to the ' Edge' containment reference list
`ActivityNode`	`createNode(String name, EClass eClass)` Creates a new `ActivityNode`, with the specified 'Name', and appends it to the ' Node' containment reference list
`InputPin`	`createStructuredNodeInput(String name, Type type)` Creates an `Input Pin` linked to the current `Structured Activity Node`.
`InputPin`	`createStructuredNodeInput(String name, Type type, EClass eClass)` Creates an `Input Pin` linked to the current `Structured Activity Node`.
`OutputPin`	`createStructuredNodeOutput(String name, Type type)` Creates an `Input Pin` linked to the current `Structured Activity Node`.
`Variable`	`createVariable(String name, Type type)` Creates a new `Variable`, with the specified 'Name', and 'Type', and appends it to the 'Variable' containment reference list
`ActivityEdge`	`getEdge(String name)` Retrieves the first `ActivityEdge` with the specified 'Name' from the ' Edge' containment reference list
`ActivityEdge`	`getEdge(String name, boolean ignoreCase, EClass eClass, boolean createOnDemand)` Retrieves the first `ActivityEdge` with the specified 'Name' from the ' Edge' containment reference list
`MDWEList<ActivityEdge>`	`getEdges()` Returns the value of the 'Edge' containment reference list.
`ActivityNode`	`getNode(String name)` Retrieves the first `ActivityNode` with the specified 'Name' from the ' Node' containment reference list
`ActivityNode`	`getNode(String name, boolean ignoreCase, EClass eClass, boolean createOnDemand)` Retrieves the first `ActivityNode` with the specified 'Name' from the ' Node' containment reference list
`MDWEList<ActivityNode>`	`getNodes()` Returns the value of the 'Node' containment reference list.
`InputPin`	`getStructuredNodeInput(String name, Type type)` Returns the `Input Pin` linked to the current `Structured Activity Node` called 'name' and `typed` 'type'.
`InputPin`	`getStructuredNodeInput(String name, Type type, boolean ignoreCase, EClass eClass, boolean createOnDemand)` Returns the `Input Pin` linked to the current `Structured Activity Node` called 'name' and `typed` 'type'.
`MDWEList<InputPin>`	`getStructuredNodeInputs()` Returns the list of `Input Pins` linked to the current `Structured Activity Node`.
`OutputPin`	`getStructuredNodeOutput(String name, Type type)` Returns the `Output Pin` linked to the current `Structured Activity Node` called 'name' and `typed` 'type'.
`OutputPin`	`getStructuredNodeOutput(String name, Type type, boolean ignoreCase, boolean createOnDemand)` Returns the `Output Pin` linked to the current `Structured Activity Node` called 'name' and `typed` 'type'.
`MDWEList<OutputPin>`	`getStructuredNodeOutputs()` Returns the list of `Output Pins` linked to the current `Structured Activity Node`.
`Variable`	`getVariable(String name, Type type)` Retrieves the first `Variable` with the specified 'Name', and 'Type' from the 'Variable' containment reference list
`Variable`	`getVariable(String name, Type type, boolean ignoreCase, boolean createOnDemand)` Retrieves the first `Variable` with the specified 'Name', and 'Type' from the 'Variable' containment reference list
`MDWEList<Variable>`	`getVariables()` Returns the value of the 'Variable' containment reference list.
`boolean`	`isMustIsolate()` Returns the value of the 'Must Isolate' attribute.
`void`	`setMustIsolate(boolean value)` Sets the value of the '`Must Isolate`' attribute
`boolean`	`validateEdges(DiagnosticChain diagnostics, Map context)` The edges owned by a structured node must have source and target nodes in the structured node, and vice versa.

Methods inherited from interface com.sodius.mdw.metamodel.uml21.Action
createLocalPostcondition, createLocalPostcondition, createLocalPrecondition, createLocalPrecondition, getContext, getInput, getInput, getInputs, getLocalPostcondition, getLocalPostcondition, getLocalPostconditions, getLocalPrecondition, getLocalPrecondition, getLocalPreconditions, getOutput, getOutput, getOutputs

Methods inherited from interface com.sodius.mdw.metamodel.uml21.ExecutableNode
createHandler, getHandlers

Methods inherited from interface com.sodius.mdw.metamodel.uml21.ActivityNode
getActivity, getIncoming, getIncoming, getIncomings, getInGroups, getInInterruptibleRegions, getInPartition, getInPartition, getInPartitions, getInStructuredNode, getOutgoing, getOutgoing, getOutgoings, getRedefinedNode, getRedefinedNode, getRedefinedNodes, setActivity, setInStructuredNode, validateOwned, validateOwnedStructuredNode

Methods inherited from interface com.sodius.mdw.metamodel.uml21.RedefinableElement
getRedefinedElement, getRedefinedElement, getRedefinedElements, getRedefinitionContext, getRedefinitionContext, getRedefinitionContexts, isConsistentWith, isLeaf, isRedefinitionContextValid, setIsLeaf, validateRedefinitionConsistent, validateRedefinitionContextValid

Methods inherited from interface com.sodius.mdw.metamodel.uml21.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 com.sodius.mdw.metamodel.uml21.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 com.sodius.mdw.core.model.MDWObject
compareTo, eExtendedClass, eIsInstanceOf, eIsInstanceOf, eIsProfiled, eIsRemoved, eMetamodel, eMetaTypeName, eModel, eRemove, eSetUniqueID, eUniqueID, superScript, superScript, toBoolean, toBoolean, toByte, toByte, toChar, toChar, toDouble, toDouble, toFloat, toFloat, toInt, toInt, toList, toList, toList, toList, toList, toLong, toLong, toObject, toObject, toSet, toSet, toShort, toShort, toString, toString

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, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver

Methods inherited from interface com.sodius.mdw.metamodel.uml21.ActivityGroup
getContainedEdge, getContainedEdge, getContainedEdges, getContainedNode, getContainedNode, getContainedNodes, getInActivity, getSubgroups, getSuperGroup, setInActivity, validateGroupOwned, validateNodesAndEdges, validateNotContained

- Method Detail
  - getVariables
```
MDWEList<Variable> getVariables()
```
    Returns the value of the 'Variable' containment reference list. The list contents are of type Variable. It is bidirectional and its opposite is 'Scope'. A variable defined in the scope of the structured activity node. It has no value and may not be accessed
    
    Returns:
    
    the value of the 'Variable' containment reference list.
    
    See Also:
    
    UMLPackage.getStructuredActivityNode_Variable(), Variable.getScope()
  - createVariable
```
Variable createVariable(String name,
                        Type type)
```
    Creates a new Variable, with the specified 'Name', and 'Type', and appends it to the 'Variable' containment reference list.
    
    Parameters:
    
    name - The 'Name' for the new Variable, or null.
    
    type - The 'Type' for the new Variable, or null.
    
    Returns:
    
    The new Variable.
    
    See Also:
    
    getVariables()
  - getVariable
```
Variable getVariable(String name,
                     Type type)
```
    Retrieves the first Variable with the specified 'Name', and 'Type' from the 'Variable' containment reference list.
    
    Parameters:
    
    name - The 'Name' of the Variable to retrieve, or null.
    
    type - The 'Type' of the Variable to retrieve, or null.
    
    Returns:
    
    The first Variable with the specified 'Name', and 'Type', or null.
    
    See Also:
    
    getVariables()
  - getVariable
```
Variable getVariable(String name,
                     Type type,
                     boolean ignoreCase,
                     boolean createOnDemand)
```
    Retrieves the first Variable with the specified 'Name', and 'Type' from the 'Variable' containment reference list.
    
    Parameters:
    
    name - The 'Name' of the Variable to retrieve, or null.
    
    type - The 'Type' of the Variable to retrieve, or null.
    
    ignoreCase - Whether to ignore case in String comparisons.
    
    createOnDemand - Whether to create a Variable on demand if not found.
    
    Returns:
    
    The first Variable with the specified 'Name', and 'Type', or null.
    
    See Also:
    
    getVariables()
  - getNodes
```
MDWEList<ActivityNode> getNodes()
```
    Returns the value of the 'Node' containment reference list. The list contents are of type ActivityNode. It is bidirectional and its opposite is 'In Structured Node'. Nodes immediately contained in the group.
    
    Returns:
    
    the value of the 'Node' containment reference list.
    
    See Also:
    
    UMLPackage.getStructuredActivityNode_Node(), ActivityNode.getInStructuredNode()
  - createNode
```
ActivityNode createNode(String name,
                        EClass eClass)
```
    Creates a new ActivityNode, with the specified 'Name', and appends it to the ' Node' containment reference list.
    
    Parameters:
    
    name - The 'Name' for the new ActivityNode, or null.
    
    eClass - The Ecore class of the ActivityNode to create.
    
    Returns:
    
    The new ActivityNode.
    
    See Also:
    
    getNodes()
  - getNode
```
ActivityNode getNode(String name)
```
    Retrieves the first ActivityNode with the specified 'Name' from the ' Node' containment 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:
    
    getNodes()
  - getNode
```
ActivityNode getNode(String name,
                     boolean ignoreCase,
                     EClass eClass,
                     boolean createOnDemand)
```
    Retrieves the first ActivityNode with the specified 'Name' from the ' Node' containment 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.
    
    createOnDemand - Whether to create a ActivityNode on demand if not found.
    
    Returns:
    
    The first ActivityNode with the specified 'Name', or null.
    
    See Also:
    
    getNodes()
  - isMustIsolate
```
boolean isMustIsolate()
```
    Returns the value of the 'Must Isolate' attribute. The default value is "false". If true, then the actions in the node execute in isolation from actions outside the node.
    
    Returns:
    
    the value of the 'Must Isolate' attribute.
    
    See Also:
    
    setMustIsolate(boolean), UMLPackage.getStructuredActivityNode_MustIsolate()
  - setMustIsolate
```
void setMustIsolate(boolean value)
```
    Sets the value of the 'Must Isolate' attribute.
    
    Parameters:
    
    value - the new value of the 'Must Isolate' attribute.
    
    See Also:
    
    isMustIsolate()
  - getEdges
```
MDWEList<ActivityEdge> getEdges()
```
    Returns the value of the 'Edge' containment reference list. The list contents are of type ActivityEdge. It is bidirectional and its opposite is 'In Structured Node'. Edges immediately contained in the structured node.
    
    Returns:
    
    the value of the 'Edge' containment reference list.
    
    See Also:
    
    UMLPackage.getStructuredActivityNode_Edge(), ActivityEdge.getInStructuredNode()
  - createEdge
```
ActivityEdge createEdge(String name,
                        EClass eClass)
```
    Creates a new ActivityEdge, with the specified 'Name', and appends it to the ' Edge' containment reference list.
    
    Parameters:
    
    name - The 'Name' for the new ActivityEdge, or null.
    
    eClass - The Ecore class of the ActivityEdge to create.
    
    Returns:
    
    The new ActivityEdge.
    
    See Also:
    
    getEdges()
  - getEdge
```
ActivityEdge getEdge(String name)
```
    Retrieves the first ActivityEdge with the specified 'Name' from the ' Edge' containment 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:
    
    getEdges()
  - getEdge
```
ActivityEdge getEdge(String name,
                     boolean ignoreCase,
                     EClass eClass,
                     boolean createOnDemand)
```
    Retrieves the first ActivityEdge with the specified 'Name' from the ' Edge' containment 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.
    
    createOnDemand - Whether to create a ActivityEdge on demand if not found.
    
    Returns:
    
    The first ActivityEdge with the specified 'Name', or null.
    
    See Also:
    
    getEdges()
  - validateEdges
```
boolean validateEdges(DiagnosticChain diagnostics,
                      Map context)
```
    The edges owned by a structured node must have source and target nodes in the structured node, and vice versa. true
  - getStructuredNodeInputs
```
MDWEList<InputPin> getStructuredNodeInputs()
```
    Returns the list of Input Pins linked to the current Structured Activity Node.
    for UML 2.3 or higher
    
    Returns:
    
    list of InputPins
    
    Since:
    
    3.5.0
  - getStructuredNodeOutputs
```
MDWEList<OutputPin> getStructuredNodeOutputs()
```
    Returns the list of Output Pins linked to the current Structured Activity Node.
    for UML 2.3 or higher
    
    Returns:
    
    list of OutputPins
    
    Since:
    
    3.4.0
  - createStructuredNodeInput
```
InputPin createStructuredNodeInput(String name,
                                   Type type)
```
    Creates an Input Pin linked to the current Structured Activity Node.
    for UML 2.3 or higher
    
    Parameters:
    
    name - the name of the InputPin created
    
    type - the type of the InputPin created
    
    Returns:
    
    a new InputPin
    
    Since:
    
    3.5.0
    
    See Also:
    
    TypedElement.getType()
  - createStructuredNodeInput
```
InputPin createStructuredNodeInput(String name,
                                   Type type,
                                   EClass eClass)
```
    Creates an Input Pin linked to the current Structured Activity Node.
    for UML 2.3 or higher
    
    Parameters:
    
    name - the name of the InputPin created
    
    type - the type of the InputPin created
    
    eClass - the kind of InputPin created : InputPin, ActionInputPin or ValuePin
    
    Returns:
    
    a new InputPin
    
    Since:
    
    3.5.0
    
    See Also:
    
    TypedElement.getType()
  - createStructuredNodeOutput
```
OutputPin createStructuredNodeOutput(String name,
                                     Type type)
```
    Creates an Input Pin linked to the current Structured Activity Node.
    for UML 2.3 or higher
    
    Parameters:
    
    name - the name of the OutputPin created
    
    type - the type of the OutputPin created
    
    Returns:
    
    list of OutputPins
    
    Since:
    
    3.5.0
    
    See Also:
    
    TypedElement.getType()
  - getStructuredNodeInput
```
InputPin getStructuredNodeInput(String name,
                                Type type)
```
    Returns the Input Pin linked to the current Structured Activity Node called 'name' and typed 'type'. Returns null if no corresponding InputPin found.
    for UML 2.3 or higher
    
    Parameters:
    
    name - the name of the InputPin
    
    type - the type of the InputPin
    
    Returns:
    
    InputPin
    
    Since:
    
    3.5.0
    
    See Also:
    
    TypedElement.getType()
  - getStructuredNodeInput
```
InputPin getStructuredNodeInput(String name,
                                Type type,
                                boolean ignoreCase,
                                EClass eClass,
                                boolean createOnDemand)
```
    Returns the Input Pin linked to the current Structured Activity Node called 'name' and typed 'type'.
    If the attribute 'ignoreCase' is set to true, the case of the InputPin name is ignored.
    If no corresponding InputPin is found, a new InputPin is created if the attribute'createOnDemand' is set to true. Returns null otherwise.
    for UML 2.3 or higher
    
    Parameters:
    
    name - the name of the InputPin
    
    type - the type of the InputPin
    
    ignoreCase - boolean to determine if the case is ignored or not
    
    createOnDemand - boolean to determine if a new InputPin is created
    
    Returns:
    
    InputPin
    
    Since:
    
    3.5.0
    
    See Also:
    
    TypedElement.getType()
  - getStructuredNodeOutput
```
OutputPin getStructuredNodeOutput(String name,
                                  Type type)
```
    Returns the Output Pin linked to the current Structured Activity Node called 'name' and typed 'type'. Returns null if no corresponding OutputPin found.
    for UML 2.3 or higher
    
    Parameters:
    
    name - the name of the OutputPin
    
    type - the type of the OutputPin
    
    Returns:
    
    OutputPin
    
    Since:
    
    3.5.0
    
    See Also:
    
    TypedElement.getType()
  - getStructuredNodeOutput
```
OutputPin getStructuredNodeOutput(String name,
                                  Type type,
                                  boolean ignoreCase,
                                  boolean createOnDemand)
```
    Returns the Output Pin linked to the current Structured Activity Node called 'name' and typed 'type'.
    If the attribute 'ignoreCase' is set to true, the case of the OutputPin name is ignored.
    If no corresponding OutputPin is found, a new OuputPin is created if the attribute'createOnDemand' is set to true. Returns null otherwise.
    for UML 2.3 or higher
    
    Parameters:
    
    name - the name of the OutputPin
    
    type - the type of the OutputPin
    
    ignoreCase - boolean to determine if the case is ignored or not
    
    createOnDemand - boolean to determine if a new OutputPin is created
    
    Returns:
    
    OutputPin
    
    Since:
    
    3.5.0
    
    See Also:
    
    TypedElement.getType()

Interface StructuredActivityNode

Field Summary

Fields inherited from interface com.sodius.mdw.metamodel.uml21.NamedElement

Method Summary

Methods inherited from interface com.sodius.mdw.metamodel.uml21.Action

Methods inherited from interface com.sodius.mdw.metamodel.uml21.ExecutableNode

Methods inherited from interface com.sodius.mdw.metamodel.uml21.ActivityNode

Methods inherited from interface com.sodius.mdw.metamodel.uml21.RedefinableElement

Methods inherited from interface com.sodius.mdw.metamodel.uml21.NamedElement

Methods inherited from interface com.sodius.mdw.metamodel.uml21.Element

Methods inherited from interface com.sodius.mdw.core.model.MDWObject

Methods inherited from interface org.eclipse.emf.ecore.EModelElement

Methods inherited from interface org.eclipse.emf.ecore.EObject

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

Methods inherited from interface com.sodius.mdw.metamodel.uml21.Namespace

Methods inherited from interface com.sodius.mdw.metamodel.uml21.ActivityGroup

Method Detail

getVariables

createVariable

getVariable

getVariable

getNodes

createNode

getNode

getNode

isMustIsolate

setMustIsolate

getEdges

createEdge

getEdge

getEdge

validateEdges

getStructuredNodeInputs

getStructuredNodeOutputs

createStructuredNodeInput

createStructuredNodeInput

createStructuredNodeOutput

getStructuredNodeInput

getStructuredNodeInput

getStructuredNodeOutput

getStructuredNodeOutput