Package de.mid.innovator.srv2api.icw2bp

Interface BPPath

All Superinterfaces:

ADAccessAble, ADClientAble, ADFindAble, ADHistoryAble, ADLockAble, ADM2AttrModifyAble, ADOptionAble, ADReferenceAble, ADVersionAble, BCBaseElement, BCBaseNamedStereotypeAble, BCPropertyAble, BCRootReuseAbleElement, BCTermAssignAble, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELNamedElement, ELNamespaceAble, ELNamespaceAsgnAble, ELObject, ELPackageAble, ELUUIDAble, ELValueContainerAble, MECommentAble, MEConstraintAble, MEModelElement, MENamedElement, MENamespaceAsgnAble, MEPackageAble, MEStereotypeAble, MMAttachmentAble, MMCommentContainerAble, MMLabelAble, MMLabelTextAttachmentAble, MMStereotypeAble, MMTextAble

public interface BPPath
extends BCRootReuseAbleElement

A path in a process.

See Also:

BPPathHelper

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	BPPath.VAttr

Method Summary

Modifier and Type	Method	Description
int	getAnimSpeed()	A value for the animation speed if the animation shall be executed automatically.
BPDia	getBestDiagramToStartAnimation()	The best diagram to start the animation.
java.lang.String	getColor()	The color to use to mark the path in a diagram.
java.util.List<BPDia>	getDiagramToStartAnimation(K_CONTROL_OPTION... behaviourFlags)	All diagrams suitable to start the animation.
java.util.List<BPDia>	getDiagramToStartAnimation(MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getDiagramToStartAnimation and filters its return values according to the given stereotype value.
<T extends BPDiaViewNode> java.util.List<T>	getDiaViewNode(java.lang.Class<T> returnType)	All view nodes displaying this path.
<T extends BPPathAble> java.util.List<T>	getElementInPath(java.lang.Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	All elements being part of this path.
<T extends BPPathAble> java.util.List<T>	getElementInPath(java.lang.Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getElementInPath and filters its return values according to the given stereotype value.
java.util.List<BCExpression>	getExpression()	All expressions defining the path.
BPElementAtPath	getFirstOccurrenceInPath(BPPathAble refObj)	Returns the first path occurrence of the element.
<T extends BPFlowElement> java.util.List<T>	getFlowElementsInPath(java.lang.Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	All flow elements being part of this path.
<T extends BPFlowElement> java.util.List<T>	getFlowElementsInPath(java.lang.Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getFlowElementsInPath and filters its return values according to the given stereotype value.
<T extends BPFlowElement> java.util.List<T>	getFlowElementsInPathWithProcessNotReachable(java.lang.Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	All flow elements being assigned to the path but not being reachable.
<T extends BPFlowElement> java.util.List<T>	getFlowElementsInPathWithProcessNotReachable(java.lang.Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getFlowElementsInPathWithProcessNotReachable and filters its return values according to the given stereotype value.
<T extends BPFlowElement> java.util.List<T>	getFlowElementsReachable(java.lang.Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	All flow elements being reachable from the collaboration or process the path is assigned to.
<T extends BPFlowElement> java.util.List<T>	getFlowElementsReachable(java.lang.Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getFlowElementsReachable and filters its return values according to the given stereotype value.
java.util.List<BPUseCasePathRel>	getIncomingPathUseCaseRel(K_CONTROL_OPTION... behaviourFlags)	The incoming relationships of the path.
java.util.List<BPMessageFlow>	getMessageFlowInPath(K_CONTROL_OPTION... behaviourFlags)	All message flows being part of this path.
java.util.List<BPMessageFlow>	getMessageFlowInPath(MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getMessageFlowInPath and filters its return values according to the given stereotype value.
java.util.List<BPElementAtPath>	getOccurrenceInPath(BPPathAble refObj, K_CONTROL_OPTION... behaviourFlags)	Returns all path occurrences of the element.
java.util.List<BPElementAtPath>	getOwnedPathAssignment(K_CONTROL_OPTION... behaviourFlags)	All path assignments of the path.
K_BP_PATH_ANIM_INFO	getPathAnimationInfo()	Information about how the path will be animated.
<T extends BPPathContextAble> java.util.List<T>	getPathContextAble(java.lang.Class<T> returnType)	All context elements of the BPPath.
K_BP_PATH_TYPE	getPathType()	The type of the path.
<T extends ADClientAble> java.util.List<T>	getPresentationOfPathAbleInMasterView(java.lang.Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	Returns all presentation elements in the defining presentation which belong to the path elements.
<T extends ADClientAble> java.util.List<T>	getPresentationOfPathAbleInMasterView(java.lang.Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getPresentationOfPathAbleInMasterView and filters its return values according to the given stereotype value.
<T extends ADClientAble> java.util.List<T>	getPresentationOfPathAbleInStandardView(java.lang.Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	Returns all presentation elements in the standard presentation which belong to the path elements.
<T extends ADClientAble> java.util.List<T>	getPresentationOfPathAbleInStandardView(java.lang.Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getPresentationOfPathAbleInStandardView and filters its return values according to the given stereotype value.
java.util.List<BPProcess>	getProcessReachable(K_CONTROL_OPTION... behaviourFlags)	All processes being reachable from the collaboration or process the path is assigned to.
java.util.List<BPProcess>	getProcessReachable(MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getProcessReachable and filters its return values according to the given stereotype value.
boolean	isConfiguredForContext(BPPathContextAble refObj)	True if the path is configured to be suitable for the specific context.
boolean	isConfiguredForPathAble(BPPathAble refObj)	True if the path is suitable to contain this specific path element.
void	replaceAssignedPathAble(java.util.List<ARG_BPPathElementSpec> seq)	Replaces the elements belonging to the path.
void	setAnimSpeed(int value)	Set the value of Attribut AnimSpeed.
void	setColor(java.lang.String value)	Set the value of Attribut Color.
void	setExpression(java.util.List<? extends BCExpression> values)	Set the value of Foreign Key Expression.
void	setPathAnimationInfo(K_BP_PATH_ANIM_INFO value)	Set the value of Attribut PathAnimationInfo.
void	setPathContextAble(java.util.List<? extends BPPathContextAble> values)	Set the value of Foreign Key PathContextAble.
void	setPathType(K_BP_PATH_TYPE value)	Set the value of Attribut PathType.

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADAccessAble

getAccessRole, getReadRole, hasAccess, setAccessRole, setReadRole

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADClientAble

getAnnotation, getEndAnalysisDia, getLogic, getLogic, getPresentationContext, getSection, getStartAnalysisDia

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.icw2meta.ADLockAble

getLock, getLockableCache, getLockLogin, getLockName, hasClutch, hasLock, hasNoLock, hasOthLock, hasOwnLock, isLockable, lock, unlock

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.icw2meta.ADOptionAble

getOwnedOption, modifyOptionDlg

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADReferenceAble

getReferenceContainer, setReferenceContainer

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADVersionAble

getVersionFile, getVersionList, getVersionListWithoutOpenInfo

Methods inherited from interface de.mid.innovator.srv2api.icw2bc.BCBaseElement

getBusinessIdentifier, setBusinessIdentifier

Methods inherited from interface de.mid.innovator.srv2api.icw2bc.BCPropertyAble

getAssignedPropertySet, getOwnedAdHocProperty, getPropertySetsAssigned, getPropertySetsAssigned, setPropertySetsAssigned

Methods inherited from interface de.mid.innovator.srv2api.icw2bc.BCRootReuseAbleElement

getOwningChoreography, getOwningCollaboration, getOwningProcess

Methods inherited from interface de.mid.innovator.srv2api.icw2bc.BCTermAssignAble

assignTerm, getAssignedTerm, getTerms, getTerms, setTerms

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELContainerAble

getClientDependency, getOwnedElement, getOwnedElementTransitiveDown, getOwnedElementTransitiveDown, getOwnedElementTransitiveDownAndUnresolved, getOwnedElementTransitiveDownAndUnresolved, getOwnedOrReferencedElementTransitiveDown, getOwnedOrReferencedElementTransitiveDown, getOwnedRelshipBinDirWithTarget, getOwnedRelshipBinDirWithTarget, getRedirectedModelContainer, getRelshipBinDirSource, getSelfAndOwnedElementTransitiveDown, getSelfAndOwnedElementTransitiveDown, getSortedContents, sortContents

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

delete

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

getName, getNameKind, getQualifiedDisplayName, getQualifiedName, getQualifiedTLName, getSupplierDependency, rename, setName, setNameKind

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.icw2elem.ELNamespaceAsgnAble

getMnClassicTREFName, getNamespace, getNamespaceName, getPath, getSeparator, getVisibility, setUniqueName, setVisibility

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

getElementImportingNamespace, getElementImportingNamespace, getImportedPackageAble, getOwningPackage

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELUUIDAble

getHyperlinkReferenceAble, getNotToTranslateAttribute, getTranslatedValue, getUUID, setUUID

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

getAssignedConstraint, getAssignedConstraint, getConstraintAssign

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.icw2model.MENamedElement

getMappingSourceElement, getMappingSourceElement, getMESupplierDependency, getMESupplierMappingDependency

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MENamespaceAsgnAble

getMENamespace, getSignatureMessage

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEPackageAble

getComponent, getManifest

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEStereotypeAble

getApplicableAnalysisDia, getClientMappingDependency, getDecisionMade, getDecisionOwned, getKnowledgeSourceOfOwner, getMappingTargetElement, getMappingTargetElement, getProxyAsgProperty, getRepresentingArtifact, getRequirementOfStakeholder, getRequirementOfStakeholderOwner, isMapped, setMapped, setRequirementOfStakeholder

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMAttachmentAble

getAssignedAttachment, getAttachmentAssign, getDefaultAttachment, getOwnedAttachment, setDefaultAttachment

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMCommentContainerAble

getOutgoingConceptRealization, getOwnedComment, getRealizedConcept, getRealizedConcept, replaceRealizedConcepts, setRealizedConcept

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

assignStereotypeDlg, cloneElement, completelySynchronizeOthers, completelySynchronizeThis, getAttrCnstrEffective, getCreateTemplate, getDisplayType, getOwnedFormat, getOwnedStereotypePropertyValSpec, getOwnedStereotypeTSOptionValSpec, getOwnedSyncedElement, getPropBoolValue, getPropLongValue, getPropStringValue, getPropValueList, getStereoPropValueByPattern, getStereoPropValueByPattern, getStereotype, getStereotypeName, getStereotypeProperty, getStereotypePropertyInfo, getStereotypePropertyNameValue, getStereotypeTSOption, getStereotypeTSOptionBoolValue, getStereotypeTSOptionInfo, getStereotypeTSOptionLongValue, getStereotypeTSOptionNameValue, getStereotypeTSOptionStringValue, getStereotypeTSOptionValueByPattern, getStereotypeTSOptionValueByPattern, getStereotypeTSOptionValueList, getSyncedElement, getSyncedStereotypeAble, getSyncedStereotypeAble, isCloneAbleElement, modifyStereotypePropertyValuesByName, modifyStereotypeTSOptionValuesByName, setStereotype, setStereotypePropertyInfo, setStereotypeTSOptionInfo, setSyncedStereotypeAble

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMTextAble

getFlowExpandedValue, getModifyFlowDocuments, getModifyTextValues, getModifyTextValuesDlgInit, getOwnedTextValue, getOwnedTextValueByPattern, getTextExpandedValue, getTextStringValue, getURIList, modifyFlowDocuments, modifyTextValuesDlg

Method Detail

getPathType

K_BP_PATH_TYPE getPathType()
                    throws InoNetException,
                           SrvErrorException

The type of the path.

Throws:

InoNetException

SrvErrorException

setPathType

void setPathType(K_BP_PATH_TYPE value)
          throws InoNetException,
                 SrvErrorException

Set the value of Attribut PathType.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getPathAnimationInfo

K_BP_PATH_ANIM_INFO getPathAnimationInfo()
                                  throws InoNetException,
                                         SrvErrorException

Information about how the path will be animated.

Throws:

InoNetException

SrvErrorException

setPathAnimationInfo

void setPathAnimationInfo(K_BP_PATH_ANIM_INFO value)
                   throws InoNetException,
                          SrvErrorException

Set the value of Attribut PathAnimationInfo.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getColor

java.lang.String getColor()
                   throws InoNetException,
                          SrvErrorException

The color to use to mark the path in a diagram.

Throws:

InoNetException

SrvErrorException

setColor

void setColor(java.lang.String value)
       throws InoNetException,
              SrvErrorException

Set the value of Attribut Color.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getAnimSpeed

int getAnimSpeed()
          throws InoNetException,
                 SrvErrorException

A value for the animation speed if the animation shall be executed automatically.

Throws:

InoNetException

SrvErrorException

setAnimSpeed

void setAnimSpeed(int value)
           throws InoNetException,
                  SrvErrorException

Set the value of Attribut AnimSpeed.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

isConfiguredForContext

boolean isConfiguredForContext(BPPathContextAble refObj)
                        throws InoNetException,
                               SrvErrorException

True if the path is configured to be suitable for the specific context.

Parameters:

refObj - A further instance of type BPPathContextAble which is used to control the behaviour of the method. (see description above)

Throws:

InoNetException

SrvErrorException

isConfiguredForPathAble

boolean isConfiguredForPathAble(BPPathAble refObj)
                         throws InoNetException,
                                SrvErrorException

True if the path is suitable to contain this specific path element.

Parameters:

refObj - A further instance of type BPPathAble which is used to control the behaviour of the method. (see description above)

Throws:

InoNetException

SrvErrorException

getFlowElementsInPath

<T extends BPFlowElement> java.util.List<T> getFlowElementsInPath(java.lang.Class<T> returnType,
                                                                  K_CONTROL_OPTION... behaviourFlags)
                                                           throws InoNetException,
                                                                  SrvErrorException

All flow elements being part of this path.

Parameters:

returnType - Specifies the type of elements to be returned.

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

Sorted:

getFlowElementsInPath

<T extends BPFlowElement> java.util.List<T> getFlowElementsInPath(java.lang.Class<T> returnType,
                                                                  MMStereotype stereotype,
                                                                  K_CONTROL_OPTION... behaviourFlags)
                                                           throws InoNetException,
                                                                  SrvErrorException

The method calls getFlowElementsInPath and filters its return values according to the given stereotype value.

Parameters:

returnType - Specifies the type of elements to be returned.

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

getFlowElementsInPathWithProcessNotReachable

<T extends BPFlowElement> java.util.List<T> getFlowElementsInPathWithProcessNotReachable(java.lang.Class<T> returnType,
                                                                                         K_CONTROL_OPTION... behaviourFlags)
                                                                                  throws InoNetException,
                                                                                         SrvErrorException

All flow elements being assigned to the path but not being reachable. This may be caused due to some change in the call hierarchy. The number of processes being reachable depends on the call activities and the call hierarchy they install, so this must be determined dynamically and may result in a path definition which is not conform with the current call hierarchy.

Parameters:

returnType - Specifies the type of elements to be returned.

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getFlowElementsInPathWithProcessNotReachable

<T extends BPFlowElement> java.util.List<T> getFlowElementsInPathWithProcessNotReachable(java.lang.Class<T> returnType,
                                                                                         MMStereotype stereotype,
                                                                                         K_CONTROL_OPTION... behaviourFlags)
                                                                                  throws InoNetException,
                                                                                         SrvErrorException

The method calls getFlowElementsInPathWithProcessNotReachable and filters its return values according to the given stereotype value.

Parameters:

returnType - Specifies the type of elements to be returned.

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

getProcessReachable

java.util.List<BPProcess> getProcessReachable(K_CONTROL_OPTION... behaviourFlags)
                                       throws InoNetException,
                                              SrvErrorException

All processes being reachable from the collaboration or process the path is assigned to.

Parameters:

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getProcessReachable

java.util.List<BPProcess> getProcessReachable(MMStereotype stereotype,
                                              K_CONTROL_OPTION... behaviourFlags)
                                       throws InoNetException,
                                              SrvErrorException

The method calls getProcessReachable 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

getFlowElementsReachable

<T extends BPFlowElement> java.util.List<T> getFlowElementsReachable(java.lang.Class<T> returnType,
                                                                     K_CONTROL_OPTION... behaviourFlags)
                                                              throws InoNetException,
                                                                     SrvErrorException

All flow elements being reachable from the collaboration or process the path is assigned to.

Parameters:

returnType - Specifies the type of elements to be returned.

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getFlowElementsReachable

<T extends BPFlowElement> java.util.List<T> getFlowElementsReachable(java.lang.Class<T> returnType,
                                                                     MMStereotype stereotype,
                                                                     K_CONTROL_OPTION... behaviourFlags)
                                                              throws InoNetException,
                                                                     SrvErrorException

The method calls getFlowElementsReachable and filters its return values according to the given stereotype value.

Parameters:

returnType - Specifies the type of elements to be returned.

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

getElementInPath

<T extends BPPathAble> java.util.List<T> getElementInPath(java.lang.Class<T> returnType,
                                                          K_CONTROL_OPTION... behaviourFlags)
                                                   throws InoNetException,
                                                          SrvErrorException

All elements being part of this path.

Parameters:

returnType - Specifies the type of elements to be returned.

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

Sorted:

getElementInPath

<T extends BPPathAble> java.util.List<T> getElementInPath(java.lang.Class<T> returnType,
                                                          MMStereotype stereotype,
                                                          K_CONTROL_OPTION... behaviourFlags)
                                                   throws InoNetException,
                                                          SrvErrorException

The method calls getElementInPath and filters its return values according to the given stereotype value.

Parameters:

returnType - Specifies the type of elements to be returned.

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

getMessageFlowInPath

java.util.List<BPMessageFlow> getMessageFlowInPath(K_CONTROL_OPTION... behaviourFlags)
                                            throws InoNetException,
                                                   SrvErrorException

All message flows being part of this path. Only iff the path is assigned to an interaction specification like a BPCollaboration it is possible that it contains message flows.

Parameters:

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

Sorted:

getMessageFlowInPath

java.util.List<BPMessageFlow> getMessageFlowInPath(MMStereotype stereotype,
                                                   K_CONTROL_OPTION... behaviourFlags)
                                            throws InoNetException,
                                                   SrvErrorException

The method calls getMessageFlowInPath 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

getFirstOccurrenceInPath

BPElementAtPath getFirstOccurrenceInPath(BPPathAble refObj)
                                  throws InoNetException,
                                         SrvErrorException

Returns the first path occurrence of the element.

Parameters:

refObj - A further instance of type BPPathAble which is used to control the behaviour of the method. (see description above)

Throws:

InoNetException

SrvErrorException

getOccurrenceInPath

java.util.List<BPElementAtPath> getOccurrenceInPath(BPPathAble refObj,
                                                    K_CONTROL_OPTION... behaviourFlags)
                                             throws InoNetException,
                                                    SrvErrorException

Returns all path occurrences of the element.

Parameters:

refObj - A further instance of type BPPathAble which is used to control the behaviour of the method. (see description above)

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

Sorted:

getPresentationOfPathAbleInMasterView

<T extends ADClientAble> java.util.List<T> getPresentationOfPathAbleInMasterView(java.lang.Class<T> returnType,
                                                                                 K_CONTROL_OPTION... behaviourFlags)
                                                                          throws InoNetException,
                                                                                 SrvErrorException

Returns all presentation elements in the defining presentation which belong to the path elements.

Parameters:

returnType - Specifies the type of elements to be returned.

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

Sorted:

getPresentationOfPathAbleInMasterView

<T extends ADClientAble> java.util.List<T> getPresentationOfPathAbleInMasterView(java.lang.Class<T> returnType,
                                                                                 MMStereotype stereotype,
                                                                                 K_CONTROL_OPTION... behaviourFlags)
                                                                          throws InoNetException,
                                                                                 SrvErrorException

The method calls getPresentationOfPathAbleInMasterView and filters its return values according to the given stereotype value.

Parameters:

returnType - Specifies the type of elements to be returned.

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

getPresentationOfPathAbleInStandardView

<T extends ADClientAble> java.util.List<T> getPresentationOfPathAbleInStandardView(java.lang.Class<T> returnType,
                                                                                   K_CONTROL_OPTION... behaviourFlags)
                                                                            throws InoNetException,
                                                                                   SrvErrorException

Returns all presentation elements in the standard presentation which belong to the path elements.

Parameters:

returnType - Specifies the type of elements to be returned.

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

Sorted:

getPresentationOfPathAbleInStandardView

<T extends ADClientAble> java.util.List<T> getPresentationOfPathAbleInStandardView(java.lang.Class<T> returnType,
                                                                                   MMStereotype stereotype,
                                                                                   K_CONTROL_OPTION... behaviourFlags)
                                                                            throws InoNetException,
                                                                                   SrvErrorException

The method calls getPresentationOfPathAbleInStandardView and filters its return values according to the given stereotype value.

Parameters:

returnType - Specifies the type of elements to be returned.

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

getDiagramToStartAnimation

java.util.List<BPDia> getDiagramToStartAnimation(K_CONTROL_OPTION... behaviourFlags)
                                          throws InoNetException,
                                                 SrvErrorException

All diagrams suitable to start the animation. If a collaboration is part of the path context, a diagram will be determined which contains a complete and correct collaboration reference and which contains at least the starting process element.

Parameters:

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getDiagramToStartAnimation

java.util.List<BPDia> getDiagramToStartAnimation(MMStereotype stereotype,
                                                 K_CONTROL_OPTION... behaviourFlags)
                                          throws InoNetException,
                                                 SrvErrorException

The method calls getDiagramToStartAnimation 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

getBestDiagramToStartAnimation

BPDia getBestDiagramToStartAnimation()
                              throws InoNetException,
                                     SrvErrorException

The best diagram to start the animation. If a collaboration is part of the path context, a diagram will be determined which contains a complete and correct collaboration reference and which contains at least the starting process element. The best diagram will contain all elements of the path.

Throws:

InoNetException

SrvErrorException

replaceAssignedPathAble

void replaceAssignedPathAble(java.util.List<ARG_BPPathElementSpec> seq)
                      throws InoNetException,
                             SrvErrorException

Replaces the elements belonging to the path.

Parameters:

seq - The sequence of the elements belonging to the path and their animation information

Throws:

InoNetException

SrvErrorException

getIncomingPathUseCaseRel

java.util.List<BPUseCasePathRel> getIncomingPathUseCaseRel(K_CONTROL_OPTION... behaviourFlags)
                                                    throws InoNetException,
                                                           SrvErrorException

The incoming relationships of the path.

Parameters:

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getOwnedPathAssignment

java.util.List<BPElementAtPath> getOwnedPathAssignment(K_CONTROL_OPTION... behaviourFlags)
                                                throws InoNetException,
                                                       SrvErrorException

All path assignments of the path. The path assignment is a model element representing the assignment of a flow element to a path.

Parameters:

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted.,

getDiaViewNode

<T extends BPDiaViewNode> java.util.List<T> getDiaViewNode(java.lang.Class<T> returnType)
                                                    throws InoNetException,
                                                           SrvErrorException

All view nodes displaying this path.

Parameters:

returnType - Specifies the type of elements to be returned.

Throws:

InoNetException

SrvErrorException

getExpression

java.util.List<BCExpression> getExpression()
                                    throws InoNetException,
                                           SrvErrorException

All expressions defining the path.

Throws:

InoNetException

SrvErrorException

setExpression

void setExpression(java.util.List<? extends BCExpression> values)
            throws InoNetException,
                   SrvErrorException

Set the value of Foreign Key Expression.

Parameters:

values - The value to be set.

Throws:

InoNetException

SrvErrorException

getPathContextAble

<T extends BPPathContextAble> java.util.List<T> getPathContextAble(java.lang.Class<T> returnType)
                                                            throws InoNetException,
                                                                   SrvErrorException

All context elements of the BPPath.

Parameters:

returnType - Specifies the type of elements to be returned.

Throws:

InoNetException

SrvErrorException

setPathContextAble

void setPathContextAble(java.util.List<? extends BPPathContextAble> values)
                 throws InoNetException,
                        SrvErrorException

Set the value of Foreign Key PathContextAble.

Parameters:

values - The value to be set.

Throws:

InoNetException

SrvErrorException