de.mid.innovator.srv2api.icw2bpdia
Interface BPDiaProcessViewNode

All Superinterfaces:
ADClientAble, ADM2AttrModifyAble, BPDiaViewNode, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELObject, MMFormatAble, PRDiaNode, PRPresContent, PRPresElement

public interface BPDiaProcessViewNode
extends BPDiaViewNode


Nested Class Summary
static class BPDiaProcessViewNode.VAttr
           
 
Method Summary
 BPDiaTaskNode getCallActivityNode()
          Containing call activity node of the process view node.
 BPDiaItemNode getDiaItemNode(BPItemAwareElement refObj)
          Returns the presentation node of the item aware element.
 BPDiaLaneNode getDiaLaneNode(BPLane refObj)
          Returns the presentation node of the lane.
 BPDiaSequenceFlow getDiaSequenceFlow(BPSequenceFlow refObj)
          Returns the presentation edge of the flow.
 BPDiaSequenceFlowNode getDiaSequenceFlowNode(BPSequenceFlowNode refObj)
          Returns the presentation node of the flow node.
 BPLaneSet getLaneSet()
          The top lane set displayed in the process view node.
 BPLaneSet getLaneSetDisplayed()
          The LaneSet to be displayed.
 List<BPDiaLaneNode> getLeafLaneNode(K_CONTROL_OPTION... behaviourFlags)
          All leaf lane nodes in this process view node.
 BPDiaLaneNode getLeafLaneNodeForNode(PRDiaNode refObj)
          Tries to find a leaf lane for the node passed considering the absolute positions of the node and the leaf lanes in the process view node.
 List<BPDiaLaneNode> getLeafLaneNodeSortedByPosition(K_CONTROL_OPTION... behaviourFlags)
          All leaf lane nodes in this process view node.
 List<BPDiaAssocEdge> getOwnedAssocEdge(K_CONTROL_OPTION... behaviourFlags)
          All BPDiaAssocEdge of the BPDiaProcessViewNode.
 List<BPDiaDataAssocEdge> getOwnedDataAssocEdge(K_CONTROL_OPTION... behaviourFlags)
          All BPDiaDataAssocEdge of the BPDiaProcessViewNode.
 List<BPDiaDataNode> getOwnedDataNode(K_CONTROL_OPTION... behaviourFlags)
          BPDiaDataNode owned by the BPDiaProcessViewNode.
 List<BPDiaLaneNode> getOwnedLaneNode(K_CONTROL_OPTION... behaviourFlags)
          All lane nodes owned by the view node.
 List<BPDiaRedundantEdge> getOwnedRedundantEdge(K_CONTROL_OPTION... behaviourFlags)
          All redundant edges in the view node.
 List<BPDiaRenderingNode> getOwnedRenderingNode(K_CONTROL_OPTION... behaviourFlags)
          All rendering nodes in the view node.
 List<BPDiaSequenceFlow> getOwnedSequenceFlow(K_CONTROL_OPTION... behaviourFlags)
          BPDiaSequenceFlow owned by the BPDiaProcessViewNode.
<T extends BPDiaSequenceFlowNode>
List<T>
getOwnedSequenceFlowNode(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)
          All BPDiaSequenceFlowNode of the BPDiaProcessViewNode.
 BPDiaParticipantNode getOwningParticipantNode()
          Owning BPDiaParticipantNode of the BPDiaProcessViewNode.
 BPProcess getProcess()
          Returns the BPProcess represented by this node.
 void setFilterCriteria(boolean hideObjectFlow)
          Modifies the criteria for visible elements inside the process view.
 void setLaneSet(BPLaneSet value)
          Set the value of Foreign Key LaneSet.
 
Methods inherited from interface de.mid.innovator.srv2api.icw2bpdia.BPDiaViewNode
becomeMasterView, becomeRegularView, becomeSynchronizedView, correctExistingViewContent, getCommentNodeOfView, getDiagramOfView, getMissingElement, getMissingElement, getOwnedArtifactNode, getOwnedCalloutNode, getOwnedMessageNode, getOwnedViewElementTransitiveDownByOrder, getOwningDia, getPath, getPathDisplayed, getPossiblePath, getPossiblePath, getPresentationInView, isCompletelyMaintained, isCorrect, isCorrectAndComplete, isInMasterViewNode, isMasterView, isSyncedCopy, isVisibleAndSelectable, moveMasterToNewDiagram, rebuildExactlyFromMasterView, removeMasterMoveToNewDiagram, setPathDisplayed, toggleOrientation
 
