Package org.camunda.bpm.engine.history
Interface HistoricDecisionInstanceQuery
- All Superinterfaces:
Query<HistoricDecisionInstanceQuery,
HistoricDecisionInstance>
- All Known Implementing Classes:
HistoricDecisionInstanceQueryImpl
public interface HistoricDecisionInstanceQuery
extends Query<HistoricDecisionInstanceQuery,HistoricDecisionInstance>
Allows programmatic querying of
HistoricDecisionInstance
s.- Author:
- Philipp Ossler
-
Method Summary
Modifier and TypeMethodDescriptionactivityIdIn
(String... activityIds) Only select historic decision instances that are evaluated inside a process or a case which have one of the activity ids.activityInstanceIdIn
(String... activityInstanceIds) Only select historic decision instances that are evaluated inside a process or a case which have one of the activity instance ids.caseDefinitionId
(String caseDefinitionId) Only select historic decision instances that are evaluated inside a case with the given case definition id.caseDefinitionKey
(String caseDefinitionKey) Only select historic decision instances that are evaluated inside a case with the given case definition key.caseInstanceId
(String caseInstanceId) Only select historic decision instances that are evaluated inside a case with the given case instance id.decisionDefinitionId
(String decisionDefinitionId) Only select historic decision instances for the given decision definitiondecisionDefinitionIdIn
(String... decisionDefinitionIdIn) Only select historic decision instances for the given decision definitionsdecisionDefinitionKey
(String decisionDefinitionKey) Only select historic decision instances with the given key of the decision definition.decisionDefinitionKeyIn
(String... decisionDefinitionKeyIn) Only select historic decision instances with the given keys of the decision definition.decisionDefinitionName
(String decisionDefinitionName) Only select historic decision instances with the given name of the decision definition.decisionDefinitionNameLike
(String decisionDefinitionNameLike) Only select historic decision instances with the given name of the decision definition using LIKE construct.decisionInstanceId
(String decisionInstanceId) Only select historic decision instances with the given decision instance id.decisionInstanceIdIn
(String... decisionInstanceIdIn) Only select historic decision instances whose id is in the given list of ids.decisionRequirementsDefinitionId
(String decisionRequirementsDefinitionId) Only select historic decision instances that belongs to a decision requirements definition with the given id.decisionRequirementsDefinitionKey
(String decisionRequirementsDefinitionKey) Only select historic decision instances that belongs to a decision requirements definition with the given key.Disable fetching of byte array input and output values.Disable deserialization of input and output values that are custom objects.evaluatedAfter
(Date date) Only select historic decision instances that were evaluated after the given date.evaluatedBefore
(Date date) Only select historic decision instances that were evaluated before the given date.Enable fetchingHistoricDecisionInputInstance
of evaluated decision.Enable fetchingHistoricDecisionOutputInstance
of evaluated decision.Order by the time when the decisions was evaluated (needs to be followed byQuery.asc()
orQuery.desc()
).Order by tenant id (needs to be followed byQuery.asc()
orQuery.desc()
).processDefinitionId
(String processDefinitionId) Only select historic decision instances that are evaluated inside a process with the given process definition id.processDefinitionKey
(String processDefinitionKey) Only select historic decision instances that are evaluated inside a process with the given process definition key.processInstanceId
(String processInstanceId) Only select historic decision instances that are evaluated inside a process with the given process instance id.rootDecisionInstanceId
(String decisionInstanceId) Only select historic decision instances with a given root historic decision instance id.Only select historic decision instances that are the root decision instance of an evaluation.tenantIdIn
(String... tenantIds) Only select historic decision instances with one of the given tenant ids.Only select historic decision instances that were evaluated by the user with the given user ID.Only selects historic decision instances that have no tenant id.Methods inherited from interface org.camunda.bpm.engine.query.Query
asc, count, desc, list, listPage, singleResult, unlimitedList
-
Method Details
-
decisionInstanceId
Only select historic decision instances with the given decision instance id. -
decisionInstanceIdIn
Only select historic decision instances whose id is in the given list of ids. -
decisionDefinitionId
Only select historic decision instances for the given decision definition -
decisionDefinitionIdIn
Only select historic decision instances for the given decision definitions -
decisionDefinitionKey
Only select historic decision instances with the given key of the decision definition. -
decisionDefinitionKeyIn
Only select historic decision instances with the given keys of the decision definition. -
decisionDefinitionName
Only select historic decision instances with the given name of the decision definition. -
decisionDefinitionNameLike
Only select historic decision instances with the given name of the decision definition using LIKE construct. -
processDefinitionKey
Only select historic decision instances that are evaluated inside a process with the given process definition key. -
processDefinitionId
Only select historic decision instances that are evaluated inside a process with the given process definition id. -
processInstanceId
Only select historic decision instances that are evaluated inside a process with the given process instance id. -
caseDefinitionKey
Only select historic decision instances that are evaluated inside a case with the given case definition key. -
caseDefinitionId
Only select historic decision instances that are evaluated inside a case with the given case definition id. -
caseInstanceId
Only select historic decision instances that are evaluated inside a case with the given case instance id. -
activityIdIn
Only select historic decision instances that are evaluated inside a process or a case which have one of the activity ids. -
activityInstanceIdIn
Only select historic decision instances that are evaluated inside a process or a case which have one of the activity instance ids. -
evaluatedBefore
Only select historic decision instances that were evaluated before the given date. -
evaluatedAfter
Only select historic decision instances that were evaluated after the given date. -
userId
Only select historic decision instances that were evaluated by the user with the given user ID.The user ID is saved for decisions which are evaluated by a authenticated user without a process or case instance
-
includeInputs
HistoricDecisionInstanceQuery includeInputs()Enable fetchingHistoricDecisionInputInstance
of evaluated decision. -
includeOutputs
HistoricDecisionInstanceQuery includeOutputs()Enable fetchingHistoricDecisionOutputInstance
of evaluated decision. -
disableBinaryFetching
HistoricDecisionInstanceQuery disableBinaryFetching()Disable fetching of byte array input and output values. By default, the query will fetch the value of a byte array. By calling this method you can prevent the values of (potentially large) blob data chunks to be fetched. -
disableCustomObjectDeserialization
HistoricDecisionInstanceQuery disableCustomObjectDeserialization()Disable deserialization of input and output values that are custom objects. By default, the query will attempt to deserialize the value of these variables. By calling this method you can prevent such attempts in environments where their classes are not available. Independent of this setting, variable serialized values are accessible. -
rootDecisionInstanceId
Only select historic decision instances with a given root historic decision instance id. This also includes the historic decision instance with the given id. -
rootDecisionInstancesOnly
HistoricDecisionInstanceQuery rootDecisionInstancesOnly()Only select historic decision instances that are the root decision instance of an evaluation. -
decisionRequirementsDefinitionId
HistoricDecisionInstanceQuery decisionRequirementsDefinitionId(String decisionRequirementsDefinitionId) Only select historic decision instances that belongs to a decision requirements definition with the given id. -
decisionRequirementsDefinitionKey
HistoricDecisionInstanceQuery decisionRequirementsDefinitionKey(String decisionRequirementsDefinitionKey) Only select historic decision instances that belongs to a decision requirements definition with the given key. -
tenantIdIn
Only select historic decision instances with one of the given tenant ids. -
withoutTenantId
HistoricDecisionInstanceQuery withoutTenantId()Only selects historic decision instances that have no tenant id. -
orderByEvaluationTime
HistoricDecisionInstanceQuery orderByEvaluationTime()Order by the time when the decisions was evaluated (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByTenantId
HistoricDecisionInstanceQuery orderByTenantId()Order by tenant id (needs to be followed byQuery.asc()
orQuery.desc()
). Note that the ordering of historic decision instances without tenant id is database-specific.
-