Interface HistoricDecisionInstance

  • All Known Implementing Classes:
    HistoricDecisionInstanceEntity

    public interface HistoricDecisionInstance
    Represents one evaluation of a decision.
    Author:
    Philipp Ossler, Ingo Richtsmeier
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getActivityId()
      The corresponding activity in case the decision was evaluated inside a process or a case.
      java.lang.String getActivityInstanceId()
      The corresponding activity instance in case the decision was evaluated inside a process or a case.
      java.lang.String getCaseDefinitionId()
      The corresponding id of the case definition in case the decision was evaluated inside a case.
      java.lang.String getCaseDefinitionKey()
      The corresponding key of the case definition in case the decision was evaluated inside a case.
      java.lang.String getCaseInstanceId()
      The corresponding case instance in case the decision was evaluated inside a case.
      java.lang.Double getCollectResultValue()
      The result of the collect operation if the hit policy 'collect' was used for the decision.
      java.lang.String getDecisionDefinitionId()
      The decision definition reference.
      java.lang.String getDecisionDefinitionKey()
      The unique identifier of the decision definition
      java.lang.String getDecisionDefinitionName()
      The name of the decision definition
      java.lang.String getDecisionRequirementsDefinitionId()
      The id of the related decision requirements definition.
      java.lang.String getDecisionRequirementsDefinitionKey()
      The key of the related decision requirements definition.
      java.util.Date getEvaluationTime()
      Time when the decision was evaluated.
      java.lang.String getId()
      The unique identifier of this historic decision instance.
      java.util.List<HistoricDecisionInputInstance> getInputs()
      The input values of the evaluated decision.
      java.util.List<HistoricDecisionOutputInstance> getOutputs()
      The output values of the evaluated decision.
      java.lang.String getProcessDefinitionId()
      The corresponding id of the process definition in case the decision was evaluated inside a process.
      java.lang.String getProcessDefinitionKey()
      The corresponding key of the process definition in case the decision was evaluated inside a process.
      java.lang.String getProcessInstanceId()
      The corresponding process instance in case the decision was evaluated inside a process.
      java.util.Date getRemovalTime()
      Time when the historic decision instance is to be removed.
      java.lang.String getRootDecisionInstanceId()
      The unique identifier of the historic decision instance of the evaluated root decision.
      java.lang.String getRootProcessInstanceId()
      The unique identifier of the root historic process instance of the evaluated root decision in case the decision was evaluated inside a process, otherwise null.
      java.lang.String getTenantId()
      The id of the tenant this historic decision instance belongs to.
      java.lang.String getUserId()
      The user ID in case the decision was evaluated by an authenticated user using the decision service outside of an execution context.
    • Method Detail

      • getId

        java.lang.String getId()
        The unique identifier of this historic decision instance.
      • getDecisionDefinitionId

        java.lang.String getDecisionDefinitionId()
        The decision definition reference.
      • getDecisionDefinitionKey

        java.lang.String getDecisionDefinitionKey()
        The unique identifier of the decision definition
      • getDecisionDefinitionName

        java.lang.String getDecisionDefinitionName()
        The name of the decision definition
      • getEvaluationTime

        java.util.Date getEvaluationTime()
        Time when the decision was evaluated.
      • getRemovalTime

        java.util.Date getRemovalTime()
        Time when the historic decision instance is to be removed.
      • getProcessDefinitionKey

        java.lang.String getProcessDefinitionKey()
        The corresponding key of the process definition in case the decision was evaluated inside a process.
      • getProcessDefinitionId

        java.lang.String getProcessDefinitionId()
        The corresponding id of the process definition in case the decision was evaluated inside a process.
      • getProcessInstanceId

        java.lang.String getProcessInstanceId()
        The corresponding process instance in case the decision was evaluated inside a process.
      • getCaseDefinitionKey

        java.lang.String getCaseDefinitionKey()
        The corresponding key of the case definition in case the decision was evaluated inside a case.
      • getCaseDefinitionId

        java.lang.String getCaseDefinitionId()
        The corresponding id of the case definition in case the decision was evaluated inside a case.
      • getCaseInstanceId

        java.lang.String getCaseInstanceId()
        The corresponding case instance in case the decision was evaluated inside a case.
      • getActivityId

        java.lang.String getActivityId()
        The corresponding activity in case the decision was evaluated inside a process or a case.
      • getActivityInstanceId

        java.lang.String getActivityInstanceId()
        The corresponding activity instance in case the decision was evaluated inside a process or a case.
      • getUserId

        java.lang.String getUserId()
        The user ID in case the decision was evaluated by an authenticated user using the decision service outside of an execution context.
      • getCollectResultValue

        java.lang.Double getCollectResultValue()
        The result of the collect operation if the hit policy 'collect' was used for the decision.
      • getRootDecisionInstanceId

        java.lang.String getRootDecisionInstanceId()
        The unique identifier of the historic decision instance of the evaluated root decision. Can be null if this instance is the root decision instance of the evaluation.
      • getRootProcessInstanceId

        java.lang.String getRootProcessInstanceId()
        The unique identifier of the root historic process instance of the evaluated root decision in case the decision was evaluated inside a process, otherwise null.
      • getDecisionRequirementsDefinitionId

        java.lang.String getDecisionRequirementsDefinitionId()
        The id of the related decision requirements definition. Can be null if the decision has no relations to other decisions.
      • getDecisionRequirementsDefinitionKey

        java.lang.String getDecisionRequirementsDefinitionKey()
        The key of the related decision requirements definition. Can be null if the decision has no relations to other decisions.
      • getTenantId

        java.lang.String getTenantId()
        The id of the tenant this historic decision instance belongs to. Can be null if the historic decision instance belongs to no single tenant.