org.camunda.bpm.engine.impl

Class HistoricDecisionInstanceQueryImpl

java.lang.Object

org.camunda.bpm.engine.impl.db.ListQueryParameterObject

org.camunda.bpm.engine.impl.AbstractQuery<HistoricDecisionInstanceQuery,HistoricDecisionInstance>

org.camunda.bpm.engine.impl.HistoricDecisionInstanceQueryImpl

All Implemented Interfaces:

Serializable, HistoricDecisionInstanceQuery, Command<Object>, Query<HistoricDecisionInstanceQuery,HistoricDecisionInstance>

public class HistoricDecisionInstanceQueryImpl
extends AbstractQuery<HistoricDecisionInstanceQuery,HistoricDecisionInstance>
implements HistoricDecisionInstanceQuery

Author:

Philipp Ossler

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.camunda.bpm.engine.impl.AbstractQuery

AbstractQuery.ResultType

Field Summary

Fields

Modifier and Type	Field and Description
protected String[]	activityIds
protected String[]	activityInstanceIds
protected String	caseDefinitionId
protected String	caseDefinitionKey
protected String	caseInstanceId
protected String	decisionDefinitionId
protected String[]	decisionDefinitionIdIn
protected String	decisionDefinitionKey
protected String[]	decisionDefinitionKeyIn
protected String	decisionDefinitionName
protected String	decisionInstanceId
protected String[]	decisionInstanceIdIn
protected String	decisionRequirementsDefinitionId
protected String	decisionRequirementsDefinitionKey
protected Date	evaluatedAfter
protected Date	evaluatedBefore
protected boolean	includeInput
protected boolean	includeOutputs
protected boolean	isByteArrayFetchingEnabled
protected boolean	isCustomObjectDeserializationEnabled
protected String	processDefinitionId
protected String	processDefinitionKey
protected String	processInstanceId
protected String	rootDecisionInstanceId
protected boolean	rootDecisionInstancesOnly
protected String[]	tenantIds
protected String	userId

Fields inherited from class org.camunda.bpm.engine.impl.AbstractQuery

commandExecutor, expressions, resultType, SORTORDER_ASC, SORTORDER_DESC, validators

Fields inherited from class org.camunda.bpm.engine.impl.db.ListQueryParameterObject

authCheck, databaseType, firstResult, maxResults, orderingProperties, parameter, tenantCheck

Constructor Summary

Constructors

Constructor and Description
HistoricDecisionInstanceQueryImpl()
HistoricDecisionInstanceQueryImpl(CommandExecutor commandExecutor)

Method Summary

Methods

