Package org.eximeebpms.bpm.engine.history

Interface HistoricDecisionInstance

All Known Implementing Classes:
HistoricDecisionInstanceEntity
public interface HistoricDecisionInstance
Represents one evaluation of a decision.
Author:
Philipp Ossler, Ingo Richtsmeier

  • Method Details Link icon

    • getId Link icon

      String getId()
      The unique identifier of this historic decision instance.

    • getDecisionDefinitionId Link icon

      String getDecisionDefinitionId()
      The decision definition reference.

    • getDecisionDefinitionKey Link icon

      String getDecisionDefinitionKey()
      The unique identifier of the decision definition

    • getDecisionDefinitionName Link icon

      String getDecisionDefinitionName()
      The name of the decision definition

    • getEvaluationTime Link icon

      Date getEvaluationTime()
      Time when the decision was evaluated.

    • getRemovalTime Link icon

      Date getRemovalTime()
      Time when the historic decision instance is to be removed.

    • getProcessDefinitionKey Link icon

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

    • getProcessDefinitionId Link icon

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

    • getProcessInstanceId Link icon

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

    • getCaseDefinitionKey Link icon

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

    • getCaseDefinitionId Link icon

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

    • getCaseInstanceId Link icon

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

    • getActivityId Link icon

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

    • getActivityInstanceId Link icon

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

    • getUserId Link icon

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

    • getInputs Link icon

      List<HistoricDecisionInputInstance> getInputs()
      The input values of the evaluated decision. The fetching of the input values must be enabled on the query.
      Throws:
      ProcessEngineException - if the input values are not fetched.
      See Also:

    • getOutputs Link icon

      List<HistoricDecisionOutputInstance> getOutputs()
      The output values of the evaluated decision. The fetching of the output values must be enabled on the query.
      Throws:
      ProcessEngineException - if the output values are not fetched.
      See Also:

    • getCollectResultValue Link icon

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

    • getRootDecisionInstanceId Link icon

      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 Link icon

      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 Link icon

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

    • getDecisionRequirementsDefinitionKey Link icon

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

    • getTenantId Link icon

      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.