org.eclipse.uml2
Interface ActivityPartition

All Superinterfaces:
ActivityGroup, Element, EModelElement, EObject, NamedElement, Notifier, TemplateableElement

public interface ActivityPartition
extends NamedElement, ActivityGroup

A representation of the model object 'Activity Partition'. Partitions divide the nodes and edges to constrain and show a view of the contained nodes. Partitions can share contents. They often correspond to organizational units in a business model. They may be used to allocate characteristics or resources among the nodes of an activity.

The following features are supported:

See Also:
UML2Package.getActivityPartition()

Field Summary
static java.lang.String copyright
           
 
Fields inherited from interface org.eclipse.uml2.NamedElement
SEPARATOR
 
Method Summary
 ActivityPartition createSubgroup()
          Creates a ActivityPartition and appends it to the 'Subgroup' containment reference list
 ActivityPartition createSubgroup(EClass eClass)
          Deprecated. Use #createSubgroup() instead.
 ActivityEdge getContainedEdge(java.lang.String name)
          Retrieves the ActivityEdge with the specified 'Name' from the 'Contained Edge' reference list
 EList getContainedEdges()
          Returns the value of the 'Contained Edge' reference list.
 ActivityNode getContainedNode(java.lang.String name)
          Retrieves the ActivityNode with the specified 'Name' from the 'Contained Node' reference list
 EList getContainedNodes()
          Returns the value of the 'Contained Node' reference list.
 Element getRepresents()
          Returns the value of the 'Represents' reference
 ActivityPartition getSubgroup(java.lang.String unqualifiedName)
          Retrieves the ActivityPartition with the specified 'Name' from the 'Subgroup' containment reference list
 EList getSubgroups()
          Returns the value of the 'Subgroup' containment reference list.
 ActivityPartition getSuperPartition()
          Returns the value of the 'Super Partition' container reference.
 boolean isDimension()
          Returns the value of the 'Is Dimension' attribute.
 boolean isExternal()
          Returns the value of the 'Is External' attribute.
 void setIsDimension(boolean value)
          Sets the value of the 'Is Dimension' attribute
 void setIsExternal(boolean value)
          Sets the value of the 'Is External' attribute
 void setRepresents(Element value)
          Sets the value of the 'Represents' reference
 void setSuperPartition(ActivityPartition value)
          Sets the value of the 'Super Partition' container reference
 
Methods inherited from interface org.eclipse.uml2.NamedElement
allNamespaces, createDependency, createNameExpression, createNameExpression, getClientDependencies, getClientDependency, getLabel, getLabel, getName, getNameExpression, getNamespace, getQualifiedName, getVisibility, isDistinguishableFrom, qualifiedName, separator, setName, setNameExpression, setVisibility, validateNoName, validateQualifiedName, validateVisibilityNeedsOwnership
 
Methods inherited from interface org.eclipse.uml2.TemplateableElement
createOwnedTemplateSignature, createOwnedTemplateSignature, createTemplateBinding, createTemplateBinding, getOwnedTemplateSignature, getTemplateBindings, parameterableElements, setOwnedTemplateSignature
 
Methods inherited from interface org.eclipse.uml2.Element
addKeyword, allOwnedElements, apply, createEAnnotation, createOwnedComment, createOwnedComment, destroy, getApplicableStereotype, getApplicableStereotypes, getAppliedStereotype, getAppliedStereotypes, getAppliedVersion, getKeywords, getModel, getNearestPackage, getOwnedComments, getOwnedElements, getOwner, getValue, hasKeyword, hasValue, 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.ActivityGroup
getActivity, getActivityGroup_activity, getSuperGroup, setActivity, setActivityGroup_activity
 

Field Detail

copyright

public static final java.lang.String copyright

See Also:
Constant Field Values
Method Detail

isDimension

public boolean isDimension()
Returns the value of the 'Is Dimension' attribute. The default value is "false".

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

Tells whether the partition groups other partitions along a dimension.

Returns:
the value of the 'Is Dimension' attribute.
See Also:
setIsDimension(boolean), UML2Package.getActivityPartition_IsDimension()

setIsDimension

public void setIsDimension(boolean value)
Sets the value of the 'Is Dimension' attribute.

Parameters:
value - the new value of the 'Is Dimension' attribute.
See Also:
isDimension()

isExternal

