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

Class CaseInstanceQueryImpl

java.lang.Object

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

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

org.camunda.bpm.engine.impl.AbstractVariableQueryImpl<CaseInstanceQuery,CaseInstance>

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

All Implemented Interfaces:

Serializable, Command<Object>, Query<CaseInstanceQuery,CaseInstance>, CaseInstanceQuery

public class CaseInstanceQueryImpl
extends AbstractVariableQueryImpl<CaseInstanceQuery,CaseInstance>
implements CaseInstanceQuery

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	businessKey
protected String	caseDefinitionId
protected String	caseDefinitionKey
protected String	caseExecutionId
protected String	deploymentId
protected boolean	isTenantIdSet
protected Boolean	repeatable
protected Boolean	repetition
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

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
CaseInstanceQueryImpl()
CaseInstanceQueryImpl(CommandExecutor commandExecutor)

Method Summary

Methods

Modifier and Type	Method and Description
CaseInstanceQuery	active() Only select case instances which are active.
CaseInstanceQuery	caseDefinitionId(String caseDefinitionId) Selects the case instances which are defined by a case definition with the given id.
CaseInstanceQuery	caseDefinitionKey(String caseDefinitionKey) Select the case instances which are defined by a case definition with the given key.
CaseInstanceQuery	caseInstanceBusinessKey(String caseInstanceBusinessKey) Select case instances with the given business key
CaseInstanceQuery	caseInstanceId(String caseInstanceId) Select the case instance with the given id
CaseInstanceQuery	completed() Only select case instances which are completed.
CaseInstanceQuery	deploymentId(String deploymentId) Selects the case instances which belong to the given deployment id.
long	executeCount(CommandContext commandContext)
List<CaseInstance>	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	isRepeatable()
Boolean	isRepetition()
Boolean	isRequired()
CaseInstanceQuery	orderByCaseDefinitionId() Order by case definition id (needs to be followed by Query.asc() or Query.desc()).
CaseInstanceQuery	orderByCaseDefinitionKey() Order by case definition key (needs to be followed by Query.asc() or Query.desc()).
CaseInstanceQuery	orderByCaseInstanceId() Order by id (needs to be followed by Query.asc() or Query.desc()).
CaseInstanceQuery	orderByTenantId() Order by tenant id (needs to be followed by Query.asc() or Query.desc()).
CaseInstanceQuery	subCaseInstanceId(String subCaseInstanceId) Select the case instance that has as sub case instance the given case instance.
CaseInstanceQuery	subProcessInstanceId(String subProcessInstanceId) Select the case instance that has as sub process instance the given process instance.
CaseInstanceQuery	superCaseInstanceId(String superCaseInstanceId) Select the case instances which are a sub case instance of the given super case instance.
CaseInstanceQuery	superProcessInstanceId(String superProcessInstanceId) Select the case instances which are a sub case instance of the given super process instance.
CaseInstanceQuery	tenantIdIn(String... tenantIds) Only select case instances with one of the given tenant ids.
CaseInstanceQuery	terminated() Only select case instances which are terminated.
CaseInstanceQuery	withoutTenantId() Only select case instances which have no tenant id.

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

addVariable, ensureVariablesInitialized, getQueryVariableValues, variableValueEquals, variableValueGreaterThan, variableValueGreaterThanOrEqual, variableValueLessThan, variableValueLessThanOrEqual, variableValueLike, variableValueNotEquals

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.runtime.CaseInstanceQuery

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

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

asc, count, desc, list, listPage, singleResult

Field Detail

caseExecutionId

protected String caseExecutionId

businessKey

protected String businessKey

caseDefinitionId

protected String caseDefinitionId

caseDefinitionKey

protected String caseDefinitionKey

deploymentId

protected String deploymentId

state

protected CaseExecutionState state

superProcessInstanceId

protected String superProcessInstanceId

subProcessInstanceId

protected String subProcessInstanceId

superCaseInstanceId

protected String superCaseInstanceId

subCaseInstanceId

protected String subCaseInstanceId

isTenantIdSet

protected boolean isTenantIdSet

tenantIds

protected String[] tenantIds

required

protected Boolean required

repeatable

protected Boolean repeatable

repetition

protected Boolean repetition

Constructor Detail

CaseInstanceQueryImpl

public CaseInstanceQueryImpl()

CaseInstanceQueryImpl

public CaseInstanceQueryImpl(CommandExecutor commandExecutor)

Method Detail

caseInstanceId

public CaseInstanceQuery caseInstanceId(String caseInstanceId)

Description copied from interface: CaseInstanceQuery

Select the case instance with the given id

Specified by:

caseInstanceId in interface CaseInstanceQuery

Parameters:

caseInstanceId - the id of the case instance

caseInstanceBusinessKey

public CaseInstanceQuery caseInstanceBusinessKey(String caseInstanceBusinessKey)

Description copied from interface: CaseInstanceQuery

Select case instances with the given business key

Specified by:

caseInstanceBusinessKey in interface CaseInstanceQuery

Parameters:

caseInstanceBusinessKey - the business key of the case instance

caseDefinitionKey

