Interface BPEventDefinition

All Superinterfaces:

ADAccessAble, ADClientAble, ADFindAble, ADHistoryAble, ADLockAble, ADM2AttrModifyAble, ADOptionAble, ADReferenceAble, ADVersionAble, BCBaseElement, BCBaseNamedStereotypeAble, BCPropertyAble, BCRootReuseAbleElement, BPMessageReferencingElement, 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

All Known Subinterfaces:

BPConditionalEventDefinition, BPLinkEventDefinition, BPTimerEventDefinition

public interface BPEventDefinition
extends BCRootReuseAbleElement, BPMessageReferencingElement

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	BPEventDefinition.VAttr

Method Summary

Modifier and Type	Method	Description
BPActivityNode	getActivityNode()	The BPActivityNode.
List<BPEventNode>	getCatchingEventNode()	All catching event nodes that assign this BPEventDefinition.
List<BPEventNode>	getCatchingEventNode(MMStereotype stereotype)	The method calls getCatchingEventNode and filters its return values according to the given stereotype value.
BPError	getErrorRef()	The error.
BPEscalation	getEscalation()	The BPEscalation that is used by the event definition.
K_BP_EVENTDEFINITION_TYPE	getEventDefinitionType()	The type of the event definition.
String	getEventExpression()	An expression describing when and how this event may become relevant.
List<BPEventNode>	getEventNode()	All event nodes referencing this event definition.
BPOperation	getOperation()	The operation that is used by the event definition.
BPMaskDefinition	getOwningMaskDefinition()	The mask definition of the event definition.
BPSignal	getSignal()	The BPSignal that is used by the event definition.
List<BPEventNode>	getThrowingEventNode()	All throwing event nodes that assign this BPEventDefinition.
List<BPEventNode>	getThrowingEventNode(MMStereotype stereotype)	The method calls getThrowingEventNode and filters its return values according to the given stereotype value.
boolean	isAllowedForBoundary(BPActivityNode refObj)	Returns if this event definition may be assigned to a boundary event of an activity node.
boolean	isWaitForCompletion()	Attribute for the CompensateEventDefinition.
void	setActivityNode(BPActivityNode value)	Set the value of Foreign Key ActivityNode.
void	setErrorRef(BPError value)	Set the value of Foreign Key ErrorRef.
void	setEscalation(BPEscalation value)	Set the value of Foreign Key Escalation.
void	setEventDefinitionType(K_BP_EVENTDEFINITION_TYPE value)	Set the value of Attribut EventDefinitionType.
void	setEventExpression(String value)	Set the value of Attribut EventExpression.
void	setOperation(BPOperation value)	Set the value of Foreign Key Operation.
void	setSignal(BPSignal value)	Set the value of Foreign Key Signal.
void	setWaitForCompletion(boolean value)	Set the value of Attribut IsWaitForCompletion.

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 BPMessageReferencingElement

getMessage, setMessage

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

getEventDefinitionType

K_BP_EVENTDEFINITION_TYPE getEventDefinitionType()
                                          throws InoNetException,
SrvErrorException

The type of the event definition.

Throws:

InoNetException

SrvErrorException

setEventDefinitionType

void setEventDefinitionType(K_BP_EVENTDEFINITION_TYPE value)
                     throws InoNetException,
SrvErrorException

Set the value of Attribut EventDefinitionType.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

isWaitForCompletion

boolean isWaitForCompletion()
                     throws InoNetException,
SrvErrorException

Attribute for the CompensateEventDefinition.

Throws:

InoNetException

SrvErrorException

setWaitForCompletion

void setWaitForCompletion(boolean value)
                   throws InoNetException,
SrvErrorException

Set the value of Attribut IsWaitForCompletion.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getEventExpression

String getEventExpression()
                   throws InoNetException,
SrvErrorException

An expression describing when and how this event may become relevant.

Throws:

InoNetException

SrvErrorException

setEventExpression

void setEventExpression(String value)
                 throws InoNetException,
SrvErrorException

Set the value of Attribut EventExpression.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

isAllowedForBoundary

boolean isAllowedForBoundary(BPActivityNode refObj)
                      throws InoNetException,
SrvErrorException

Returns if this event definition may be assigned to a boundary event of an activity node.

Parameters:

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

Throws:

InoNetException

SrvErrorException

getCatchingEventNode

List<BPEventNode> getCatchingEventNode()
                                throws InoNetException,
SrvErrorException

All catching event nodes that assign this BPEventDefinition.

Throws:

InoNetException

SrvErrorException

getCatchingEventNode

List<BPEventNode> getCatchingEventNode(MMStereotype stereotype)
                                throws InoNetException,
SrvErrorException

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

Parameters:

stereotype - The stereotype used to filter the result list

Throws:

InoNetException

SrvErrorException

getThrowingEventNode

List<BPEventNode> getThrowingEventNode()
                                throws InoNetException,
SrvErrorException

All throwing event nodes that assign this BPEventDefinition.

Throws:

InoNetException

SrvErrorException

getThrowingEventNode

List<BPEventNode> getThrowingEventNode(MMStereotype stereotype)
                                throws InoNetException,
SrvErrorException

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

Parameters:

stereotype - The stereotype used to filter the result list

Throws:

InoNetException

SrvErrorException

getEventNode

List<BPEventNode> getEventNode()
                        throws InoNetException,
SrvErrorException

All event nodes referencing this event definition.

Throws:

InoNetException

SrvErrorException

getErrorRef

BPError getErrorRef()
             throws InoNetException,
SrvErrorException

The error.

Throws:

InoNetException

SrvErrorException

setErrorRef

void setErrorRef(BPError value)
          throws InoNetException,
SrvErrorException

Set the value of Foreign Key ErrorRef.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getOperation

BPOperation getOperation()
                  throws InoNetException,
SrvErrorException

The operation that is used by the event definition.

Throws:

InoNetException

SrvErrorException

setOperation

void setOperation(BPOperation value)
           throws InoNetException,
SrvErrorException

Set the value of Foreign Key Operation.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getEscalation

BPEscalation getEscalation()
                    throws InoNetException,
SrvErrorException

The BPEscalation that is used by the event definition.

Throws:

InoNetException

SrvErrorException

setEscalation

void setEscalation(BPEscalation value)
            throws InoNetException,
SrvErrorException

Set the value of Foreign Key Escalation.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getSignal

BPSignal getSignal()
            throws InoNetException,
SrvErrorException

The BPSignal that is used by the event definition.

Throws:

InoNetException

SrvErrorException

setSignal

void setSignal(BPSignal value)
        throws InoNetException,
SrvErrorException

Set the value of Foreign Key Signal.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getActivityNode

BPActivityNode getActivityNode()
                        throws InoNetException,
SrvErrorException

The BPActivityNode.

Throws:

InoNetException

SrvErrorException

setActivityNode

void setActivityNode(BPActivityNode value)
              throws InoNetException,
SrvErrorException

Set the value of Foreign Key ActivityNode.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getOwningMaskDefinition

BPMaskDefinition getOwningMaskDefinition()
                                  throws InoNetException,
SrvErrorException

The mask definition of the event definition.

Throws:

InoNetException

SrvErrorException