org.eclipse.uml2.uml
Interface CallAction

All Superinterfaces:
Action, ActivityNode, Element, EModelElement, EObject, ExecutableNode, InvocationAction, NamedElement, Notifier, RedefinableElement
All Known Subinterfaces:
CallBehaviorAction, CallOperationAction

public interface CallAction
extends InvocationAction

A representation of the model object 'Call Action'. CallAction is an abstract class for actions that invoke behavior and receive return values.

The following features are supported:

See Also:
UMLPackage.getCallAction()

Field Summary
 
Fields inherited from interface org.eclipse.uml2.uml.NamedElement
SEPARATOR
 
Method Summary
 OutputPin createResult(String name, Type type)
          Creates a new OutputPin, with the specified 'Name', and 'Type', and appends it to the 'Result' containment reference list
 OutputPin getResult(String name, Type type)
          Retrieves the first OutputPin with the specified 'Name', and 'Type' from the 'Result' containment reference list
 OutputPin getResult(String name, Type type, boolean ignoreCase, boolean createOnDemand)
          Retrieves the first OutputPin with the specified 'Name', and 'Type' from the 'Result' containment reference list
 EList getResults()
          Returns the value of the 'Result' containment reference list.
 boolean isSynchronous()
          Returns the value of the 'Is Synchronous' attribute.
 void setIsSynchronous(boolean value)
          Sets the value of the 'Is Synchronous' attribute
 boolean validateNumberAndOrder(DiagnosticChain diagnostics, Map context)
           The number and order of argument pins must be the same as the number and order of parameters of the invoked behavior or behavioral feature.
 boolean validateSynchronousCall(DiagnosticChain diagnostics, Map context)
           Only synchronous call actions can have result pins.
 boolean validateTypeOrderingMultiplicity(DiagnosticChain diagnostics, Map context)
           The type, ordering, and multiplicity of an argument pin must be the same as the corresponding parameter of the behavior or behavioral feature.
 
Methods inherited from interface org.eclipse.uml2.uml.InvocationAction
createArgument, createArgument, getArgument, getArgument, getArguments, getOnPort, setOnPort, validateOnPortReceiver
 
Methods inherited from interface org.eclipse.uml2.uml.Action
createLocalPostcondition, createLocalPostcondition, createLocalPrecondition, createLocalPrecondition, getContext, getInput, getInput, getInputs, getLocalPostcondition, getLocalPostcondition, getLocalPostconditions, getLocalPrecondition, getLocalPrecondition, getLocalPreconditions, getOutput, getOutput, getOutputs
 
Methods inherited from interface org.eclipse.uml2.uml.ExecutableNode
createHandler, getHandlers
 
Methods inherited from interface org.eclipse.uml2.uml.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 org.eclipse.uml2.uml.RedefinableElement
getRedefinedElement, getRedefinedElement, getRedefinedElements, getRedefinitionContext, getRedefinitionContext, getRedefinitionContexts, isConsistentWith, isLeaf, isRedefinitionContextValid, setIsLeaf, validateRedefinitionConsistent, validateRedefinitionContextValid
 
Methods inherited from interface org.eclipse.uml2.uml.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 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, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 

Method Detail

isSynchronous

public boolean isSynchronous()
Returns the value of the 'Is Synchronous' attribute. The default value is "true". If true, the call is synchronous and the caller waits for completion of the invoked behavior. If false, the call is asynchronous and the caller proceeds immediately and does not expect a return values.

Returns:
the value of the 'Is Synchronous' attribute.
See Also:
CallAction.setIsSynchronous(boolean), UMLPackage.getCallAction_IsSynchronous()

setIsSynchronous

public void setIsSynchronous(boolean value)
Sets the value of the 'Is Synchronous' attribute.

Parameters:
value - the new value of the 'Is Synchronous' attribute.
See Also:
CallAction.isSynchronous()

getResults

public EList getResults()
Returns the value of the 'Result' containment reference list. The list contents are of type OutputPin. A list of output pins where the results of performing the invocation are placed.

Returns:
the value of the 'Result' containment reference list.
See Also:
UMLPackage.getCallAction_Result()

createResult

public OutputPin createResult(String name,
                              Type type)
Creates a new OutputPin, with the specified 'Name', and 'Type', and appends it to the 'Result' containment reference list.

Parameters:
name - The 'Name' for the new OutputPin, or null.
type - The 'Type' for the new OutputPin, or null.
Returns:
The new OutputPin.
See Also:
CallAction.getResults()

getResult

public OutputPin getResult(String name,
                           Type type)
Retrieves the first OutputPin with the specified 'Name', and 'Type' from the 'Result' containment reference list.

Parameters:
name - The 'Name' of the OutputPin to retrieve, or null.
type - The 'Type' of the OutputPin to retrieve, or null.
Returns:
The first OutputPin with the specified 'Name', and 'Type', or null.
See Also:
CallAction.getResults()

getResult

public OutputPin getResult(String name,
                           Type type,
                           boolean ignoreCase,
                           boolean createOnDemand)
Retrieves the first OutputPin with the specified 'Name', and 'Type' from the 'Result' containment reference list.

Parameters:
name - The 'Name' of the OutputPin to retrieve, or null.
type - The 'Type' of the OutputPin to retrieve, or null.
ignoreCase - Whether to ignore case in String comparisons.
createOnDemand - Whether to create a OutputPin on demand if not found.
Returns:
The first OutputPin with the specified 'Name', and 'Type', or null.
See Also:
CallAction.getResults()

validateSynchronousCall

public boolean validateSynchronousCall(DiagnosticChain diagnostics,
                                       Map context)
Only synchronous call actions can have result pins. true


validateNumberAndOrder

public boolean validateNumberAndOrder(DiagnosticChain diagnostics,
                                      Map context)
The number and order of argument pins must be the same as the number and order of parameters of the invoked behavior or behavioral feature. Pins are matched to parameters by order. true


validateTypeOrderingMultiplicity

public boolean validateTypeOrderingMultiplicity(DiagnosticChain diagnostics,
                                                Map context)
The type, ordering, and multiplicity of an argument pin must be the same as the corresponding parameter of the behavior or behavioral feature. true


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