public CaseInstanceQuery caseDefinitionKey(String caseDefinitionKey)

Description copied from interface: CaseInstanceQuery

Select the case instances which are defined by a case definition with the given key.

Specified by:

caseDefinitionKey in interface CaseInstanceQuery

Parameters:

caseDefinitionKey - the key of the case definition

caseDefinitionId

public CaseInstanceQuery caseDefinitionId(String caseDefinitionId)

Description copied from interface: CaseInstanceQuery

Selects the case instances which are defined by a case definition with the given id.

Specified by:

caseDefinitionId in interface CaseInstanceQuery

Parameters:

caseDefinitionId - the id of the case definition

deploymentId

public CaseInstanceQuery deploymentId(String deploymentId)

Description copied from interface: CaseInstanceQuery

Selects the case instances which belong to the given deployment id.

Specified by:

deploymentId in interface CaseInstanceQuery

superProcessInstanceId

public CaseInstanceQuery superProcessInstanceId(String superProcessInstanceId)

Description copied from interface: CaseInstanceQuery

Select the case instances which are a sub case instance of the given super process instance.

Specified by:

superProcessInstanceId in interface CaseInstanceQuery

subProcessInstanceId

public CaseInstanceQuery subProcessInstanceId(String subProcessInstanceId)

Description copied from interface: CaseInstanceQuery

Select the case instance that has as sub process instance the given process instance. Note that there will always be at most one such case instance that can be the result of this query.

Specified by:

subProcessInstanceId in interface CaseInstanceQuery

superCaseInstanceId

public CaseInstanceQuery superCaseInstanceId(String superCaseInstanceId)

Description copied from interface: CaseInstanceQuery

Select the case instances which are a sub case instance of the given super case instance.

Specified by:

superCaseInstanceId in interface CaseInstanceQuery

subCaseInstanceId

public CaseInstanceQuery subCaseInstanceId(String subCaseInstanceId)

Description copied from interface: CaseInstanceQuery

Select the case instance that has as sub case instance the given case instance. Note that there will always be at most one such process instance that can be the result of this query.

Specified by:

subCaseInstanceId in interface CaseInstanceQuery

tenantIdIn

public CaseInstanceQuery tenantIdIn(String... tenantIds)

Description copied from interface: CaseInstanceQuery

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

Specified by:

tenantIdIn in interface CaseInstanceQuery

withoutTenantId

public CaseInstanceQuery withoutTenantId()

Description copied from interface: CaseInstanceQuery

Only select case instances which have no tenant id.

Specified by:

withoutTenantId in interface CaseInstanceQuery

active

public CaseInstanceQuery active()

Description copied from interface: CaseInstanceQuery

Only select case instances which are active.

Specified by:

active in interface CaseInstanceQuery

completed

public CaseInstanceQuery completed()

Description copied from interface: CaseInstanceQuery

Only select case instances which are completed.

Specified by:

completed in interface CaseInstanceQuery

terminated

public CaseInstanceQuery terminated()

Description copied from interface: CaseInstanceQuery

Only select case instances which are terminated.

Specified by:

terminated in interface CaseInstanceQuery

orderByCaseInstanceId

public CaseInstanceQuery orderByCaseInstanceId()

Description copied from interface: CaseInstanceQuery

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

Specified by:

orderByCaseInstanceId in interface CaseInstanceQuery

orderByCaseDefinitionKey

public CaseInstanceQuery orderByCaseDefinitionKey()

Description copied from interface: CaseInstanceQuery

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

Specified by:

orderByCaseDefinitionKey in interface CaseInstanceQuery

orderByCaseDefinitionId

public CaseInstanceQuery orderByCaseDefinitionId()

Description copied from interface: CaseInstanceQuery

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

Specified by:

orderByCaseDefinitionId in interface CaseInstanceQuery

orderByTenantId

public CaseInstanceQuery orderByTenantId()

Description copied from interface: CaseInstanceQuery

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

Specified by:

orderByTenantId in interface CaseInstanceQuery

executeCount

public long executeCount(CommandContext commandContext)

Specified by:

executeCount in class AbstractVariableQueryImpl<CaseInstanceQuery,CaseInstance>

executeList

public List<CaseInstance> 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<CaseInstanceQuery,CaseInstance>

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

getCaseInstanceId

public String getCaseInstanceId()

getCaseExecutionId

public String getCaseExecutionId()

getActivityId

public String getActivityId()

getBusinessKey

public String getBusinessKey()

getCaseDefinitionId

public String getCaseDefinitionId()

getCaseDefinitionKey

public String getCaseDefinitionKey()

getDeploymentId

public String getDeploymentId()

getState

public CaseExecutionState getState()

isCaseInstancesOnly

public boolean isCaseInstancesOnly()

getSuperProcessInstanceId

public String getSuperProcessInstanceId()

getSubProcessInstanceId

public String getSubProcessInstanceId()

getSuperCaseInstanceId

public String getSuperCaseInstanceId()

getSubCaseInstanceId

public String getSubCaseInstanceId()

isRequired

public Boolean isRequired()

isRepeatable

public Boolean isRepeatable()

isRepetition

public Boolean isRepetition()