org.eclipse.uml2.uml
Interface ReadVariableAction

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

public interface ReadVariableAction
extends VariableAction

A representation of the model object 'Read Variable Action'. A read variable action is a variable action that retrieves the values of a variable.

The following features are supported:

See Also:
UMLPackage.getReadVariableAction()

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 sets the 'Result' containment reference
 OutputPin getResult()
          Returns the value of the 'Result' containment reference
 void setResult(OutputPin value)
          Sets the value of the 'Result' containment reference
 boolean validateCompatibleMultiplicity(DiagnosticChain diagnostics, Map context)
           The multiplicity of the variable must be compatible with the multiplicity of the output pin.
 boolean validateTypeAndOrdering(DiagnosticChain diagnostics, Map context)
           The type and ordering of the result output pin of a read-variable action are the same as the type and ordering of the variable.
 
Methods inherited from interface org.eclipse.uml2.uml.VariableAction
getVariable, setVariable, validateScopeOfVariable
 
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

getResult

public OutputPin getResult()
Returns the value of the 'Result' containment reference. Gives the output pin on which the result is put.

Returns:
the value of the 'Result' containment reference.
See Also:
ReadVariableAction.setResult(OutputPin), UMLPackage.getReadVariableAction_Result()

setResult

public void setResult(OutputPin value)
Sets the value of the 'Result' containment reference.

Parameters:
value - the new value of the 'Result' containment reference.
See Also:
ReadVariableAction.getResult()

createResult

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

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:
ReadVariableAction.getResult()

validateTypeAndOrdering

public boolean validateTypeAndOrdering(DiagnosticChain diagnostics,
                                       Map context)
The type and ordering of the result output pin of a read-variable action are the same as the type and ordering of the variable. self.result.type =self.variable.type and self.result.ordering = self.variable.ordering


validateCompatibleMultiplicity

public boolean validateCompatibleMultiplicity(DiagnosticChain diagnostics,
                                              Map context)
The multiplicity of the variable must be compatible with the multiplicity of the output pin. self.variable.multiplicity.compatibleWith(self.result.multiplicity)


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