org.eclipse.uml2.uml
Interface Variable

All Superinterfaces:

ConnectableElement, Element, org.eclipse.emf.ecore.EModelElement, org.eclipse.emf.ecore.EObject, MultiplicityElement, NamedElement, org.eclipse.emf.common.notify.Notifier, ParameterableElement, TypedElement

public interface Variable
extends ConnectableElement, MultiplicityElement

A representation of the model object 'Variable'. A Variable is a ConnectableElement that may store values during the execution of an Activity. Reading and writing the values of a Variable provides an alternative means for passing data than the use of ObjectFlows. A Variable may be owned directly by an Activity, in which case it is accessible from anywhere within that activity, or it may be owned by a StructuredActivityNode, in which case it is only accessible within that node.

From package UML::Activities.

The following features are supported:

• Activity Scope
• Scope

See Also:

UMLPackage.getVariable()

Field Summary

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

SEPARATOR

Method Summary

Activity	getActivityScope() Returns the value of the 'Activity Scope' container reference.
StructuredActivityNode	getScope() Returns the value of the 'Scope' container reference.
boolean	isAccessibleBy(Action a) A Variable is accessible by Actions within its scope (the Activity or StructuredActivityNode that owns it).
void	setActivityScope(Activity value) Sets the value of the 'Activity Scope' container reference
void	setScope(StructuredActivityNode value) Sets the value of the 'Scope' container reference

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

getEnds

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

getType, setType

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.ParameterableElement

getOwningTemplateParameter, getTemplateParameter, isCompatibleWith, isTemplateParameter, setOwningTemplateParameter, setTemplateParameter

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

compatibleWith, createLowerValue, createUpperValue, getLower, getLowerValue, getUpper, getUpperValue, includesMultiplicity, is, isMultivalued, isOrdered, isUnique, lowerBound, setIsOrdered, setIsUnique, setLower, setLowerValue, setUpper, setUpperValue, upperBound, validateLowerGe0, validateLowerIsInteger, validateUpperGeLower, validateUpperIsUnlimitedNatural, validateValueSpecificationConstant, validateValueSpecificationNoSideEffects

Method Detail

getActivityScope

Activity getActivityScope()

Returns the value of the 'Activity Scope' container reference. It is bidirectional and its opposite is 'Variable'.

This feature subsets the following features:

• 'Namespace'

An Activity that owns the Variable.

From package UML::Activities.

Returns:

the value of the 'Activity Scope' container reference.

See Also:

setActivityScope(Activity), UMLPackage.getVariable_ActivityScope(), Activity.getVariables()

setActivityScope

void setActivityScope(Activity value)

Sets the value of the 'Activity Scope' container reference.

Parameters:

value - the new value of the 'Activity Scope' container reference.

See Also:

getActivityScope()

getScope

StructuredActivityNode getScope()

Returns the value of the 'Scope' container reference. It is bidirectional and its opposite is 'Variable'.

This feature subsets the following features:

• 'Namespace'

A StructuredActivityNode that owns the Variable.

From package UML::Activities.

Returns:

the value of the 'Scope' container reference.

See Also:

setScope(StructuredActivityNode), UMLPackage.getVariable_Scope(), StructuredActivityNode.getVariables()

setScope

void setScope(StructuredActivityNode value)

Sets the value of the 'Scope' container reference.

Parameters:

value - the new value of the 'Scope' container reference.

See Also:

getScope()

isAccessibleBy

boolean isAccessibleBy(Action a)

A Variable is accessible by Actions within its scope (the Activity or StructuredActivityNode that owns it). result = (if scope<>null then scope.allOwnedNodes()->includes(a) else a.containingActivity()=activityScope endif)

From package UML::Activities.