de.mid.innovator.srv2api.icw2ac
Interface ACPartition

All Superinterfaces:
ACActivityGroup, ADClientAble, ADFindAble, ADHistoryAble, ADM2AttrModifyAble, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELNamedElement, ELNamespaceAble, ELNamespaceAsgnAble, ELObject, ELUUIDAble, ELValueContainerAble, MECommentAble, MEConstraintAble, MEModelElement, MENamedElement, MENamespaceAsgnAble, MEStereotypeAble, MMAttachmentAble, MMCommentContainerAble, MMLabelAble, MMLabelTextAttachmentAble, MMStereotypeAble, MMTextAble

public interface ACPartition
extends ACActivityGroup

An activity partition is a kind of activity group that identifies actions that have common characteristics. Partitions divide the nodes and edges to constrain and show a view of the contained nodes. Partitions can share contents.

See Also:
ACPartitionHelper

Nested Class Summary
static class ACPartition.VAttr
           
 
Method Summary
 List<ACPartition> getBrothers(K_CONTROL_OPTION... behaviourFlags)
          All partitions within the same container and with the same presentation (horizontal or vertical or none), excluding the partition itself and regardless of the property if a partition is external.
 List<ACPartition> getBrothers(MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)
          The method calls getBrothers and filters its return values according to the given stereotype value.
 ACPartition getPredecessor()
          The partition preceding this one as the son of their common owner - if there is one.
 K_AC_PARTITION_PRESENTATION getPresentation()
          Specifies if the partition is displayed at all and, if it is displayed, if it is aligned horizontally or vertically.
 MEModelElement getRepresents()
          The element represented by the partition.
 List<ACPartition> getSelfAndBrothers(K_CONTROL_OPTION... behaviourFlags)
          All partitions within the same container and with the same presentation (horizontal or vertical or none), including the partition itself and regardless of the property if a partition is external.
 List<ACPartition> getSelfAndBrothers(MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)
          The method calls getSelfAndBrothers and filters its return values according to the given stereotype value.
 List<ACPartition> getSelfAndNonExternalBrothers(K_CONTROL_OPTION... behaviourFlags)
          All non-external partitions within the same container and with the same presentation (horizontal or vertical or none), including the partition itself.
 List<ACPartition> getSelfAndNonExternalBrothers(MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)
          The method calls getSelfAndNonExternalBrothers and filters its return values according to the given stereotype value.
 List<ACPartition> getSubPartition(K_CONTROL_OPTION... behaviourFlags)
          The partitions immediately contained by the partition.
 ACPartition getSuccessor()
          The partition succeeding this one as the son of their common owner - if there is one.
 ACPartition getSuperPartition()
          Partition that immediately contains the partition.
 boolean isDimension()
          Informs whether the partition groups other partitions along a dimension.
 boolean isExternal()
          Informs whether the partition represents an entity which the partitioning structure does not apply to.
 void setDimension(boolean value)
          Set the value of Attribut IsDimension.
 void setExternal(boolean value)
          Set the value of Attribut IsExternal.
 void setPresentation(K_AC_PARTITION_PRESENTATION value)
          Set the value of Attribut Presentation.
 void setPresentationAndOwner(ELContainerAble ohOwner, K_AC_PARTITION_PRESENTATION kPres)
          Modifies the presentation of the partition, e.g. from vertical to horizontal or to no representation at all.
 void setRepresents(MEModelElement value)
          Set the value of Foreign Key Represents.
 
