Interface ModifyProcessInstanceCommandStep1
- All Known Implementing Classes:
ModifyProcessInstanceCommandImpl
public interface ModifyProcessInstanceCommandStep1
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic interface
static interface
-
Method Summary
Modifier and TypeMethodDescriptionactivateElement
(String elementId) Create anGatewayOuterClass.ModifyProcessInstanceRequest.ActivateInstruction
for the given element id.activateElement
(String elementId, long ancestorElementInstanceKey) Create anGatewayOuterClass.ModifyProcessInstanceRequest.ActivateInstruction
for the given element id.terminateElement
(long elementInstanceKey) Create aGatewayOuterClass.ModifyProcessInstanceRequest.TerminateInstruction
for the given element id.
-
Method Details
-
activateElement
ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3 activateElement(String elementId) Create anGatewayOuterClass.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 useactivateElement(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 anGatewayOuterClass.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 activateancestorElementInstanceKey
- the element instance key in which the element will be created- Returns:
- the builder for this command
-
terminateElement
ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep2 terminateElement(long elementInstanceKey) Create aGatewayOuterClass.ModifyProcessInstanceRequest.TerminateInstruction
for the given element id.- Parameters:
elementInstanceKey
- the element instance key of the element to termiante- Returns:
- the builder for this command
-