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

Interface IncidentRecordValue

All Superinterfaces:
JsonSerializable, ProcessInstanceRelated, RecordValue, TenantOwned
All Known Implementing Classes:
ImmutableIncidentRecordValue
@Immutable public interface IncidentRecordValue extends RecordValue, ProcessInstanceRelated, TenantOwned
Represents a process incident.

See IncidentIntent for intents.

  • Method Details

    • getErrorType

      ErrorType getErrorType()
      Returns:
      the type of error this incident is caused by. Can be UNKNOWN if the incident record is part of a IncidentIntent.RESOLVE command.

    • getErrorMessage

      String getErrorMessage()
      Returns:
      the description of the error this incident is caused by. Can be empty if the incident record is part of a IncidentIntent.RESOLVE command.

    • getBpmnProcessId

      String getBpmnProcessId()
      Returns:
      the BPMN process id this incident belongs to. Can be empty if the incident record is part of a IncidentIntent.RESOLVE command.

    • getProcessDefinitionKey

      long getProcessDefinitionKey()
      Returns:
      the key of the process this incident belongs to. Can be -1 if the incident record is part of a IncidentIntent.RESOLVE command.

    • getProcessInstanceKey

      long getProcessInstanceKey()
      Specified by:
      getProcessInstanceKey in interface ProcessInstanceRelated
      Returns:
      the key of the process instance this incident belongs to. Can be -1 if the incident record is part of a IncidentIntent.RESOLVE command.

    • getElementId

      String getElementId()
      Returns:
      the id of the element this incident belongs to. Can be empty if incident record is part of a IncidentIntent.RESOLVE command.

    • getElementInstanceKey

      long getElementInstanceKey()
      Returns:
      the key of the element instance this incident belongs to. Can be -1 if the incident record is part of a IncidentIntent.RESOLVE command.

    • getJobKey

      long getJobKey()
      Returns:
      the key of the job this incident belongs to. Can be -1 if the incident belongs to no job or the incident record is part of a IncidentIntent.RESOLVE command.

    • getVariableScopeKey

      long getVariableScopeKey()
      Returns:
      the key of the variable scope on which the variables need to be updated. Can be -1 if the incident record is part of a IncidentIntent.RESOLVE command.

    • getElementInstancePath

      List<List<Long>> getElementInstancePath()
      Returns:
      tree path information about all element instances in the call hierarchy leading to an incident. It contains an entry per process instance in the hierarchy of the incident, each contains all the instance keys of all the elements in the call hierarchy within this process instance

    • getProcessDefinitionPath

      List<Long> getProcessDefinitionPath()
      Returns:
      tree path information for all process definitions in the hierarchy of the incident. Each entry is a process definition key for the corresponding process instance

    • getCallingElementPath

      List<Integer> getCallingElementPath()
      Returns:
      tree path information about call activities in the hierarchy of the incident. Each entry is a reference to the call activity in BPMN model containing an incident.