de.mid.innovator.srv2api.icw2bp
Interface BPSubProcess

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

public interface BPSubProcess
extends BPActivityNode, BPFlowProcessContainer


Nested Class Summary
static class BPSubProcess.VAttr
           
 
Method Summary
 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 de.mid.innovator.srv2api.icw2bp.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, getResourceAssigned, getResourceAssigned, getStartQuantity, getStdLoopCondition, getStdLoopMaximum, getStdLoopTestBefore, getUseResources, getVisibleIncomingItemAwareElement, getVisibleIncomingItemAwareElement, getVisibleOutgoingItemAwareElement, getVisibleOutgoingItemAwareElement, isForCompensation, setApplyInCalculation, setCompletionQuantity, setCostsPerExecution, setEventDefinition, setExecutionTime, setForCompensation, setFrequencyPerYear, setLoopCharxType, setMeanLoopNumber, setMultiLoopCardinality, setMultiLoopCompletionCondition, setMultiLoopIsSequential, setResourceAssigned, setStartQuantity, setStdLoopCondition, setStdLoopMaximum, setStdLoopTestBefore, setUseResources
 
Methods inherited from interface de.mid.innovator.srv2api.icw2bp.BPInputOutputSpecifyAble
getDataInput, getDataInput, getDataOutput, getDataOutput, getFlowExpandedShortValue, getInputOutputObject, getInputOutputObject, getInputSet, getIODataObject, getIODataObjectByKind, getIODataObjectByKind, getModifyIOSpecs, getOutputSet
 
Methods inherited from interface de.mid.innovator.srv2api.icw2bp.BPSequenceFlowNode
getIncomingSequenceFlow, getOutgoingSequenceFlow
 
Methods inherited from interface de.mid.innovator.srv2api.icw2bp.BPFlowElement
assignToLane, getFlowElementContainer, getGroupArtifact, getIncomingAssociationArtifact, getLane, getLaneAssigned, getLaneAssigned, getLaneAssignedInLaneSet, getLaneAssignedInTopLaneSet, getLaneAssignedTransitiveUp, getLaneAssignedTransitiveUp, getLaneSetAssigned, getLaneSetAssigned, getLaneSetAssignedTransitiveUp, getLaneSetAssignedTransitiveUp, getTopFlowElementContainer, setGroupArtifact
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEStereotypeAble
getClientMappingDependency, getOutgoingConceptRealization, getProxyAsgProperty, getRealizedConcept, getRealizedConcept, getRepresentingArtifact, getRequirementOfStakeholder, getRequirementOfStakeholderOwner, isMapped, replaceRealizedConcepts, setMapped, setRealizedConcept, setRequirementOfStakeholder
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMCommentContainerAble
getOwnedComment
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMStereotypeAble
assignStereotypeDlg, cloneElement, getAttrCnstrEffective, getCreateTemplate, getDisplayType, getOwnedFormat, getOwnedStereotypePropertyValSpec, getPropBoolValue, getPropLongValue, getPropStringValue, getPropValueList, getStereoPropValueByPattern, getStereoPropValueByPattern, getStereotype, getStereotypeName, getStereotypeProperty, getStereotypePropertyInfo, getStereotypePropertyNameValue, isCloneAbleElement, modifyStereotypePropertyValuesByName, setStereotype, setStereotypePropertyInfo
 
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.icw2bc.BCBaseElement
getBusinessIdentifier, setBusinessIdentifier
 
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.icw2elem.ELUUIDAble
getUUID, setUUID
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEConstraintAble
getAssignedConstraint, getAssignedConstraint, getConstraintAssign
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MECommentAble
getAssignedComment, getAssignedComment, getCommentAssign
 
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.icw2meta.ADClientAble
getAnnotation, getLogic, getLogic, getPresentationContext, getSection
 
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.icw2meta.MMTextAble
getFlowExpandedValue, getModifyFlowDocuments, getModifyTextValues, getModifyTextValuesDlgInit, getOwnedTextValue, getOwnedTextValueByPattern, getTextExpandedValue, getTextStringValue, getURIList, modifyFlowDocuments, modifyTextValuesDlg
 
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.icw2elem.ELValueContainerAble
getValueReUseAble, setValueReUseAble
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMAttachmentAble
getAssignedAttachment, getAttachmentAssign, getDefaultAttachment, getOwnedAttachment, setDefaultAttachment
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELContainerAble
getCheckSetNotToLocalizeAttribute, getClientDependency, getNotToLocalizeAttribute, getOwnedElement, getOwnedElementTransitiveDown, getOwnedElementTransitiveDown, getOwnedElementTransitiveDownAndUnresolved, getOwnedElementTransitiveDownAndUnresolved, getOwnedLocalizedValue, getOwnedOrReferencedElementTransitiveDown, getOwnedOrReferencedElementTransitiveDown, getOwnedRelshipBinDirWithTarget, getOwnedRelshipBinDirWithTarget, getRedirectedModelContainer, getRelshipBinDirSource, getSelfAndOwnedElementTransitiveDown, getSelfAndOwnedElementTransitiveDown, getSortedContents, resetNotToLocalizeAttribute, setNotToLocalizeAttribute, sortContents
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELDeleteAble
delete
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MENamedElement
getMESupplierDependency, getMESupplierMappingDependency
 
Methods inherited from interface de.mid.innovator.srv2api.icw2bc.BCPropertyAble
getAssignedPropertySet, getOwnedAdHocProperty, getPropertySetsAssigned, getPropertySetsAssigned, setPropertySetsAssigned
 
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.ELNamedElement
getName, getNameKind, getQualifiedDisplayName, getQualifiedName, getQualifiedTLName, getResetDefaultName, getSupplierDependency, rename, setName, setNameKind, setResetDefaultName
 
Methods inherited from interface de.mid.innovator.srv2api.icw2bp.BPPathAble
getElementAtPathR, getPath, getPath, getPresentationInMasterView, getPresentationInStandardView
 
Methods inherited from interface de.mid.innovator.srv2api.icw2br.BRCostCenterAble
getCostCenter, setCostCenter
 
Methods inherited from interface de.mid.innovator.srv2api.icw2bp.BPFlowProcessContainer
getActivity, getDataObject, getDataStoreNode, getDataStoreNode, getFlowElementTransitiveDown, getFlowElementTransitiveDown, getLinkEventDefinitionUsed, getLinkEventDefinitionUsed, getNestedFlowElement, getNestedFlowElement
 
Methods inherited from interface de.mid.innovator.srv2api.icw2bp.BPFlowElementContainer
getGatewayByDirection, getGatewayByDirection, getGatewayByType, getGatewayByType, getSequenceFlowElement
 
Methods inherited from interface de.mid.innovator.srv2api.icw2bp.BPArtifactContainerAble
getOwnedArtifact
 

Method Detail

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

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

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

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

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

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

isTriggeredByEvent

boolean isTriggeredByEvent()
                           throws InoNetException,
                                  SrvErrorException
If set to TRUE the subprocess is triggered by an event.

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

setAdHocCompletionCondition

void setAdHocCompletionCondition(String value)
                                 throws InoNetException,
                                        SrvErrorException
Set the value of Attribut AdHocCompletionCondition.

Parameters:
value - The value to be set.
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

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

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

setTriggeredByEvent

void setTriggeredByEvent(boolean value)
                         throws InoNetException,
                                SrvErrorException
Set the value of Attribut IsTriggeredByEvent.

Parameters:
value - The value to be set.
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