Modifier and Type	Method and Description
HistoricDecisionInstanceQuery	activityIdIn(String... activityIds) Only select historic decision instances that are evaluated inside a process or a case which have one of the activity ids.
HistoricDecisionInstanceQuery	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.
HistoricDecisionInstanceQuery	caseDefinitionId(String caseDefinitionId) Only select historic decision instances that are evaluated inside a case with the given case definition id.
HistoricDecisionInstanceQuery	caseDefinitionKey(String caseDefinitionKey) Only select historic decision instances that are evaluated inside a case with the given case definition key.
HistoricDecisionInstanceQuery	caseInstanceId(String caseInstanceId) Only select historic decision instances that are evaluated inside a case with the given case instance id.
HistoricDecisionInstanceQuery	decisionDefinitionId(String decisionDefinitionId) Only select historic decision instances for the given decision definition
HistoricDecisionInstanceQuery	decisionDefinitionIdIn(String... decisionDefinitionIdIn) Only select historic decision instances for the given decision definitions
HistoricDecisionInstanceQuery	decisionDefinitionKey(String decisionDefinitionKey) Only select historic decision instances with the given key of the decision definition.
HistoricDecisionInstanceQuery	decisionDefinitionKeyIn(String... decisionDefinitionKeyIn) Only select historic decision instances with the given keys of the decision definition.
HistoricDecisionInstanceQuery	decisionDefinitionName(String decisionDefinitionName) Only select historic decision instances with the given name of the decision definition.
HistoricDecisionInstanceQuery	decisionInstanceId(String decisionInstanceId) Only select historic decision instances with the given decision instance id.
HistoricDecisionInstanceQuery	decisionInstanceIdIn(String... decisionInstanceIdIn) Only select historic decision instances whose id is in the given list of ids.
HistoricDecisionInstanceQuery	decisionRequirementsDefinitionId(String decisionRequirementsDefinitionId) Only select historic decision instances that belongs to a decision requirements definition with the given id.
HistoricDecisionInstanceQuery	decisionRequirementsDefinitionKey(String decisionRequirementsDefinitionKey) Only select historic decision instances that belongs to a decision requirements definition with the given key.
HistoricDecisionInstanceQuery	disableBinaryFetching() Disable fetching of byte array input and output values.
HistoricDecisionInstanceQuery	disableCustomObjectDeserialization() Disable deserialization of input and output values that are custom objects.
HistoricDecisionInstanceQuery	evaluatedAfter(Date evaluatedAfter) Only select historic decision instances that were evaluated after the given date.
HistoricDecisionInstanceQuery	evaluatedBefore(Date evaluatedBefore) Only select historic decision instances that were evaluated before the given date.
long	executeCount(CommandContext commandContext)
List<HistoricDecisionInstance>	executeList(CommandContext commandContext, Page page) Executes the actual query to retrieve the list of results.
String[]	getActivityIds()
String[]	getActivityInstanceIds()
String	getCaseDefinitionId()
String	getCaseDefinitionKey()
String	getCaseInstanceId()
String	getDecisionDefinitionId()
String	getDecisionDefinitionKey()
String	getDecisionDefinitionName()
String	getDecisionRequirementsDefinitionId()
String	getDecisionRequirementsDefinitionKey()
String	getProcessDefinitionId()
String	getProcessDefinitionKey()
String	getProcessInstanceId()
String	getRootDecisionInstanceId()
String[]	getTenantIds()
HistoricDecisionInstanceQuery	includeInputs() Enable fetching HistoricDecisionInputInstance of evaluated decision.
HistoricDecisionInstanceQuery	includeOutputs() Enable fetching HistoricDecisionOutputInstance of evaluated decision.
boolean	isByteArrayFetchingEnabled()
boolean	isCustomObjectDeserializationEnabled()
boolean	isIncludeInput()
boolean	isIncludeOutputs()
boolean	isRootDecisionInstancesOnly()
HistoricDecisionInstanceQuery	orderByEvaluationTime() Order by the time when the decisions was evaluated (needs to be followed by Query.asc() or Query.desc()).
HistoricDecisionInstanceQuery	orderByTenantId() Order by tenant id (needs to be followed by Query.asc() or Query.desc()).
HistoricDecisionInstanceQuery	processDefinitionId(String processDefinitionId) Only select historic decision instances that are evaluated inside a process with the given process definition id.
HistoricDecisionInstanceQuery	processDefinitionKey(String processDefinitionKey) Only select historic decision instances that are evaluated inside a process with the given process definition key.
HistoricDecisionInstanceQuery	processInstanceId(String processInstanceId) Only select historic decision instances that are evaluated inside a process with the given process instance id.
HistoricDecisionInstanceQuery	rootDecisionInstanceId(String rootDecisionInstanceId) Only select historic decision instances with a given root historic decision instance id.
HistoricDecisionInstanceQuery	rootDecisionInstancesOnly() Only select historic decision instances that are the root decision instance of an evaluation.
HistoricDecisionInstanceQuery	tenantIdIn(String... tenantIds) Only select historic decision instances with one of the given tenant ids.
HistoricDecisionInstanceQuery	userId(String userId) Only select historic decision instances that were evaluated by the user with the given user ID.

Methods inherited from class org.camunda.bpm.engine.impl.AbstractQuery

addExpression, addValidator, asc, checkQueryOk, count, desc, direction, evaluateExpressions, evaluateExpressionsAndExecuteCount, evaluateExpressionsAndExecuteIdsList, evaluateExpressionsAndExecuteList, execute, executeIdsList, executeSingleResult, extend, getExpressions, getMethod, hasExcludingConditions, list, listIds, listPage, mergeExpressions, mergeOrdering, orderBy, orderBy, removeValidator, setCommandExecutor, setExpressions, singleResult, validate, validate

Methods inherited from class org.camunda.bpm.engine.impl.db.ListQueryParameterObject

getAuthCheck, getDatabaseType, getFirstResult, getFirstRow, getLastRow, getMaxResults, getOrderingProperties, getParameter, getTenantCheck, setAuthCheck, setDatabaseType, setFirstResult, setMaxResults, setOrderingProperties, setParameter, setTenantCheck

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.camunda.bpm.engine.query.Query

