org.camunda.bpm.engine.runtime
Interface CaseInstanceQuery

All Superinterfaces:

Query<CaseInstanceQuery,CaseInstance>

All Known Implementing Classes:

CaseInstanceQueryImpl

public interface CaseInstanceQuery
extends Query<CaseInstanceQuery,CaseInstance>

Author:

Roman Smirnov

Method Summary

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	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	variableValueEquals(String name, Object value) Only select cases instances which have a global variable with the given value.
CaseInstanceQuery	variableValueGreaterThan(String name, Object value) Only select cases instances which have a variable value greater than the passed value.
CaseInstanceQuery	variableValueGreaterThanOrEqual(String name, Object value) Only select cases instances which have a global variable value greater than or equal to the passed value.
CaseInstanceQuery	variableValueLessThan(String name, Object value) Only select cases instances which have a global variable value less than the passed value.
CaseInstanceQuery	variableValueLessThanOrEqual(String name, Object value) Only select cases instances which have a global variable value less than or equal to the passed value.
CaseInstanceQuery	variableValueLike(String name, String value) Only select cases instances which have a global variable value like the given value.
CaseInstanceQuery	variableValueNotEquals(String name, Object value) Only select cases instances which have a global variable with the given name, but with a different value than the passed value.

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

asc, count, desc, list, listPage, singleResult

Method Detail

caseInstanceId

CaseInstanceQuery caseInstanceId(String caseInstanceId)

Select the case instance with the given id

caseInstanceBusinessKey

CaseInstanceQuery caseInstanceBusinessKey(String caseInstanceBusinessKey)

Select case instances with the given business key

caseDefinitionKey

CaseInstanceQuery caseDefinitionKey(String caseDefinitionKey)

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

caseDefinitionId

CaseInstanceQuery caseDefinitionId(String caseDefinitionId)

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

active

CaseInstanceQuery active()

Only select case instances which are active.

variableValueEquals

CaseInstanceQuery variableValueEquals(String name,
                                      Object value)

Only select cases instances which have a global variable with the given value. The type of variable is determined based on the value, using types configured in ProcessEngineConfiguration#getVariableTypes(). Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.

Parameters:

name - name of the variable, cannot be null.

variableValueNotEquals

CaseInstanceQuery variableValueNotEquals(String name,
                                         Object value)

Only select cases instances which have a global 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.

Parameters:

name - name of the variable, cannot be null.

variableValueGreaterThan

CaseInstanceQuery variableValueGreaterThan(String name,
                                           Object value)

Only select cases instances which have a variable value greater than the passed value. Booleans, Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.

Parameters:

name - variable name, cannot be null.

value - variable value, cannot be null.

variableValueGreaterThanOrEqual

CaseInstanceQuery variableValueGreaterThanOrEqual(String name,
                                                  Object value)

Only select cases instances which have a global 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.

Parameters:

name - variable name, cannot be null.

value - variable value, cannot be null.

variableValueLessThan

CaseInstanceQuery variableValueLessThan(String name,
                                        Object value)

Only select cases instances which have a global variable value less than the passed value. Booleans, Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.

Parameters:

name - variable name, cannot be null.

value - variable value, cannot be null.

variableValueLessThanOrEqual

CaseInstanceQuery variableValueLessThanOrEqual(String name,
                                               Object value)

Only select cases instances which have a global 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.

Parameters:

name - variable name, cannot be null.

value - variable value, cannot be null.

variableValueLike

CaseInstanceQuery variableValueLike(String name,
                                    String value)

Only select cases instances which have a global variable value like the given value. This be used on string variables only.

Parameters:

name - variable name, cannot be null.

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

orderByCaseInstanceId

CaseInstanceQuery orderByCaseInstanceId()

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

orderByCaseDefinitionKey

CaseInstanceQuery orderByCaseDefinitionKey()

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

orderByCaseDefinitionId

CaseInstanceQuery orderByCaseDefinitionId()

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