Package de.mid.innovator.srv2api.icw2cldia

Interface CLDia

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

All Known Subinterfaces:

CLClassDia, CLComponentDia, CLCompositeStructureDia, CLDeploymentDia, CLHierarchyAbleDia, CLRequirementDia, CLStructureDefinitionDia, CLUseCaseDia, DBDia, DRDecisionRequirementDia, ERDia, ERDiaAll, IMDia

public interface CLDia
extends PRVersionAbleDia

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

Note:

The interface CLDia 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	CLDia.VAttr

Method Summary

Modifier and Type	Method	Description
List<PRPresContent>	addAssociationDlg(List<? extends ADClientAble> seqSel, boolean isDirParent, boolean addNode)	Adds associations as edges or nodes to this diagram.
List<CLDiaSocketBallNode>	addAsSocketBall(List<ARG_AddAbleAsSocketBallList> seq)	Add interfaces in socket ball notation to the specified nodes within this diagram.
void	addCompartmentDlg(MM2CLCompartment ohComp, K_COMPARTMENT kComp, List<? extends ADClientAble> seqSel)	Adds elements as compartments of the selected nodes in this diagram.
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.
List<CLDiaOwnershipEdge>	addOwnershipDlg(List<? extends ADClientAble> seqSel, boolean isDirParent, boolean addNode)	Adds ownership edges to this diagram.
List<CLDiaRelshipLinkEdge>	addRelationshipDlg(MM2Class ohClass, List<? extends ADClientAble> seqNode, List<? extends ADClientAble> seqSel, boolean isDirParent, boolean addNode)	Adds relationships as edges to this diagram.
CLDia	createDiagramOfSelection(List<? extends PRDiaNode> seqNode, boolean subtractNodesFromSource)	Creates a copy of this CLDia with the selected nodes as content.
List<ARG_AddAbleAsSocketBallList>	getAddAbleAsSocketBall(List<? extends PRDiaNode> seqNode)	Calculates all interfaces which may be added in socket ball notation within this diagram.
List<ARG_SourceTargetRelship>	getAddAbleRelship()	Returns a list of all directed relationships which may be added to this diagram.
<T extends CLDiaCnstrNode> List<T>	getOwnedConstraintNode(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	All occurrences of constraints as constraint nodes owned by this diagram.
<T extends CLDiaMergeAbleEdge> List<T>	getOwnedMergeAbleEdge(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	All occurences of relationships and associations as edge owned by this diagram.
<T extends CLDiaMergeAbleNode> List<T>	getOwnedMergeAbleNode(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	All occurrences of relationships and associations as node owned by this diagram.
CLComponent	getOwningComponent()	The component that owns this classifier diagram.
List<ARG_CompartmentVisibilityOut>	getVisibleCompartmentDlgInit(List<? extends ELElement> seq)	Fills the dialog for the modification of visibility and maintenance of compartments.
void	setVisibleCompartment(List<? extends PRDiaNode> seqNode, List<ARG_CompartmentVisibilityList> seqComp)	Sets the visible compartments of the selected nodes.

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

getAddAbleAsSocketBall

List<ARG_AddAbleAsSocketBallList> getAddAbleAsSocketBall(List<? extends PRDiaNode> seqNode)
                                                  throws InoNetException,
SrvErrorException

Calculates all interfaces which may be added in socket ball notation within this diagram. If a list of nodes is specified only these nodes are evaluated otherwise all nodes of the diagram are evaluated.

Parameters:

seqNode - list of nodes or empty

Throws:

InoNetException

SrvErrorException

getAddAbleRelship

List<ARG_SourceTargetRelship> getAddAbleRelship()
                                         throws InoNetException,
SrvErrorException

Returns a list of all directed relationships which may be added to this diagram. Each list entry contains the source and target node of the relationship.

Throws:

InoNetException

SrvErrorException

getVisibleCompartmentDlgInit

List<ARG_CompartmentVisibilityOut> getVisibleCompartmentDlgInit(List<? extends ELElement> seq)
                                                         throws InoNetException,
SrvErrorException

Fills the dialog for the modification of visibility and maintenance of compartments.

Parameters:

seq - List of ELElement

Throws:

InoNetException

SrvErrorException

addAsSocketBall

List<CLDiaSocketBallNode> addAsSocketBall(List<ARG_AddAbleAsSocketBallList> seq)
                                   throws InoNetException,
SrvErrorException

Add interfaces in socket ball notation to the specified nodes within this diagram.

Parameters:

seq -

Throws:

InoNetException

SrvErrorException

addAssociationDlg

List<PRPresContent> addAssociationDlg(List<? extends ADClientAble> seqSel,
 boolean isDirParent,
 boolean addNode)
                               throws InoNetException,
SrvErrorException

Adds associations as edges or nodes to this diagram.

Parameters:

seqSel - List of selected nodes and elements

isDirParent - isTrue/isFalse means edges to parent/son only

addNode - isTrue, if nodes may be added

Throws:

InoNetException

SrvErrorException

addCompartmentDlg

void addCompartmentDlg(MM2CLCompartment ohComp,
 K_COMPARTMENT kComp,
 List<? extends ADClientAble> seqSel)
                throws InoNetException,
SrvErrorException

Adds elements as compartments of the selected nodes in this diagram.

Parameters:

ohComp - compartment of the added elements

kComp - kind of the compartment of the added elements

seqSel - list of selected nodes and elements

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

addOwnershipDlg

List<CLDiaOwnershipEdge> addOwnershipDlg(List<? extends ADClientAble> seqSel,
 boolean isDirParent,
 boolean addNode)
                                  throws InoNetException,
SrvErrorException

Adds ownership edges to this diagram.

Parameters:

seqSel - List of selected nodes and elements

isDirParent - isTrue/isFalse means Edges to parent/son

addNode - isTrue, if nodes may be added

Throws:

InoNetException

SrvErrorException

addRelationshipDlg

List<CLDiaRelshipLinkEdge> addRelationshipDlg(MM2Class ohClass,
 List<? extends ADClientAble> seqNode,
 List<? extends ADClientAble> seqSel,
 boolean isDirParent,
 boolean addNode)
                                       throws InoNetException,
SrvErrorException

Adds relationships as edges to this diagram.

Parameters:

ohClass - Meta class of the element type

seqNode - List of selected nodes

seqSel - List of selected elements

isDirParent - isTrue/isFalse means Edges to parent/son

addNode - isTrue, if nodes may be added

Throws:

InoNetException

SrvErrorException

createDiagramOfSelection

CLDia createDiagramOfSelection(List<? extends PRDiaNode> seqNode,
 boolean subtractNodesFromSource)
                        throws InoNetException,
SrvErrorException

Creates a copy of this CLDia with the selected nodes as content.

Parameters:

seqNode - list of selected nodes

subtractNodesFromSource - isTrue, if the nodes are subtracted from the source diagram

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.

Parameters:

seqNode - List of nodes (invalid as null)

seqComp - List of compartment states

Throws:

InoNetException

SrvErrorException

getOwnedMergeAbleNode

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

All occurrences of relationships and associations as node owned by this diagram.

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

getOwnedMergeAbleEdge

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

All occurences of relationships and associations as edge owned by this diagram.

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

getOwnedConstraintNode

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

All occurrences of constraints as constraint nodes owned by this diagram.

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

getOwningComponent

CLComponent getOwningComponent()
                        throws InoNetException,
SrvErrorException

The component that owns this classifier diagram.

Throws:

InoNetException

SrvErrorException