Interface BPDia

All Superinterfaces:

ADAccessAble, ADClientAble, ADFindAble, ADHistoryAble, ADLockAble, ADM2AttrModifyAble, ADOptionAble, ADReferenceAble, ADVersionAble, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELNamedElement, ELNamespaceAsgnAble, ELObject, ELPackageAble, ELPictureAble, ELUUIDAble, ELValueContainerAble, MMAttachmentAble, MMCommentContainerAble, MMFormatAble, MMLabelAble, MMLabelTextAttachmentAble, MMMenuAble, MMStereotypeAble, MMTextAble, PRDia, PRPresContext, PRPresElement, PRVersionAbleDia

public interface BPDia
extends PRVersionAbleDia

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	BPDia.VAttr

Method Summary

Modifier and Type	Method	Description
BPDiaCollaborationViewNode	addDiaCollaborationViewNode(BPCollaboration ohCollaboration, Point position, Point size, boolean isExpanded, boolean areProcessesExpanded)	Adds a node representing a collaboration to the diagram.
BPDiaCollaborationViewNode	addDiaCollaborationViewNodeForExistingProcessViewNodes(BPCollaboration ohCollaboration)	Adds a node representing a collaboration to the diagram if the processes concerned are already displayed in the diagram without already having a collaboration context.
List<PRDiaNode>	addDiaNodes(Class<? extends ELObject> kVOclModel, Class<? extends ELObject> kVOclPres, List<? extends ADClientAble> adds, Point position, Point size, Point offset)	Adds elements as nodes to this diagram.
BPDiaProcessViewNode	addDiaProcessViewNode(BPProcess ohProcess, PRPresElement ohPresOfOwner, Point position, Point size, boolean isExpanded)	Adds a node representing a process to the diagram.
<T extends PRPresContent> List<T>	getContentForHighlighting(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	All elements eligible for being highlighted in the diagram, e.g.
<T extends BPDiaArtifactNode> List<T>	getOwnedArtifactNode(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	All BPDiaArtifactNode of the BPDia.
<T extends BPDiaItemNode> List<T>	getOwnedItemNode(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	All BPDiaItemNode.
List<BPDiaMessageFlow>	getOwnedMessageFlow()	message flow edge owned by the diagram.
List<BPDiaSupportEdge>	getOwnedSupportEdge()	All support edges of the BPDia.
<T extends BPDiaViewNode> List<T>	getOwnedViewNode(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	All BPDiaViewNode.
boolean	isMasterDia()	True if the diagram is meant to contain exactly one master view node.
boolean	isMasterWithoutDefinition()	True if it is the master BPMN process diagram but does not contain the process definition, just a synchronized reference to it.
void	setBPDiaNotation(K_BP_DISP_DIA kDisp)	Changes the display option diagram notation of this BPDia.
void	setVisibleCompartment(List<? extends PRDiaNode> seqNode, List<ARG_CompartmentVisibilityList> seqComp)	Sets the visible compartments of the selected nodes in the business diagram.

Methods inherited from interface ADAccessAble

getAccessRole, getReadRole, hasAccess, setAccessRole, setReadRole

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 ADLockAble

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

Methods inherited from interface ADM2AttrModifyAble

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

Methods inherited from interface ADOptionAble

getOwnedOption, modifyOptionDlg

Methods inherited from interface ADReferenceAble

getReferenceContainer, setReferenceContainer

Methods inherited from interface ADVersionAble

getVersionFile, getVersionList, getVersionListWithoutOpenInfo

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 ELNamespaceAsgnAble

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

Methods inherited from interface ELObject

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

Methods inherited from interface ELPackageAble

getElementImportingNamespace, getElementImportingNamespace, getImportedPackageAble, getOwningPackage

Methods inherited from interface ELPictureAble

getOwnedPicture, getOwnedPictures, getPictureRawData, pictureSetRawData

Methods inherited from interface ELUUIDAble

getHyperlinkReferenceAble, getInnoRef, getNotToTranslateAttribute, getTranslatedValue, getUUID, setUUID

Methods inherited from interface ELValueContainerAble

getValueReUseAble, setValueReUseAble

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 MMFormatAble

copyFormatDlg, copyFormatRule, getCopyFormatDlgInit, getFormat

Methods inherited from interface MMLabelAble

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

Methods inherited from interface MMMenuAble

getMenu, getMenuItem, getMenuItemsForTransform

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

Methods inherited from interface PRDia

addAbleDiaEdge, addEdgeAndTargetNode, addEdgesAndTargetNodes, getAddAbleDiaEdge, getAddEdgeAndTargetNodeList, getDiaWhiteboardNode, getOwnedAnnotations, getOwnedCalloutNode, getOwnedDiaAttachmentNode, getOwnedDiaNote, getOwnedFrameNode, getSVGPictureRawData, getXClientForSVG, setDiaFilterCriteria, setSVGPictureRawData

Methods inherited from interface PRPresContext

getContextFormat, getContextValue, getCopy, getCopyToFile, getHorPage, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMarginUnit, getModelElementOfTransitiveOwnedPresentationElement, getModelElementOfTransitiveOwnedPresentationElement, getOrientation, getOwnedFooterText, getOwnedHeaderText, getOwnedPresContent, getPageBreakX, getPageBreakY, getPageOrder, getPageView, getVerPage, getXClient, getXClientContentModelElementList, getXClientContentModelElementList, getXClientHash, isPageViewActive, pageView, paste, pasteFromFile, setContextFormat, setContextValue, setHorPage, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setOrientation, setPageViewActive, setVerPage

Methods inherited from interface PRPresElement

getDiagramTagValue, getOpacity, getOwnedPresContentElement, getPresColor, getPresentationOfLogic, setDiagramTagValue, setOpacity, setPresColor

Methods inherited from interface PRVersionAbleDia

getMEModelName, isMapped, setMapped

Method Details

isMasterDia

boolean isMasterDia()
             throws InoNetException,
SrvErrorException

True if the diagram is meant to contain exactly one master view node.

Throws:

InoNetException

SrvErrorException

isMasterWithoutDefinition

boolean isMasterWithoutDefinition()
                           throws InoNetException,
SrvErrorException

True if it is the master BPMN process diagram but does not contain the process definition, just a synchronized reference to it. Therefore the BPMN process diagram will not be opened by default locked. Reserving it by locking the diagram will result in the process definition to be moved from another BPMN diagram to the BPMN process diagram.

Throws:

InoNetException

SrvErrorException

getContentForHighlighting

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

All elements eligible for being highlighted in the diagram, e.g. the path contents of the paths selected for highlighting.

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

addDiaCollaborationViewNode

BPDiaCollaborationViewNode addDiaCollaborationViewNode(BPCollaboration ohCollaboration,
 Point position,
 Point size,
 boolean isExpanded,
 boolean areProcessesExpanded)
                                                throws InoNetException,
SrvErrorException

Adds a node representing a collaboration to the diagram.

Parameters:

ohCollaboration - The collaboration to be added to the diagram

position - Position of the node

size - Size of the node

isExpanded - If true, the node should be displayed as expanded node

areProcessesExpanded - If true, the processes inside the participants are displayed as expanded node

Throws:

InoNetException

SrvErrorException

addDiaCollaborationViewNodeForExistingProcessViewNodes

BPDiaCollaborationViewNode addDiaCollaborationViewNodeForExistingProcessViewNodes(BPCollaboration ohCollaboration)
                                                                           throws InoNetException,
SrvErrorException

Adds a node representing a collaboration to the diagram if the processes concerned are already displayed in the diagram without already having a collaboration context.

Parameters:

ohCollaboration - The collaboration to be added to the diagram

Throws:

InoNetException

SrvErrorException

addDiaNodes

List<PRDiaNode> addDiaNodes(Class<? extends ELObject> kVOclModel,
 Class<? extends ELObject> kVOclPres,
 List<? extends ADClientAble> adds,
 Point position,
 Point size,
 Point offset)
                     throws InoNetException,
SrvErrorException

Adds elements as nodes to this diagram.

Parameters:

kVOclModel - Type of the model element to be added

kVOclPres - Type of the presentation element to be created

adds - List of the elements to be added

position - Position of the first created node

size - Size of the first created node

offset - Position offset, if more than one node is created

Throws:

InoNetException

SrvErrorException

addDiaProcessViewNode

BPDiaProcessViewNode addDiaProcessViewNode(BPProcess ohProcess,
 PRPresElement ohPresOfOwner,
 Point position,
 Point size,
 boolean isExpanded)
                                    throws InoNetException,
SrvErrorException

Adds a node representing a process to the diagram.

Parameters:

ohProcess - The process to be added to the diagram

ohPresOfOwner - The presentation element which will own the Process View Node, either BPDiaParticipantNode or BPDia

position - Position of the process

size - Size of the process

isExpanded - If true, the process should be displayed as expanded node

Throws:

InoNetException

SrvErrorException

setBPDiaNotation

void setBPDiaNotation(K_BP_DISP_DIA kDisp)
               throws InoNetException,
SrvErrorException

Changes the display option diagram notation of this BPDia. The display option has to be defined within the configuration and marked for changes within diagrams.

Parameters:

kDisp - new diagram notation value

Throws:

InoNetException

SrvErrorException

setVisibleCompartment

void setVisibleCompartment(List<? extends PRDiaNode> seqNode,
 List<ARG_CompartmentVisibilityList> seqComp)
                    throws InoNetException,
SrvErrorException

Sets the visible compartments of the selected nodes in the business diagram.

Parameters:

seqNode - List of nodes (invalid as null)

seqComp - List of compartment states

Throws:

InoNetException

SrvErrorException

getOwnedSupportEdge

List<BPDiaSupportEdge> getOwnedSupportEdge()
                                    throws InoNetException,
SrvErrorException

All support edges of the BPDia.

Throws:

InoNetException

SrvErrorException

getOwnedItemNode

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

All BPDiaItemNode.

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

getOwnedArtifactNode

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

All BPDiaArtifactNode of the BPDia.

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

getOwnedMessageFlow

List<BPDiaMessageFlow> getOwnedMessageFlow()
                                    throws InoNetException,
SrvErrorException

message flow edge owned by the diagram.

Throws:

InoNetException

SrvErrorException

getOwnedViewNode

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

All BPDiaViewNode.

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