ObjectNode

All Superinterfaces:

ActivityNode, Comparable<Object>, Element, EModelElement, EObject, MDWEObject, MDWObject, NamedElement, Notifier, RedefinableElement, TypedElement

All Known Subinterfaces:

ActionInputPin, ActivityParameterNode, CentralBufferNode, DataStoreNode, ExpansionNode, InputPin, OutputPin, Pin, ValuePin
```
public interface ObjectNode
extends ActivityNode, TypedElement
```
A representation of the model object 'Object Node'. An object node is an abstract activity node that is part of defining object flow in an activity. Object nodes have support for token selection, limitation on the number of tokens, specifying the state required for tokens, and carrying control values.
The following features are supported:
See Also:

UMLPackage.getObjectNode()

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
`ValueSpecification`	`createUpperBound(String name, Type type, EClass eClass)` Creates a new `ValueSpecification`, with the specified 'Name', and 'Type', and sets the 'Upper Bound' containment reference
`State`	`getInState(String name)` Retrieves the first `State` with the specified 'Name' from the 'In State' reference list
`State`	`getInState(String name, boolean ignoreCase, EClass eClass)` Retrieves the first `State` with the specified 'Name' from the 'In State' reference list
`MDWEList<State>`	`getInStates()` Returns the value of the 'In State' reference list.
`ObjectNodeOrderingKind`	`getOrdering()` Returns the value of the 'Ordering' attribute.
`Behavior`	`getSelection()` Returns the value of the 'Selection' reference
`ValueSpecification`	`getUpperBound()` Returns the value of the 'Upper Bound' containment reference
`boolean`	`isControlType()` Returns the value of the 'Is Control Type' attribute.
`void`	`setIsControlType(boolean value)` Sets the value of the '`Is Control Type`' attribute
`void`	`setOrdering(ObjectNodeOrderingKind value)` Sets the value of the '`Ordering`' attribute
`void`	`setSelection(Behavior value)` Sets the value of the '`Selection`' reference
`void`	`setUpperBound(ValueSpecification value)` Sets the value of the '`Upper Bound`' containment reference
`boolean`	`validateInputOutputParameter(DiagnosticChain diagnostics, Map context)` A selection behavior has one input parameter and one output parameter.
`boolean`	`validateNotUnique(DiagnosticChain diagnostics, Map context)` Object nodes are not unique typed elements isUnique = false
`boolean`	`validateObjectFlowEdges(DiagnosticChain diagnostics, Map context)` All edges coming into or going out of object nodes must be object flow edges.
`boolean`	`validateSelectionBehavior(DiagnosticChain diagnostics, Map context)` If an object node has a selection behavior, then the ordering of the object node is ordered, and vice versa.

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.TypedElement
getType, setType

- Method Detail
  - getOrdering
```
ObjectNodeOrderingKind getOrdering()
```
    Returns the value of the 'Ordering' attribute. The default value is "FIFO". The literals are from the enumeration ObjectNodeOrderingKind. Tells whether and how the tokens in the object node are ordered for selection to traverse edges outgoing from the object node.
    
    Returns:
    
    the value of the 'Ordering' attribute.
    
    See Also:
    
    ObjectNodeOrderingKind, setOrdering(ObjectNodeOrderingKind), UMLPackage.getObjectNode_Ordering()
  - setOrdering
```
void setOrdering(ObjectNodeOrderingKind value)
```
    Sets the value of the 'Ordering' attribute.
    
    Parameters:
    
    value - the new value of the 'Ordering' attribute.
    
    See Also:
    
    ObjectNodeOrderingKind, getOrdering()
  - isControlType
```
boolean isControlType()
```
    Returns the value of the 'Is Control Type' attribute. The default value is "false". Tells whether the type of the object node is to be treated as control.
    
    Returns:
    
    the value of the 'Is Control Type' attribute.
    
    See Also:
    
    setIsControlType(boolean), UMLPackage.getObjectNode_IsControlType()
  - setIsControlType
```
void setIsControlType(boolean value)
```
    Sets the value of the 'Is Control Type' attribute.
    
    Parameters:
    
    value - the new value of the 'Is Control Type' attribute.
    
    See Also:
    
    isControlType()
  - getUpperBound