public boolean isExternal()
Returns the value of the 'Is External' attribute. The default value is "false".

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

Tells whether the partition represents an entity to which the partitioning structure does not apply.

Returns:
the value of the 'Is External' attribute.
See Also:
setIsExternal(boolean), UML2Package.getActivityPartition_IsExternal()

setIsExternal

public void setIsExternal(boolean value)
Sets the value of the 'Is External' attribute.

Parameters:
value - the new value of the 'Is External' attribute.
See Also:
isExternal()

getContainedEdges

public EList getContainedEdges()
Returns the value of the 'Contained Edge' reference list. The list contents are of type ActivityEdge. It is bidirectional and its opposite is 'In Partition'.

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

Specified by:
getContainedEdges in interface ActivityGroup
Returns:
the value of the 'Contained Edge' reference list.
See Also:
UML2Package.getActivityPartition_ContainedEdge(), ActivityEdge.getInPartitions()

getContainedEdge

public ActivityEdge getContainedEdge(java.lang.String name)
Retrieves the ActivityEdge with the specified 'Name' from the 'Contained Edge' reference list.

Specified by:
getContainedEdge in interface ActivityGroup
Parameters:
name - The 'Name' of the ActivityEdge to retrieve.
Returns:
The ActivityEdge with the specified 'Name', or null.
See Also:
getContainedEdges()

getContainedNodes

public EList getContainedNodes()
Returns the value of the 'Contained Node' reference list. The list contents are of type ActivityNode. It is bidirectional and its opposite is 'In Partition'.

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

Specified by:
getContainedNodes in interface ActivityGroup
Returns:
the value of the 'Contained Node' reference list.
See Also:
UML2Package.getActivityPartition_ContainedNode(), ActivityNode.getInPartitions()

getContainedNode

public ActivityNode getContainedNode(java.lang.String name)
Retrieves the ActivityNode with the specified 'Name' from the 'Contained Node' reference list.

Specified by:
getContainedNode in interface ActivityGroup
Parameters:
name - The 'Name' of the ActivityNode to retrieve.
Returns:
The ActivityNode with the specified 'Name', or null.
See Also:
getContainedNodes()

getSubgroups

public EList getSubgroups()
Returns the value of the 'Subgroup' containment reference list. The list contents are of type ActivityPartition. It is bidirectional and its opposite is 'Super Partition'.

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

Specified by:
getSubgroups in interface ActivityGroup
Returns:
the value of the 'Subgroup' containment reference list.
See Also:
UML2Package.getActivityPartition_Subgroup(), getSuperPartition()

getSubgroup

public ActivityPartition getSubgroup(java.lang.String unqualifiedName)
Retrieves the ActivityPartition with the specified 'Name' from the 'Subgroup' containment reference list.

Returns:
The ActivityPartition with the specified 'Name', or null.
See Also:
getSubgroups()

createSubgroup

public ActivityPartition createSubgroup(EClass eClass)
Deprecated. Use #createSubgroup() instead.

Creates a ActivityPartition and appends it to the 'Subgroup' containment reference list.

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

createSubgroup

public ActivityPartition createSubgroup()
Creates a ActivityPartition and appends it to the 'Subgroup' containment reference list.

Returns:
The new ActivityPartition.
See Also:
getSubgroups()

getSuperPartition

public ActivityPartition getSuperPartition()
Returns the value of the 'Super Partition' container reference. It is bidirectional and its opposite is 'Subgroup'.

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

Returns:
the value of the 'Super Partition' container reference.
See Also:
setSuperPartition(ActivityPartition), UML2Package.getActivityPartition_SuperPartition(), getSubgroups()

setSuperPartition

public void setSuperPartition(ActivityPartition value)
Sets the value of the 'Super Partition' container reference.

Parameters:
value - the new value of the 'Super Partition' container reference.
See Also:
getSuperPartition()

getRepresents

public Element getRepresents()
Returns the value of the 'Represents' reference.

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

An element constraining behaviors invoked by nodes in the partition.

Returns:
the value of the 'Represents' reference.
See Also:
setRepresents(Element), UML2Package.getActivityPartition_Represents()

setRepresents

public void setRepresents(Element value)
Sets the value of the 'Represents' reference.

Parameters:
value - the new value of the 'Represents' reference.
See Also:
getRepresents()

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