org.eclipse.uml2
Interface Activity

All Superinterfaces:
Behavior, BehavioredClassifier, Class, Classifier, Element, EModelElement, EncapsulatedClassifier, EObject, NamedElement, Namespace, Notifier, PackageableElement, ParameterableElement, RedefinableElement, StructuredClassifier, TemplateableElement, Type

public interface Activity
extends Behavior

A representation of the model object 'Activity'. An activity contains a language-specific text string used to describe a computation, and an optional specification of the language. OCL, natural language, or programming languages may be used to specify an activity.

The following features are supported:

See Also:
UML2Package.getActivity()

Field Summary
static String copyright
           
 
Fields inherited from interface org.eclipse.uml2.NamedElement
SEPARATOR
 
Method Summary
 ActivityEdge createEdge(EClass eClass)
          Creates a ActivityEdge and appends it to the 'Edge' containment reference list
 ActivityGroup createGroup(EClass eClass)
          Creates a ActivityGroup and appends it to the 'Group' containment reference list
 ActivityNode createNode(EClass eClass)
          Creates a ActivityNode and appends it to the 'Node' containment reference list
 Action getAction(String unqualifiedName)
          Retrieves the Action with the specified name from the 'Action' reference list
 EList getActions()
          Returns the value of the 'Action' reference list.
 String getBody()
          Returns the value of the 'Body' attribute.
 ActivityEdge getEdge(String unqualifiedName)
          Retrieves the ActivityEdge with the specified name from the 'Edge' containment reference list
 EList getEdges()
          Returns the value of the 'Edge' containment reference list.
 EList getGroups()
          Returns the value of the 'Group' containment reference list.
 String getLanguage()
          Returns the value of the 'Language' attribute.
 ActivityNode getNode(String unqualifiedName)
          Retrieves the ActivityNode with the specified name from the 'Node' containment reference list
 EList getNodes()
          Returns the value of the 'Node' containment reference list.
 EList getOwnedElements()
           
 StructuredActivityNode getStructuredNode(String unqualifiedName)
          Retrieves the StructuredActivityNode with the specified name from the 'Structured Node' reference list
 EList getStructuredNodes()
          Returns the value of the 'Structured Node' reference list.
 boolean isReadOnly()
          Returns the value of the 'Is Read Only' attribute.
 boolean isSingleExecution()
          Returns the value of the 'Is Single Execution' attribute
 void setBody(String value)
          Sets the value of the 'Body' attribute
 void setIsReadOnly(boolean value)
          Sets the value of the 'Is Read Only' attribute
 void setIsSingleExecution(boolean value)
          Sets the value of the 'Is Single Execution' attribute
 void setLanguage(String value)
          Sets the value of the 'Language' attribute
 
Methods inherited from interface org.eclipse.uml2.Behavior
createOwnedParameterSet, createParameter, getContext, getFormalParameter, getFormalParameters, getOwnedMembers, getOwnedParameterSet, getOwnedParameterSets, getOwnedRules, getParameter, getParameters, getPostcondition, getPostconditions, getPrecondition, getPreconditions, getRedefinedBehavior, getRedefinedBehaviors, getRedefinedElements, getReturnResult, getReturnResults, getSpecification, isReentrant, setContext, setIsReentrant, setSpecification
 
Methods inherited from interface org.eclipse.uml2.Class
createNestedClassifier, createOwnedOperation, createOwnedReception, getAttributes, getExtension, getExtensions, getFeatures, getGenerals, getNestedClassifier, getNestedClassifiers, getOwnedAttributes, getOwnedOperation, getOwnedOperations, getOwnedReception, getOwnedReceptions, getSuperClass, getSuperClasses, inherit, isAbstract, isActive, isMetaclass, setIsAbstract, setIsActive
 
Methods inherited from interface org.eclipse.uml2.BehavioredClassifier
createImplementation, createOwnedBehavior, createOwnedStateMachine, createOwnedTrigger, getClassifierBehavior, getClientDependencies, getImplementation, getImplementations, getImplementedInterfaces, getOwnedBehavior, getOwnedBehaviors, getOwnedStateMachine, getOwnedStateMachines, getOwnedTrigger, getOwnedTriggers, setClassifierBehavior
 
Methods inherited from interface org.eclipse.uml2.Classifier
allFeatures, allParents, conformsTo, createGeneralization, createGeneralization, createOccurrence, createOwnedUseCase, createSubstitution, general, getAttribute, getFeature, getGeneral, getGeneralizations, getInheritedMember, getInheritedMembers, getMembers, getOccurrence, getOccurrences, getOwnedUseCase, getOwnedUseCases, getPowertypeExtent, getPowertypeExtents, getRedefinedClassifier, getRedefinedClassifiers, getRepresentation, getSubstitution, getSubstitutions, getUseCase, getUseCases, getUsedInterfaces, hasVisibilityOf, inheritableMembers, inheritedMember, maySpecializeType, parents, setRepresentation, validateGeneralEqualsParents, validateInheritedMember, validateNoCyclesInGeneralization, validateSpecializeType
 
Methods inherited from interface org.eclipse.uml2.Namespace
createElementImport, createOwnedRule, createPackageImport, excludeCollisions, getElementImports, getImportedMember, getImportedMembers, getImportedPackages, getMember, getNamesOfMember, getOwnedRule, getPackageImports, importedMember, importElement, importMembers, importPackage, membersAreDistinguishable, validateImportedMemberDerived, validateMembersAreDistinguishable
 
Methods inherited from interface org.eclipse.uml2.NamedElement
allNamespaces, createNameExpression, getClientDependency, getName, getNameExpression, getNamespace, getOwner, 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
 