asc, count, desc, list, listPage, singleResult

Field Detail

decisionInstanceId

protected String decisionInstanceId

decisionInstanceIdIn

protected String[] decisionInstanceIdIn

decisionDefinitionId

protected String decisionDefinitionId

decisionDefinitionIdIn

protected String[] decisionDefinitionIdIn

decisionDefinitionKey

protected String decisionDefinitionKey

decisionDefinitionKeyIn

protected String[] decisionDefinitionKeyIn

decisionDefinitionName

protected String decisionDefinitionName

processDefinitionKey

protected String processDefinitionKey

processDefinitionId

protected String processDefinitionId

processInstanceId

protected String processInstanceId

caseDefinitionKey

protected String caseDefinitionKey

caseDefinitionId

protected String caseDefinitionId

caseInstanceId

protected String caseInstanceId

activityInstanceIds

protected String[] activityInstanceIds

activityIds

protected String[] activityIds

evaluatedBefore

protected Date evaluatedBefore

evaluatedAfter

protected Date evaluatedAfter

userId

protected String userId

includeInput

protected boolean includeInput

includeOutputs

protected boolean includeOutputs

isByteArrayFetchingEnabled

protected boolean isByteArrayFetchingEnabled

isCustomObjectDeserializationEnabled

protected boolean isCustomObjectDeserializationEnabled

rootDecisionInstanceId

protected String rootDecisionInstanceId

rootDecisionInstancesOnly

protected boolean rootDecisionInstancesOnly

decisionRequirementsDefinitionId

protected String decisionRequirementsDefinitionId

decisionRequirementsDefinitionKey

protected String decisionRequirementsDefinitionKey

tenantIds

protected String[] tenantIds

Constructor Detail

HistoricDecisionInstanceQueryImpl

public HistoricDecisionInstanceQueryImpl()

HistoricDecisionInstanceQueryImpl

public HistoricDecisionInstanceQueryImpl(CommandExecutor commandExecutor)

Method Detail

decisionInstanceId

public HistoricDecisionInstanceQuery decisionInstanceId(String decisionInstanceId)

Description copied from interface: HistoricDecisionInstanceQuery

Only select historic decision instances with the given decision instance id.

Specified by:

decisionInstanceId in interface HistoricDecisionInstanceQuery

decisionInstanceIdIn

public HistoricDecisionInstanceQuery decisionInstanceIdIn(String... decisionInstanceIdIn)

Description copied from interface: HistoricDecisionInstanceQuery

Only select historic decision instances whose id is in the given list of ids.

Specified by:

decisionInstanceIdIn in interface HistoricDecisionInstanceQuery

decisionDefinitionId

public HistoricDecisionInstanceQuery decisionDefinitionId(String decisionDefinitionId)

Description copied from interface: HistoricDecisionInstanceQuery

Only select historic decision instances for the given decision definition

Specified by:

decisionDefinitionId in interface HistoricDecisionInstanceQuery

decisionDefinitionIdIn

public HistoricDecisionInstanceQuery decisionDefinitionIdIn(String... decisionDefinitionIdIn)

Description copied from interface: HistoricDecisionInstanceQuery

Only select historic decision instances for the given decision definitions

Specified by:

decisionDefinitionIdIn in interface HistoricDecisionInstanceQuery

decisionDefinitionKey

public HistoricDecisionInstanceQuery decisionDefinitionKey(String decisionDefinitionKey)

Description copied from interface: HistoricDecisionInstanceQuery

Only select historic decision instances with the given key of the decision definition.

Specified by:

decisionDefinitionKey in interface HistoricDecisionInstanceQuery

decisionDefinitionKeyIn

public HistoricDecisionInstanceQuery decisionDefinitionKeyIn(String... decisionDefinitionKeyIn)

Description copied from interface: HistoricDecisionInstanceQuery

Only select historic decision instances with the given keys of the decision definition.

Specified by:

decisionDefinitionKeyIn in interface HistoricDecisionInstanceQuery

decisionDefinitionName

public HistoricDecisionInstanceQuery decisionDefinitionName(String decisionDefinitionName)

Description copied from interface: HistoricDecisionInstanceQuery

Only select historic decision instances with the given name of the decision definition.

Specified by:

decisionDefinitionName in interface HistoricDecisionInstanceQuery

processDefinitionKey

public HistoricDecisionInstanceQuery processDefinitionKey(String processDefinitionKey)

Description copied from interface: HistoricDecisionInstanceQuery

