Package io.camunda.client.api.command

Interface CreateBatchOperationCommandStep1.ProcessInstanceModificationStep<E extends TypedSearchRequest.SearchRequestFilter>

All Superinterfaces:
CreateBatchOperationCommandStep1.CreateBatchOperationCommandStep2<E>
All Known Implementing Classes:
CreateBatchOperationCommandImpl
Enclosing interface:
CreateBatchOperationCommandStep1
public static interface CreateBatchOperationCommandStep1.ProcessInstanceModificationStep<E extends TypedSearchRequest.SearchRequestFilter> extends CreateBatchOperationCommandStep1.CreateBatchOperationCommandStep2<E>

  • Method Details

    • addMoveInstruction

      CreateBatchOperationCommandStep1.ProcessInstanceModificationStep<E> addMoveInstruction(String sourceElementId, String targetElementId)
      Adds a move instruction to the command. These instructions will be applied to all matching sourceElementIds and create matching new targetElementId's tokens on all processInstances matching the filter.

      Example:
      Given a process instance with the following structure: 

         (start) -----> [ taskA ] -----> [ taskB ] ----> (end)
      A running processInstance has an active element taskA.

      When the following move instructions are applied:
      • sourceElementId: taskA, targetElementId: taskB
      Then taskA will be terminated and taskB will be activated.
      • move instructions, matching no active source element will have no effect on the processInstance
      • elements not matching any move instruction, will stay untouched
      • when the processInstance has more than one active instance of a sourceElement, all sourceElements will be terminated and for each terminated element a new targetElement will be activated
      Returns:
      Returns a list of move instructions