Package de.mid.innovator.srv2api.icw2bp

Interface BPGateway

All Superinterfaces:

ADClientAble, ADFindAble, ADHistoryAble, ADM2AttrModifyAble, BCBaseElement, BCBaseNamedStereotypeAble, BCPropertyAble, BPFlowElement, BPPathAble, BPResourceRoleAble, BPSequenceFlowNode, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELNamedElement, ELNamespaceAble, ELObject, ELUUIDAble, ELValueContainerAble, MECommentAble, MEConstraintAble, MEModelElement, MENamedElement, MEStereotypeAble, METermAble, MMAttachmentAble, MMCommentContainerAble, MMLabelAble, MMLabelTextAttachmentAble, MMStereotypeAble, MMTextAble

public interface BPGateway
extends BPSequenceFlowNode, BPResourceRoleAble

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	BPGateway.VAttr

Method Summary

Modifier and Type	Method	Description
K_BP_GATEWAY_DIRECTION	getGatewayDirection()	An attribute that adds constraints on how the gateway may be used.
K_BP_GATEWAY_TYPE	getGatewayType()	An attribute that specifies the subclass of the gateway class which is used in the model.
List<BPGatewayResource>	getResource(K_CONTROL_OPTION... behaviourFlags)	All resource assignments of the gateway.
boolean	isGatewayDirectionDynamic()	If this flag is true, the direction is automatically modified if the context of the BPEventNode changes.
boolean	isInstantiateEventBasedGateway()	By default the gateway's instantiate attribute is false, but if set to true, then the process is instantiated when the first Event of the gateway's configuration is triggered.
void	setGatewayDirection(K_BP_GATEWAY_DIRECTION value)	Set the value of Attribut GatewayDirection.
void	setGatewayDirectionDynamic(boolean value)	Set the value of Attribut IsGatewayDirectionDynamic.
void	setGatewayType(K_BP_GATEWAY_TYPE value)	Set the value of Attribut GatewayType.
void	setInstantiateEventBasedGateway(boolean value)	Set the value of Attribut IsInstantiateEventBasedGateway.

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, getTabElementRelshipTypeList, getTabElementRowList, getTabElementRowTypeList, getTabRelshipList, getTabRowList, tabCellModify, tabCreateTemplate, tabElementModify

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

getBusinessIdentifier, setBusinessIdentifier

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

getAssignedPropertySet, getOwnedAdHocProperty, getPropertySetsAssigned, getPropertySetsAssigned, setPropertySetsAssigned

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

assignToLane, getFlowElementContainer, getGroupArtifact, getIncomingAssociationArtifact, getLane, getLaneAssigned, getLaneAssignedInLaneSet, getLaneAssignedInTopLaneSet, getLaneAssignedTransitiveUp, getLaneAssignedTransitiveUp, getLaneSetAssigned, getLaneSetAssigned, getLaneSetAssignedTransitiveUp, getLaneSetAssignedTransitiveUp, getTopFlowElementContainer, setGroupArtifact

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

getElementAtPathR, getPath, getPath, getPresentationInMasterView, getPresentationInStandardView

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

getResourceAssigned, getResourceAssigned, getResourceRole, getResourceRoleByRACIType, getResourceRoleByRACIType, getUseResources, setResourceAssigned, setUseResources

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

getIncomingSequenceFlow, getOutgoingSequenceFlow

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

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

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, 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.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, getDataModel, getDataModelName, 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.MEStereotypeAble

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

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

getTerm, setTerm

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

Method Details

getGatewayDirection

K_BP_GATEWAY_DIRECTION getGatewayDirection()
                                    throws InoNetException,
SrvErrorException

An attribute that adds constraints on how the gateway may be used.

Throws:

InoNetException

SrvErrorException

setGatewayDirection

void setGatewayDirection(K_BP_GATEWAY_DIRECTION value)
                  throws InoNetException,
SrvErrorException

Set the value of Attribut GatewayDirection.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getGatewayType

K_BP_GATEWAY_TYPE getGatewayType()
                          throws InoNetException,
SrvErrorException

An attribute that specifies the subclass of the gateway class which is used in the model.

Throws:

InoNetException

SrvErrorException

setGatewayType

void setGatewayType(K_BP_GATEWAY_TYPE value)
             throws InoNetException,
SrvErrorException

Set the value of Attribut GatewayType.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

isInstantiateEventBasedGateway

boolean isInstantiateEventBasedGateway()
                                throws InoNetException,
SrvErrorException

By default the gateway's instantiate attribute is false, but if set to true, then the process is instantiated when the first Event of the gateway's configuration is triggered.

Throws:

InoNetException

SrvErrorException

setInstantiateEventBasedGateway

void setInstantiateEventBasedGateway(boolean value)
                              throws InoNetException,
SrvErrorException

Set the value of Attribut IsInstantiateEventBasedGateway.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

isGatewayDirectionDynamic

boolean isGatewayDirectionDynamic()
                           throws InoNetException,
SrvErrorException

If this flag is true, the direction is automatically modified if the context of the BPEventNode changes.

Throws:

InoNetException

SrvErrorException

setGatewayDirectionDynamic

void setGatewayDirectionDynamic(boolean value)
                         throws InoNetException,
SrvErrorException

Set the value of Attribut IsGatewayDirectionDynamic.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getResource

List<BPGatewayResource> getResource(K_CONTROL_OPTION... behaviourFlags)
                             throws InoNetException,
SrvErrorException

All resource assignments of the gateway.

Parameters:

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

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted.