Package io.camunda.client.api.command

Interface ModifyProcessInstanceCommandStep1

All Superinterfaces:

CommandWithCommunicationApiStep<ModifyProcessInstanceCommandStep1>

All Known Implementing Classes:

ModifyProcessInstanceCommandImpl

public interface ModifyProcessInstanceCommandStep1
extends CommandWithCommunicationApiStep<ModifyProcessInstanceCommandStep1>

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep2
static interface	ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3

Method Summary

Modifier and Type	Method	Description
ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3	activateElement(String elementId)	Create an GatewayOuterClass.ModifyProcessInstanceRequest.ActivateInstruction for the given element id.
ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3	activateElement(String elementId, long ancestorElementInstanceKey)	Create an GatewayOuterClass.ModifyProcessInstanceRequest.ActivateInstruction for the given element id.
ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep2	terminateElement(long elementInstanceKey)	Create a GatewayOuterClass.ModifyProcessInstanceRequest.TerminateInstruction for the given element id.

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

useGrpc, useRest

Method Details

activateElement

ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3 activateElement(String elementId)

Create an GatewayOuterClass.ModifyProcessInstanceRequest.ActivateInstruction for the given element id. The element will be created within an existing element instance of the flow scope. When activating an element inside a multi-instance element the element instance key of the ancestor must be defined. For this use activateElement(String, long).

Parameters:

elementId - the id of the element to activate

Returns:

the builder for this command

activateElement

ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3 activateElement(String elementId,
 long ancestorElementInstanceKey)

Create an GatewayOuterClass.ModifyProcessInstanceRequest.ActivateInstruction for the given element id. The element will be created within the scope that is passed. This scope must be an ancestor of the element that's getting activated.

Parameters:

elementId - the id of the element to activate

ancestorElementInstanceKey - the element instance key in which the element will be created

Returns:

the builder for this command

terminateElement

ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep2 terminateElement(long elementInstanceKey)

Create a GatewayOuterClass.ModifyProcessInstanceRequest.TerminateInstruction for the given element id.

Parameters:

elementInstanceKey - the element instance key of the element to termiante

Returns:

the builder for this command