Interface BPCollaboration

All Superinterfaces:

ADAccessAble, ADClientAble, ADFindAble, ADHistoryAble, ADLockAble, ADM2AttrModifyAble, ADOptionAble, ADReferenceAble, ADVersionAble, BCBaseElement, BCBaseNamedStereotypeAble, BCPropertyAble, BCRootReuseAbleElement, BPArtifactContainerAble, BPInteractionSpecification, BPPathContextAble, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELNamedElement, ELNamespaceAble, ELNamespaceAsgnAble, ELObject, ELPackageAble, ELUUIDAble, ELValueContainerAble, MECommentAble, MEConstraintAble, MEModelElement, MENamedElement, MENamespaceAsgnAble, MEPackageAble, MEStereotypeAble, METermAble, MMAttachmentAble, MMCommentContainerAble, MMLabelAble, MMLabelTextAttachmentAble, MMStereotypeAble, MMTextAble

public interface BPCollaboration
extends BCRootReuseAbleElement, BPInteractionSpecification, BPArtifactContainerAble

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	BPCollaboration.VAttr

Method Summary

Modifier and Type	Method	Description
List<BPDiaCollaborationViewNode>	getCollaborationViewCompletelyMaintained()	Returns a list of all views of the same model element being maintained completely.
List<BPDiaCollaborationViewNode>	getCollaborationViewIncomplete()	Returns a list of all views of the same model element being incomplete with regard to its master view.
List<BPDiaCollaborationViewNode>	getCollaborationViewIncorrect()	Returns a list of all views of the same model element being incorrect with regard to its master view.
List<BPDia>	getDiagramWithViewCompletelyMaintained()	All diagrams containing at least one complete view of this collaboration.
List<BPDia>	getDiagramWithViewCompletelyMaintained(MMStereotype stereotype)	The method calls getDiagramWithViewCompletelyMaintained and filters its return values according to the given stereotype value.
BPDiaCollaborationViewNode	getMasterCollaborationViewNode()	The master collaboration view node of the element.
List<BPDiaCollaborationViewNode>	getNonMasterCollaborationViewNode()	All references to this collaboration except the defining BPDiaCollaborationViewNode.
<T extends BCRootReuseAbleElement> List<T>	getOwnedReuseAbleElement(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	All reusable elements being relevant in the context of this collaboration.
List<BPProcess>	getProcess()	All processes being defined by the collaboration.

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 BCBaseElement

getBusinessIdentifier, setBusinessIdentifier

Methods inherited from interface BCPropertyAble

getAssignedPropertySet, getOwnedAdHocProperty, getPropertySetsAssigned, getPropertySetsAssigned, setPropertySetsAssigned

Methods inherited from interface BCRootReuseAbleElement

getOwningCollaboration, getOwningProcess

Methods inherited from interface BPArtifactContainerAble

getOwnedArtifact

Methods inherited from interface BPInteractionSpecification

getCreateOrientation, getMasterViewNode, getOutgoingInteractionUseCaseRel, getParticipant, setCreateOrientation

Methods inherited from interface BPPathContextAble

getDefinitionDiagram, getDiagramOfStandardView, getPath, getStandardView, getViewVisibleAndSelectAble

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 ELNamespaceAble

getElementImport, getImportedElement, getImportedElement, getImportedPackage, getImportedPackage, getItemDefinition, getMember, getMember, getMemberByPattern, getMemberByPattern, getOwnedConstraint, getOwnedMember, getOwnedMemberByPath, getOwnedMemberByPattern, getOwnedMemberByPattern, getOwnedMemberTransitiveByPattern, getOwnedMemberTransitiveByPattern, getOwnedMemberTransitiveByPatternIgnoreCase, getOwnedMemberTransitiveByPatternIgnoreCase, getPackageImport

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 ELUUIDAble

getHyperlinkReferenceAble, getInnoRef, getNotToTranslateAttribute, getTranslatedValue, getUUID, setUUID

Methods inherited from interface ELValueContainerAble

getValueReUseAble, setValueReUseAble

Methods inherited from interface MECommentAble

getAssignedComment, getAssignedComment, getCommentAssign

Methods inherited from interface MEConstraintAble

getAssignedConstraint, getAssignedConstraint, getConstraintAssign

Methods inherited from interface MEModelElement

buildProxyConnection, getActivityPartition, getConsider, getContentStereotypeByClass, getCreateTemplateByClass, getDataModel, getDataModelName, getElementColor, getFirstValidContentStereotype, getIgnore, getKnownTypeSystems, getMEModelName, getModelElement, getModelElement, getPresContext, getPresContext, getPresetMapping, getPRPresContent, setElementColor

Methods inherited from interface MENamedElement

getMappingSourceElement, getMappingSourceElement, getMESupplierDependency, getMESupplierMappingDependency

Methods inherited from interface MENamespaceAsgnAble

getSignatureMessage

Methods inherited from interface MEPackageAble

getComponent, getManifest

Methods inherited from interface MEStereotypeAble

getClientMappingDependency, getDecisionMade, getDecisionOwned, getKnowledgeSourceOfOwner, getMappingTargetElement, getMappingTargetElement, getMEClientDependency, getProxyAsgProperty, getRepresentingArtifact, getRequirementOfStakeholder, getRequirementOfStakeholderOwner, isMapped, setMapped, setRequirementOfStakeholder

Methods inherited from interface METermAble

getTerm, setTerm

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 MMLabelAble

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

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

Method Details

getCollaborationViewCompletelyMaintained

List<BPDiaCollaborationViewNode> getCollaborationViewCompletelyMaintained()
                                                                   throws InoNetException,
SrvErrorException

Returns a list of all views of the same model element being maintained completely.

Throws:

InoNetException

SrvErrorException

getDiagramWithViewCompletelyMaintained

List<BPDia> getDiagramWithViewCompletelyMaintained()
                                            throws InoNetException,
SrvErrorException

All diagrams containing at least one complete view of this collaboration.

Throws:

InoNetException

SrvErrorException

getDiagramWithViewCompletelyMaintained

List<BPDia> getDiagramWithViewCompletelyMaintained(MMStereotype stereotype)
                                            throws InoNetException,
SrvErrorException

The method calls getDiagramWithViewCompletelyMaintained and filters its return values according to the given stereotype value.

Parameters:

stereotype - The stereotype used to filter the result list

Throws:

InoNetException

SrvErrorException

getMasterCollaborationViewNode

BPDiaCollaborationViewNode getMasterCollaborationViewNode()
                                                   throws InoNetException,
SrvErrorException

The master collaboration view node of the element.

Throws:

InoNetException

SrvErrorException

getNonMasterCollaborationViewNode

List<BPDiaCollaborationViewNode> getNonMasterCollaborationViewNode()
                                                            throws InoNetException,
SrvErrorException

All references to this collaboration except the defining BPDiaCollaborationViewNode.

Throws:

InoNetException

SrvErrorException

getCollaborationViewIncomplete

List<BPDiaCollaborationViewNode> getCollaborationViewIncomplete()
                                                         throws InoNetException,
SrvErrorException

Returns a list of all views of the same model element being incomplete with regard to its master view.

Throws:

InoNetException

SrvErrorException

getCollaborationViewIncorrect

List<BPDiaCollaborationViewNode> getCollaborationViewIncorrect()
                                                        throws InoNetException,
SrvErrorException

Returns a list of all views of the same model element being incorrect with regard to its master view.

Throws:

InoNetException

SrvErrorException

getOwnedReuseAbleElement

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

All reusable elements being relevant in the context of this collaboration.

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:

the result may be sorted.

getProcess

List<BPProcess> getProcess()
                    throws InoNetException,
SrvErrorException

All processes being defined by the collaboration.

Throws:

InoNetException

SrvErrorException