Methods inherited from interface de.mid.innovator.srv2api.icw2ac.ACActivityGroup
assignContainedNodeExplicit, getContainedEdge, getContainedEdge, getContainedEdgeExplicit, getContainedEdgeImplicit, getContainedEdgeImplicit, getContainedNode, getContainedNode, getContainedNodeExplicit, getContainedNodeImplicit, getContainedNodeImplicitExclusive, getContainedNodeImplicitExclusive, getGroupCoord, getInActivity, getSubgroup, getSuperGroup, removeAllContainedNodeExplicit, removeContainedNodeExplicit, replaceContainedNodeExplicit, setContainedEdgeExplicit, setContainedNodeExplicit, setContainedNodeImplicit, setGroupCoord
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADHistoryAble
getCreateTime, getCreator, getHistory, getModifier, getModifyTime, modifyHistory, setHistory
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELNamespaceAble
getElementImport, getImportedElement, getImportedElement, getImportedPackage, getImportedPackage, getMember, getMember, getMemberByPattern, getMemberByPattern, getOwnedConstraint, getOwnedMember, getOwnedMemberByPath, getOwnedMemberByPattern, getOwnedMemberByPattern, getOwnedMemberTransitiveByPattern, getOwnedMemberTransitiveByPattern, getOwnedMemberTransitiveByPatternIgnoreCase, getOwnedMemberTransitiveByPatternIgnoreCase, getPackageImport
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEConstraintAble
getAssignedConstraint, getAssignedConstraint, getConstraintAssign
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEStereotypeAble
getClientMappingDependency, getOutgoingConceptRealization, getProxyAsgProperty, getRealizedConcept, getRealizedConcept, getRepresentingArtifact, getRequirementOfStakeholder, getRequirementOfStakeholderOwner, isMapped, replaceRealizedConcepts, setMapped, setRealizedConcept, setRequirementOfStakeholder
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMCommentContainerAble
getOwnedComment
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMStereotypeAble
assignStereotypeDlg, cloneElement, getAttrCnstrEffective, getCreateTemplate, getDisplayType, getOwnedFormat, getOwnedStereotypePropertyValSpec, getPropBoolValue, getPropLongValue, getPropStringValue, getPropValueList, getStereoPropValueByPattern, getStereoPropValueByPattern, getStereotype, getStereotypeName, getStereotypeProperty, getStereotypePropertyInfo, getStereotypePropertyNameValue, isCloneAbleElement, modifyStereotypePropertyValuesByName, setStereotype, setStereotypePropertyInfo
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELContAsgnAble
getAsgnKind, getContSortOrder, getFirstOwnerWhichIsConformTo, getOwner, getOwnerTransitive, getOwnerTransitive, getSelfAndOwnerTransitive, getSelfAndOwnerTransitive, getVersionRoot, isTransitiveChildOf, setAsgnKind, setContSortOrder, setOwner
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELValueContainerAble
getValueReUseAble, setValueReUseAble
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MECommentAble
getAssignedComment, getAssignedComment, getCommentAssign
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MENamespaceAsgnAble
getMENamespace
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELUUIDAble
getUUID, setUUID
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELNamespaceAsgnAble
getMnClassicTREFName, getNamespace, getNamespaceName, getPath, getSeparator, getVisibility, setUniqueName, setVisibility
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MENamedElement
getMESupplierDependency, getMESupplierMappingDependency
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEModelElement
buildProxyConnection, getActivityPartition, getConsider, getContentStereotypeByClass, getCreateTemplateByClass, getElementColor, getFirstValidContentStereotype, getIgnore, getKnownTypeSystems, getMEModelName, getModelElement, getModelElement, getPresContext, getPresContext, getPresetMapping, getPRPresContent, setElementColor
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADClientAble
getAnnotation, getLogic, getLogic, getPresentationContext, getSection
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADM2AttrModifyAble
getTabCell, getTabCellObjectList, getTabCreateTemplate, getTabCreateTemplateObjectList, getTabElement, getTabElementRowList, getTabElementRowTypeList, getTabRowList, tabCellModify, tabCreateTemplate, tabElementModify
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELElement
duplicateElement, getAssignAbleToVattr, getAssignAbleToVattr, getClientId, getCreateTemplateOfInstance, getDisplayBitmap, getDisplayColor, getDisplayFont, getDisplayLine, getDisplayName, getDisplayNameShort, getDisplayNSName, getElementCache, getElementMappingInformation, getQualifiedNamespaceName, getRelshipBinDir, getRelshipBinDir, getRelshipBinDirTarget, getUnitToLock, getValSpecElement, isContainedInProfile, isUnresolved, lockUnit, setUnresolved, unlockUnit
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELObject
getId, getLongId, getMetaClass, getMetaName, getOclClass, getSrvCon, hasRead
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELNamedElement
getName, getNameKind, getQualifiedDisplayName, getQualifiedName, getQualifiedTLName, getResetDefaultName, getSupplierDependency, rename, setName, setNameKind, setResetDefaultName
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMTextAble
getFlowExpandedValue, getModifyFlowDocuments, getModifyTextValues, getModifyTextValuesDlgInit, getOwnedTextValue, getOwnedTextValueByPattern, getTextExpandedValue, getTextStringValue, getURIList, modifyFlowDocuments, modifyTextValuesDlg
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMLabelAble
getLabel, getLabelBoolValue, getLabelColor, getLabelInfo, getLabelLongValue, getLabelNameValue, getLabelStringValue, getLabelValueByPattern, getLabelValueByPattern, getLabelValueList, getOwnedLabelValSpec, hasLabel, modifyLabelValuesByName, setLabelInfo
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMAttachmentAble
getAssignedAttachment, getAttachmentAssign, getDefaultAttachment, getOwnedAttachment, setDefaultAttachment
 

