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

Class CaseInstanceQueryImpl

java.lang.Object

org.camunda.bpm.engine.impl.db.AuthorizationCheck

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

Field Summary

Fields

Modifier and Type	Field and Description
protected String	businessKey
protected String	caseDefinitionId
protected String	caseDefinitionKey
protected String	caseExecutionId
protected CaseExecutionState	state

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

queryVariableValues

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

commandExecutor, expressions, orderProperty, resultType, SORTORDER_ASC, SORTORDER_DESC, validators

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

databaseType, DEFAULT_ORDER_BY, firstResult, maxResults, orderBy, parameter

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

authDefaultPerm, authGroupIds, authPerms, authResourceId, authResourceIdQueryParam, authResourceType, authUserId, isAuthorizationCheckEnabled

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.
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()
CaseExecutionState	getState()
boolean	isCaseInstancesOnly()
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	terminated() Only select case instances which are terminated.

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, addOrder, addValidator, asc, checkQueryOk, count, desc, direction, evaluateExpressions, evaluateExpressionsAndExecuteCount, evaluateExpressionsAndExecuteList, execute, executeSingleResult, extend, getExpressions, getMethod, getOrderBy, getOrderProperty, list, listPage, mergeExpressions, mergeOrdering, orderBy, removeValidator, setCommandExecutor, setExpressions, singleResult, validate, validate

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

getDatabaseType, getFirstResult, getFirstRow, getLastRow, getMaxResults, getParameter, setDatabaseType, setFirstResult, setMaxResults, setOrderBy, setParameter

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

getAuthDefaultPerm, getAuthGroupIds, getAuthPerms, getAuthResourceId, getAuthResourceIdQueryParam, getAuthResourceType, getAuthUserId, isAuthorizationCheckEnabled, setAuthDefaultPerm, setAuthGroupIds, setAuthorizationCheckEnabled, setAuthPerms, setAuthResourceId, setAuthResourceIdQueryParam, setAuthResourceType, setAuthUserId

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

state

protected CaseExecutionState state

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

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

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()

getState

public CaseExecutionState getState()

isCaseInstancesOnly

public boolean isCaseInstancesOnly()