Methods inherited from interface de.mid.innovator.srv2api.icw2pres.PRDiaNode
collapse, expand, getDiagram, getExpandedNodeRoot, getExpandedPresContext, getOnFramePositionSpecification, getOrientation, getOwningFrameNode, getPosition, getPositionAbsolute, getPresContainer, getSize, getTextPositionAbsolute, getXClientNode, hasEmbeddedContent, isExpanded, setCoord, setEmbeddedContent, setPosition, setSize
 
Methods inherited from interface de.mid.innovator.srv2api.icw2pres.PRPresContent
getIncoming, getMEModelElement, getModelContainer, getOutgoing, getOwnedPresContent, getOwningPresContent, getOwningPresContext, getOwningPresElement, getTextPosition, getTextSize, setTextCoord, setTextPosition, setTextSize
 
Methods inherited from interface de.mid.innovator.srv2api.icw2pres.PRPresElement
getOwnedPresContentElement, getPresColor, getPresentationOfLogic, setPresColor
 
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.icw2elem.ELContAsgnAble
getAsgnKind, getContSortOrder, getFirstOwnerWhichIsConformTo, getOwner, getOwnerTransitive, getOwnerTransitive, getSelfAndOwnerTransitive, getSelfAndOwnerTransitive, getVersionRoot, isTransitiveChildOf, setAsgnKind, setContSortOrder, setOwner
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMFormatAble
copyFormatDlg, getCopyFormatDlgInit, getFormat
 
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
 

Method Detail

getCallActivityNode

BPDiaTaskNode getCallActivityNode()
                                  throws InoNetException,
                                         SrvErrorException
Containing call activity node of the process view node.

Throws:
InoNetException
SrvErrorException

getDiaItemNode

BPDiaItemNode getDiaItemNode(BPItemAwareElement refObj)
                             throws InoNetException,
                                    SrvErrorException
Returns the presentation node of the item aware element. The result may be null.

Parameters:
refObj - A further instance of type BPItemAwareElement which is used to control the behaviour of the method. (see description above)
Throws:
InoNetException
SrvErrorException

getDiaLaneNode

BPDiaLaneNode getDiaLaneNode(BPLane refObj)
                             throws InoNetException,
                                    SrvErrorException
Returns the presentation node of the lane. The result may be null.

Parameters:
refObj - A further instance of type BPLane which is used to control the behaviour of the method. (see description above)
Throws:
InoNetException
SrvErrorException

getDiaSequenceFlow

BPDiaSequenceFlow getDiaSequenceFlow(BPSequenceFlow refObj)
                                     throws InoNetException,
                                            SrvErrorException
Returns the presentation edge of the flow. The result may be null.

Parameters:
refObj - A further instance of type BPSequenceFlow which is used to control the behaviour of the method. (see description above)
Throws:
InoNetException
SrvErrorException

getDiaSequenceFlowNode

BPDiaSequenceFlowNode getDiaSequenceFlowNode(BPSequenceFlowNode refObj)
                                             throws InoNetException,
                                                    SrvErrorException
Returns the presentation node of the flow node. The result may be null.

Parameters:
refObj - A further instance of type BPSequenceFlowNode which is used to control the behaviour of the method. (see description above)
Throws:
InoNetException
SrvErrorException

getLaneSet

BPLaneSet getLaneSet()
                     throws InoNetException,
                            SrvErrorException
The top lane set displayed in the process view node.

Throws:
InoNetException
SrvErrorException

getLaneSetDisplayed

BPLaneSet getLaneSetDisplayed()
                              throws InoNetException,
                                     SrvErrorException
The LaneSet to be displayed.

Throws:
InoNetException
SrvErrorException

getLeafLaneNode

