InteractionUse

All Superinterfaces:

Comparable<Object>, Element, EModelElement, EObject, InteractionFragment, MDWEObject, MDWObject, NamedElement, Notifier

All Known Subinterfaces:

PartDecomposition
```
public interface InteractionUse
extends InteractionFragment
```
A representation of the model object 'Interaction Use'. An interaction use refers to an interaction. The interaction use is a shorthand for copying the contents of the referenced interaction where the interaction use is. To be accurate the copying must take into account substituting parameters with arguments and connect the formal gates with the actual ones.
The following features are supported:
See Also:

UMLPackage.getInteractionUse()

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
`Gate`	`createActualGate(String name)` Creates a new `Gate`, with the specified 'Name', and appends it to the ' Actual Gate' containment reference list
`Action`	`createArgument(String name, EClass eClass)` Creates a new `Action`, with the specified 'Name', and appends it to the ' Argument' containment reference list
`Gate`	`getActualGate(String name)` Retrieves the first `Gate` with the specified 'Name' from the 'Actual Gate ' containment reference list
`Gate`	`getActualGate(String name, boolean ignoreCase, boolean createOnDemand)` Retrieves the first `Gate` with the specified 'Name' from the 'Actual Gate ' containment reference list
`MDWEList<Gate>`	`getActualGates()` Returns the value of the 'Actual Gate' containment reference list.
`Action`	`getArgument(String name)` Retrieves the first `Action` with the specified 'Name' from the 'Argument' containment reference list
`Action`	`getArgument(String name, boolean ignoreCase, EClass eClass, boolean createOnDemand)` Retrieves the first `Action` with the specified 'Name' from the 'Argument' containment reference list
`MDWEList<Action>`	`getArguments()` Returns the value of the 'Argument' containment reference list.
`Interaction`	`getRefersTo()` Returns the value of the 'Refers To' reference
`void`	`setRefersTo(Interaction value)` Sets the value of the '`Refers To`' reference
`boolean`	`validateAllLifelines(DiagnosticChain diagnostics, Map context)` The InteractionUse must cover all Lifelines of the enclosing Interaction which appear within the referred Interaction.
`boolean`	`validateArgumentsAreConstants(DiagnosticChain diagnostics, Map context)` The arguments must only be constants, parameters of the enclosing Interaction or attributes of the classifier owning the enclosing Interaction.
`boolean`	`validateArgumentsCorrespondToParameters(DiagnosticChain diagnostics, Map context)` The arguments of the InteractionUse must correspond to parameters of the referred Interaction true
`boolean`	`validateGatesMatch(DiagnosticChain diagnostics, Map context)` Actual Gates of the InteractionUse must match Formal Gates of the referred Interaction.

Methods inherited from interface com.sodius.mdw.metamodel.uml21.InteractionFragment
createGeneralOrdering, getCovered, getCovered, getCovereds, getEnclosingInteraction, getEnclosingOperand, getGeneralOrdering, getGeneralOrdering, getGeneralOrderings, setEnclosingInteraction, setEnclosingOperand

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

- Method Detail
  - getRefersTo
```
Interaction getRefersTo()
```
    Returns the value of the 'Refers To' reference. Refers to the Interaction that defines its meaning
    
    Returns:
    
    the value of the 'Refers To' reference.
    
    See Also:
    
    setRefersTo(Interaction), UMLPackage.getInteractionUse_RefersTo()
  - setRefersTo
```
void setRefersTo(Interaction value)
```
    Sets the value of the 'Refers To' reference.
    
    Parameters:
    
    value - the new value of the 'Refers To' reference.
    
    See Also:
    
    getRefersTo()
  - getActualGates
```
MDWEList<Gate> getActualGates()
```
    Returns the value of the 'Actual Gate' containment reference list. The list contents are of type Gate. The actual gates of the InteractionUse
    
    Returns:
    
    the value of the 'Actual Gate' containment reference list.
    
    See Also:
    
    UMLPackage.getInteractionUse_ActualGate()
  - createActualGate
