org.eclipse.uml2.uml

Interface ReplyAction

All Superinterfaces:

Action, ActivityContent, ActivityNode, Element, org.eclipse.emf.ecore.EModelElement, org.eclipse.emf.ecore.EObject, ExecutableNode, NamedElement, org.eclipse.emf.common.notify.Notifier, RedefinableElement

public interface ReplyAction
extends Action

A representation of the model object 'Reply Action'. A ReplyAction is an Action that accepts a set of reply values and a value containing return information produced by a previous AcceptCallAction. The ReplyAction returns the values to the caller of the previous call, completing execution of the call.

From package UML::Actions.

The following features are supported:

• Reply To Call
• Reply Value
• Return Information

See Also:

UMLPackage.getReplyAction()

Field Summary

Fields inherited from interface org.eclipse.uml2.uml.NamedElement

SEPARATOR

Method Summary

Modifier and Type	Method and Description
InputPin	createReplyValue(java.lang.String name, Type type) Creates a new InputPin, with the specified 'Name', and 'Type', and appends it to the 'Reply Value' containment reference list
InputPin	createReplyValue(java.lang.String name, Type type, org.eclipse.emf.ecore.EClass eClass) Creates a new InputPin, with the specified 'Name', and 'Type', and appends it to the 'Reply Value' containment reference list
InputPin	createReturnInformation(java.lang.String name, Type type) Creates a new InputPin,with the specified 'Name', and 'Type', and sets the 'Return Information' containment reference
InputPin	createReturnInformation(java.lang.String name, Type type, org.eclipse.emf.ecore.EClass eClass) Creates a new InputPin, with the specified 'Name', and 'Type', and sets the 'Return Information' containment reference
Trigger	getReplyToCall() Returns the value of the 'Reply To Call' reference
InputPin	getReplyValue(java.lang.String name, Type type) Retrieves the first InputPin with the specified 'Name', and 'Type' from the 'Reply Value' containment reference list
InputPin	getReplyValue(java.lang.String name, Type type, boolean ignoreCase, org.eclipse.emf.ecore.EClass eClass, boolean createOnDemand) Retrieves the first InputPin with the specified 'Name', and 'Type' from the 'Reply Value' containment reference list
org.eclipse.emf.common.util.EList<InputPin>	getReplyValues() Returns the value of the 'Reply Value' containment reference list.
InputPin	getReturnInformation() Returns the value of the 'Return Information' containment reference.
void	setReplyToCall(Trigger value) Sets the value of the 'Reply To Call' reference
void	setReturnInformation(InputPin value) Sets the value of the 'Return Information' containment reference
boolean	validateEventOnReplyToCallTrigger(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context) The event of the replyToCall Trigger must be a CallEvent.
boolean	validatePinsMatchParameter(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context) The replyValue InputPins must match the output (return, out, and inout) parameters of the operation of the event of the replyToCall Trigger in number, type, ordering, and multiplicity.

Methods inherited from interface org.eclipse.uml2.uml.Action

allActions, allOwnedNodes, containingBehavior, createLocalPostcondition, createLocalPostcondition, createLocalPrecondition, createLocalPrecondition, getContext, getInput, getInput, getInputs, getLocalPostcondition, getLocalPostcondition, getLocalPostconditions, getLocalPrecondition, getLocalPrecondition, getLocalPreconditions, getOutput, getOutput, getOutputs, isLocallyReentrant, setIsLocallyReentrant

Methods inherited from interface org.eclipse.uml2.uml.ExecutableNode

createHandler, getHandlers

Methods inherited from interface org.eclipse.uml2.uml.ActivityNode

getActivity, getIncoming, getIncoming, getIncomings, getInGroup, getInGroup, getInGroups, getInInterruptibleRegion, getInInterruptibleRegion, getInInterruptibleRegions, getInPartition, getInPartition, getInPartitions, getInStructuredNode, getOutgoing, getOutgoing, getOutgoings, getRedefinedNode, getRedefinedNode, getRedefinedNodes, setActivity, setInStructuredNode

Methods inherited from interface org.eclipse.uml2.uml.RedefinableElement

getRedefinedElement, getRedefinedElement, getRedefinedElements, getRedefinitionContext, getRedefinitionContext, getRedefinitionContexts, isConsistentWith, isLeaf, isRedefinitionContextValid, setIsLeaf, validateNonLeafRedefinition, validateRedefinitionConsistent, validateRedefinitionContextValid

Methods inherited from interface org.eclipse.uml2.uml.NamedElement

allNamespaces, allOwningPackages, createDependency, createNameExpression, createUsage, 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, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset

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

eAdapters, eDeliver, eNotify, eSetDeliver

Methods inherited from interface org.eclipse.uml2.uml.ActivityContent

containingActivity

Method Detail

getReplyToCall

Trigger getReplyToCall()

Returns the value of the 'Reply To Call' reference. The Trigger specifying the Operation whose call is being replied to.

From package UML::Actions.

Returns:

the value of the 'Reply To Call' reference.

See Also:

setReplyToCall(Trigger), UMLPackage.getReplyAction_ReplyToCall()

setReplyToCall

void setReplyToCall(Trigger value)

Sets the value of the 'Reply To Call' reference.

Parameters:

value - the new value of the 'Reply To Call' reference.

See Also:

