Package io.camunda.zeebe.protocol.record.value

Interface ProcessInstanceModificationRecordValue.ProcessInstanceModificationActivateInstructionValue

All Known Implementing Classes:

ImmutableProcessInstanceModificationActivateInstructionValue

Enclosing interface:

ProcessInstanceModificationRecordValue

@Immutable
public static interface ProcessInstanceModificationRecordValue.ProcessInstanceModificationActivateInstructionValue

Method Summary

Modifier and Type	Method	Description
long	getAncestorScopeKey()	Returns the key of the ancestor scope to create the new element instance in, or -1 if no specific ancestor is selected.
Set<Long>	getAncestorScopeKeys()	Returns all ancestor scope keys of the element that will be activated.
String	getElementId()	Returns the id of the element to create a new element instance at.
List<ProcessInstanceModificationRecordValue.ProcessInstanceModificationVariableInstructionValue>	getVariableInstructions()	Returns a list of variable instructions (if available), or an empty list.

Method Details

getElementId

String getElementId()

Returns the id of the element to create a new element instance at.

getAncestorScopeKey

long getAncestorScopeKey()

Returns the key of the ancestor scope to create the new element instance in, or -1 if no specific ancestor is selected.

This key is used for ancestor selection:

By default, the new element instance is created within an existing element instance of the flow scope. For example, when activating an element inside an embedded subprocess and the subprocess is already active.

If there is more than one element instance of the flow scope active then the engine can't decide which element instance to create the new element instance in. Instead, the element instance must be selected by its element instance key. The new element instance is created within the selected element instance.

If the selected element instance is not of the flow scope but from a higher scope (e.g. the process instance key instead of the element instance key of the subprocess) then the engine creates a new element instance of the flow scope first and then creates the new element instance within this scope.

getVariableInstructions

List<ProcessInstanceModificationRecordValue.ProcessInstanceModificationVariableInstructionValue> getVariableInstructions()

Returns a list of variable instructions (if available), or an empty list.

getAncestorScopeKeys

Set<Long> getAncestorScopeKeys()

Returns all ancestor scope keys of the element that will be activated. The property is set in the event only after the modification is applied.