org.camunda.bpm.engine.impl.cmmn.entity.runtime

Class CaseExecutionQueryImpl

java.lang.Object

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

org.camunda.bpm.engine.impl.AbstractQuery<T,U>

org.camunda.bpm.engine.impl.AbstractVariableQueryImpl<CaseExecutionQuery,CaseExecution>

org.camunda.bpm.engine.impl.cmmn.entity.runtime.CaseExecutionQueryImpl

All Implemented Interfaces:

Serializable, Command<Object>, Query<CaseExecutionQuery,CaseExecution>, CaseExecutionQuery

public class CaseExecutionQueryImpl
extends AbstractVariableQueryImpl<CaseExecutionQuery,CaseExecution>
implements CaseExecutionQuery

Author:

Roman Smirnov

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	activityId
protected String	businessKey
protected String	caseDefinitionId
protected String	caseDefinitionKey
protected String	caseExecutionId
protected String	caseInstanceId
protected String	deploymentId
protected boolean	isTenantIdSet
protected Boolean	required
protected CaseExecutionState	state
protected String	subCaseInstanceId
protected String	subProcessInstanceId
protected String	superCaseInstanceId
protected String	superProcessInstanceId
protected String[]	tenantIds

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

queryVariableValues, variableNamesIgnoreCase, variableValuesIgnoreCase

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

commandExecutor, expressions, maxResultsLimitEnabled, 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
CaseExecutionQueryImpl()
CaseExecutionQueryImpl(CommandExecutor commandExecutor)

Method Summary

Modifier and Type	Method and Description
CaseExecutionQuery	active() Only select case executions which are active.
CaseExecutionQuery	activityId(String activityId) Only select case executions which contain an activity with the given id.
CaseExecutionQuery	available() Only select case executions which are available.
CaseExecutionQuery	caseDefinitionId(String caseDefinitionId) Only select case executions which have the given case definition id.
CaseExecutionQuery	caseDefinitionKey(String caseDefinitionKey) Only select case executions which have the given case definition key.
CaseExecutionQuery	caseExecutionId(String caseExecutionId) Only select case executions with the given id.
CaseExecutionQuery	caseInstanceBusinessKey(String caseInstanceBusinessKey) Only select case executions that belong to a case instance with the given business key
CaseExecutionQuery	caseInstanceId(String caseInstanceId) Only select case executions which have the given case instance id.
CaseExecutionQuery	caseInstanceVariableValueEquals(String name, Object value) Only select case executions which are part of a case instance that have a variable with the given name set to the given value.
CaseExecutionQuery	caseInstanceVariableValueGreaterThan(String name, Object value) Only select case executions which are part of a case instance that have a variable with the given name and a variable value greater than the passed value.
CaseExecutionQuery	caseInstanceVariableValueGreaterThanOrEqual(String name, Object value) Only select case executions which are part of a case instance that have a variable value greater than or equal to the passed value.
CaseExecutionQuery	caseInstanceVariableValueLessThan(String name, Object value) Only select case executions which are part of a case instance that have a variable value less than the passed value.
CaseExecutionQuery	caseInstanceVariableValueLessThanOrEqual(String name, Object value) Only select case executions which are part of a case instance that have a variable value less than or equal to the passed value.
CaseExecutionQuery	caseInstanceVariableValueLike(String name, String value) Only select case executions which are part of a case instance that have a variable value like the given value.
CaseExecutionQuery	caseInstanceVariableValueNotEquals(String name, Object value) Only select case executions which are part of a case instance that have a variable with the given name, but with a different value than the passed value.
CaseExecutionQuery	disabled() Only select case executions which are disabled.
CaseExecutionQuery	enabled() Only select case executions which are enabled.
long	executeCount(CommandContext commandContext)
List<CaseExecution>	executeList(CommandContext commandContext, Page page) Executes the actual query to retrieve the list of results.
String	getActivityId()
String	getBusinessKey()
String	getCaseDefinitionId()
String	getCaseDefinitionKey()
String	getCaseExecutionId()
String	getCaseInstanceId()
String	getDeploymentId()
CaseExecutionState	getState()
String	getSubCaseInstanceId()
String	getSubProcessInstanceId()
String	getSuperCaseInstanceId()
String	getSuperProcessInstanceId()
boolean	isCaseInstancesOnly()
Boolean	isRequired()
CaseExecutionQuery	orderByCaseDefinitionId() Order by case definition id (needs to be followed by Query.asc() or Query.desc()).
CaseExecutionQuery	orderByCaseDefinitionKey() Order by case definition key (needs to be followed by Query.asc() or Query.desc()).
CaseExecutionQuery	orderByCaseExecutionId() Order by id (needs to be followed by Query.asc() or Query.desc()).
CaseExecutionQuery	orderByTenantId() Order by tenant id (needs to be followed by Query.asc() or Query.desc()).
CaseExecutionQuery	required() Only select case executions which are required.
CaseExecutionQuery	tenantIdIn(String... tenantIds) Only select case execution with one of the given tenant ids.
CaseExecutionQuery	withoutTenantId() Only select case executions which have no tenant id.

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

