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

Interface DecisionEvaluationRecordValue

All Superinterfaces:
JsonSerializable, RecordValue, RecordValueWithVariables
All Known Implementing Classes:
ImmutableDecisionEvaluationRecordValue
@Immutable public interface DecisionEvaluationRecordValue extends RecordValue, RecordValueWithVariables
Represents the evaluation of a DMN decision.

  • Method Details

    • getDecisionKey

      long getDecisionKey()
      Returns:
      the key of the evaluated decision

    • getDecisionId

      String getDecisionId()
      Returns:
      the id of the evaluated decision in the DMN

    • getDecisionName

      String getDecisionName()
      Returns:
      the name of the evaluated decision in the DMN

    • getDecisionVersion

      int getDecisionVersion()
      Returns:
      the version of the evaluated decision

    • getDecisionRequirementsId

      String getDecisionRequirementsId()
      Returns:
      the id of the DRG in the DMN the evaluated decision belongs to

    • getDecisionRequirementsKey

      long getDecisionRequirementsKey()
      Returns:
      the key of the deployed DRG the evaluated decision belongs to

    • getDecisionOutput

      String getDecisionOutput()
      Returns:
      the output of the evaluated decision as JSON string

    • getBpmnProcessId

      String getBpmnProcessId()
      Returns:
      the BPMN process id in which context the decision was evaluated

    • getProcessDefinitionKey

      long getProcessDefinitionKey()
      Returns:
      the key of the process in which context the decision was evaluated

    • getProcessInstanceKey

      long getProcessInstanceKey()
      Returns:
      the key of the process instance in which context the decision was evaluated

    • getElementId

      String getElementId()
      Returns:
      the id of the element in the BPMN in which context the decision was evaluated

    • getElementInstanceKey

      long getElementInstanceKey()
      Returns:
      the key of the element instance in which context the decision was evaluated

    • getEvaluatedDecisions

      List<EvaluatedDecisionValue> getEvaluatedDecisions()
      Returns the details of the evaluated decision and its required decisions. The order depends on the evaluation order, starting from the required decisions.
      Returns:
      details of the evaluated decisions

    • getEvaluationFailureMessage

      String getEvaluationFailureMessage()
      If the evaluation of the decision failed then it returns the reason why the evaluation of the failed decision was not successful. The failure message is not available if the decision was evaluated successfully.
      Returns:
      the failure message why the evaluation failed, or an empty string if the evaluation was successful

    • getFailedDecisionId

      String getFailedDecisionId()
      If the evaluation of the decision failed then it returns the id of the decision where the evaluation failed. It can be the called/root decision or any of its required decisions. The reason of the failure can be retrieved as evaluation failure message. The decision id is not available if the decision was evaluated successfully.
      Returns:
      the id of the decision in the DMN where the evaluation failed, or an empty string if the evaluation was successful