Methods inherited from interface org.eclipse.uml2.Type
conformsTo, createAssociation, getNamespace, getPackage
 
Methods inherited from interface org.eclipse.uml2.PackageableElement
getPackageableElement_visibility, getVisibility, setPackageableElement_visibility, setVisibility
 
Methods inherited from interface org.eclipse.uml2.ParameterableElement
getOwner, getOwningParameter, getTemplateParameter, setOwningParameter, setTemplateParameter
 
Methods inherited from interface org.eclipse.uml2.RedefinableElement
getRedefinitionContext, getRedefinitionContexts, isConsistentWith, isLeaf, isRedefinitionContextValid, setIsLeaf, validateRedefinitionConsistent, validateRedefinitionContextValid
 
Methods inherited from interface org.eclipse.uml2.EncapsulatedClassifier
createOwnedPort, getOwnedPort, getOwnedPorts
 
Methods inherited from interface org.eclipse.uml2.StructuredClassifier
createOwnedAttribute, createOwnedConnector, getMembers, getOwnedAttribute, getOwnedConnector, getOwnedConnectors, getPart, getParts, getRole, getRoles
 

Field Detail

copyright

public static final String copyright

See Also:
Constant Field Values
Method Detail

getBody

public String getBody()
Returns the value of the 'Body' attribute. The default value is "".

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

A textual representation of the computation in the surface language determined by the language attribute.

Returns:
the value of the 'Body' attribute.
See Also:
setBody(String), UML2Package.getActivity_Body()

setBody

public void setBody(String value)
Sets the value of the 'Body' attribute.

Parameters:
value - the new value of the 'Body' attribute.
See Also:
getBody()

getLanguage

public String getLanguage()
Returns the value of the 'Language' attribute. The default value is "".

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

Specifies the language in which the body of the activity is stated. The interpretation of the expression body depends on the language.

Returns:
the value of the 'Language' attribute.
See Also:
setLanguage(String), UML2Package.getActivity_Language()

setLanguage

public void setLanguage(String value)
Sets the value of the 'Language' attribute.

Parameters:
value - the new value of the 'Language' attribute.
See Also:
getLanguage()

isReadOnly

public boolean isReadOnly()
Returns the value of the 'Is Read Only' attribute. The default value is "false".

If the meaning of the 'Is Read Only' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Is Read Only' attribute.
See Also:
setIsReadOnly(boolean), UML2Package.getActivity_IsReadOnly()

setIsReadOnly

public void setIsReadOnly(boolean value)
Sets the value of the 'Is Read Only' attribute.

Parameters:
value - the new value of the 'Is Read Only' attribute.
See Also:
isReadOnly()

isSingleExecution

public boolean isSingleExecution()
Returns the value of the 'Is Single Execution' attribute.

If the meaning of the 'Is Single Execution' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Is Single Execution' attribute.
See Also:
setIsSingleExecution(boolean), UML2Package.getActivity_IsSingleExecution()

setIsSingleExecution

public void setIsSingleExecution(boolean value)
Sets the value of the 'Is Single Execution' attribute.

Parameters:
value - the new value of the 'Is Single Execution' attribute.
See Also:
isSingleExecution()

getEdges

public EList getEdges()
Returns the value of the 'Edge' containment reference list. The list contents are of type ActivityEdge. It is bidirectional and its opposite is 'Activity'.

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

Returns:
the value of the 'Edge' containment reference list.
See Also:
UML2Package.getActivity_Edge(), ActivityEdge.getActivity()

getEdge

public ActivityEdge getEdge(String unqualifiedName)
Retrieves the ActivityEdge with the specified name from the 'Edge' containment reference list.

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

createEdge

public ActivityEdge createEdge(EClass eClass)
Creates a ActivityEdge and appends it to the 'Edge' containment reference list.

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

getGroups

public EList getGroups()
Returns the value of the 'Group' containment reference list. The list contents are of type ActivityGroup. It is bidirectional and its opposite is 'Activity Group activity'.

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

Returns:
the value of the 'Group' containment reference list.
See Also:
UML2Package.getActivity_Group(), ActivityGroup.getActivityGroup_activity()

createGroup

public ActivityGroup createGroup(EClass eClass)
Creates a ActivityGroup and appends it to the 'Group' containment reference list.

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

getNodes

public EList getNodes()
Returns the value of the 'Node' containment reference list. The list contents are of type ActivityNode. It is bidirectional and its opposite is 'Activity'.

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

Returns:
the value of the 'Node' containment reference list.
See Also:
UML2Package.getActivity_Node(), ActivityNode.getActivity()

getNode

public ActivityNode getNode(String unqualifiedName)
Retrieves the ActivityNode with the specified name from the 'Node' containment reference list.

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

createNode

public ActivityNode createNode(EClass eClass)
Creates a ActivityNode and appends it to the 'Node' containment reference list.

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

getActions

public EList getActions()
Returns the value of the 'Action' reference list. The list contents are of type Action.

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

Returns:
the value of the 'Action' reference list.
See Also:
UML2Package.getActivity_Action()

getAction

public Action getAction(String unqualifiedName)
Retrieves the Action with the specified name from the 'Action' reference list.

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

getStructuredNodes

public EList getStructuredNodes()
Returns the value of the 'Structured Node' reference list. The list contents are of type StructuredActivityNode.

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

Returns:
the value of the 'Structured Node' reference list.
See Also:
UML2Package.getActivity_StructuredNode()

getStructuredNode

public StructuredActivityNode getStructuredNode(String unqualifiedName)
Retrieves the StructuredActivityNode with the specified name from the 'Structured Node' reference list.

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

getOwnedElements

public EList getOwnedElements()

Specified by:
getOwnedElements in interface BehavioredClassifier

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