Package io.camunda.client.impl.command

Class ActivateAdHocSubProcessActivitiesCommandImpl

java.lang.Object

io.camunda.client.impl.command.CommandWithVariables<ActivateAdHocSubProcessActivitiesCommandStep1.ActivateAdHocSubProcessActivitiesCommandStep2>

io.camunda.client.impl.command.ActivateAdHocSubProcessActivitiesCommandImpl

All Implemented Interfaces:

ActivateAdHocSubProcessActivitiesCommandStep1, ActivateAdHocSubProcessActivitiesCommandStep1.ActivateAdHocSubProcessActivitiesCommandStep2, CommandWithVariables<ActivateAdHocSubProcessActivitiesCommandStep1.ActivateAdHocSubProcessActivitiesCommandStep2>, FinalCommandStep<ActivateAdHocSubProcessActivitiesResponse>

public final class ActivateAdHocSubProcessActivitiesCommandImpl
extends CommandWithVariables<ActivateAdHocSubProcessActivitiesCommandStep1.ActivateAdHocSubProcessActivitiesCommandStep2>
implements ActivateAdHocSubProcessActivitiesCommandStep1, ActivateAdHocSubProcessActivitiesCommandStep1.ActivateAdHocSubProcessActivitiesCommandStep2

Nested Class Summary

Nested classes/interfaces inherited from interface io.camunda.client.api.command.ActivateAdHocSubProcessActivitiesCommandStep1

ActivateAdHocSubProcessActivitiesCommandStep1.ActivateAdHocSubProcessActivitiesCommandStep2

Field Summary

Fields inherited from class io.camunda.client.impl.command.CommandWithVariables

objectMapper

Constructor Summary

Constructors

Constructor	Description
ActivateAdHocSubProcessActivitiesCommandImpl(HttpClient httpClient, JsonMapper jsonMapper, String adHocSubProcessInstanceKey)

Method Summary

Modifier and Type	Method	Description
ActivateAdHocSubProcessActivitiesCommandStep1.ActivateAdHocSubProcessActivitiesCommandStep2	activateElement(String elementId)	Create an AdHocSubProcessActivateActivitiesInstruction for the given element id.
ActivateAdHocSubProcessActivitiesCommandStep1.ActivateAdHocSubProcessActivitiesCommandStep2	activateElement(String elementId, Map<String,Object> variables)	Create an AdHocSubProcessActivateActivitiesInstruction for the given element id with variables.
ActivateAdHocSubProcessActivitiesCommandStep1.ActivateAdHocSubProcessActivitiesCommandStep2	cancelRemainingInstances(boolean cancelRemainingInstances)	Set whether to cancel remaining instances of the ad-hoc sub-process.
FinalCommandStep<ActivateAdHocSubProcessActivitiesResponse>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
CamundaFuture<ActivateAdHocSubProcessActivitiesResponse>	send()	Sends the command to the Camunda gateway.
protected ActivateAdHocSubProcessActivitiesCommandStep1.ActivateAdHocSubProcessActivitiesCommandStep2	setVariablesInternal(String variables)

Methods inherited from class io.camunda.client.impl.command.CommandWithVariables

variable, variables, variables, variables, variables

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.ActivateAdHocSubProcessActivitiesCommandStep1

activateElements, activateElements

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

variable, variables, variables, variables, variables

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

execute

Constructor Details

ActivateAdHocSubProcessActivitiesCommandImpl

public ActivateAdHocSubProcessActivitiesCommandImpl(HttpClient httpClient,
 JsonMapper jsonMapper,
 String adHocSubProcessInstanceKey)

Method Details

activateElement

public ActivateAdHocSubProcessActivitiesCommandStep1.ActivateAdHocSubProcessActivitiesCommandStep2 activateElement(String elementId)

Description copied from interface: ActivateAdHocSubProcessActivitiesCommandStep1

Create an AdHocSubProcessActivateActivitiesInstruction for the given element id.

Specified by:

activateElement in interface ActivateAdHocSubProcessActivitiesCommandStep1

Parameters:

elementId - the id of the element to activate

Returns:

the builder for this command

activateElement

public ActivateAdHocSubProcessActivitiesCommandStep1.ActivateAdHocSubProcessActivitiesCommandStep2 activateElement(String elementId,
 Map<String,Object> variables)

Description copied from interface: ActivateAdHocSubProcessActivitiesCommandStep1

Create an AdHocSubProcessActivateActivitiesInstruction for the given element id with variables.

Specified by:

activateElement in interface ActivateAdHocSubProcessActivitiesCommandStep1

Parameters:

elementId - the id of the element to activate

variables - variables to be set when activating the element

Returns:

the builder for this command

cancelRemainingInstances

public ActivateAdHocSubProcessActivitiesCommandStep1.ActivateAdHocSubProcessActivitiesCommandStep2 cancelRemainingInstances(boolean cancelRemainingInstances)

Description copied from interface: ActivateAdHocSubProcessActivitiesCommandStep1

Set whether to cancel remaining instances of the ad-hoc sub-process.

Specified by:

cancelRemainingInstances in interface ActivateAdHocSubProcessActivitiesCommandStep1

Parameters:

cancelRemainingInstances - true to cancel remaining instances, false otherwise

Returns:

the builder for this command

requestTimeout

public FinalCommandStep<ActivateAdHocSubProcessActivitiesResponse> 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<ActivateAdHocSubProcessActivitiesResponse>

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

public CamundaFuture<ActivateAdHocSubProcessActivitiesResponse> 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<ActivateAdHocSubProcessActivitiesResponse>

Returns:

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

setVariablesInternal

protected ActivateAdHocSubProcessActivitiesCommandStep1.ActivateAdHocSubProcessActivitiesCommandStep2 setVariablesInternal(String variables)

Specified by:

setVariablesInternal in class CommandWithVariables<ActivateAdHocSubProcessActivitiesCommandStep1.ActivateAdHocSubProcessActivitiesCommandStep2>