Package org.finos.fluxnova.bpm.model.bpmn.instance

Interface AdHocSubProcess

All Superinterfaces:

Activity, BaseElement, BpmnModelElementInstance, FlowElement, FlowNode, InteractionNode, ModelElementInstance, SubProcess

All Known Implementing Classes:

AdHocSubProcessImpl

public interface AdHocSubProcess
extends SubProcess

The BPMN 2.0 adHocSubProcess element.

An Ad-Hoc Sub-Process is a specialized type of Sub-Process that has a set of Activities that can be performed in any order, and some of which may not be performed at all. It is intended to be used in cases where the sequence and number of performances are determined by the performers of the Activities.

Method Summary

Modifier and Type	Method	Description
CompletionCondition	getCompletionCondition()	The Expression that, when evaluated to true, signals that the Ad-Hoc Sub-Process should complete.
String	getOrdering()	Returns the BPMN ordering attribute of the ad-hoc activities.
boolean	isCancelRemainingInstances()	If true (default), when the completionCondition is met, any remaining running Activity instances within the Ad-Hoc Sub-Process will be cancelled.
void	setCancelRemainingInstances(boolean cancelRemainingInstances)
void	setCompletionCondition(CompletionCondition completionCondition)
void	setOrdering(String ordering)

Methods inherited from interface org.finos.fluxnova.bpm.model.bpmn.instance.Activity

getCompletionQuantity, getDataInputAssociations, getDataOutputAssociations, getDefault, getIoSpecification, getLoopCharacteristics, getProperties, getResourceRoles, getStartQuantity, isForCompensation, setCompletionQuantity, setDefault, setForCompensation, setIoSpecification, setLoopCharacteristics, setStartQuantity

Methods inherited from interface org.finos.fluxnova.bpm.model.bpmn.instance.BaseElement

getDiagramElement, getDocumentations, getExtensionElements, getId, setExtensionElements, setId

Methods inherited from interface org.finos.fluxnova.bpm.model.bpmn.instance.BpmnModelElementInstance

getScope, isScope

Methods inherited from interface org.finos.fluxnova.bpm.model.bpmn.instance.FlowElement

getAuditing, getCategoryValueRefs, getMonitoring, getName, setAuditing, setMonitoring, setName

Methods inherited from interface org.finos.fluxnova.bpm.model.bpmn.instance.FlowNode

getFluxnovaJobPriority, getIncoming, getOutgoing, getPreviousNodes, getSucceedingNodes, isFluxnovaAsyncAfter, isFluxnovaAsyncBefore, isFluxnovaExclusive, setFluxnovaAsyncAfter, setFluxnovaAsyncBefore, setFluxnovaExclusive, setFluxnovaJobPriority

Methods inherited from interface org.finos.fluxnova.bpm.model.bpmn.instance.InteractionNode

getId, setId

Methods inherited from interface org.finos.fluxnova.bpm.model.xml.instance.ModelElementInstance

addChildElement, getAttributeValue, getAttributeValueNs, getChildElementsByType, getChildElementsByType, getDomElement, getElementType, getModelInstance, getParentElement, getRawTextContent, getTextContent, getUniqueChildElementByNameNs, getUniqueChildElementByType, insertElementAfter, removeAttribute, removeAttributeNs, removeChildElement, replaceChildElement, replaceWithElement, setAttributeValue, setAttributeValue, setAttributeValue, setAttributeValueNs, setAttributeValueNs, setAttributeValueNs, setTextContent, setUniqueChildElementByNameNs, updateAfterReplacement

Methods inherited from interface org.finos.fluxnova.bpm.model.bpmn.instance.SubProcess

builder, getArtifacts, getFlowElements, getLaneSets, isFluxnovaAsync, setFluxnovaAsync, setTriggeredByEvent, triggeredByEvent

Method Details

getOrdering

String getOrdering()

Returns the BPMN ordering attribute of the ad-hoc activities. Typical values are "Parallel" (default) and "Sequential".

This is model metadata. In the current engine implementation, ad-hoc runtime activation is parallel-only and "Sequential" is not enforced as execution behavior.

setOrdering

void setOrdering(String ordering)

isCancelRemainingInstances

boolean isCancelRemainingInstances()

If true (default), when the completionCondition is met, any remaining running Activity instances within the Ad-Hoc Sub-Process will be cancelled.

setCancelRemainingInstances

void setCancelRemainingInstances(boolean cancelRemainingInstances)

getCompletionCondition

CompletionCondition getCompletionCondition()

The Expression that, when evaluated to true, signals that the Ad-Hoc Sub-Process should complete.

setCompletionCondition

void setCompletionCondition(CompletionCondition completionCondition)