Package de.mid.innovator.srv2api.icw2bpdia

Interface BPDiaViewNode

All Superinterfaces:

ADClientAble, ADM2AttrModifyAble, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELObject, ELUUIDAble, MMFormatAble, PRDiaNode, PRPresContent, PRPresElement

All Known Subinterfaces:

BPDiaChoreographyViewNode, BPDiaCollaborationViewNode, BPDiaProcessViewNode

public interface BPDiaViewNode
extends PRDiaNode

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

Note:

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

Method Summary

Modifier and Type	Method	Description
void	becomeMasterView()	Declare this view to be the one and only master view.
void	becomeRegularView()	Declare this view to be a reference to the master view which is allowed only if it is not the master view.
void	becomeSynchronizedView()	Declare this view to be an exact reference to the master view.
void	correctExistingViewContent()	Makes this view a correct but not necessarily complete copy of the current master view.
java.util.List<PRDiaNote>	getCommentNodeOfView(K_CONTROL_OPTION... behaviourFlags)	All comment nodes which belong to the model element which is displayed by the view.
BPDia	getDiagramOfView()	The diagram of the view node.
<T extends MEModelElement> java.util.List<T>	getMissingElement(java.lang.Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	Returns all model elements missing in this view.
<T extends MEModelElement> java.util.List<T>	getMissingElement(java.lang.Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getMissingElement and filters its return values according to the given stereotype value.
<T extends BPDiaArtifactNode> java.util.List<T>	getOwnedArtifactNode(java.lang.Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	All BPDiaArtifactNode owned by the BPDiaViewNode.
java.util.List<PRDiaCalloutNode>	getOwnedCalloutNode(K_CONTROL_OPTION... behaviourFlags)	All callout nodes owned by this view node.
java.util.List<BPDiaMessageNode>	getOwnedMessageNode(K_CONTROL_OPTION... behaviourFlags)	All message nodes in the view node.
<T extends PRPresContent> java.util.List<T>	getOwnedViewElementTransitiveDownByOrder(java.lang.Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	All presentation elements in this view.
BPDia	getOwningDia()	The BPDia of the element.
BPPath	getPath()	The path being displayed in the view node.
BPPath	getPathDisplayed()	The path being emphasized in the view node.
java.util.List<BPPath>	getPossiblePath(K_CONTROL_OPTION... behaviourFlags)	All paths eligible for visualization in this context.
java.util.List<BPPath>	getPossiblePath(MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getPossiblePath and filters its return values according to the given stereotype value.
<T extends PRPresContent> java.util.List<T>	getPresentationInView(java.lang.Class<T> returnType, MEModelElement refObj, K_CONTROL_OPTION... behaviourFlags)	All presentation contents of this view which are connected to the model element specified by argument refObj and which do not belong to another view nested into this one.
boolean	isCompletelyMaintained()	Returns TRUE if all model elements contained in the element being displayed by the view have a presentation element.
boolean	isCorrect()	Returns true if the hierarchy of the model elements is displayed correctly.
boolean	isCorrectAndComplete()	Returns true if the view is considered to be correct and complete.
boolean	isInMasterViewNode()	True if the view node IS a master view node itself.
boolean	isMasterView()	Returns true if the view is the master view, which means it is the definition of either a process or an interaction specification.
boolean	isSyncedCopy()	True if it is a reference and if the reference always contains a complete and correct copy of the defining view.
boolean	isVisibleAndSelectable()	True if the view is either top-level or nested inside of nodes which are expanded.
ARG_BPDiaMasterDiaWithView	moveMasterToNewDiagram()	Creates a new diagram of the same stereotype the diagram of the view to be moved has.
void	rebuildExactlyFromMasterView()	Makes this view a perfect copy of the current master view.
ARG_BPDiaMasterDiaWithView	removeMasterMoveToNewDiagram()	Creates a new diagram of the same stereotype the diagram of the view to be moved has.
void	setPathDisplayed(BPPath value)	Set the value of View PathDisplayed.
void	toggleOrientation()	Switches the current orientation to the other one - from vertical to horizontal and vice versa.

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

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

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, getQualifiedNamespaceName, getRelshipBinDir, getRelshipBinDir, getRelshipBinDirTarget, getUnitToLock, getValSpecElement, isContainedInProfile, isUnresolved, lockUnit, setUnresolved, unlockUnit

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

getHyperlinkReferenceAble, getNotToTranslateAttribute, getTranslatedValue, getUUID, setUUID

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

copyFormatDlg, copyFormatRule, getCopyFormatDlgInit, getFormat

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, getPresentationLevel, getTextPosition, getTextSize, setPresentationLevel, setTextCoord, setTextPosition, setTextSize

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

getOpacity, getOwnedPresContentElement, getPresColor, getPresentationOfLogic, setOpacity, setPresColor

Method Detail

isMasterView

boolean isMasterView()
              throws InoNetException,
                     SrvErrorException

Returns true if the view is the master view, which means it is the definition of either a process or an interaction specification.

Throws:

InoNetException

SrvErrorException

isCorrectAndComplete

boolean isCorrectAndComplete()
                      throws InoNetException,
                             SrvErrorException

Returns true if the view is considered to be correct and complete. Either it is the definition itself or it differs from the definition by mere graphical details.

Throws:

InoNetException

SrvErrorException

isCompletelyMaintained

boolean isCompletelyMaintained()
                        throws InoNetException,
                               SrvErrorException

Returns TRUE if all model elements contained in the element being displayed by the view have a presentation element.

Throws:

InoNetException

SrvErrorException

isInMasterViewNode

boolean isInMasterViewNode()
                    throws InoNetException,
                           SrvErrorException

True if the view node IS a master view node itself. This stands in contrast to the other nodes which return if they are inside a master view node. Since this information is used to determine if a node shall be considered for the reorganization of the logical information according to the graphical information, the info shall be available for all nodes including the view nodes. They shall be considered if they are masters themselves.

Throws:

InoNetException

SrvErrorException

isCorrect

boolean isCorrect()
           throws InoNetException,
                  SrvErrorException

Returns true if the hierarchy of the model elements is displayed correctly. There may be missing model elements but if they are displayed, they have to be displayed with their correct owners.

Throws:

InoNetException

SrvErrorException

isSyncedCopy

boolean isSyncedCopy()
              throws InoNetException,
                     SrvErrorException

True if it is a reference and if the reference always contains a complete and correct copy of the defining view.

Throws:

InoNetException

SrvErrorException

isVisibleAndSelectable

boolean isVisibleAndSelectable()
                        throws InoNetException,
                               SrvErrorException

True if the view is either top-level or nested inside of nodes which are expanded. If just the graphical display of the view is embedded in a node this does not count as physical presence.

Throws:

InoNetException

SrvErrorException

getPresentationInView

<T extends PRPresContent> java.util.List<T> getPresentationInView(java.lang.Class<T> returnType,
                                                                  MEModelElement refObj,
                                                                  K_CONTROL_OPTION... behaviourFlags)
                                                           throws InoNetException,
                                                                  SrvErrorException

All presentation contents of this view which are connected to the model element specified by argument refObj and which do not belong to another view nested into this one.

Parameters:

returnType - Specifies the type of elements to be returned.

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

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getMissingElement

<T extends MEModelElement> java.util.List<T> getMissingElement(java.lang.Class<T> returnType,
                                                               K_CONTROL_OPTION... behaviourFlags)
                                                        throws InoNetException,
                                                               SrvErrorException

Returns all model elements missing in this view. For the definition the list returned must be empty.

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

getMissingElement

<T extends MEModelElement> java.util.List<T> getMissingElement(java.lang.Class<T> returnType,
                                                               MMStereotype stereotype,
                                                               K_CONTROL_OPTION... behaviourFlags)
                                                        throws InoNetException,
                                                               SrvErrorException

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

getPossiblePath

java.util.List<BPPath> getPossiblePath(K_CONTROL_OPTION... behaviourFlags)
                                throws InoNetException,
                                       SrvErrorException

All paths eligible for visualization in this context.

Parameters:

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getPossiblePath

java.util.List<BPPath> getPossiblePath(MMStereotype stereotype,
                                       K_CONTROL_OPTION... behaviourFlags)
                                throws InoNetException,
                                       SrvErrorException

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

getPathDisplayed

BPPath getPathDisplayed()
                 throws InoNetException,
                        SrvErrorException

The path being emphasized in the view node.

Throws:

InoNetException

SrvErrorException

setPathDisplayed

void setPathDisplayed(BPPath value)
               throws InoNetException,
                      SrvErrorException

Set the value of View PathDisplayed.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getCommentNodeOfView

java.util.List<PRDiaNote> getCommentNodeOfView(K_CONTROL_OPTION... behaviourFlags)
                                        throws InoNetException,
                                               SrvErrorException

All comment nodes which belong to the model element which is displayed by the view.

Parameters:

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getOwnedViewElementTransitiveDownByOrder

<T extends PRPresContent> java.util.List<T> getOwnedViewElementTransitiveDownByOrder(java.lang.Class<T> returnType,
                                                                                     K_CONTROL_OPTION... behaviourFlags)
                                                                              throws InoNetException,
                                                                                     SrvErrorException

All presentation elements in this view. The presentation elements are retrieved transitively but other views and their contents are excluded. The presentation elements may be returned sorted by their internal sorting order which can be set via API functions.

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

Sorted:

becomeMasterView

void becomeMasterView()
               throws InoNetException,
                      SrvErrorException

Declare this view to be the one and only master view. The current master view will become a normal view, but before this view checks if it is complete and if it is not, it copies the current master view exactly.

Throws:

InoNetException

SrvErrorException

becomeRegularView

void becomeRegularView()
                throws InoNetException,
                       SrvErrorException

Declare this view to be a reference to the master view which is allowed only if it is not the master view. This command is meant to change a synchronized view to be a regular view. If it is called for a regular view it has not effect.

Throws:

InoNetException

SrvErrorException

becomeSynchronizedView

void becomeSynchronizedView()
                     throws InoNetException,
                            SrvErrorException

Declare this view to be an exact reference to the master view. The master view will be displayed here and the content displayed will be the same content as that inside the master view. Hence, the current view is just an empty node which pretends to contain the content of the master view but in fact displays the content of the one and only master view. If the command is called for a synchronized view it has not effect.

Throws:

InoNetException

SrvErrorException

correctExistingViewContent

void correctExistingViewContent()
                         throws InoNetException,
                                SrvErrorException

Makes this view a correct but not necessarily complete copy of the current master view.

Throws:

InoNetException

SrvErrorException

moveMasterToNewDiagram

ARG_BPDiaMasterDiaWithView moveMasterToNewDiagram()
                                           throws InoNetException,
                                                  SrvErrorException

Creates a new diagram of the same stereotype the diagram of the view to be moved has.

Throws:

InoNetException

SrvErrorException

rebuildExactlyFromMasterView

void rebuildExactlyFromMasterView()
                           throws InoNetException,
                                  SrvErrorException

Makes this view a perfect copy of the current master view.

Throws:

InoNetException

SrvErrorException

removeMasterMoveToNewDiagram

ARG_BPDiaMasterDiaWithView removeMasterMoveToNewDiagram()
                                                 throws InoNetException,
                                                        SrvErrorException

Creates a new diagram of the same stereotype the diagram of the view to be moved has. Moves the view to the new diagram by simply changing its owner, hence it is removed from the current diagram and assigned to the new diagram.

Throws:

InoNetException

SrvErrorException

toggleOrientation

void toggleOrientation()
                throws InoNetException,
                       SrvErrorException

Switches the current orientation to the other one - from vertical to horizontal and vice versa. This is allowed for master views only.

Throws:

InoNetException

SrvErrorException

getDiagramOfView

BPDia getDiagramOfView()
                throws InoNetException,
                       SrvErrorException

The diagram of the view node.

Throws:

InoNetException

SrvErrorException

getOwnedMessageNode

java.util.List<BPDiaMessageNode> getOwnedMessageNode(K_CONTROL_OPTION... behaviourFlags)
                                              throws InoNetException,
                                                     SrvErrorException

All message nodes in the view node.

Parameters:

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getOwnedArtifactNode

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

All BPDiaArtifactNode owned by the 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

getOwnedCalloutNode

java.util.List<PRDiaCalloutNode> getOwnedCalloutNode(K_CONTROL_OPTION... behaviourFlags)
                                              throws InoNetException,
                                                     SrvErrorException

All callout nodes owned by this view node.

Parameters:

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getPath

BPPath getPath()
        throws InoNetException,
               SrvErrorException

The path being displayed in the view node.

Throws:

InoNetException

SrvErrorException

getOwningDia

BPDia getOwningDia()
            throws InoNetException,
                   SrvErrorException

The BPDia of the element.

Throws:

InoNetException

SrvErrorException