Overview  Package   Class  Use  Help 
SDK Help DE  EN
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

de.mid.innovator.srv2api.icw2bp
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, MMAttachmentAble, MMCommentContainerAble, MMLabelAble, MMLabelTextAttachmentAble, MMStereotypeAble, MMTextAble
All Known Subinterfaces:
BPActivityNode, BPChoreographyActivity, BPChoreographySubProcess, BPChoreographyTask, 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
static class BPFlowElement.VAttr
           
 
Method Summary
 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(K_CONTROL_OPTION... behaviourFlags)
          The lanes being assigned directly to the BPFlowElement.
 List<BPLane> getLaneAssigned(MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)
          The method calls getLaneAssigned and filters its return values according to the given stereotype value.
 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(K_CONTROL_OPTION... behaviourFlags)
          The lanes being assigned directly to the BPFlowElement and the lanes being parent lanes of them.
 List<BPLane> getLaneAssignedTransitiveUp(MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)
          The method calls getLaneAssignedTransitiveUp and filters its return values according to the given stereotype value.
 List<BPLaneSet> getLaneSetAssigned(K_CONTROL_OPTION... behaviourFlags)
          The lane sets being assigned directly to the flow element via its lanes.
 List<BPLaneSet> getLaneSetAssigned(MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)
          The method calls getLaneSetAssigned and filters its return values according to the given stereotype value.
 List<BPLaneSet> getLaneSetAssignedTransitiveUp(K_CONTROL_OPTION... behaviourFlags)
          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, K_CONTROL_OPTION... behaviourFlags)
          The method calls getLaneSetAssignedTransitiveUp and filters its return values according to the given stereotype value.
 BPFlowElementContainer getTopFlowElementContainer()
          Returns the top flow element container, which is either a process or a choreography.
 void setGroupArtifact(List<? extends BPGroupArtifact> values)
          Set the value of Foreign Key GroupArtifact.
 
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.icw2bc.BCBaseElement
getBusinessIdentifier, setBusinessIdentifier
 
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.ELUUIDAble
getUUID, setUUID
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEConstraintAble
getAssignedConstraint, getAssignedConstraint, getConstraintAssign
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MECommentAble
getAssignedComment, getAssignedComment, getCommentAssign
 
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.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.icw2elem.ELValueContainerAble
getValueReUseAble, setValueReUseAble
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMAttachmentAble
getAssignedAttachment, getAttachmentAssign, getDefaultAttachment, getOwnedAttachment, setDefaultAttachment
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELContainerAble
getCheckSetNotToLocalizeAttribute, getClientDependency, getNotToLocalizeAttribute, getOwnedElement, getOwnedElementTransitiveDown, getOwnedElementTransitiveDown, getOwnedElementTransitiveDownAndUnresolved, getOwnedElementTransitiveDownAndUnresolved, getOwnedLocalizedValue, getOwnedOrReferencedElementTransitiveDown, getOwnedOrReferencedElementTransitiveDown, getOwnedRelshipBinDirWithTarget, getOwnedRelshipBinDirWithTarget, getRedirectedModelContainer, getRelshipBinDirSource, getSelfAndOwnedElementTransitiveDown, getSelfAndOwnedElementTransitiveDown, getSortedContents, resetNotToLocalizeAttribute, setNotToLocalizeAttribute, sortContents
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELDeleteAble
delete
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MENamedElement
getMESupplierDependency, getMESupplierMappingDependency
 
Methods inherited from interface de.mid.innovator.srv2api.icw2bc.BCPropertyAble
getAssignedPropertySet, getOwnedAdHocProperty, getPropertySetsAssigned, getPropertySetsAssigned, setPropertySetsAssigned
 
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.ELNamedElement
getName, getNameKind, getQualifiedDisplayName, getQualifiedName, getQualifiedTLName, getResetDefaultName, getSupplierDependency, rename, setName, setNameKind, setResetDefaultName
 
Methods inherited from interface de.mid.innovator.srv2api.icw2bp.BPPathAble
getElementAtPathR, getPath, getPath, getPresentationInMasterView, getPresentationInStandardView
 

Method Detail

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

getFlowElementContainer

BPFlowElementContainer getFlowElementContainer()
                                               throws InoNetException,
                                                      SrvErrorException
The container of the BPFlowElement.

Throws:
InoNetException
SrvErrorException

getGroupArtifact

List<BPGroupArtifact> getGroupArtifact()
                                       throws InoNetException,
                                              SrvErrorException
All group artifacts which contain this flow element.

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

getLane

List<BPLane> getLane()
                     throws InoNetException,
                            SrvErrorException
All lanes which contain the flow element.

Throws:
InoNetException
SrvErrorException

getLaneAssigned

List<BPLane> getLaneAssigned(K_CONTROL_OPTION... behaviourFlags)
                             throws InoNetException,
                                    SrvErrorException
The lanes being assigned directly to the BPFlowElement.

Parameters:
behaviourFlags - An optional list of enum values to control the behaviour of the command.
Throws:
InoNetException
SrvErrorException

getLaneAssigned

List<BPLane> getLaneAssigned(MMStereotype stereotype,
                             K_CONTROL_OPTION... behaviourFlags)
                             throws InoNetException,
                                    SrvErrorException
The method calls getLaneAssigned 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

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

getLaneAssignedTransitiveUp

List<BPLane> getLaneAssignedTransitiveUp(K_CONTROL_OPTION... behaviourFlags)
                                         throws InoNetException,
                                                SrvErrorException
The lanes being assigned directly to the BPFlowElement and the lanes being parent lanes of them.

Parameters:
behaviourFlags - An optional list of enum values to control the behaviour of the command.
Throws:
InoNetException
SrvErrorException

getLaneAssignedTransitiveUp

List<BPLane> getLaneAssignedTransitiveUp(MMStereotype stereotype,
                                         K_CONTROL_OPTION... behaviourFlags)
                                         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
behaviourFlags - An optional list of enum values to control the behaviour of the command.
Throws:
InoNetException
SrvErrorException

getLaneSetAssigned

List<BPLaneSet> getLaneSetAssigned(K_CONTROL_OPTION... behaviourFlags)
                                   throws InoNetException,
                                          SrvErrorException
The lane sets being assigned directly to the flow element via its lanes.

Parameters:
behaviourFlags - An optional list of enum values to control the behaviour of the command.
Throws:
InoNetException
SrvErrorException

getLaneSetAssigned

List<BPLaneSet> getLaneSetAssigned(MMStereotype stereotype,
                                   K_CONTROL_OPTION... behaviourFlags)
                                   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
behaviourFlags - An optional list of enum values to control the behaviour of the command.
Throws:
InoNetException
SrvErrorException

getLaneSetAssignedTransitiveUp

List<BPLaneSet> getLaneSetAssignedTransitiveUp(K_CONTROL_OPTION... behaviourFlags)
                                               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.

Parameters:
behaviourFlags - An optional list of enum values to control the behaviour of the command.
Throws:
InoNetException
SrvErrorException

getLaneSetAssignedTransitiveUp

List<BPLaneSet> getLaneSetAssignedTransitiveUp(MMStereotype stereotype,
                                               K_CONTROL_OPTION... behaviourFlags)
                                               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
behaviourFlags - An optional list of enum values to control the behaviour of the command.
Throws:
InoNetException
SrvErrorException

getTopFlowElementContainer

BPFlowElementContainer getTopFlowElementContainer()
                                                  throws InoNetException,
                                                         SrvErrorException
Returns the top flow element container, which is either a process or a choreography.

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
Overview  Package   Class  Use  Help 
SDK Help DE  EN
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

© MID GmbH, All rights reserved.