```
ValueSpecification getUpperBound()
```
    Returns the value of the 'Upper Bound' containment reference. The maximum number of tokens allowed in the node. Objects cannot flow into the node if the upper bound is reached.
    
    Returns:
    
    the value of the 'Upper Bound' containment reference.
    
    See Also:
    
    setUpperBound(ValueSpecification), UMLPackage.getObjectNode_UpperBound()
  - setUpperBound
```
void setUpperBound(ValueSpecification value)
```
    Sets the value of the 'Upper Bound' containment reference.
    
    Parameters:
    
    value - the new value of the 'Upper Bound' containment reference.
    
    See Also:
    
    getUpperBound()
  - createUpperBound
```
ValueSpecification createUpperBound(String name,
                                    Type type,
                                    EClass eClass)
```
    Creates a new ValueSpecification, with the specified 'Name', and 'Type', and sets the 'Upper Bound' containment reference.
    
    Parameters:
    
    name - The 'Name' for the new ValueSpecification, or null.
    
    type - The 'Type' for the new ValueSpecification, or null.
    
    eClass - The Ecore class of the ValueSpecification to create.
    
    Returns:
    
    The new ValueSpecification.
    
    See Also:
    
    getUpperBound()
  - getInStates
```
MDWEList<State> getInStates()
```
    Returns the value of the 'In State' reference list. The list contents are of type State. The required states of the object available at this point in the activity.
    
    Returns:
    
    the value of the 'In State' reference list.
    
    See Also:
    
    UMLPackage.getObjectNode_InState()
  - getInState
```
State getInState(String name)
```
    Retrieves the first State with the specified 'Name' from the 'In State' reference list.
    
    Parameters:
    
    name - The 'Name' of the State to retrieve, or null.
    
    Returns:
    
    The first State with the specified 'Name', or null.
    
    See Also:
    
    getInStates()
  - getInState
```
State getInState(String name,
                 boolean ignoreCase,
                 EClass eClass)
```
    Retrieves the first State with the specified 'Name' from the 'In State' reference list.
    
    Parameters:
    
    name - The 'Name' of the State to retrieve, or null.
    
    ignoreCase - Whether to ignore case in String comparisons.
    
    eClass - The Ecore class of the State to retrieve, or null.
    
    Returns:
    
    The first State with the specified 'Name', or null.
    
    See Also:
    
    getInStates()
  - getSelection
```
Behavior getSelection()
```
    Returns the value of the 'Selection' reference. Selects tokens for outgoing edges.
    
    Returns:
    
    the value of the 'Selection' reference.
    
    See Also:
    
    setSelection(Behavior), UMLPackage.getObjectNode_Selection()
  - setSelection
```
void setSelection(Behavior value)
```
    Sets the value of the 'Selection' reference.
    
    Parameters:
    
    value - the new value of the 'Selection' reference.
    
    See Also:
    
    getSelection()
  - validateObjectFlowEdges
```
boolean validateObjectFlowEdges(DiagnosticChain diagnostics,
                                Map context)
```
    All edges coming into or going out of object nodes must be object flow edges. true
  - validateNotUnique
```
boolean validateNotUnique(DiagnosticChain diagnostics,
                          Map context)
```
    Object nodes are not unique typed elements isUnique = false
  - validateSelectionBehavior
```
boolean validateSelectionBehavior(DiagnosticChain diagnostics,
                                  Map context)
```
    If an object node has a selection behavior, then the ordering of the object node is ordered, and vice versa. true
  - validateInputOutputParameter
```
boolean validateInputOutputParameter(DiagnosticChain diagnostics,
                                     Map context)
```
    A selection behavior has one input parameter and one output parameter. The input parameter must be a bag of elements of the same type as the object node or a supertype of the type of object node. The output parameter must be the same or a subtype of the type of object node. The behavior cannot have side effects. true

Interface ObjectNode

Field Summary

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

Method Summary

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.TypedElement

Method Detail

getOrdering

setOrdering

isControlType

setIsControlType

getUpperBound

setUpperBound

createUpperBound

getInStates

getInState

getInState

getSelection

setSelection

validateObjectFlowEdges

validateNotUnique

validateSelectionBehavior

validateInputOutputParameter