```
Gate createActualGate(String name)
```
    Creates a new Gate, with the specified 'Name', and appends it to the ' Actual Gate' containment reference list.
    
    Parameters:
    
    name - The 'Name' for the new Gate, or null.
    
    Returns:
    
    The new Gate.
    
    See Also:
    
    getActualGates()
  - getActualGate
```
Gate getActualGate(String name)
```
    Retrieves the first Gate with the specified 'Name' from the 'Actual Gate ' containment reference list.
    
    Parameters:
    
    name - The 'Name' of the Gate to retrieve, or null.
    
    Returns:
    
    The first Gate with the specified 'Name', or null.
    
    See Also:
    
    getActualGates()
  - getActualGate
```
Gate getActualGate(String name,
                   boolean ignoreCase,
                   boolean createOnDemand)
```
    Retrieves the first Gate with the specified 'Name' from the 'Actual Gate ' containment reference list.
    
    Parameters:
    
    name - The 'Name' of the Gate to retrieve, or null.
    
    ignoreCase - Whether to ignore case in String comparisons.
    
    createOnDemand - Whether to create a Gate on demand if not found.
    
    Returns:
    
    The first Gate with the specified 'Name', or null.
    
    See Also:
    
    getActualGates()
  - getArguments
```
MDWEList<Action> getArguments()
```
    Returns the value of the 'Argument' containment reference list. The list contents are of type Action. The actual arguments of the Interaction
    
    Returns:
    
    the value of the 'Argument' containment reference list.
    
    See Also:
    
    UMLPackage.getInteractionUse_Argument()
  - createArgument
```
Action createArgument(String name,
                      EClass eClass)
```
    Creates a new Action, with the specified 'Name', and appends it to the ' Argument' containment reference list.
    
    Parameters:
    
    name - The 'Name' for the new Action, or null.
    
    eClass - The Ecore class of the Action to create.
    
    Returns:
    
    The new Action.
    
    See Also:
    
    getArguments()
  - getArgument
```
Action getArgument(String name)
```
    Retrieves the first Action with the specified 'Name' from the 'Argument' containment reference list.
    
    Parameters:
    
    name - The 'Name' of the Action to retrieve, or null.
    
    Returns:
    
    The first Action with the specified 'Name', or null.
    
    See Also:
    
    getArguments()
  - getArgument
```
Action getArgument(String name,
                   boolean ignoreCase,
                   EClass eClass,
                   boolean createOnDemand)
```
    Retrieves the first Action with the specified 'Name' from the 'Argument' containment reference list.
    
    Parameters:
    
    name - The 'Name' of the Action to retrieve, or null.
    
    ignoreCase - Whether to ignore case in String comparisons.
    
    eClass - The Ecore class of the Action to retrieve, or null.
    
    createOnDemand - Whether to create a Action on demand if not found.
    
    Returns:
    
    The first Action with the specified 'Name', or null.
    
    See Also:
    
    getArguments()
  - validateGatesMatch
```
boolean validateGatesMatch(DiagnosticChain diagnostics,
                           Map context)
```
    Actual Gates of the InteractionUse must match Formal Gates of the referred Interaction. Gates match when their names are equal. true
  - validateAllLifelines
```
boolean validateAllLifelines(DiagnosticChain diagnostics,
                             Map context)
```
    The InteractionUse must cover all Lifelines of the enclosing Interaction which appear within the referred Interaction. true
  - validateArgumentsCorrespondToParameters
```
boolean validateArgumentsCorrespondToParameters(DiagnosticChain diagnostics,
                                                Map context)
```
    The arguments of the InteractionUse must correspond to parameters of the referred Interaction true
  - validateArgumentsAreConstants
```
boolean validateArgumentsAreConstants(DiagnosticChain diagnostics,
                                      Map context)
```
    The arguments must only be constants, parameters of the enclosing Interaction or attributes of the classifier owning the enclosing Interaction. true

Interface InteractionUse

Field Summary

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

Method Summary

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

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

Method Detail

getRefersTo

setRefersTo

getActualGates

createActualGate

getActualGate

getActualGate

getArguments

createArgument

getArgument

getArgument

validateGatesMatch

validateAllLifelines

validateArgumentsCorrespondToParameters

validateArgumentsAreConstants