Interface BPSubProcess

All Superinterfaces:

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

public interface BPSubProcess
extends BPActivityNode, BPFlowProcessContainer

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	BPSubProcess.VAttr

Method Summary

Modifier and Type	Method	Description
boolean	getAdHocCancelRemainingInstances()	This attribute is used only if ordering is parallel.
String	getAdHocCompletionCondition()	This expression defines the conditions when the process will end.
K_BP_SUBPROCESS_ADHOC_ORDERING	getAdHocOrdering()	This attribute defines if the activities within the process can be performed in parallel or must be performed sequentially.
K_BP_SUBPROCESS_TYPE	getSubProcessType()	Type of the sub-process.
K_BP_SUBPROCESS_TRANSACTION_METHOD	getTransactionMethod()	Defines the technique that will be used to undo a transaction that has been cancelled.
boolean	getUseSubProcess()	Specifies if the algorithm for activity based costing should step in the subprocess or use the attributes specified directly on this subprocess to do the calculation.
boolean	isTriggeredByEvent()	If set to TRUE the subprocess is triggered by an event.
void	setAdHocCancelRemainingInstances(boolean value)	Set the value of Attribut AdHocCancelRemainingInstances.
void	setAdHocCompletionCondition(String value)	Set the value of Attribut AdHocCompletionCondition.
void	setAdHocOrdering(K_BP_SUBPROCESS_ADHOC_ORDERING value)	Set the value of Attribut AdHocOrdering.
void	setSubProcessType(K_BP_SUBPROCESS_TYPE value)	Set the value of Attribut SubProcessType.
void	setTransactionMethod(K_BP_SUBPROCESS_TRANSACTION_METHOD value)	Set the value of Attribut TransactionMethod.
void	setTriggeredByEvent(boolean value)	Set the value of Attribut IsTriggeredByEvent.
void	setUseSubProcess(boolean value)	Set the value of Attribut UseSubProcess.

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 ADM2AttrModifyAble

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

Methods inherited from interface BCBaseElement

getBusinessIdentifier, setBusinessIdentifier

Methods inherited from interface BCPropertyAble

getAssignedPropertySet, getOwnedAdHocProperty, getPropertySetsAssigned, getPropertySetsAssigned, setPropertySetsAssigned

Methods inherited from interface BPActivityNode

getActivityProperty, getActivityResourceAccountable, getActivityResourceAccountable, getActivityResourceByRACIType, getActivityResourceByRACIType, getActivityResourceConsulted, getActivityResourceConsulted, getActivityResourceInformed, getActivityResourceInformed, getActivityResourceResponsible, getActivityResourceResponsible, getActivityResourceSupportive, getActivityResourceSupportive, getActivityResourceUnspecified, getActivityResourceUnspecified, getApplyInCalculation, getCompletionQuantity, getCostsPerExecution, getEventDefinition, getEventNode, getExecutionTime, getFrequencyPerYear, getIncomingCompensationAssociation, getIncomingDataIOAssociation, getIncomingDataIOAssociation, getLoopCharacteristics, getLoopCharxType, getMeanLoopNumber, getMultiLoopCardinality, getMultiLoopCompletionCondition, getMultiLoopIsSequential, getOutgoingDataIOAssociation, getOutgoingDataIOAssociation, getOwnedDataAssociation, getResource, getStartQuantity, getStdLoopCondition, getStdLoopMaximum, getStdLoopTestBefore, getVisibleIncomingItemAwareElement, getVisibleIncomingItemAwareElement, getVisibleOutgoingItemAwareElement, getVisibleOutgoingItemAwareElement, isForCompensation, setApplyInCalculation, setCompletionQuantity, setCostsPerExecution, setEventDefinition, setExecutionTime, setForCompensation, setFrequencyPerYear, setLoopCharxType, setMeanLoopNumber, setMultiLoopCardinality, setMultiLoopCompletionCondition, setMultiLoopIsSequential, setStartQuantity, setStdLoopCondition, setStdLoopMaximum, setStdLoopTestBefore

Methods inherited from interface BPArtifactContainerAble

getOwnedArtifact

Methods inherited from interface BPFlowElement

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

Methods inherited from interface BPFlowElementContainer

getGatewayByDirection, getGatewayByDirection, getGatewayByType, getGatewayByType, getSequenceFlowElement

Methods inherited from interface BPFlowProcessContainer

getActivity, getDataObject, getDataStoreNode, getDataStoreNode, getFlowElementTransitiveDown, getFlowElementTransitiveDown, getLinkEventDefinitionUsed, getLinkEventDefinitionUsed, getNestedFlowElement, getNestedFlowElement