addVariable, ensureVariablesInitialized, getQueryVariableValues, isVariableNamesIgnoreCase, isVariableValuesIgnoreCase, matchVariableNamesIgnoreCase, matchVariableValuesIgnoreCase, variableValueEquals, variableValueGreaterThan, variableValueGreaterThanOrEqual, variableValueLessThan, variableValueLessThanOrEqual, variableValueLike, variableValueNotEquals

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

addExpression, addValidator, asc, checkMaxResultsLimit, checkQueryOk, count, desc, direction, disableMaxResultsLimit, enableMaxResultsLimit, evaluateExpressions, evaluateExpressionsAndExecuteCount, evaluateExpressionsAndExecuteDeploymentIdMappingsList, evaluateExpressionsAndExecuteIdsList, evaluateExpressionsAndExecuteList, execute, executeDeploymentIdMappingsList, executeIdsList, executeResult, executeSingleResult, extend, getExpressions, getMethod, hasExcludingConditions, list, listDeploymentIdMappings, listIds, listPage, mergeExpressions, mergeOrdering, orderBy, orderBy, removeValidator, setCommandExecutor, setExpressions, singleResult, unlimitedList, 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.runtime.CaseExecutionQuery

matchVariableNamesIgnoreCase, matchVariableValuesIgnoreCase, variableValueEquals, variableValueGreaterThan, variableValueGreaterThanOrEqual, variableValueLessThan, variableValueLessThanOrEqual, variableValueLike, variableValueNotEquals

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

asc, count, desc, list, listPage, singleResult, unlimitedList

Field Detail

caseDefinitionId

protected String caseDefinitionId

caseDefinitionKey

protected String caseDefinitionKey

activityId

protected String activityId

caseExecutionId

protected String caseExecutionId

caseInstanceId

protected String caseInstanceId

businessKey

protected String businessKey

state

protected CaseExecutionState state

required

protected Boolean required

isTenantIdSet

protected boolean isTenantIdSet

tenantIds

protected String[] tenantIds

superProcessInstanceId

protected String superProcessInstanceId

subProcessInstanceId

protected String subProcessInstanceId

superCaseInstanceId

protected String superCaseInstanceId

subCaseInstanceId

protected String subCaseInstanceId

deploymentId

protected String deploymentId

Constructor Detail

CaseExecutionQueryImpl

public CaseExecutionQueryImpl()

CaseExecutionQueryImpl

public CaseExecutionQueryImpl(CommandExecutor commandExecutor)

Method Detail

caseInstanceId

public CaseExecutionQuery caseInstanceId(String caseInstanceId)

Description copied from interface: CaseExecutionQuery

Only select case executions which have the given case instance id.

Specified by:

caseInstanceId in interface CaseExecutionQuery

Parameters:

caseInstanceId - the id of the case instance

caseDefinitionId

public CaseExecutionQuery caseDefinitionId(String caseDefinitionId)

Description copied from interface: CaseExecutionQuery

Only select case executions which have the given case definition id.

Specified by:

caseDefinitionId in interface CaseExecutionQuery

Parameters:

caseDefinitionId - the id of the case definition

