Package org.camunda.bpm.engine.runtime
Interface CaseExecutionQuery
- All Superinterfaces:
Query<CaseExecutionQuery,
CaseExecution>
- All Known Implementing Classes:
CaseExecutionQueryImpl
- Author:
- Roman Smirnov
-
Method Summary
Modifier and TypeMethodDescriptionactive()
Only select case executions which are active.activityId
(String activityId) Only select case executions which contain an activity with the given id.Only select case executions which are available.caseDefinitionId
(String caseDefinitionId) Only select case executions which have the given case definition id.caseDefinitionKey
(String caseDefinitionKey) Only select case executions which have the given case definition key.caseExecutionId
(String executionId) Only select case executions with the given id.caseInstanceBusinessKey
(String caseInstanceBusinessKey) Only select case executions that belong to a case instance with the given business keycaseInstanceId
(String caseInstanceId) Only select case executions which have the given case instance id.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.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.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.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.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.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.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.disabled()
Only select case executions which are disabled.enabled()
Only select case executions which are enabled.The query will match the names of variables in a case-insensitive way.The query will match the values of variables in a case-insensitive way.Order by case definition id (needs to be followed byQuery.asc()
orQuery.desc()
).Order by case definition key (needs to be followed byQuery.asc()
orQuery.desc()
).Order by id (needs to be followed byQuery.asc()
orQuery.desc()
).Order by tenant id (needs to be followed byQuery.asc()
orQuery.desc()
).required()
Only select case executions which are required.tenantIdIn
(String... tenantIds) Only select case execution with one of the given tenant ids.variableValueEquals
(String name, Object value) Only select case executions which have a local variable with the given value.variableValueGreaterThan
(String name, Object value) Only select case executions which have a variable value greater than the passed value.variableValueGreaterThanOrEqual
(String name, Object value) Only select case executions which have a local variable value greater than or equal to the passed value.variableValueLessThan
(String name, Object value) Only select case executions which have a local variable value less than the passed value.variableValueLessThanOrEqual
(String name, Object value) Only select case executions which have a local variable value less than or equal to the passed value.variableValueLike
(String name, String value) Only select case executions which have a local variable value like the given value.variableValueNotEquals
(String name, Object value) Only select case executions which have a local variable with the given name, but with a different value than the passed value.Only select case executions which have no tenant id.Methods inherited from interface org.camunda.bpm.engine.query.Query
asc, count, desc, list, listPage, singleResult, unlimitedList
-
Method Details
-
caseInstanceId
Only select case executions which have the given case instance id.- Parameters:
caseInstanceId
- the id of the case instance- Throws:
NotValidException
- when the given case instance id is null
-
caseDefinitionId
Only select case executions which have the given case definition id.- Parameters:
caseDefinitionId
- the id of the case definition- Throws:
NotValidException
- when the given case definition id is null
-
caseDefinitionKey
Only select case executions which have the given case definition key.- Parameters:
caseDefinitionKey
- the key of the case definition- Throws:
NotValidException
- when the given case definition key is null
-
caseInstanceBusinessKey
Only select case executions that belong to a case instance with the given business key- Parameters:
caseInstanceBusinessKey
- the business key of the case instance- Throws:
NotValidException
- when the given case instance business key is null
-
caseExecutionId
Only select case executions with the given id.- Parameters:
executionId
- the id of the case execution- Throws:
NotValidException
- when the given case execution id is null
-
activityId
Only select case executions which contain an activity with the given id.- Parameters:
activityId
- the id of the activity- Throws:
NotValidException
- when the given activity id is null
-
required
CaseExecutionQuery required()Only select case executions which are required. -
available
CaseExecutionQuery available()Only select case executions which are available. -
enabled
CaseExecutionQuery enabled()Only select case executions which are enabled. -
active
CaseExecutionQuery active()Only select case executions which are active. -
disabled
CaseExecutionQuery disabled()Only select case executions which are disabled. -
matchVariableNamesIgnoreCase
CaseExecutionQuery matchVariableNamesIgnoreCase()The query will match the names of variables in a case-insensitive way. -
matchVariableValuesIgnoreCase
CaseExecutionQuery matchVariableValuesIgnoreCase()The query will match the values of variables in a case-insensitive way. -
variableValueEquals
Only select case executions which have a local variable with the given value. The type of variable is determined based on the value, using types configured inProcessEngineConfigurationImpl.getVariableSerializers()
. Byte-arrays andSerializable
objects (which are not primitive type wrappers) are not supported.- Parameters:
name
- the name of the variable, cannot be nullvalue
- the value of the variable- Throws:
NotValidException
- when the given name is null
-
variableValueNotEquals
Only select case executions which have a local variable with the given name, but with a different value than the passed value. Byte-arrays andSerializable
objects (which are not primitive type wrappers) are not supported.- Parameters:
name
- the name of the variable, cannot be nullvalue
- the value of the variable- Throws:
NotValidException
- when the given name is null
-
variableValueGreaterThan
Only select case executions which have a variable value greater than the passed value. Booleans, Byte-arrays andSerializable
objects (which are not primitive type wrappers) are not supported.- Parameters:
name
- the name of the variable, cannot be nullvalue
- the value of the variable, cannot be null- Throws:
NotValidException
- when the given name is null or a null-value or a boolean-value is used
-
variableValueGreaterThanOrEqual
Only select case executions which have a local variable value greater than or equal to the passed value. Booleans, Byte-arrays andSerializable
objects (which are not primitive type wrappers) are not supported.- Parameters:
name
- the name of the variable, cannot be nullvalue
- the value of the variable, cannot be null- Throws:
NotValidException
- when the given name is null or a null-value or a boolean-value is used
-
variableValueLessThan
Only select case executions which have a local variable value less than the passed value. Booleans, Byte-arrays andSerializable
objects (which are not primitive type wrappers) are not supported.- Parameters:
name
- the name of the variable, cannot be nullvalue
- the value of the variable, cannot be null- Throws:
NotValidException
- when the given name is null or a null-value or a boolean-value is used
-
variableValueLessThanOrEqual
Only select case executions which have a local variable value less than or equal to the passed value. Booleans, Byte-arrays andSerializable
objects (which are not primitive type wrappers) are not supported.- Parameters:
name
- the name of the variable, cannot be nullvalue
- the value of the variable, cannot be null- Throws:
NotValidException
- when the given name is null or a null-value or a boolean-value is used
-
variableValueLike
Only select case executions which have a local variable value like the given value. This can be used on string variables only.- Parameters:
name
- the name of the variable, cannot be nullvalue
- 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%).- Throws:
NotValidException
- when the given name is null or a null-value or a boolean-value is used
-
caseInstanceVariableValueEquals
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 inProcessEngineConfiguration#getVariableSerializers()
. Byte-arrays andSerializable
objects (which are not primitive type wrappers) are not supported.- Parameters:
name
- the name of the variable, cannot be nullvalue
- the value of the variable- Throws:
NotValidException
- when the given name is null
-
caseInstanceVariableValueNotEquals
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 andSerializable
objects (which are not primitive type wrappers) are not supported.- Parameters:
name
- the name of the variable, cannot be nullvalue
- the value of the variable- Throws:
NotValidException
- when the given name is null
-
caseInstanceVariableValueGreaterThan
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 andSerializable
objects (which are not primitive type wrappers) are not supported.- Parameters:
name
- the name of the variable, cannot be nullvalue
- the value of the variable, cannot be null- Throws:
NotValidException
- when the given name is null or a null-value or a boolean-value is used
-
caseInstanceVariableValueGreaterThanOrEqual
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 andSerializable
objects (which are not primitive type wrappers) are not supported.- Parameters:
name
- the name of the variable, cannot be nullvalue
- the value of the variable, cannot be null- Throws:
NotValidException
- when the given name is null or a null-value or a boolean-value is used
-
caseInstanceVariableValueLessThan
Only select case executions which are part of a case instance that have a variable value less than the passed value. Booleans, Byte-arrays andSerializable
objects (which are not primitive type wrappers) are not supported.- Parameters:
name
- the name of the variable, cannot be nullvalue
- the value of the variable, cannot be null- Throws:
NotValidException
- when the given name is null or a null-value or a boolean-value is used
-
caseInstanceVariableValueLessThanOrEqual
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 andSerializable
objects (which are not primitive type wrappers) are not supported.- Parameters:
name
- the name of the variable, cannot be nullvalue
- the value of the variable, cannot be null- Throws:
NotValidException
- when the given name is null or a null-value or a boolean-value is used
-
caseInstanceVariableValueLike
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.- Parameters:
name
- the name of the variable, cannot be nullvalue
- 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%).- Throws:
NotValidException
- when the given name is null or a null-value or a boolean-value is used
-
tenantIdIn
Only select case execution with one of the given tenant ids. -
withoutTenantId
CaseExecutionQuery withoutTenantId()Only select case executions which have no tenant id. -
orderByCaseExecutionId
CaseExecutionQuery orderByCaseExecutionId()Order by id (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByCaseDefinitionKey
CaseExecutionQuery orderByCaseDefinitionKey()Order by case definition key (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByCaseDefinitionId
CaseExecutionQuery orderByCaseDefinitionId()Order by case definition id (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByTenantId
CaseExecutionQuery orderByTenantId()Order by tenant id (needs to be followed byQuery.asc()
orQuery.desc()
). Note that the ordering of case executions without tenant id is database-specific.
-