Package io.camunda.client.impl.command

Class CreateBatchOperationCommandImpl<E extends TypedFilterableRequest.SearchRequestFilter>

java.lang.Object

io.camunda.client.impl.command.CreateBatchOperationCommandImpl<E>

All Implemented Interfaces:

CreateBatchOperationCommandStep1.CreateBatchOperationCommandStep2<E>, CreateBatchOperationCommandStep1.CreateBatchOperationCommandStep3<E>, CreateBatchOperationCommandStep1.ProcessInstanceMigrationStep<E>, CreateBatchOperationCommandStep1.ProcessInstanceModificationStep<E>, FinalCommandStep<CreateBatchOperationResponse>

public class CreateBatchOperationCommandImpl<E extends TypedFilterableRequest.SearchRequestFilter>
extends Object
implements CreateBatchOperationCommandStep1.ProcessInstanceMigrationStep<E>, CreateBatchOperationCommandStep1.CreateBatchOperationCommandStep2<E>, CreateBatchOperationCommandStep1.ProcessInstanceModificationStep<E>, CreateBatchOperationCommandStep1.CreateBatchOperationCommandStep3<E>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CreateBatchOperationCommandImpl.CreateBatchOperationCommandStep1Impl

Constructor Summary

Constructors

Constructor	Description
CreateBatchOperationCommandImpl(HttpClient httpClient, JsonMapper jsonMapper, BatchOperationTypeEnum type, Function<Consumer<E>,E> filterFactory)

Method Summary

Modifier and Type	Method	Description
CreateBatchOperationCommandStep1.ProcessInstanceMigrationStep<E>	addMappingInstruction(String sourceElementId, String targetElementId)	Adds a single migration mapping instruction to the command.
CreateBatchOperationCommandStep1.ProcessInstanceModificationStep<E>	addMoveInstruction(String sourceElementId, String targetElementId)	Adds a move instruction to the command.
CreateBatchOperationCommandStep1.CreateBatchOperationCommandStep3<E>	filter(E filter)	Sets the filter for the batch operation.
CreateBatchOperationCommandStep1.CreateBatchOperationCommandStep3<E>	filter(Consumer<E> fn)	Sets the filter for the batch operation.
CreateBatchOperationCommandStep1.ProcessInstanceMigrationStep<E>	migrationPlan(MigrationPlan migrationPlan)	Sets the whole migration plan for the batch operation.
FinalCommandStep<CreateBatchOperationResponse>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
CamundaFuture<CreateBatchOperationResponse>	send()	Sends the command to the Camunda gateway.
CreateBatchOperationCommandStep1.ProcessInstanceMigrationStep<E>	targetProcessDefinitionKey(long targetProcessDefinitionKey)	Sets the target process definition key for the migration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.camunda.client.api.command.FinalCommandStep

execute

Constructor Details

CreateBatchOperationCommandImpl

public CreateBatchOperationCommandImpl(HttpClient httpClient,
 JsonMapper jsonMapper,
 BatchOperationTypeEnum type,
 Function<Consumer<E>,E> filterFactory)

Method Details

filter

public CreateBatchOperationCommandStep1.CreateBatchOperationCommandStep3<E> filter(E filter)

Description copied from interface: CreateBatchOperationCommandStep1.CreateBatchOperationCommandStep2

Sets the filter for the batch operation.

Specified by:

filter in interface CreateBatchOperationCommandStep1.CreateBatchOperationCommandStep2<E extends TypedFilterableRequest.SearchRequestFilter>

Parameters:

filter - the filter to use

Returns:

the builder for fluent use

filter

public CreateBatchOperationCommandStep1.CreateBatchOperationCommandStep3<E> filter(Consumer<E> fn)

Description copied from interface: CreateBatchOperationCommandStep1.CreateBatchOperationCommandStep2

Sets the filter for the batch operation. Uses a consumer to modify the default filter.

Specified by:

filter in interface CreateBatchOperationCommandStep1.CreateBatchOperationCommandStep2<E extends TypedFilterableRequest.SearchRequestFilter>

Parameters:

fn - the filter to use

Returns:

the builder for fluent use

addMoveInstruction

public CreateBatchOperationCommandStep1.ProcessInstanceModificationStep<E> addMoveInstruction(String sourceElementId,
 String targetElementId)

Description copied from interface: CreateBatchOperationCommandStep1.ProcessInstanceModificationStep

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

Specified by:

addMoveInstruction in interface CreateBatchOperationCommandStep1.ProcessInstanceModificationStep<E extends TypedFilterableRequest.SearchRequestFilter>

Returns:

Returns a list of move instructions

requestTimeout

public FinalCommandStep<CreateBatchOperationResponse> requestTimeout(Duration requestTimeout)

Description copied from interface: FinalCommandStep

Sets the request timeout for the command. The default request timeout can be configured using CamundaClientBuilder.defaultRequestTimeout(Duration).

Specified by:

requestTimeout in interface FinalCommandStep<E extends TypedFilterableRequest.SearchRequestFilter>

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

public CamundaFuture<CreateBatchOperationResponse> send()

Description copied from interface: FinalCommandStep

Sends the command to the Camunda gateway. This operation is asynchronous. In case of success, the future returns the event that was generated by the Camunda gateway in response to the command.

Call CamundaFuture.join() to wait until the response is available.

 Future<JobEventinvalid input: '&#62' future = command.send();
 JobEvent event = future.join();
 

Specified by:

send in interface FinalCommandStep<E extends TypedFilterableRequest.SearchRequestFilter>

Returns:

a future tracking state of success/failure of the command.

migrationPlan

public CreateBatchOperationCommandStep1.ProcessInstanceMigrationStep<E> migrationPlan(MigrationPlan migrationPlan)

Description copied from interface: CreateBatchOperationCommandStep1.ProcessInstanceMigrationStep

Sets the whole migration plan for the batch operation. The migration plan contains the detailed instructions how to migrate single active elements from the source process definition to the target process definition.

Specified by:

migrationPlan in interface CreateBatchOperationCommandStep1.ProcessInstanceMigrationStep<E extends TypedFilterableRequest.SearchRequestFilter>

Parameters:

migrationPlan - the migration plan to use for the batch operation

Returns:

the builder for fluent use

addMappingInstruction

public CreateBatchOperationCommandStep1.ProcessInstanceMigrationStep<E> addMappingInstruction(String sourceElementId,
 String targetElementId)

Description copied from interface: CreateBatchOperationCommandStep1.ProcessInstanceMigrationStep

Adds a single migration mapping instruction to the command.

Specified by:

addMappingInstruction in interface CreateBatchOperationCommandStep1.ProcessInstanceMigrationStep<E extends TypedFilterableRequest.SearchRequestFilter>

Parameters:

sourceElementId - the id of the source element to migrate

targetElementId - the id of the target element to migrate into

Returns:

the builder for fluent use

targetProcessDefinitionKey

public CreateBatchOperationCommandStep1.ProcessInstanceMigrationStep<E> targetProcessDefinitionKey(long targetProcessDefinitionKey)

Description copied from interface: CreateBatchOperationCommandStep1.ProcessInstanceMigrationStep

Sets the target process definition key for the migration.

Specified by:

targetProcessDefinitionKey in interface CreateBatchOperationCommandStep1.ProcessInstanceMigrationStep<E extends TypedFilterableRequest.SearchRequestFilter>

Parameters:

targetProcessDefinitionKey - the key of the target process definition to migrate to

Returns:

the builder for fluent use