List<BPDiaLaneNode> getLeafLaneNode(K_CONTROL_OPTION... behaviourFlags)
                                    throws InoNetException,
                                           SrvErrorException
All leaf lane nodes in this process view node.

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

getLeafLaneNodeForNode

BPDiaLaneNode getLeafLaneNodeForNode(PRDiaNode refObj)
                                     throws InoNetException,
                                            SrvErrorException
Tries to find a leaf lane for the node passed considering the absolute positions of the node and the leaf lanes in the process view node.

Parameters:
refObj - A further instance of type PRDiaNode which is used to control the behaviour of the method. (see description above)
Throws:
InoNetException
SrvErrorException

getLeafLaneNodeSortedByPosition

List<BPDiaLaneNode> getLeafLaneNodeSortedByPosition(K_CONTROL_OPTION... behaviourFlags)
                                                    throws InoNetException,
                                                           SrvErrorException
All leaf lane nodes in this process view node.

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

getOwnedAssocEdge

List<BPDiaAssocEdge> getOwnedAssocEdge(K_CONTROL_OPTION... behaviourFlags)
                                       throws InoNetException,
                                              SrvErrorException
All BPDiaAssocEdge of the BPDiaProcessViewNode.

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

getOwnedDataAssocEdge

List<BPDiaDataAssocEdge> getOwnedDataAssocEdge(K_CONTROL_OPTION... behaviourFlags)
                                               throws InoNetException,
                                                      SrvErrorException
All BPDiaDataAssocEdge of the BPDiaProcessViewNode.

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

getOwnedDataNode

List<BPDiaDataNode> getOwnedDataNode(K_CONTROL_OPTION... behaviourFlags)
                                     throws InoNetException,
                                            SrvErrorException
BPDiaDataNode owned by the BPDiaProcessViewNode.

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

getOwnedLaneNode

List<BPDiaLaneNode> getOwnedLaneNode(K_CONTROL_OPTION... behaviourFlags)
                                     throws InoNetException,
                                            SrvErrorException
All lane nodes owned by the view node.

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

getOwnedRedundantEdge

List<BPDiaRedundantEdge> getOwnedRedundantEdge(K_CONTROL_OPTION... behaviourFlags)
                                               throws InoNetException,
                                                      SrvErrorException
All redundant edges in the view node.

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

getOwnedRenderingNode

List<BPDiaRenderingNode> getOwnedRenderingNode(K_CONTROL_OPTION... behaviourFlags)
                                               throws InoNetException,
                                                      SrvErrorException
All rendering nodes in the view node.

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

getOwnedSequenceFlow

List<BPDiaSequenceFlow> getOwnedSequenceFlow(K_CONTROL_OPTION... behaviourFlags)
                                             throws InoNetException,
                                                    SrvErrorException
BPDiaSequenceFlow owned by the BPDiaProcessViewNode.

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

getOwnedSequenceFlowNode

<T extends BPDiaSequenceFlowNode> List<T> getOwnedSequenceFlowNode(Class<T> returnType,
                                                                   K_CONTROL_OPTION... behaviourFlags)
                                                               throws InoNetException,
                                                                      SrvErrorException
All BPDiaSequenceFlowNode of the BPDiaProcessViewNode.

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

getOwningParticipantNode

BPDiaParticipantNode getOwningParticipantNode()
                                              throws InoNetException,
                                                     SrvErrorException
Owning BPDiaParticipantNode of the BPDiaProcessViewNode.

Throws:
InoNetException
SrvErrorException

getProcess

BPProcess getProcess()
                     throws InoNetException,
                            SrvErrorException
Returns the BPProcess represented by this node.

Throws:
InoNetException
SrvErrorException

setFilterCriteria

void setFilterCriteria(boolean hideObjectFlow)
                       throws InoNetException,
                              SrvErrorException
Modifies the criteria for visible elements inside the process view. Elements to be hidden will be visible while the diagram is locked for modifications.

Parameters:
hideObjectFlow - flag for hiding the object flow information
Throws:
InoNetException
SrvErrorException

setLaneSet

void setLaneSet(BPLaneSet value)
                throws InoNetException,
                       SrvErrorException
Set the value of Foreign Key LaneSet.

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