getReplyToCall()

getReturnInformation

InputPin getReturnInformation()

Returns the value of the 'Return Information' containment reference.

This feature subsets the following features:

• 'Input'

An InputPin that holds the return information value produced by an earlier AcceptCallAction.

From package UML::Actions.

Returns:

the value of the 'Return Information' containment reference.

See Also:

setReturnInformation(InputPin), UMLPackage.getReplyAction_ReturnInformation()

setReturnInformation

void setReturnInformation(InputPin value)

Sets the value of the 'Return Information' containment reference.

Parameters:

value - the new value of the 'Return Information' containment reference.

See Also:

getReturnInformation()

createReturnInformation

InputPin createReturnInformation(java.lang.String name,
                                 Type type,
                                 org.eclipse.emf.ecore.EClass eClass)

Creates a new InputPin, with the specified 'Name', and 'Type', and sets the 'Return Information' containment reference.

Parameters:

name - The 'Name' for the new InputPin, or null.

type - The 'Type' for the new InputPin, or null.

eClass - The Ecore class of the InputPin to create.

Returns:

The new InputPin.

See Also:

getReturnInformation()

createReturnInformation

InputPin createReturnInformation(java.lang.String name,
                                 Type type)

Creates a new InputPin,with the specified 'Name', and 'Type', and sets the 'Return Information' containment reference.

Parameters:

name - The 'Name' for the new InputPin, or null.

type - The 'Type' for the new InputPin, or null.

Returns:

The new InputPin.

See Also:

getReturnInformation()

getReplyValues

org.eclipse.emf.common.util.EList<InputPin> getReplyValues()

Returns the value of the 'Reply Value' containment reference list. The list contents are of type InputPin.

This feature subsets the following features:

• 'Input'

A list of InputPins providing the values for the output (inout, out, and return) Parameters of the Operation. These values are returned to the caller.

From package UML::Actions.

Returns:

the value of the 'Reply Value' containment reference list.

See Also:

UMLPackage.getReplyAction_ReplyValue()

createReplyValue

InputPin createReplyValue(java.lang.String name,
                          Type type,
                          org.eclipse.emf.ecore.EClass eClass)

Creates a new InputPin, with the specified 'Name', and 'Type', and appends it to the 'Reply Value' containment reference list.

Parameters:

name - The 'Name' for the new InputPin, or null.

type - The 'Type' for the new InputPin, or null.

eClass - The Ecore class of the InputPin to create.

Returns:

The new InputPin.

See Also:

getReplyValues()

createReplyValue

InputPin createReplyValue(java.lang.String name,
                          Type type)

Creates a new InputPin, with the specified 'Name', and 'Type', and appends it to the 'Reply Value' containment reference list.

Parameters:

name - The 'Name' for the new InputPin, or null.

type - The 'Type' for the new InputPin, or null.

Returns:

The new InputPin.

See Also:

getReplyValues()

getReplyValue

InputPin getReplyValue(java.lang.String name,
                       Type type)

Retrieves the first InputPin with the specified 'Name', and 'Type' from the 'Reply Value' containment reference list.

Parameters:

name - The 'Name' of the InputPin to retrieve, or null.

type - The 'Type' of the InputPin to retrieve, or null.

Returns:

The first InputPin with the specified 'Name', and 'Type', or null.

See Also:

getReplyValues()

getReplyValue

InputPin getReplyValue(java.lang.String name,
                       Type type,
                       boolean ignoreCase,
                       org.eclipse.emf.ecore.EClass eClass,
                       boolean createOnDemand)

Retrieves the first InputPin with the specified 'Name', and 'Type' from the 'Reply Value' containment reference list.

Parameters:

name - The 'Name' of the InputPin to retrieve, or null.

type - The 'Type' of the InputPin to retrieve, or null.

ignoreCase - Whether to ignore case in String comparisons.

eClass - The Ecore class of the InputPin to retrieve, or null.

createOnDemand - Whether to create a InputPin on demand if not found.

Returns:

The first InputPin with the specified 'Name', and 'Type', or null.

See Also:

getReplyValues()

validatePinsMatchParameter

boolean validatePinsMatchParameter(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
                                   java.util.Map<java.lang.Object,java.lang.Object> context)

The replyValue InputPins must match the output (return, out, and inout) parameters of the operation of the event of the replyToCall Trigger in number, type, ordering, and multiplicity. let parameter:OrderedSet(Parameter) = replyToCall.event.oclAsType(CallEvent).operation.outputParameters() in replyValue->size()=parameter->size() and Sequence{1..replyValue->size()}->forAll(i | replyValue->at(i).type.conformsTo(parameter->at(i).type) and replyValue->at(i).isOrdered=parameter->at(i).isOrdered and replyValue->at(i).compatibleWith(parameter->at(i)))

Parameters:

diagnostics - The chain of diagnostics to which problems are to be appended.

context - The cache of context-specific information.

validateEventOnReplyToCallTrigger

boolean validateEventOnReplyToCallTrigger(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
                                          java.util.Map<java.lang.Object,java.lang.Object> context)

The event of the replyToCall Trigger must be a CallEvent. replyToCall.event.oclIsKindOf(CallEvent)

Parameters:

diagnostics - The chain of diagnostics to which problems are to be appended.

context - The cache of context-specific information.