caseDefinitionKey

public CaseExecutionQuery caseDefinitionKey(String caseDefinitionKey)

Description copied from interface: CaseExecutionQuery

Only select case executions which have the given case definition key.

Specified by:

caseDefinitionKey in interface CaseExecutionQuery

Parameters:

caseDefinitionKey - the key of the case definition

caseInstanceBusinessKey

public CaseExecutionQuery caseInstanceBusinessKey(String caseInstanceBusinessKey)

Description copied from interface: CaseExecutionQuery

Only select case executions that belong to a case instance with the given business key

Specified by:

caseInstanceBusinessKey in interface CaseExecutionQuery

Parameters:

caseInstanceBusinessKey - the business key of the case instance

caseExecutionId

public CaseExecutionQuery caseExecutionId(String caseExecutionId)

Description copied from interface: CaseExecutionQuery

Only select case executions with the given id.

Specified by:

caseExecutionId in interface CaseExecutionQuery

Parameters:

caseExecutionId - the id of the case execution

activityId

public CaseExecutionQuery activityId(String activityId)

Description copied from interface: CaseExecutionQuery

Only select case executions which contain an activity with the given id.

Specified by:

activityId in interface CaseExecutionQuery

Parameters:

activityId - the id of the activity

tenantIdIn

public CaseExecutionQuery tenantIdIn(String... tenantIds)

Description copied from interface: CaseExecutionQuery

Only select case execution with one of the given tenant ids.

Specified by:

tenantIdIn in interface CaseExecutionQuery

withoutTenantId

public CaseExecutionQuery withoutTenantId()

Description copied from interface: CaseExecutionQuery

Only select case executions which have no tenant id.

Specified by:

withoutTenantId in interface CaseExecutionQuery

required

public CaseExecutionQuery required()

Description copied from interface: CaseExecutionQuery

Only select case executions which are required.

Specified by:

required in interface CaseExecutionQuery

available

public CaseExecutionQuery available()

Description copied from interface: CaseExecutionQuery

Only select case executions which are available.

Specified by:

available in interface CaseExecutionQuery

enabled

public CaseExecutionQuery enabled()

Description copied from interface: CaseExecutionQuery

Only select case executions which are enabled.

Specified by:

enabled in interface CaseExecutionQuery

active

public CaseExecutionQuery active()

Description copied from interface: CaseExecutionQuery

Only select case executions which are active.

Specified by:

active in interface CaseExecutionQuery

disabled

public CaseExecutionQuery disabled()

Description copied from interface: CaseExecutionQuery

Only select case executions which are disabled.

Specified by:

disabled in interface CaseExecutionQuery

caseInstanceVariableValueEquals

public CaseExecutionQuery caseInstanceVariableValueEquals(String name,
                                                          Object value)

Description copied from interface: CaseExecutionQuery

Only select case executions which are part of a case instance that have a variable with the given name set to the given value. The type of variable is determined based on the value, using types configured in ProcessEngineConfiguration#getVariableSerializers(). Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.

Specified by:

caseInstanceVariableValueEquals in interface CaseExecutionQuery

Parameters:

name - the name of the variable, cannot be null

value - the value of the variable

caseInstanceVariableValueNotEquals

public CaseExecutionQuery caseInstanceVariableValueNotEquals(String name,
                                                             Object value)

Description copied from interface: CaseExecutionQuery

Only select case executions which are part of a case instance that have a variable with the given name, but with a different value than the passed value. Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.

Specified by:

caseInstanceVariableValueNotEquals in interface CaseExecutionQuery

Parameters:

name - the name of the variable, cannot be null

value - the value of the variable

caseInstanceVariableValueGreaterThan

public CaseExecutionQuery caseInstanceVariableValueGreaterThan(String name,
                                                               Object value)

Description copied from interface: CaseExecutionQuery

Only select case executions which are part of a case instance that have a variable with the given name and a variable value greater than the passed value. Booleans, Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.

Specified by:

caseInstanceVariableValueGreaterThan in interface CaseExecutionQuery

Parameters:

name - the name of the variable, cannot be null

value - the value of the variable, cannot be null