Only select historic decision instances that are evaluated inside a process with the given process definition key.

Specified by:

processDefinitionKey in interface HistoricDecisionInstanceQuery

processDefinitionId

public HistoricDecisionInstanceQuery processDefinitionId(String processDefinitionId)

Description copied from interface: HistoricDecisionInstanceQuery

Only select historic decision instances that are evaluated inside a process with the given process definition id.

Specified by:

processDefinitionId in interface HistoricDecisionInstanceQuery

processInstanceId

public HistoricDecisionInstanceQuery processInstanceId(String processInstanceId)

Description copied from interface: HistoricDecisionInstanceQuery

Only select historic decision instances that are evaluated inside a process with the given process instance id.

Specified by:

processInstanceId in interface HistoricDecisionInstanceQuery

caseDefinitionKey

public HistoricDecisionInstanceQuery caseDefinitionKey(String caseDefinitionKey)

Description copied from interface: HistoricDecisionInstanceQuery

Only select historic decision instances that are evaluated inside a case with the given case definition key.

Specified by:

caseDefinitionKey in interface HistoricDecisionInstanceQuery

caseDefinitionId

public HistoricDecisionInstanceQuery caseDefinitionId(String caseDefinitionId)

Description copied from interface: HistoricDecisionInstanceQuery

Only select historic decision instances that are evaluated inside a case with the given case definition id.

Specified by:

caseDefinitionId in interface HistoricDecisionInstanceQuery

caseInstanceId

public HistoricDecisionInstanceQuery caseInstanceId(String caseInstanceId)

Description copied from interface: HistoricDecisionInstanceQuery

Only select historic decision instances that are evaluated inside a case with the given case instance id.

Specified by:

caseInstanceId in interface HistoricDecisionInstanceQuery

activityIdIn

public HistoricDecisionInstanceQuery activityIdIn(String... activityIds)

Description copied from interface: HistoricDecisionInstanceQuery

Only select historic decision instances that are evaluated inside a process or a case which have one of the activity ids.

Specified by:

activityIdIn in interface HistoricDecisionInstanceQuery

activityInstanceIdIn

public HistoricDecisionInstanceQuery activityInstanceIdIn(String... activityInstanceIds)

Description copied from interface: HistoricDecisionInstanceQuery

Only select historic decision instances that are evaluated inside a process or a case which have one of the activity instance ids.

Specified by:

activityInstanceIdIn in interface HistoricDecisionInstanceQuery

evaluatedBefore

public HistoricDecisionInstanceQuery evaluatedBefore(Date evaluatedBefore)

Description copied from interface: HistoricDecisionInstanceQuery

Only select historic decision instances that were evaluated before the given date.

Specified by:

evaluatedBefore in interface HistoricDecisionInstanceQuery

evaluatedAfter

public HistoricDecisionInstanceQuery evaluatedAfter(Date evaluatedAfter)

Description copied from interface: HistoricDecisionInstanceQuery

Only select historic decision instances that were evaluated after the given date.

Specified by:

evaluatedAfter in interface HistoricDecisionInstanceQuery

tenantIdIn

public HistoricDecisionInstanceQuery tenantIdIn(String... tenantIds)

Description copied from interface: HistoricDecisionInstanceQuery

Only select historic decision instances with one of the given tenant ids.

Specified by:

tenantIdIn in interface HistoricDecisionInstanceQuery

orderByTenantId

public HistoricDecisionInstanceQuery orderByTenantId()

Description copied from interface: HistoricDecisionInstanceQuery

Order by tenant id (needs to be followed by Query.asc() or Query.desc()). Note that the ordering of historic decision instances without tenant id is database-specific.

Specified by:

orderByTenantId in interface HistoricDecisionInstanceQuery

userId

public HistoricDecisionInstanceQuery userId(String userId)

Description copied from interface: HistoricDecisionInstanceQuery

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

Specified by:

userId in interface HistoricDecisionInstanceQuery

orderByEvaluationTime

public HistoricDecisionInstanceQuery orderByEvaluationTime()

Description copied from interface: HistoricDecisionInstanceQuery

Order by the time when the decisions was evaluated (needs to be followed by Query.asc() or Query.desc()).

Specified by:

orderByEvaluationTime in interface HistoricDecisionInstanceQuery

executeCount

public long executeCount(CommandContext commandContext)

Specified by:

