T - The generated multi instance scope handler type.public class MultiInstanceScopeHandler<T extends MultiInstanceScopeHandler<?>> extends Object
| Modifier and Type | Field and Description |
|---|---|
protected TestCaseInstance |
instance |
| Constructor and Description |
|---|
MultiInstanceScopeHandler(TestCaseInstance instance,
String activityId) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
apply(org.camunda.bpm.engine.runtime.ProcessInstance pi) |
protected boolean |
apply(org.camunda.bpm.engine.runtime.ProcessInstance pi,
int loopIndex)
Applies the multi instance loop for the given index.
|
T |
customize(Consumer<MultiInstanceScopeHandler<T>> customizer)
Customizes the handler, using the given
Consumer function. |
T |
execute(int loopIndex,
BiFunction<org.camunda.bpm.engine.test.assertions.bpmn.ProcessInstanceAssert,Integer,Boolean> action)
Executes a custom action, which handles the activities within the scope, for a given loop index.
|
protected org.camunda.bpm.engine.ProcessEngine |
getProcessEngine() |
protected void |
handleAsyncBefore(org.camunda.bpm.engine.runtime.ProcessInstance pi,
int loopIndex) |
protected boolean |
isEnded(org.camunda.bpm.engine.runtime.ProcessInstance pi)
Checks if the multi instance scope is ended or not.
|
protected boolean |
isSequential()
Determines if the multi instance loop is sequentially executed or not.
|
protected void |
registerCallActivityHandler(String activityId,
CallActivityHandler handler)
Registers the given call activity handler at the test case instance, so that it will be executed
when the custom call activity behavior is applied.
Since there can be multiple handlers (one for each loop index), it is necessary to register the correct one before the next multi instance loop is executed. |
T |
verify(int loopIndex,
BiConsumer<org.camunda.bpm.engine.test.assertions.bpmn.ProcessInstanceAssert,Integer> verifier)
Verifies the state before the multi instance loop with the given index is executed.
|
T |
verifyLoopCount(int loopCount)
Verifies that the multi instance loop is executed n-times.
|
T |
verifyParallel()
Verifies that the multi instance loop execution is done in parallel.
|
T |
verifySequential()
Verifies that the multi instance loop is sequentially executed.
|
protected final TestCaseInstance instance
public MultiInstanceScopeHandler(TestCaseInstance instance, String activityId)
protected void apply(org.camunda.bpm.engine.runtime.ProcessInstance pi)
protected boolean apply(org.camunda.bpm.engine.runtime.ProcessInstance pi,
int loopIndex)
pi - The process instance, used to execute the test case.loopIndex - The current loop index.true, if the multi instance execution should be continued. Otherwise
false.public T customize(Consumer<MultiInstanceScopeHandler<T>> customizer)
Consumer function. This method can be used to
apply a common customization needed for different test cases.
tc.handleMultiInstanceScope().customize(this::prepareMultiInstanceScope);
customizer - A function that accepts a suitable MultiInstanceScopeHandler.public T execute(int loopIndex, BiFunction<org.camunda.bpm.engine.test.assertions.bpmn.ProcessInstanceAssert,Integer,Boolean> action)
loopIndex - A specific loop index (>= 0).action - A specific action that accepts the related process instance as
ProcessInstanceAssert and the loop index. It returns a boolean value that
indicates if the multi instance loop should be continued or not (e.g. in case of a
boundary event that will be triggered afterwards).protected org.camunda.bpm.engine.ProcessEngine getProcessEngine()
protected void handleAsyncBefore(org.camunda.bpm.engine.runtime.ProcessInstance pi,
int loopIndex)
protected boolean isEnded(org.camunda.bpm.engine.runtime.ProcessInstance pi)
pi - The related process instance.true, if the multi instance scope is ended. Otherwise false.protected boolean isSequential()
true, if execution is done sequentially. false, if execution is done in
parallel.protected void registerCallActivityHandler(String activityId, CallActivityHandler handler)
activityId - The ID of the call activity.handler - The call activity handler to be executed next.public T verify(int loopIndex, BiConsumer<org.camunda.bpm.engine.test.assertions.bpmn.ProcessInstanceAssert,Integer> verifier)
loopIndex - A specific loop index (>= 0).verifier - Verifier that accepts an ProcessInstanceAssert and the loop index.public T verifyLoopCount(int loopCount)
loopCount - The expected loop count at the point of time when the multi instance scope is
left (finished or terminated by a boundary event).public T verifyParallel()
public T verifySequential()
Copyright © 2023 Camunda. All rights reserved.