Package de.mid.innovator.srv2api.icw2brdia

Interface BRDia

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 BRDia
extends PRVersionAbleDia

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	BRDia.VAttr

Method Summary

Modifier and Type	Method	Description
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.
BRDiaResourceEdge	addEdgeForResourceRel(BRResourceRel ohResourceRel, Class<? extends ELObject> kVOclPres, BRDiaResourceNode ohNodeSrc, BRDiaResourceNode ohNodeTrg, boolean ifExistsDontAdd)	Adds an resource relationship edge representing a business resource relationship to the diagram.
BRDiaResourceNode	addNodeForResource(BRResource ohResource, Class<? extends ELObject> kVOclPres, boolean allowMultiple, Point position, Point size)	Adds an resource node representing a business resource to the diagram.
List<BRDiaResourceEdge>	addResourceRelationship(List<? extends BRDiaResourceNode> seqNode, List<? extends BRResourceRel> seqSel, boolean isDirParent, boolean addNode)	Adds resource relationships as edges to this diagram.
List<BRDiaResourceNode>	getNodeForResource(BRResource refObj)	Returns all resource nodes representing the resource which already exist in the diagram.
<T extends BRDiaResourceEdge> List<T>	getOwnedResourceEdge(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	The resource edges in this BRDia.
List<BRDiaResourceNode>	getOwnedResourceNode()	The resource nodes in this BRDia.
<T extends BRDiaTextNode> List<T>	getOwnedTextNode(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	The text nodes in this BRDia.
<T extends BRResource> List<T>	getResourceInDia(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	Returns a unique list of all business resources being displayed in the BRDia.
<T extends BRResource> List<T>	getResourceInDia(Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getResourceInDia and filters its return values according to the given stereotype value.

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, getTabElementRelshipTypeList, getTabElementRowList, getTabElementRowTypeList, getTabRelshipList, 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.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, getNotificationElement, 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.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.ELPictureAble

getOwnedPicture, getOwnedPictures, getPictureRawData, pictureSetRawData

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

getHyperlinkReferenceAble, getInnoRef, getNotToTranslateAttribute, getTranslatedValue, getUUID, setUUID

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

getOutgoingConceptRealization, getOwnedComment, getRealizedConcept, getRealizedConcept, replaceRealizedConcepts, setRealizedConcept

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

copyFormatDlg, copyFormatRule, getCopyFormatDlgInit, getFormat

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

getMenu, getMenuItem, getMenuItemsForTransform

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, getText, getTextExpandedValue, getTextStringValue, getURIList, modifyFlowDocuments, modifyTextValuesDlg

Methods inherited from interface de.mid.innovator.srv2api.icw2pres.PRDia

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

Methods inherited from interface de.mid.innovator.srv2api.icw2pres.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 de.mid.innovator.srv2api.icw2pres.PRPresElement

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

Methods inherited from interface de.mid.innovator.srv2api.icw2pres.PRVersionAbleDia

getMEModelName, getVersionAbleDiaClientDependency, getVersionAbleDiaSupplierDependency, isMapped, setMapped

Method Details

getResourceInDia

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

Returns a unique list of all business resources being displayed in the BRDia.

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

getResourceInDia

<T extends BRResource> List<T> getResourceInDia(Class<T> returnType,
 MMStereotype stereotype,
 K_CONTROL_OPTION... behaviourFlags)
                                         throws InoNetException,
SrvErrorException

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

getNodeForResource

List<BRDiaResourceNode> getNodeForResource(BRResource refObj)
                                    throws InoNetException,
SrvErrorException

Returns all resource nodes representing the resource which already exist in the diagram.

Parameters:

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

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

addEdgeForResourceRel

BRDiaResourceEdge addEdgeForResourceRel(BRResourceRel ohResourceRel,
 Class<? extends ELObject> kVOclPres,
 BRDiaResourceNode ohNodeSrc,
 BRDiaResourceNode ohNodeTrg,
 boolean ifExistsDontAdd)
                                 throws InoNetException,
SrvErrorException

Adds an resource relationship edge representing a business resource relationship to the diagram. The source node and the target node have to be specified since the source resource and the target resource of the business resource relationship may have more than one representation in the diagram.

Parameters:

ohResourceRel - Model Element to be added

kVOclPres - Type of the new edge

ohNodeSrc - source node

ohNodeTrg - target node

ifExistsDontAdd - if true and if the edge does already exist, the existing edge is taken

Throws:

InoNetException

SrvErrorException

addNodeForResource

BRDiaResourceNode addNodeForResource(BRResource ohResource,
 Class<? extends ELObject> kVOclPres,
 boolean allowMultiple,
 Point position,
 Point size)
                              throws InoNetException,
SrvErrorException

Adds an resource node representing a business resource to the diagram.

Parameters:

ohResource - Business resource to be added as node

kVOclPres - Type of the new node

allowMultiple - If true, more than one node of the resource is allowed

position - Position of the new node

size - Size of the new node

Throws:

InoNetException

SrvErrorException

addResourceRelationship

List<BRDiaResourceEdge> addResourceRelationship(List<? extends BRDiaResourceNode> seqNode,
 List<? extends BRResourceRel> seqSel,
 boolean isDirParent,
 boolean addNode)
                                         throws InoNetException,
SrvErrorException

Adds resource relationships as edges to this diagram.

Parameters:

seqNode - List of selected nodes

seqSel - List of selected relationships

isDirParent - isTrue/isFalse means Edges to parent/son

addNode - isTrue, if nodes may be added

Throws:

InoNetException

SrvErrorException

getOwnedResourceEdge

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

The resource edges in this BRDia.

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

getOwnedResourceNode

List<BRDiaResourceNode> getOwnedResourceNode()
                                      throws InoNetException,
SrvErrorException

The resource nodes in this BRDia.

Throws:

InoNetException

SrvErrorException

getOwnedTextNode

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

The text nodes in this BRDia.

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