Methods inherited from interface BPInputOutputSpecifyAble

getDataInput, getDataInput, getDataOutput, getDataOutput, getFlowExpandedShortValue, getInputOutputObject, getInputOutputObject, getInputSet, getIODataObject, getIODataObjectByKind, getIODataObjectByKind, getModifyIOSpecs, getOutputSet

Methods inherited from interface BPMessageSequenceFlowNode

getIncomingMessageFlow, getOutgoingMessageFlow

Methods inherited from interface BPPathAble

getElementAtPathR, getPath, getPath, getPresentationInMasterView, getPresentationInStandardView

Methods inherited from interface BPResourceRoleAble

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

Methods inherited from interface BPSequenceFlowNode

getIncomingSequenceFlow, getOutgoingSequenceFlow

Methods inherited from interface BRCostCenterAble

getCostCenter, setCostCenter

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 ELObject

getId, getLongId, getMetaClass, getMetaName, getOclClass, getSrvCon, hasRead

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

isTriggeredByEvent

boolean isTriggeredByEvent()
                    throws InoNetException,
SrvErrorException

If set to TRUE the subprocess is triggered by an event.

Throws:

InoNetException

SrvErrorException

setTriggeredByEvent

void setTriggeredByEvent(boolean value)
                  throws InoNetException,
SrvErrorException

Set the value of Attribut IsTriggeredByEvent.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getSubProcessType

K_BP_SUBPROCESS_TYPE getSubProcessType()
                                throws InoNetException,
SrvErrorException

Type of the sub-process. It may be a plain sub-process, or it may be ad-Hoc or a transaction.

Throws:

InoNetException

SrvErrorException

setSubProcessType

void setSubProcessType(K_BP_SUBPROCESS_TYPE value)
                throws InoNetException,
SrvErrorException

Set the value of Attribut SubProcessType.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getTransactionMethod

K_BP_SUBPROCESS_TRANSACTION_METHOD getTransactionMethod()
                                                 throws InoNetException,
SrvErrorException

Defines the technique that will be used to undo a transaction that has been cancelled.

Throws:

InoNetException

SrvErrorException

setTransactionMethod

void setTransactionMethod(K_BP_SUBPROCESS_TRANSACTION_METHOD value)
                   throws InoNetException,
SrvErrorException

Set the value of Attribut TransactionMethod.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getAdHocOrdering

K_BP_SUBPROCESS_ADHOC_ORDERING getAdHocOrdering()
                                         throws InoNetException,
SrvErrorException

This attribute defines if the activities within the process can be performed in parallel or must be performed sequentially. The default setting is parallel and the setting of sequential is a restriction on the performance that may be required due to shared resources. When the setting is sequential, then only one activities can be performed at a time. When the setting is parallel, then zero to all the BPActivityNode of the BPSubProcess can be performed in parallel.

Throws:

InoNetException

SrvErrorException

setAdHocOrdering

void setAdHocOrdering(K_BP_SUBPROCESS_ADHOC_ORDERING value)
               throws InoNetException,
SrvErrorException

Set the value of Attribut AdHocOrdering.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getAdHocCancelRemainingInstances

boolean getAdHocCancelRemainingInstances()
                                  throws InoNetException,
SrvErrorException

This attribute is used only if ordering is parallel. It determines whether running instances are cancelled when the completionCondition becomes true.

Throws:

InoNetException

SrvErrorException

setAdHocCancelRemainingInstances

void setAdHocCancelRemainingInstances(boolean value)
                               throws InoNetException,
SrvErrorException

Set the value of Attribut AdHocCancelRemainingInstances.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getAdHocCompletionCondition

String getAdHocCompletionCondition()
                            throws InoNetException,
SrvErrorException

This expression defines the conditions when the process will end. When the expression is evaluated to True, the process will be terminated.

Throws:

InoNetException

SrvErrorException

setAdHocCompletionCondition

void setAdHocCompletionCondition(String value)
                          throws InoNetException,
SrvErrorException

Set the value of Attribut AdHocCompletionCondition.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getUseSubProcess

boolean getUseSubProcess()
                  throws InoNetException,
SrvErrorException

Specifies if the algorithm for activity based costing should step in the subprocess or use the attributes specified directly on this subprocess to do the calculation.

Throws:

InoNetException

SrvErrorException

setUseSubProcess

void setUseSubProcess(boolean value)
               throws InoNetException,
SrvErrorException

Set the value of Attribut UseSubProcess.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException