org.eclipse.uml2
Interface ReplyAction

All Superinterfaces:
Action, ActivityNode, Element, EModelElement, EObject, ExecutableNode, NamedElement, Notifier, RedefinableElement, TemplateableElement

public interface ReplyAction
extends Action

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

The following features are supported:

See Also:
UML2Package.getReplyAction()

Field Summary
static String copyright
           
 
Fields inherited from interface org.eclipse.uml2.NamedElement
SEPARATOR
 
Method Summary
 EList getInputs()
           
 CallTrigger getReplyToCall()
          Returns the value of the 'Reply To Call' reference
 InputPin getReplyValue(String unqualifiedName)
          Retrieves the InputPin with the specified name from the 'Reply Value' reference list
 EList getReplyValues()
          Returns the value of the 'Reply Value' reference list.
 InputPin getReturnInformation()
          Returns the value of the 'Return Information' reference
 void setReplyToCall(CallTrigger value)
          Sets the value of the 'Reply To Call' reference
 void setReturnInformation(InputPin value)
          Sets the value of the 'Return Information' reference
 
Methods inherited from interface org.eclipse.uml2.Action
createLocalPostcondition, createLocalPrecondition, getContext, getEffect, getInput, getLocalPostcondition, getLocalPostconditions, getLocalPrecondition, getLocalPreconditions, getOutput, getOutputs, getOwnedElements, setEffect
 
Methods inherited from interface org.eclipse.uml2.ExecutableNode
createHandler, getHandlers
 
Methods inherited from interface org.eclipse.uml2.ActivityNode
getActivity, getIncoming, getIncomings, getInGroups, getInInterruptibleRegions, getInPartition, getInPartitions, getInStructuredNode, getOutgoing, getOutgoings, getOwner, getRedefinedElement, getRedefinedElements, setActivity, setInStructuredNode
 
Methods inherited from interface org.eclipse.uml2.RedefinableElement
getRedefinitionContext, getRedefinitionContexts, isConsistentWith, isLeaf, isRedefinitionContextValid, setIsLeaf, validateRedefinitionConsistent, validateRedefinitionContextValid
 
Methods inherited from interface org.eclipse.uml2.NamedElement
allNamespaces, createNameExpression, getClientDependencies, getClientDependency, getName, getNameExpression, getNamespace, getQualifiedName, getVisibility, isDistinguishableFrom, qualifiedName, separator, setName, setNameExpression, setVisibility, validateNoName, validateQualifiedName, validateVisibilityNeedsOwnership
 
Methods inherited from interface org.eclipse.uml2.TemplateableElement
createOwnedTemplateSignature, createTemplateBinding, getOwnedTemplateSignature, getTemplateBindings, parameterableElements, setOwnedTemplateSignature
 
Methods inherited from interface org.eclipse.uml2.Element
addKeyword, allOwnedElements, apply, createEAnnotation, createOwnedComment, destroy, getApplicableStereotype, getApplicableStereotypes, getAppliedStereotype, getAppliedStereotypes, getAppliedVersion, getKeywords, getModel, getNearestPackage, getOwnedComments, getValue, hasKeyword, isApplied, isRequired, mustBeOwned, removeKeyword, setValue, unapply, 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
 

Field Detail

copyright

public static final String copyright

See Also:
Constant Field Values
Method Detail

getReplyToCall

public CallTrigger getReplyToCall()
Returns the value of the 'Reply To Call' reference.

If the meaning of the 'Reply To Call' reference isn't clear, there really should be more of a description here...

The operation call trigger being replied to.

Returns:
the value of the 'Reply To Call' reference.
See Also:
setReplyToCall(CallTrigger), UML2Package.getReplyAction_ReplyToCall()

setReplyToCall

public void setReplyToCall(CallTrigger value)
Sets the value of the 'Reply To Call' reference.

Parameters:
value - the new value of the 'Reply To Call' reference.
See Also:
getReplyToCall()

getReplyValues

public EList getReplyValues()
Returns the value of the 'Reply Value' reference list. The list contents are of type InputPin.

If the meaning of the 'Reply Value' reference list isn't clear, there really should be more of a description here...

A list of pins containing the reply values of the operation. These values are returned to the caller.

Returns:
the value of the 'Reply Value' reference list.
See Also:
UML2Package.getReplyAction_ReplyValue()

getReplyValue

public InputPin getReplyValue(String unqualifiedName)
Retrieves the InputPin with the specified name from the 'Reply Value' reference list.

Parameters:
unqualifiedName - The unqualified name of the InputPin to retrieve.
Returns:
The InputPin with the specified name, or null.
See Also:
getReplyValues()

getReturnInformation

public InputPin getReturnInformation()
Returns the value of the 'Return Information' reference.

If the meaning of the 'Return Information' reference isn't clear, there really should be more of a description here...

A pin containing the return information token produced by an earlier AcceptCallAction.

Returns:
the value of the 'Return Information' reference.
See Also:
setReturnInformation(InputPin), UML2Package.getReplyAction_ReturnInformation()

setReturnInformation

public void setReturnInformation(InputPin value)
Sets the value of the 'Return Information' reference.

Parameters:
value - the new value of the 'Return Information' reference.
See Also:
getReturnInformation()

getInputs

public EList getInputs()

Specified by:
getInputs in interface Action
Returns:
the value of the 'Input' reference list.
See Also:
UML2Package.getAction_Input()

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