org.eclipse.uml2
Interface ApplyFunctionAction

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

public interface ApplyFunctionAction
extends Action

A representation of the model object 'Apply Function Action'. ApplyFunctionAction is an action that invokes a primitive predefined function that computes output values based only on the input values and the function. The execution does not have access to object memory or to any objects. The execution of a primitive function has no side effects on any other object.

The following features are supported:

See Also:
UML2Package.getApplyFunctionAction()

Field Summary
static String copyright
           
 
Fields inherited from interface org.eclipse.uml2.NamedElement
SEPARATOR
 
Method Summary
 InputPin createArgument(EClass eClass)
          Creates a InputPin and appends it to the 'Argument' containment reference list
 OutputPin createResult(EClass eClass)
          Creates a OutputPin and appends it to the 'Result' containment reference list
 InputPin getArgument(String unqualifiedName)
          Retrieves the InputPin with the specified name from the 'Argument' containment reference list
 EList getArguments()
          Returns the value of the 'Argument' containment reference list.
 PrimitiveFunction getFunction()
          Returns the value of the 'Function' reference
 EList getInputs()
           
 EList getOutputs()
           
 OutputPin getResult(String unqualifiedName)
          Retrieves the OutputPin with the specified name from the 'Result' containment reference list
 EList getResults()
          Returns the value of the 'Result' containment reference list.
 void setFunction(PrimitiveFunction value)
          Sets the value of the 'Function' reference
 
Methods inherited from interface org.eclipse.uml2.Action
createLocalPostcondition, createLocalPrecondition, getContext, getEffect, getInput, getLocalPostcondition, getLocalPostconditions, getLocalPrecondition, getLocalPreconditions, getOutput, 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

getFunction

public PrimitiveFunction getFunction()
Returns the value of the 'Function' reference.

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

The primitive function to be invoked.

Returns:
the value of the 'Function' reference.
See Also:
setFunction(PrimitiveFunction), UML2Package.getApplyFunctionAction_Function()

setFunction

public void setFunction(PrimitiveFunction value)
Sets the value of the 'Function' reference.

Parameters:
value - the new value of the 'Function' reference.
See Also:
getFunction()

getArguments

public EList getArguments()
Returns the value of the 'Argument' containment reference list. The list contents are of type InputPin.

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

The pins that provide inputs to the function. (Specializes Action.input.)

Returns:
the value of the 'Argument' containment reference list.
See Also:
UML2Package.getApplyFunctionAction_Argument()

getArgument

public InputPin getArgument(String unqualifiedName)
Retrieves the InputPin with the specified name from the 'Argument' containment reference list.

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

createArgument

public InputPin createArgument(EClass eClass)
Creates a InputPin and appends it to the 'Argument' containment reference list.

Parameters:
eClass - The Ecore class of the InputPin to create.
Returns:
The new InputPin.
See Also:
getArguments()

getResults

public EList getResults()
Returns the value of the 'Result' containment reference list. The list contents are of type OutputPin.

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

The pins on which the results of invoking the function are returned. (Specializes Action.output.)

Returns:
the value of the 'Result' containment reference list.
See Also:
UML2Package.getApplyFunctionAction_Result()

getResult

public OutputPin getResult(String unqualifiedName)
Retrieves the OutputPin with the specified name from the 'Result' containment reference list.

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

createResult

public OutputPin createResult(EClass eClass)
Creates a OutputPin and appends it to the 'Result' containment reference list.

Parameters:
eClass - The Ecore class of the OutputPin to create.
Returns:
The new OutputPin.
See Also:
getResults()

getInputs

public EList getInputs()

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

getOutputs

public EList getOutputs()

Specified by:
getOutputs in interface Action
Returns:
the value of the 'Output' reference list.
See Also:
UML2Package.getAction_Output()

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