Method Detail

getBrothers

List<ACPartition> getBrothers(K_CONTROL_OPTION... behaviourFlags)
                              throws InoNetException,
                                     SrvErrorException
All partitions within the same container and with the same presentation (horizontal or vertical or none), excluding the partition itself and regardless of the property if a partition is external.

Parameters:
behaviourFlags - An optional list of enum values to control the behaviour of the command.
Throws:
InoNetException
SrvErrorException
Sorted:
the result may be sorted

getBrothers

List<ACPartition> getBrothers(MMStereotype stereotype,
                              K_CONTROL_OPTION... behaviourFlags)
                              throws InoNetException,
                                     SrvErrorException
The method calls getBrothers and filters its return values according to the given stereotype value.

Parameters:
stereotype - The stereotype used to filter the result list
behaviourFlags - An optional list of enum values to control the behaviour of the command.
Throws:
InoNetException
SrvErrorException

getPredecessor

ACPartition getPredecessor()
                           throws InoNetException,
                                  SrvErrorException
The partition preceding this one as the son of their common owner - if there is one.

Throws:
InoNetException
SrvErrorException

getPresentation

K_AC_PARTITION_PRESENTATION getPresentation()
                                            throws InoNetException,
                                                   SrvErrorException
Specifies if the partition is displayed at all and, if it is displayed, if it is aligned horizontally or vertically.

Throws:
InoNetException
SrvErrorException

getRepresents

MEModelElement getRepresents()
                             throws InoNetException,
                                    SrvErrorException
The element represented by the partition.

Throws:
InoNetException
SrvErrorException

getSelfAndBrothers

List<ACPartition> getSelfAndBrothers(K_CONTROL_OPTION... behaviourFlags)
                                     throws InoNetException,
                                            SrvErrorException
All partitions within the same container and with the same presentation (horizontal or vertical or none), including the partition itself and regardless of the property if a partition is external.

Parameters:
behaviourFlags - An optional list of enum values to control the behaviour of the command.
Throws:
InoNetException
SrvErrorException
Sorted:
the result may be sorted

getSelfAndBrothers

List<ACPartition> getSelfAndBrothers(MMStereotype stereotype,
                                     K_CONTROL_OPTION... behaviourFlags)
                                     throws InoNetException,
                                            SrvErrorException
The method calls getSelfAndBrothers and filters its return values according to the given stereotype value.

