public interface ProcessInstanceQuery extends Query<ProcessInstanceQuery,ProcessInstance>
ProcessInstance
s.Modifier and Type | Method and Description |
---|---|
ProcessInstanceQuery |
active()
Only selects process instances which are active, which means that
neither the process instance nor the corresponding process definition
are suspended.
|
ProcessInstanceQuery |
activityIdIn(String... activityIds)
Only selects process instances with leaf activity instances
or transition instances (async before, async after) in
at least one of the given activity ids.
|
ProcessInstanceQuery |
caseInstanceId(String caseInstanceId)
Selects the process instances which are associated with the given case instance id.
|
ProcessInstanceQuery |
deploymentId(String deploymentId)
Selects the process instances which belong to the given deployment id.
|
ProcessInstanceQuery |
incidentId(String incidentId)
Only selects process instances with the given incident id.
|
ProcessInstanceQuery |
incidentMessage(String incidentMessage)
Only selects process instances with the given incident message.
|
ProcessInstanceQuery |
incidentMessageLike(String incidentMessageLike)
Only selects process instances with an incident message like the given.
|
ProcessInstanceQuery |
incidentType(String incidentType)
Only selects process instances with the given incident type.
|
ProcessInstanceQuery |
orderByBusinessKey()
Order by the business key (needs to be followed by
Query.asc() or Query.desc() ). |
ProcessInstanceQuery |
orderByProcessDefinitionId()
Order by process definition id (needs to be followed by
Query.asc() or Query.desc() ). |
ProcessInstanceQuery |
orderByProcessDefinitionKey()
Order by process definition key (needs to be followed by
Query.asc() or Query.desc() ). |
ProcessInstanceQuery |
orderByProcessInstanceId()
Order by id (needs to be followed by
Query.asc() or Query.desc() ). |
ProcessInstanceQuery |
orderByTenantId()
Order by tenant id (needs to be followed by
Query.asc() or Query.desc() ). |
ProcessInstanceQuery |
processDefinitionId(String processDefinitionId)
Selects the process instances which are defined by a process definition
with the given id.
|
ProcessInstanceQuery |
processDefinitionKey(String processDefinitionKey)
Select the process instances which are defined by a process definition with
the given key.
|
ProcessInstanceQuery |
processDefinitionWithoutTenantId()
Only selects process instances which process definition has no tenant id.
|
ProcessInstanceQuery |
processInstanceBusinessKey(String processInstanceBusinessKey)
Select process instances with the given business key
|
ProcessInstanceQuery |
processInstanceBusinessKey(String processInstanceBusinessKey,
String processDefinitionKey)
Select process instance with the given business key, unique for the given process definition
|
ProcessInstanceQuery |
processInstanceBusinessKeyLike(String processInstanceBusinessKeyLike)
Select process instances with a business key like the given value.
|
ProcessInstanceQuery |
processInstanceId(String processInstanceId)
Select the process instance with the given id
|
ProcessInstanceQuery |
processInstanceIds(Set<String> processInstanceIds)
Select process instances whose id is in the given set of ids
|
ProcessInstanceQuery |
rootProcessInstances()
Only selects process instances which are top level process instances.
|
ProcessInstanceQuery |
subCaseInstanceId(String subCaseInstanceId)
Select the process instance that has as sub case instance the given
case instance.
|
ProcessInstanceQuery |
subProcessInstanceId(String subProcessInstanceId)
Select the process instance that have as sub process instance the given
process instance.
|
ProcessInstanceQuery |
superCaseInstanceId(String superCaseInstanceId)
Select the process instances which are a sub process instance of the given
super case instance.
|
ProcessInstanceQuery |
superProcessInstanceId(String superProcessInstanceId)
Select the process instances which are a sub process instance of the given
super process instance.
|
ProcessInstanceQuery |
suspended()
Only selects process instances which are suspended, either because the
process instance itself is suspended or because the corresponding process
definition is suspended
|
ProcessInstanceQuery |
tenantIdIn(String... tenantIds)
Only select process instances with one of the given tenant ids.
|
ProcessInstanceQuery |
variableValueEquals(String name,
Object value)
Only select process instances which have a global variable with the given value.
|
ProcessInstanceQuery |
variableValueGreaterThan(String name,
Object value)
Only select process instances which have a variable value greater than the passed value.
|
ProcessInstanceQuery |
variableValueGreaterThanOrEqual(String name,
Object value)
Only select process instances which have a global variable value greater than or equal to
the passed value.
|
ProcessInstanceQuery |
variableValueLessThan(String name,
Object value)
Only select process instances which have a global variable value less than the passed value.
|
ProcessInstanceQuery |
variableValueLessThanOrEqual(String name,
Object value)
Only select process instances which have a global variable value less than or equal to the passed value.
|
ProcessInstanceQuery |
variableValueLike(String name,
String value)
Only select process instances which have a global variable value like the given value.
|
ProcessInstanceQuery |
variableValueNotEquals(String name,
Object value)
Only select process instances which have a global variable with the given name, but
with a different value than the passed value.
|
ProcessInstanceQuery |
withoutTenantId()
Only selects process instances which have no tenant id.
|
ProcessInstanceQuery processInstanceId(String processInstanceId)
ProcessInstanceQuery processInstanceIds(Set<String> processInstanceIds)
ProcessInstanceQuery processInstanceBusinessKey(String processInstanceBusinessKey)
ProcessInstanceQuery processInstanceBusinessKey(String processInstanceBusinessKey, String processDefinitionKey)
ProcessInstanceQuery processInstanceBusinessKeyLike(String processInstanceBusinessKeyLike)
processInstanceBusinessKeyLike
- The string can include the wildcard character '%' to express
like-strategy: starts with (string%), ends with (%string) or contains (%string%).ProcessInstanceQuery processDefinitionKey(String processDefinitionKey)
ProcessInstanceQuery processDefinitionId(String processDefinitionId)
ProcessInstanceQuery deploymentId(String deploymentId)
ProcessInstanceQuery superProcessInstanceId(String superProcessInstanceId)
ProcessInstanceQuery subProcessInstanceId(String subProcessInstanceId)
ProcessInstanceQuery caseInstanceId(String caseInstanceId)
ProcessInstanceQuery superCaseInstanceId(String superCaseInstanceId)
ProcessInstanceQuery subCaseInstanceId(String subCaseInstanceId)
ProcessInstanceQuery variableValueEquals(String name, Object value)
ProcessEngineConfiguration#getVariableSerializers()
.
Byte-arrays and Serializable
objects (which are not primitive type wrappers)
are not supported.name
- name of the variable, cannot be null.ProcessInstanceQuery variableValueNotEquals(String name, Object value)
Serializable
objects (which are not primitive type wrappers)
are not supported.name
- name of the variable, cannot be null.ProcessInstanceQuery variableValueGreaterThan(String name, Object value)
Serializable
objects (which are not primitive type wrappers)
are not supported.name
- variable name, cannot be null.value
- variable value, cannot be null.ProcessInstanceQuery variableValueGreaterThanOrEqual(String name, Object value)
Serializable
objects (which
are not primitive type wrappers) are not supported.name
- variable name, cannot be null.value
- variable value, cannot be null.ProcessInstanceQuery variableValueLessThan(String name, Object value)
Serializable
objects (which are not primitive type wrappers)
are not supported.name
- variable name, cannot be null.value
- variable value, cannot be null.ProcessInstanceQuery variableValueLessThanOrEqual(String name, Object value)
Serializable
objects (which are not primitive type wrappers)
are not supported.name
- variable name, cannot be null.value
- variable value, cannot be null.ProcessInstanceQuery variableValueLike(String name, String value)
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%).ProcessInstanceQuery suspended()
ProcessInstanceQuery active()
ProcessInstanceQuery incidentType(String incidentType)
ProcessInstanceQuery incidentId(String incidentId)
ProcessInstanceQuery incidentMessage(String incidentMessage)
ProcessInstanceQuery incidentMessageLike(String incidentMessageLike)
ProcessInstanceQuery tenantIdIn(String... tenantIds)
ProcessInstanceQuery withoutTenantId()
ProcessInstanceQuery activityIdIn(String... activityIds)
Only selects process instances with leaf activity instances or transition instances (async before, async after) in at least one of the given activity ids.
Leaf instance means this filter works for instances of a user task is matched, but not the embedded sub process it is contained in.
ProcessInstanceQuery rootProcessInstances()
ProcessInstanceQuery processDefinitionWithoutTenantId()
ProcessInstanceQuery orderByProcessInstanceId()
Query.asc()
or Query.desc()
).ProcessInstanceQuery orderByProcessDefinitionKey()
Query.asc()
or Query.desc()
).ProcessInstanceQuery orderByProcessDefinitionId()
Query.asc()
or Query.desc()
).ProcessInstanceQuery orderByTenantId()
Query.asc()
or Query.desc()
).
Note that the ordering of process instances without tenant id is database-specific.ProcessInstanceQuery orderByBusinessKey()
Query.asc()
or Query.desc()
).Copyright © 2020. All rights reserved.