executeCount in class AbstractQuery<HistoricDecisionInstanceQuery,HistoricDecisionInstance>

executeList

public List<HistoricDecisionInstance> executeList(CommandContext commandContext,
                                         Page page)

Description copied from class: AbstractQuery

Executes the actual query to retrieve the list of results.

Specified by:

executeList in class AbstractQuery<HistoricDecisionInstanceQuery,HistoricDecisionInstance>

page - used if the results must be paged. If null, no paging will be applied.

getDecisionDefinitionId

public String getDecisionDefinitionId()

getDecisionDefinitionKey

public String getDecisionDefinitionKey()

getDecisionDefinitionName

public String getDecisionDefinitionName()

getProcessDefinitionKey

public String getProcessDefinitionKey()

getProcessDefinitionId

public String getProcessDefinitionId()

getProcessInstanceId

public String getProcessInstanceId()

getCaseDefinitionKey

public String getCaseDefinitionKey()

getCaseDefinitionId

public String getCaseDefinitionId()

getCaseInstanceId

public String getCaseInstanceId()

getActivityInstanceIds

public String[] getActivityInstanceIds()

getActivityIds

public String[] getActivityIds()

getTenantIds

public String[] getTenantIds()

includeInputs

public HistoricDecisionInstanceQuery includeInputs()

Description copied from interface: HistoricDecisionInstanceQuery

Enable fetching HistoricDecisionInputInstance of evaluated decision.

Specified by:

includeInputs in interface HistoricDecisionInstanceQuery

includeOutputs

public HistoricDecisionInstanceQuery includeOutputs()

Description copied from interface: HistoricDecisionInstanceQuery

Enable fetching HistoricDecisionOutputInstance of evaluated decision.

Specified by:

includeOutputs in interface HistoricDecisionInstanceQuery

isIncludeInput

public boolean isIncludeInput()

isIncludeOutputs

public boolean isIncludeOutputs()

disableBinaryFetching

public HistoricDecisionInstanceQuery disableBinaryFetching()

Description copied from interface: HistoricDecisionInstanceQuery

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.

Specified by:

disableBinaryFetching in interface HistoricDecisionInstanceQuery

disableCustomObjectDeserialization

public HistoricDecisionInstanceQuery disableCustomObjectDeserialization()

Description copied from interface: HistoricDecisionInstanceQuery

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.

Specified by:

disableCustomObjectDeserialization in interface HistoricDecisionInstanceQuery

isByteArrayFetchingEnabled

public boolean isByteArrayFetchingEnabled()

isCustomObjectDeserializationEnabled

public boolean isCustomObjectDeserializationEnabled()

getRootDecisionInstanceId

public String getRootDecisionInstanceId()

rootDecisionInstanceId

public HistoricDecisionInstanceQuery rootDecisionInstanceId(String rootDecisionInstanceId)

Description copied from interface: HistoricDecisionInstanceQuery

Only select historic decision instances with a given root historic decision instance id. This also includes the historic decision instance with the given id.

Specified by:

rootDecisionInstanceId in interface HistoricDecisionInstanceQuery

isRootDecisionInstancesOnly

public boolean isRootDecisionInstancesOnly()

rootDecisionInstancesOnly

public HistoricDecisionInstanceQuery rootDecisionInstancesOnly()

Description copied from interface: HistoricDecisionInstanceQuery

Only select historic decision instances that are the root decision instance of an evaluation.

Specified by:

rootDecisionInstancesOnly in interface HistoricDecisionInstanceQuery

decisionRequirementsDefinitionId

public HistoricDecisionInstanceQuery decisionRequirementsDefinitionId(String decisionRequirementsDefinitionId)

Description copied from interface: HistoricDecisionInstanceQuery

Only select historic decision instances that belongs to a decision requirements definition with the given id.

Specified by:

decisionRequirementsDefinitionId in interface HistoricDecisionInstanceQuery

decisionRequirementsDefinitionKey

public HistoricDecisionInstanceQuery decisionRequirementsDefinitionKey(String decisionRequirementsDefinitionKey)

Description copied from interface: HistoricDecisionInstanceQuery

Only select historic decision instances that belongs to a decision requirements definition with the given key.

Specified by:

decisionRequirementsDefinitionKey in interface HistoricDecisionInstanceQuery

getDecisionRequirementsDefinitionId

public String getDecisionRequirementsDefinitionId()

getDecisionRequirementsDefinitionKey

public String getDecisionRequirementsDefinitionKey()