caseInstanceVariableValueGreaterThanOrEqual

public CaseExecutionQuery caseInstanceVariableValueGreaterThanOrEqual(String name,
                                                                      Object value)

Description copied from interface: CaseExecutionQuery

Only select case executions which are part of a case instance that have a variable value greater than or equal to the passed value. Booleans, Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.

Specified by:

caseInstanceVariableValueGreaterThanOrEqual in interface CaseExecutionQuery

Parameters:

name - the name of the variable, cannot be null

value - the value of the variable, cannot be null

caseInstanceVariableValueLessThan

public CaseExecutionQuery caseInstanceVariableValueLessThan(String name,
                                                            Object value)

Description copied from interface: CaseExecutionQuery

Only select case executions which are part of a case instance that have a variable value less than the passed value. Booleans, Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.

Specified by:

caseInstanceVariableValueLessThan in interface CaseExecutionQuery

Parameters:

name - the name of the variable, cannot be null

value - the value of the variable, cannot be null

caseInstanceVariableValueLessThanOrEqual

public CaseExecutionQuery caseInstanceVariableValueLessThanOrEqual(String name,
                                                                   Object value)

Description copied from interface: CaseExecutionQuery

Only select case executions which are part of a case instance that have a variable value less than or equal to the passed value. Booleans, Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.

Specified by:

caseInstanceVariableValueLessThanOrEqual in interface CaseExecutionQuery

Parameters:

name - the name of the variable, cannot be null

value - the value of the variable, cannot be null

caseInstanceVariableValueLike

public CaseExecutionQuery caseInstanceVariableValueLike(String name,
                                                        String value)

Description copied from interface: CaseExecutionQuery

Only select case executions which are part of a case instance that have a variable value like the given value. This can be used on string variables only.

Specified by:

caseInstanceVariableValueLike in interface CaseExecutionQuery

Parameters:

name - the name of the variable, cannot be null

value - the value of the variable, cannot be null. The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%).

orderByCaseExecutionId

public CaseExecutionQuery orderByCaseExecutionId()

Description copied from interface: CaseExecutionQuery

Order by id (needs to be followed by Query.asc() or Query.desc()).

Specified by:

orderByCaseExecutionId in interface CaseExecutionQuery

orderByCaseDefinitionKey

public CaseExecutionQuery orderByCaseDefinitionKey()

Description copied from interface: CaseExecutionQuery

Order by case definition key (needs to be followed by Query.asc() or Query.desc()).

Specified by:

orderByCaseDefinitionKey in interface CaseExecutionQuery

orderByCaseDefinitionId

public CaseExecutionQuery orderByCaseDefinitionId()

Description copied from interface: CaseExecutionQuery

Order by case definition id (needs to be followed by Query.asc() or Query.desc()).

Specified by:

orderByCaseDefinitionId in interface CaseExecutionQuery

orderByTenantId

public CaseExecutionQuery orderByTenantId()

Description copied from interface: CaseExecutionQuery

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

Specified by:

orderByTenantId in interface CaseExecutionQuery

executeCount

public long executeCount(CommandContext commandContext)

Specified by:

executeCount in class AbstractVariableQueryImpl<CaseExecutionQuery,CaseExecution>

executeList

public List<CaseExecution> 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 AbstractVariableQueryImpl<CaseExecutionQuery,CaseExecution>

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

getCaseDefinitionId

public String getCaseDefinitionId()

getCaseDefinitionKey

public String getCaseDefinitionKey()

getActivityId

public String getActivityId()

getCaseExecutionId

public String getCaseExecutionId()

getCaseInstanceId

public String getCaseInstanceId()

getBusinessKey

public String getBusinessKey()

getState

public CaseExecutionState getState()

isCaseInstancesOnly

public boolean isCaseInstancesOnly()

getSuperProcessInstanceId

public String getSuperProcessInstanceId()

getSubProcessInstanceId

public String getSubProcessInstanceId()

getSuperCaseInstanceId

public String getSuperCaseInstanceId()

getSubCaseInstanceId

public String getSubCaseInstanceId()

getDeploymentId

public String getDeploymentId()

isRequired

public Boolean isRequired()