Interface BPFlowElement

All Superinterfaces:

ADClientAble, ADFindAble, ADHistoryAble, ADM2AttrModifyAble, BCBaseElement, BCBaseNamedStereotypeAble, BCPropertyAble, BPPathAble, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELNamedElement, ELNamespaceAble, ELObject, ELUUIDAble, ELValueContainerAble, MECommentAble, MEConstraintAble, MEModelElement, MENamedElement, MEStereotypeAble, METermAble, MMAttachmentAble, MMCommentContainerAble, MMLabelAble, MMLabelTextAttachmentAble, MMStereotypeAble, MMTextAble

All Known Subinterfaces:

BPActivityNode, BPDataObject, BPEventNode, BPGateway, BPMaskTask, BPSequenceFlow, BPSequenceFlowNode, BPSubProcess, BPTaskNode

public interface BPFlowElement
extends BCBaseNamedStereotypeAble, BCPropertyAble, BPPathAble

This is a utility class for BPFlowElement that provides static methods for creation or other purposes.

Note:

The interface BPFlowElement describes an abstract ability of an object. Therefore no instances of this type can be found in the repository!

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	BPFlowElement.VAttr

Method Summary

Modifier and Type	Method	Description
void	assignToLane(BPLane ohLane)	Assigns the element to the lane and removes the current assignment to a lane in the same top lane set, if there is any.
BPFlowElementContainer	getFlowElementContainer()	The container of the BPFlowElement.
List<BPGroupArtifact>	getGroupArtifact()	All group artifacts which contain this flow element.
<T extends BPAssociationArtifact> List<T>	getIncomingAssociationArtifact(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	All incoming association artifacts.
List<BPLane>	getLane()	All lanes which contain the flow element.
List<BPLane>	getLaneAssigned()	The lanes being assigned directly to the BPFlowElement.
BPLane	getLaneAssignedInLaneSet(BPLaneSet refObj)	For a given lane set the lane is returned which contains the flow element - if there is such a lane.
BPLane	getLaneAssignedInTopLaneSet(BPLaneSet refObj)	For a given top lane set the lane is returned which contains the flow element - if there is such a lane.
List<BPLane>	getLaneAssignedTransitiveUp()	The lanes being assigned directly to the BPFlowElement and the lanes being parent lanes of them.
List<BPLane>	getLaneAssignedTransitiveUp(MMStereotype stereotype)	The method calls getLaneAssignedTransitiveUp and filters its return values according to the given stereotype value.
List<BPLaneSet>	getLaneSetAssigned()	The lane sets being assigned directly to the flow element via its lanes.
List<BPLaneSet>	getLaneSetAssigned(MMStereotype stereotype)	The method calls getLaneSetAssigned and filters its return values according to the given stereotype value.
List<BPLaneSet>	getLaneSetAssignedTransitiveUp()	The lane sets being assigned directly and indirectly to the flow element via its lanes or the 'upper' lane sets and lanes.
List<BPLaneSet>	getLaneSetAssignedTransitiveUp(MMStereotype stereotype)	The method calls getLaneSetAssignedTransitiveUp and filters its return values according to the given stereotype value.
BPFlowElementContainer	getTopFlowElementContainer()	Returns the process as top flow element container.
void	setGroupArtifact(List<? extends BPGroupArtifact> values)	Set the value of Foreign Key GroupArtifact.

Methods inherited from interface ADClientAble

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

Methods inherited from interface ADHistoryAble

getCreateTime, getCreator, getHistory, getModifier, getModifyTime, modifyHistory, setHistory

Methods inherited from interface ADM2AttrModifyAble

getTabCell, getTabCellObjectList, getTabCreateTemplate, getTabCreateTemplateObjectList, getTabElement, getTabElementRelshipTypeList, getTabElementRowList, getTabElementRowTypeList, getTabRelshipList, getTabRowList, tabCellModify, tabCreateTemplate, tabElementModify

Methods inherited from interface BCBaseElement

getBusinessIdentifier, setBusinessIdentifier

Methods inherited from interface BCPropertyAble

getAssignedPropertySet, getOwnedAdHocProperty, getPropertySetsAssigned, getPropertySetsAssigned, setPropertySetsAssigned

Methods inherited from interface BPPathAble

getElementAtPathR, getPath, getPath, getPresentationInMasterView, getPresentationInStandardView

Methods inherited from interface ELContainerAble

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

Methods inherited from interface ELContAsgnAble

getAsgnKind, getContSortOrder, getFirstOwnerWhichIsConformTo, getOwner, getOwnerTransitive, getOwnerTransitive, getSelfAndOwnerTransitive, getSelfAndOwnerTransitive, getVersionRoot, isTransitiveChildOf, setAsgnKind, setContSortOrder, setOwner

Methods inherited from interface ELDeleteAble

delete

Methods inherited from interface ELElement

duplicateElement, getAssignAbleToVattr, getAssignAbleToVattr, getClientId, getCreateTemplateOfInstance, getDisplayBitmap, getDisplayColor, getDisplayFont, getDisplayLine, getDisplayName, getDisplayNameShort, getDisplayNSName, getElementCache, getElementMappingInformation, getNotificationElement, getQualifiedNamespaceName, getRelshipBinDir, getRelshipBinDir, getRelshipBinDirTarget, getUnitToLock, getValSpecElement, isContainedInProfile, isUnresolved, lockUnit, setUnresolved, unlockUnit

Methods inherited from interface ELNamedElement

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

Methods inherited from interface ELNamespaceAble

getElementImport, getImportedElement, getImportedElement, getImportedPackage, getImportedPackage, getItemDefinition, getMember, getMember, getMemberByPattern, getMemberByPattern, getOwnedConstraint, getOwnedMember, getOwnedMemberByPath, getOwnedMemberByPattern, getOwnedMemberByPattern, getOwnedMemberTransitiveByPattern, getOwnedMemberTransitiveByPattern, getOwnedMemberTransitiveByPatternIgnoreCase, getOwnedMemberTransitiveByPatternIgnoreCase, getPackageImport

Methods inherited from interface ELObject

getId, getLongId, getMetaClass, getMetaName, getOclClass, getSrvCon, hasRead

Methods inherited from interface ELUUIDAble

getHyperlinkReferenceAble, getInnoRef, getNotToTranslateAttribute, getTranslatedValue, getUUID, setUUID

Methods inherited from interface ELValueContainerAble

getValueReUseAble, setValueReUseAble

Methods inherited from interface MECommentAble

getAssignedComment, getAssignedComment, getCommentAssign

Methods inherited from interface MEConstraintAble

getAssignedConstraint, getAssignedConstraint, getConstraintAssign

Methods inherited from interface MEModelElement

buildProxyConnection, getActivityPartition, getConsider, getContentStereotypeByClass, getCreateTemplateByClass, getDataModel, getDataModelName, getElementColor, getFirstValidContentStereotype, getIgnore, getKnownTypeSystems, getMEModelName, getModelElement, getModelElement, getPresContext, getPresContext, getPresetMapping, getPRPresContent, setElementColor

Methods inherited from interface MENamedElement

getMappingSourceElement, getMappingSourceElement, getMESupplierDependency, getMESupplierMappingDependency

Methods inherited from interface MEStereotypeAble

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

Methods inherited from interface METermAble

getTerm, setTerm

Methods inherited from interface MMAttachmentAble

getAssignedAttachment, getAttachmentAssign, getDefaultAttachment, getOwnedAttachment, setDefaultAttachment

Methods inherited from interface MMCommentContainerAble

getOutgoingConceptRealization, getOwnedComment, getRealizedConcept, getRealizedConcept, replaceRealizedConcepts, setRealizedConcept

Methods inherited from interface MMLabelAble

getLabel, getLabelBoolValue, getLabelColor, getLabelInfo, getLabelLongValue, getLabelNameValue, getLabelStringValue, getLabelValueByPattern, getLabelValueByPattern, getLabelValueList, getOwnedLabelValSpec, hasLabel, modifyLabelValuesByName, setLabelInfo

Methods inherited from interface MMStereotypeAble

assignStereotypeDlg, cloneElement, completelySynchronizeOthers, completelySynchronizeThis, getAttrCnstrEffective, getCreateTemplate, getDisplayType, getExtendingStereotype, getExtendingStereotypeNames, 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, setExtendingStereotype, setStereotype, setStereotypePropertyInfo, setStereotypeTSOptionInfo, setSyncedStereotypeAble

Methods inherited from interface MMTextAble

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

Method Details

getLaneSetAssigned

List<BPLaneSet> getLaneSetAssigned()
                            throws InoNetException,
SrvErrorException

The lane sets being assigned directly to the flow element via its lanes.

Throws:

InoNetException

SrvErrorException

getLaneSetAssigned

List<BPLaneSet> getLaneSetAssigned(MMStereotype stereotype)
                            throws InoNetException,
SrvErrorException

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

Parameters:

stereotype - The stereotype used to filter the result list

Throws:

InoNetException

SrvErrorException

getLaneAssignedTransitiveUp

List<BPLane> getLaneAssignedTransitiveUp()
                                  throws InoNetException,
SrvErrorException

The lanes being assigned directly to the BPFlowElement and the lanes being parent lanes of them.

Throws:

InoNetException

SrvErrorException

getLaneAssignedTransitiveUp

List<BPLane> getLaneAssignedTransitiveUp(MMStereotype stereotype)
                                  throws InoNetException,
SrvErrorException

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

Parameters:

stereotype - The stereotype used to filter the result list

Throws:

InoNetException

SrvErrorException

getLaneSetAssignedTransitiveUp

List<BPLaneSet> getLaneSetAssignedTransitiveUp()
                                        throws InoNetException,
SrvErrorException

The lane sets being assigned directly and indirectly to the flow element via its lanes or the 'upper' lane sets and lanes.

Throws:

InoNetException

SrvErrorException

getLaneSetAssignedTransitiveUp

List<BPLaneSet> getLaneSetAssignedTransitiveUp(MMStereotype stereotype)
                                        throws InoNetException,
SrvErrorException

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

Parameters:

stereotype - The stereotype used to filter the result list

Throws:

InoNetException

SrvErrorException

getLaneAssignedInLaneSet

BPLane getLaneAssignedInLaneSet(BPLaneSet refObj)
                         throws InoNetException,
SrvErrorException

For a given lane set the lane is returned which contains the flow element - if there is such a lane. Each lane set may have at most one such lane.

Parameters:

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

Throws:

InoNetException

SrvErrorException

getLaneAssignedInTopLaneSet

BPLane getLaneAssignedInTopLaneSet(BPLaneSet refObj)
                            throws InoNetException,
SrvErrorException

For a given top lane set the lane is returned which contains the flow element - if there is such a lane. Each lane set may have at most one such lane which is directly assigned. At most one lane of all the lanes being contained directly or transitively in a top lane set has an explicit assignment to a flow element.

Parameters:

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

Throws:

InoNetException

SrvErrorException

getTopFlowElementContainer

BPFlowElementContainer getTopFlowElementContainer()
                                           throws InoNetException,
SrvErrorException

Returns the process as top flow element container.

Throws:

InoNetException

SrvErrorException

assignToLane

void assignToLane(BPLane ohLane)
           throws InoNetException,
SrvErrorException

Assigns the element to the lane and removes the current assignment to a lane in the same top lane set, if there is any.

Parameters:

ohLane - The lane to be assigned.

Throws:

InoNetException

SrvErrorException

getLaneAssigned

List<BPLane> getLaneAssigned()
                      throws InoNetException,
SrvErrorException

The lanes being assigned directly to the BPFlowElement.

Throws:

InoNetException

SrvErrorException

getIncomingAssociationArtifact

<T extends BPAssociationArtifact> List<T> getIncomingAssociationArtifact(Class<T> returnType,
 K_CONTROL_OPTION... behaviourFlags)
                                                                  throws InoNetException,
SrvErrorException

All incoming association artifacts.

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

getGroupArtifact

List<BPGroupArtifact> getGroupArtifact()
                                throws InoNetException,
SrvErrorException

All group artifacts which contain this flow element.

Throws:

InoNetException

SrvErrorException

setGroupArtifact

void setGroupArtifact(List<? extends BPGroupArtifact> values)
               throws InoNetException,
SrvErrorException

Set the value of Foreign Key GroupArtifact.

Parameters:

values - The value to be set.

Throws:

InoNetException

SrvErrorException

getLane

List<BPLane> getLane()
              throws InoNetException,
SrvErrorException

All lanes which contain the flow element.

Throws:

InoNetException

SrvErrorException

getFlowElementContainer

BPFlowElementContainer getFlowElementContainer()
                                        throws InoNetException,
SrvErrorException

The container of the BPFlowElement.

Throws:

InoNetException

SrvErrorException