Package de.mid.innovator.srv2api.icw2bp

Interface BPParticipant

All Superinterfaces:

ADClientAble, ADFindAble, ADHistoryAble, ADM2AttrModifyAble, BCBaseElement, BCBaseNamedStereotypeAble, BPMessageFlowNode, BPPathAble, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELMultiplicityAble, ELNamedElement, ELNamespaceAsgnAble, ELObject, ELUUIDAble, ELValueContainerAble, MECommentAble, MEConstraintAble, MEModelElement, MENamedElement, MENamespaceAsgnAble, MEStereotypeAble, MMAttachmentAble, MMCommentContainerAble, MMLabelAble, MMLabelTextAttachmentAble, MMStereotypeAble, MMTextAble

public interface BPParticipant
extends ELMultiplicityAble, MENamespaceAsgnAble, BCBaseNamedStereotypeAble, BPMessageFlowNode, BPPathAble

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	BPParticipant.VAttr

Method Summary

Modifier and Type	Method	Description
void	assignProcess(BPProcess ohProcess)	Assigns a process to the participant.
java.util.List<BPParticipantAtActivity>	getChoreographyActivityR(K_CONTROL_OPTION... behaviourFlags)	The activity the participant takes part in.
java.util.List<BPEndPoint>	getEndPoint()	All end points of the participant.
java.util.List<BPMessageFlow>	getIncomingMessageFlow(K_CONTROL_OPTION... behaviourFlags)	All incoming message flows.
BPInteractionSpecification	getInteraction()	The interaction the BPParticipant takes part in.
java.util.List<BPInterface>	getInterfaceRef()	The interface being referenced by the participant.
java.util.List<BPMessageFlow>	getOutgoingMessageFlow(K_CONTROL_OPTION... behaviourFlags)	All outgoing message flows.
java.util.List<BPParticipantEntity>	getOwnedEntityAssignment(K_CONTROL_OPTION... behaviourFlags)	All partner entity assignments of the participant.
java.util.List<BPParticipantRole>	getOwnedRoleAssignment(K_CONTROL_OPTION... behaviourFlags)	All partner role assignments of the participant.
<T extends MERefAbleAsResource> java.util.List<T>	getPartnerEntity(java.lang.Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	All partner entity elements being assigned to the participant.
<T extends MERefAbleAsResource> java.util.List<T>	getPartnerEntity(java.lang.Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getPartnerEntity and filters its return values according to the given stereotype value.
<T extends MERefAbleAsResource> java.util.List<T>	getPartnerRole(java.lang.Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	All partner role elements being assigned to the participant.
<T extends MERefAbleAsResource> java.util.List<T>	getPartnerRole(java.lang.Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getPartnerRole and filters its return values according to the given stereotype value.
BPProcess	getProcess()	The process being executed or supervised by the participant in the BPInteractionSpecification.
java.util.List<BPParticipantMapping>	getReferencedToRef(K_CONTROL_OPTION... behaviourFlags)	All BPParticipantMapping of the participant being referenced to the participants referencing him.
java.util.List<BPParticipantMapping>	getRefToReferenced(K_CONTROL_OPTION... behaviourFlags)	All BPParticipantMapping of the referencing participant to the participants being referenced.
void	removeProcess()	Removes the process from the participant so that it is not used any more and hence not being displayed in the participant nodes of the participant.
void	setInterfaceRef(java.util.List<? extends BPInterface> values)	Set the value of Foreign Key InterfaceRef.
void	setPartnerEntity(java.util.List<? extends MERefAbleAsResource> values)	Set the value of View PartnerEntity.
void	setPartnerRole(java.util.List<? extends MERefAbleAsResource> values)	Set the value of View PartnerRole.
void	setProcess(BPProcess value)	Set the value of Foreign Key Process.

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

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

Methods inherited from interface de.mid.innovator.srv2api.icw2bc.BCBaseElement

getBusinessIdentifier, setBusinessIdentifier

Methods inherited from interface de.mid.innovator.srv2api.icw2bp.BPPathAble

getElementAtPathR, getPath, getPath, getPresentationInMasterView, getPresentationInStandardView

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

getLower, getLowerBoundAsString, getLowerUpperVal, getUpper, getUpperBoundAsString, hasMultiplicity11, hasUpper1, isMany, isMultivalued, isOptional, isOrdered, isUnique, setLower, setMany, setOptional, setOrdered, setUnique, setUpper

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

getHyperlinkReferenceAble, getNotToTranslateAttribute, getTranslatedValue, getUUID, setUUID

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

getValueReUseAble, setValueReUseAble

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MECommentAble

getAssignedComment, getAssignedComment, getCommentAssign

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEConstraintAble

getAssignedConstraint, getAssignedConstraint, getConstraintAssign

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEModelElement

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

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MENamedElement

getMappingSourceElement, getMappingSourceElement, getMESupplierDependency, getMESupplierMappingDependency

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MENamespaceAsgnAble

getMENamespace, getSignatureMessage

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEStereotypeAble

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

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

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

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

Method Detail

getPartnerEntity

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

All partner entity elements being assigned to the participant.

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

getPartnerEntity

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

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

setPartnerEntity

void setPartnerEntity(java.util.List<? extends MERefAbleAsResource> values)
               throws InoNetException,
                      SrvErrorException

Set the value of View PartnerEntity.

Parameters:

values - The value to be set.

Throws:

InoNetException

SrvErrorException

getPartnerRole

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

All partner role elements being assigned to the participant.

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

getPartnerRole

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

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

setPartnerRole

void setPartnerRole(java.util.List<? extends MERefAbleAsResource> values)
             throws InoNetException,
                    SrvErrorException

Set the value of View PartnerRole.

Parameters:

values - The value to be set.

Throws:

InoNetException

SrvErrorException

assignProcess

void assignProcess(BPProcess ohProcess)
            throws InoNetException,
                   SrvErrorException

Assigns a process to the participant. It the participant already uses a process, the current process is removed from the participant and the new one is assigned.

Parameters:

ohProcess - The process to be assigned

Throws:

InoNetException

SrvErrorException

removeProcess

void removeProcess()
            throws InoNetException,
                   SrvErrorException

Removes the process from the participant so that it is not used any more and hence not being displayed in the participant nodes of the participant.

Throws:

InoNetException

SrvErrorException

getChoreographyActivityR

java.util.List<BPParticipantAtActivity> getChoreographyActivityR(K_CONTROL_OPTION... behaviourFlags)
                                                          throws InoNetException,
                                                                 SrvErrorException

The activity the participant takes part in.

Parameters:

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

Throws:

InoNetException

SrvErrorException

getProcess

BPProcess getProcess()
              throws InoNetException,
                     SrvErrorException

The process being executed or supervised by the participant in the BPInteractionSpecification.

Throws:

InoNetException

SrvErrorException

setProcess

void setProcess(BPProcess value)
         throws InoNetException,
                SrvErrorException

Set the value of Foreign Key Process.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getRefToReferenced

java.util.List<BPParticipantMapping> getRefToReferenced(K_CONTROL_OPTION... behaviourFlags)
                                                 throws InoNetException,
                                                        SrvErrorException

All BPParticipantMapping of the referencing participant to the participants being referenced.

Parameters:

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

Throws:

InoNetException

SrvErrorException

getReferencedToRef

java.util.List<BPParticipantMapping> getReferencedToRef(K_CONTROL_OPTION... behaviourFlags)
                                                 throws InoNetException,
                                                        SrvErrorException

All BPParticipantMapping of the participant being referenced to the participants referencing him.

Parameters:

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

Throws:

InoNetException

SrvErrorException

getEndPoint

java.util.List<BPEndPoint> getEndPoint()
                                throws InoNetException,
                                       SrvErrorException

All end points of the participant.

Throws:

InoNetException

SrvErrorException

getOutgoingMessageFlow

java.util.List<BPMessageFlow> getOutgoingMessageFlow(K_CONTROL_OPTION... behaviourFlags)
                                              throws InoNetException,
                                                     SrvErrorException

All outgoing message flows.

Parameters:

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

Throws:

InoNetException

SrvErrorException

getIncomingMessageFlow

java.util.List<BPMessageFlow> getIncomingMessageFlow(K_CONTROL_OPTION... behaviourFlags)
                                              throws InoNetException,
                                                     SrvErrorException

All incoming message flows.

Parameters:

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

Throws:

InoNetException

SrvErrorException

getInterfaceRef

java.util.List<BPInterface> getInterfaceRef()
                                     throws InoNetException,
                                            SrvErrorException

The interface being referenced by the participant.

Throws:

InoNetException

SrvErrorException

setInterfaceRef

void setInterfaceRef(java.util.List<? extends BPInterface> values)
              throws InoNetException,
                     SrvErrorException

Set the value of Foreign Key InterfaceRef.

Parameters:

values - The value to be set.

Throws:

InoNetException

SrvErrorException

getOwnedEntityAssignment

java.util.List<BPParticipantEntity> getOwnedEntityAssignment(K_CONTROL_OPTION... behaviourFlags)
                                                      throws InoNetException,
                                                             SrvErrorException

All partner entity assignments of the participant.

Parameters:

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

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted.

getOwnedRoleAssignment

java.util.List<BPParticipantRole> getOwnedRoleAssignment(K_CONTROL_OPTION... behaviourFlags)
                                                  throws InoNetException,
                                                         SrvErrorException

All partner role assignments of the participant.

Parameters:

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

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted.

getInteraction

BPInteractionSpecification getInteraction()
                                   throws InoNetException,
                                          SrvErrorException

The interaction the BPParticipant takes part in.

Throws:

InoNetException

SrvErrorException