HistoricDecisionInstance (Camunda BPM Javadocs 7.13.0-SNAPSHOT)

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 and Description
`String`	`getActivityId()` The corresponding activity in case the decision was evaluated inside a process or a case.
`String`	`getActivityInstanceId()` The corresponding activity instance in case the decision was evaluated inside a process or a case.
`String`	`getCaseDefinitionId()` The corresponding id of the case definition in case the decision was evaluated inside a case.
`String`	`getCaseDefinitionKey()` The corresponding key of the case definition in case the decision was evaluated inside a case.
`String`	`getCaseInstanceId()` The corresponding case instance in case the decision was evaluated inside a case.
`Double`	`getCollectResultValue()` The result of the collect operation if the hit policy 'collect' was used for the decision.
`String`	`getDecisionDefinitionId()` The decision definition reference.
`String`	`getDecisionDefinitionKey()` The unique identifier of the decision definition
`String`	`getDecisionDefinitionName()` The name of the decision definition
`String`	`getDecisionRequirementsDefinitionId()` The id of the related decision requirements definition.
`String`	`getDecisionRequirementsDefinitionKey()` The key of the related decision requirements definition.
`Date`	`getEvaluationTime()` Time when the decision was evaluated.
`String`	`getId()` The unique identifier of this historic decision instance.
`List<HistoricDecisionInputInstance>`	`getInputs()` The input values of the evaluated decision.
`List<HistoricDecisionOutputInstance>`	`getOutputs()` The output values of the evaluated decision.
`String`	`getProcessDefinitionId()` The corresponding id of the process definition in case the decision was evaluated inside a process.
`String`	`getProcessDefinitionKey()` The corresponding key of the process definition in case the decision was evaluated inside a process.
`String`	`getProcessInstanceId()` The corresponding process instance in case the decision was evaluated inside a process.
`Date`	`getRemovalTime()` Time when the historic decision instance is to be removed.
`String`	`getRootDecisionInstanceId()` The unique identifier of the historic decision instance of the evaluated root decision.
`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`.
`String`	`getTenantId()` The id of the tenant this historic decision instance belongs to.
`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
```
String getId()
```
    The unique identifier of this historic decision instance.
  - getDecisionDefinitionId
```
String getDecisionDefinitionId()
```
    The decision definition reference.
  - getDecisionDefinitionKey
```
String getDecisionDefinitionKey()
```
    The unique identifier of the decision definition
  - getDecisionDefinitionName
```
String getDecisionDefinitionName()
```
    The name of the decision definition
  - getEvaluationTime
```
Date getEvaluationTime()
```
    Time when the decision was evaluated.
  - getRemovalTime
```
Date getRemovalTime()
```
    Time when the historic decision instance is to be removed.
  - getProcessDefinitionKey
```
String getProcessDefinitionKey()
```
    The corresponding key of the process definition in case the decision was evaluated inside a process.
  - getProcessDefinitionId
```
String getProcessDefinitionId()
```
    The corresponding id of the process definition in case the decision was evaluated inside a process.
  - getProcessInstanceId
```
String getProcessInstanceId()
```
    The corresponding process instance in case the decision was evaluated inside a process.
  - getCaseDefinitionKey
```
String getCaseDefinitionKey()
```
    The corresponding key of the case definition in case the decision was evaluated inside a case.
  - getCaseDefinitionId
```
String getCaseDefinitionId()
```
    The corresponding id of the case definition in case the decision was evaluated inside a case.
  - getCaseInstanceId
```
String getCaseInstanceId()
```
    The corresponding case instance in case the decision was evaluated inside a case.
  - getActivityId
```
String getActivityId()
```
    The corresponding activity in case the decision was evaluated inside a process or a case.
  - getActivityInstanceId
```
String getActivityInstanceId()
```
    The corresponding activity instance in case the decision was evaluated inside a process or a case.
  - getUserId
```
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
```
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:
    
    HistoricDecisionInstanceQuery.includeInputs()
  - getOutputs
```
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:
    
    HistoricDecisionInstanceQuery.includeOutputs()
  - getCollectResultValue
```
Double getCollectResultValue()
```
    The result of the collect operation if the hit policy 'collect' was used for the decision.
  - getRootDecisionInstanceId
```
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
```
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
```
String getDecisionRequirementsDefinitionId()
```
    The id of the related decision requirements definition. Can be null if the decision has no relations to other decisions.
  - getDecisionRequirementsDefinitionKey
```
String getDecisionRequirementsDefinitionKey()
```
    The key of the related decision requirements definition. Can be null if the decision has no relations to other decisions.
  - getTenantId
```
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.

Interface HistoricDecisionInstance

Method Summary

Method Detail

getId

getDecisionDefinitionId

getDecisionDefinitionKey

getDecisionDefinitionName

getEvaluationTime

getRemovalTime

getProcessDefinitionKey

getProcessDefinitionId

getProcessInstanceId

getCaseDefinitionKey

getCaseDefinitionId

getCaseInstanceId

getActivityId

getActivityInstanceId

getUserId

getInputs

getOutputs

getCollectResultValue

getRootDecisionInstanceId

getRootProcessInstanceId

getDecisionRequirementsDefinitionId

getDecisionRequirementsDefinitionKey

getTenantId