Parameters:
stereotype - The stereotype used to filter the result list
behaviourFlags - An optional list of enum values to control the behaviour of the command.
Throws:
InoNetException
SrvErrorException

getSelfAndNonExternalBrothers

List<ACPartition> getSelfAndNonExternalBrothers(K_CONTROL_OPTION... behaviourFlags)
                                                throws InoNetException,
                                                       SrvErrorException
All non-external partitions within the same container and with the same presentation (horizontal or vertical or none), including the partition itself.

Parameters:
behaviourFlags - An optional list of enum values to control the behaviour of the command.
Throws:
InoNetException
SrvErrorException
Sorted:
the result may be sorted

getSelfAndNonExternalBrothers

List<ACPartition> getSelfAndNonExternalBrothers(MMStereotype stereotype,
                                                K_CONTROL_OPTION... behaviourFlags)
                                                throws InoNetException,
                                                       SrvErrorException
The method calls getSelfAndNonExternalBrothers and filters its return values according to the given stereotype value.

Parameters:
stereotype - The stereotype used to filter the result list
behaviourFlags - An optional list of enum values to control the behaviour of the command.
Throws:
InoNetException
SrvErrorException

getSubPartition

List<ACPartition> getSubPartition(K_CONTROL_OPTION... behaviourFlags)
                                  throws InoNetException,
                                         SrvErrorException
The partitions immediately contained by the partition.

Parameters:
behaviourFlags - An optional list of enum values to control the behaviour of the command.
Throws:
InoNetException
SrvErrorException
Sorted:
the result may be sorted.

getSuccessor

ACPartition getSuccessor()
                         throws InoNetException,
                                SrvErrorException
The partition succeeding this one as the son of their common owner - if there is one.

Throws:
InoNetException
SrvErrorException

getSuperPartition

ACPartition getSuperPartition()
                              throws InoNetException,
                                     SrvErrorException
Partition that immediately contains the partition.

Throws:
InoNetException
SrvErrorException

isDimension

boolean isDimension()
                    throws InoNetException,
                           SrvErrorException
Informs whether the partition groups other partitions along a dimension.

Throws:
InoNetException
SrvErrorException

isExternal

boolean isExternal()
                   throws InoNetException,
                          SrvErrorException
Informs whether the partition represents an entity which the partitioning structure does not apply to.

Throws:
InoNetException
SrvErrorException

setDimension

void setDimension(boolean value)
                  throws InoNetException,
                         SrvErrorException
Set the value of Attribut IsDimension.

Parameters:
value - The value to be set.
Throws:
InoNetException
SrvErrorException

setExternal

void setExternal(boolean value)
                 throws InoNetException,
                        SrvErrorException
Set the value of Attribut IsExternal.

Parameters:
value - The value to be set.
Throws:
InoNetException
SrvErrorException

setPresentation

void setPresentation(K_AC_PARTITION_PRESENTATION value)
                     throws InoNetException,
                            SrvErrorException
Set the value of Attribut Presentation.

Parameters:
value - The value to be set.
Throws:
InoNetException
SrvErrorException

setPresentationAndOwner

void setPresentationAndOwner(ELContainerAble ohOwner,
                             K_AC_PARTITION_PRESENTATION kPres)
                             throws InoNetException,
                                    SrvErrorException
Modifies the presentation of the partition, e.g. from vertical to horizontal or to no representation at all. If a horizontal or a vertical partition is modified, all partitions owned by the partition are also modified accordingly. If the partition is owned by another partition and not by the activity, the change of the presentation also means a change of the owner, which means that the new owner also has to be passed as an argument.

Parameters:
ohOwner -
kPres -
Throws:
InoNetException
SrvErrorException

setRepresents

void setRepresents(MEModelElement value)
                   throws InoNetException,
                          SrvErrorException
Set the value of Foreign Key Represents.

Parameters:
value - The value to be set.
Throws:
InoNetException
SrvErrorException