public interface HistoricProcessInstanceQuery extends Query<HistoricProcessInstanceQuery,HistoricProcessInstance>
HistoricProcessInstance
s.Modifier and Type | Method and Description |
---|---|
HistoricProcessInstanceQuery |
active()
Only select historic process instances that are active.
|
HistoricProcessInstanceQuery |
activeActivityIdIn(String... ids)
Only select historic process instances that have active activities with given ids.
|
HistoricProcessInstanceQuery |
caseInstanceId(String caseInstanceId)
Only select historic process instances which are associated with the given case instance id.
|
HistoricProcessInstanceQuery |
completed()
Only select historic process instances that are completed.
|
HistoricProcessInstanceQuery |
endOr()
endOr() terminates an OR query on which an arbitrary amount of filter criteria were applied.
|
HistoricProcessInstanceQuery |
executedActivityAfter(Date date)
Only select historic process instances that executed an activity after the given date.
|
HistoricProcessInstanceQuery |
executedActivityBefore(Date date)
Only select historic process instances that executed an activity before the given date.
|
HistoricProcessInstanceQuery |
executedActivityIdIn(String... ids)
Only select historic process instances that executed activities with given ids.
|
HistoricProcessInstanceQuery |
executedJobAfter(Date date)
Only select historic process instances that executed an job after the given date.
|
HistoricProcessInstanceQuery |
executedJobBefore(Date date)
Only select historic process instances that executed an job before the given date.
|
HistoricProcessInstanceQuery |
externallyTerminated()
Only select historic process instances that are externallyTerminated.
|
HistoricProcessInstanceQuery |
finishDateBy(Date date)
Deprecated.
use
startedAfter(Date) and startedBefore(Date) instead |
HistoricProcessInstanceQuery |
finishDateOn(Date date)
Deprecated.
use
startedAfter(Date) and startedBefore(Date) instead |
HistoricProcessInstanceQuery |
finished()
Only select historic process instances that are completely finished.
|
HistoricProcessInstanceQuery |
finishedAfter(Date date)
Only select historic process instances that were started after the given date.
|
HistoricProcessInstanceQuery |
finishedBefore(Date date)
Only select historic process instances that were started before the given date.
|
HistoricProcessInstanceQuery |
incidentMessage(String incidentMessage)
Only select historic process instances with the given incident message.
|
HistoricProcessInstanceQuery |
incidentMessageLike(String incidentMessageLike)
Only select historic process instances which had an incident message like the given value.
|
HistoricProcessInstanceQuery |
incidentStatus(String status)
Only select historic process instances with incident status either 'open' or 'resolved'.
|
HistoricProcessInstanceQuery |
incidentType(String incidentType)
Only selects process instances with the given incident type.
|
HistoricProcessInstanceQuery |
internallyTerminated()
Only select historic process instances that are internallyTerminated.
|
HistoricProcessInstanceQuery |
matchVariableNamesIgnoreCase()
The query will match the names of variables in a case-insensitive way.
|
HistoricProcessInstanceQuery |
matchVariableValuesIgnoreCase()
The query will match the values of variables in a case-insensitive way.
|
HistoricProcessInstanceQuery |
or()
After calling or(), a chain of several filter criteria could follow.
|
HistoricProcessInstanceQuery |
orderByProcessDefinitionId()
Order by the process definition id (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricProcessInstanceQuery |
orderByProcessDefinitionKey()
Order by the process definition key (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricProcessInstanceQuery |
orderByProcessDefinitionName()
Order by the process definition name (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricProcessInstanceQuery |
orderByProcessDefinitionVersion()
Order by the process definition version (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricProcessInstanceQuery |
orderByProcessInstanceBusinessKey()
Order by the business key (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricProcessInstanceQuery |
orderByProcessInstanceDuration()
Order by the duration of the process instance (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricProcessInstanceQuery |
orderByProcessInstanceEndTime()
Order by the end time (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricProcessInstanceQuery |
orderByProcessInstanceId()
Order by the process instance id (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricProcessInstanceQuery |
orderByProcessInstanceStartTime()
Order by the start time (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricProcessInstanceQuery |
orderByTenantId()
Order by tenant id (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricProcessInstanceQuery |
processDefinitionId(String processDefinitionId)
Only select historic process instances for the given process definition
|
HistoricProcessInstanceQuery |
processDefinitionKey(String processDefinitionKey)
Only select historic process instances that are defined by a process
definition with the given key.
|
HistoricProcessInstanceQuery |
processDefinitionKeyIn(String... processDefinitionKeys)
Only select historic process instances that are defined by any given process
definition key.
|
HistoricProcessInstanceQuery |
processDefinitionKeyNotIn(List<String> processDefinitionKeys)
Only select historic process instances that don't have a process-definition of which the key is present in the given list
|
HistoricProcessInstanceQuery |
processDefinitionName(String processDefinitionName)
Only select historic process instances that are defined by a process
definition with the given name.
|
HistoricProcessInstanceQuery |
processDefinitionNameLike(String nameLike)
Only select historic process instances that are defined by process definition which name
is like the given value.
|
HistoricProcessInstanceQuery |
processInstanceBusinessKey(String processInstanceBusinessKey)
Only select historic process instances with the given business key
|
HistoricProcessInstanceQuery |
processInstanceBusinessKeyLike(String processInstanceBusinessKeyLike)
Only select historic process instances which had a business key like the given value.
|
HistoricProcessInstanceQuery |
processInstanceId(String processInstanceId)
Only select historic process instances with the given process instance.
|
HistoricProcessInstanceQuery |
processInstanceIds(Set<String> processInstanceIds)
Only select historic process instances whose id is in the given set of ids.
|
HistoricProcessInstanceQuery |
rootProcessInstances()
Only select historic process instances that are top level process instances.
|
HistoricProcessInstanceQuery |
startDateBy(Date date)
Deprecated.
use
startedAfter(Date) and startedBefore(Date) instead |
HistoricProcessInstanceQuery |
startDateOn(Date date)
Deprecated.
use
startedAfter(Date) and startedBefore(Date) instead |
HistoricProcessInstanceQuery |
startedAfter(Date date)
Only select historic process instances that were started after the given date.
|
HistoricProcessInstanceQuery |
startedBefore(Date date)
Only select historic process instances that were started before the given date.
|
HistoricProcessInstanceQuery |
startedBy(String userId)
Only select historic process instance that are started by the given user.
|
HistoricProcessInstanceQuery |
subCaseInstanceId(String subCaseInstanceId)
Only select historic process instances having a sub case instance
with the given case instance id.
|
HistoricProcessInstanceQuery |
subProcessInstanceId(String subProcessInstanceId)
Only select historic process instances having a sub process instance
with the given process instance id.
|
HistoricProcessInstanceQuery |
superCaseInstanceId(String superCaseInstanceId)
Only select historic process instances started by the given case
instance.
|
HistoricProcessInstanceQuery |
superProcessInstanceId(String superProcessInstanceId)
Only select historic process instances started by the given process
instance.
|
HistoricProcessInstanceQuery |
suspended()
Only select historic process instances that are suspended.
|
HistoricProcessInstanceQuery |
tenantIdIn(String... tenantIds)
Only select historic process instances with one of the given tenant ids.
|
HistoricProcessInstanceQuery |
unfinished()
Only select historic process instance that are not yet finished.
|
HistoricProcessInstanceQuery |
variableValueEquals(String name,
Object value)
Only select process instances which had a global variable with the given value
when they ended.
|
HistoricProcessInstanceQuery |
variableValueGreaterThan(String name,
Object value)
Only select process instances which had a global variable value greater than the
passed value when they ended.
|
HistoricProcessInstanceQuery |
variableValueGreaterThanOrEqual(String name,
Object value)
Only select process instances which had a global variable value greater than or
equal to the passed value when they ended.
|
HistoricProcessInstanceQuery |
variableValueLessThan(String name,
Object value)
Only select process instances which had a global variable value less than the
passed value when the ended.
|
HistoricProcessInstanceQuery |
variableValueLessThanOrEqual(String name,
Object value)
Only select process instances which has a global variable value less than or equal
to the passed value when they ended.
|
HistoricProcessInstanceQuery |
variableValueLike(String name,
String value)
Only select process instances which had global variable value like the given value
when they ended.
|
HistoricProcessInstanceQuery |
variableValueNotEquals(String name,
Object value)
Only select process instances which had a global variable with the given name, but
with a different value than the passed value when they ended.
|
HistoricProcessInstanceQuery |
withIncidents()
Only select historic process instances with incidents
|
HistoricProcessInstanceQuery |
withoutTenantId()
Only selects historic process instances which have no tenant id.
|
HistoricProcessInstanceQuery |
withRootIncidents()
Only select historic process instances with root incidents
|
asc, count, desc, list, listPage, singleResult, unlimitedList
HistoricProcessInstanceQuery processInstanceId(String processInstanceId)
HistoricProcessInstanceQuery processInstanceIds(Set<String> processInstanceIds)
HistoricProcessInstanceQuery processDefinitionId(String processDefinitionId)
HistoricProcessInstanceQuery processDefinitionKey(String processDefinitionKey)
HistoricProcessInstanceQuery processDefinitionKeyIn(String... processDefinitionKeys)
HistoricProcessInstanceQuery processDefinitionKeyNotIn(List<String> processDefinitionKeys)
HistoricProcessInstanceQuery processDefinitionName(String processDefinitionName)
HistoricProcessInstanceQuery processDefinitionNameLike(String nameLike)
nameLike
- The string can include the wildcard character '%' to express
like-strategy: starts with (string%), ends with (%string) or contains (%string%).HistoricProcessInstanceQuery processInstanceBusinessKey(String processInstanceBusinessKey)
HistoricProcessInstanceQuery processInstanceBusinessKeyLike(String processInstanceBusinessKeyLike)
processInstanceBusinessKeyLike
- The string can include the wildcard character '%' to express
like-strategy: starts with (string%), ends with (%string) or contains (%string%).HistoricProcessInstanceQuery finished()
HistoricProcessInstanceQuery unfinished()
HistoricProcessInstanceQuery withIncidents()
HistoricProcessInstanceQuery withRootIncidents()
HistoricProcessInstanceQuery incidentStatus(String status)
withIncidents()
.status
- indicates the incident status, which is either 'open' or 'resolved'HistoricProcessInstanceQuery
HistoricProcessInstanceQuery incidentType(String incidentType)
HistoricProcessInstanceQuery incidentMessage(String incidentMessage)
incidentMessage
- Incidents Message for which the historic process instances should be selectedHistoricProcessInstanceQuery incidentMessageLike(String incidentMessageLike)
incidentMessageLike
- The string can include the wildcard character '%' to express
like-strategy: starts with (string%), ends with (%string) or contains (%string%).HistoricProcessInstanceQuery caseInstanceId(String caseInstanceId)
HistoricProcessInstanceQuery matchVariableNamesIgnoreCase()
HistoricProcessInstanceQuery matchVariableValuesIgnoreCase()
HistoricProcessInstanceQuery variableValueEquals(String name, Object value)
ProcessInstanceQuery
instead! of
variable is determined based on the value, using types configured in
ProcessEngineConfiguration#getVariableSerializers()
. Byte-arrays and
Serializable
objects (which are not primitive type wrappers) are
not supported.name
- of the variable, cannot be null.HistoricProcessInstanceQuery variableValueNotEquals(String name, Object value)
Serializable
objects (which are not
primitive type wrappers) are not supported.name
- of the variable, cannot be null.HistoricProcessInstanceQuery variableValueGreaterThan(String name, Object value)
Serializable
objects (which are not primitive type wrappers) are
not supported. Only select process instances which have a variable value
greater than the passed value.name
- cannot be null.value
- cannot be null.HistoricProcessInstanceQuery variableValueGreaterThanOrEqual(String name, Object value)
Serializable
objects (which are not primitive type wrappers) are
not supported. Only applies to already ended process instances, otherwise
use a ProcessInstanceQuery
instead!name
- cannot be null.value
- cannot be null.HistoricProcessInstanceQuery variableValueLessThan(String name, Object value)
ProcessInstanceQuery
instead! Booleans,
Byte-arrays and Serializable
objects (which are not primitive type
wrappers) are not supported.name
- cannot be null.value
- cannot be null.HistoricProcessInstanceQuery variableValueLessThanOrEqual(String name, Object value)
ProcessInstanceQuery
instead! Booleans,
Byte-arrays and Serializable
objects (which are not primitive type
wrappers) are not supported.name
- cannot be null.value
- cannot be null.HistoricProcessInstanceQuery variableValueLike(String name, String value)
ProcessInstanceQuery
instead! This can be used on string
variables only.name
- cannot be null.value
- cannot be null. The string can include the
wildcard character '%' to express like-strategy: starts with
(string%), ends with (%string) or contains (%string%).HistoricProcessInstanceQuery startedBefore(Date date)
HistoricProcessInstanceQuery startedAfter(Date date)
HistoricProcessInstanceQuery finishedBefore(Date date)
HistoricProcessInstanceQuery finishedAfter(Date date)
HistoricProcessInstanceQuery startedBy(String userId)
HistoricProcessInstanceQuery orderByProcessInstanceId()
Query.asc()
or Query.desc()
).HistoricProcessInstanceQuery orderByProcessDefinitionId()
Query.asc()
or Query.desc()
).HistoricProcessInstanceQuery orderByProcessDefinitionKey()
Query.asc()
or Query.desc()
).HistoricProcessInstanceQuery orderByProcessDefinitionName()
Query.asc()
or Query.desc()
).HistoricProcessInstanceQuery orderByProcessDefinitionVersion()
Query.asc()
or Query.desc()
).HistoricProcessInstanceQuery orderByProcessInstanceBusinessKey()
Query.asc()
or Query.desc()
).HistoricProcessInstanceQuery orderByProcessInstanceStartTime()
Query.asc()
or Query.desc()
).HistoricProcessInstanceQuery orderByProcessInstanceEndTime()
Query.asc()
or Query.desc()
).HistoricProcessInstanceQuery orderByProcessInstanceDuration()
Query.asc()
or Query.desc()
).HistoricProcessInstanceQuery rootProcessInstances()
HistoricProcessInstanceQuery superProcessInstanceId(String superProcessInstanceId)
HistoricProcessInstanceQuery subProcessInstanceId(String subProcessInstanceId)
HistoricProcessInstanceQuery superCaseInstanceId(String superCaseInstanceId)
HistoricProcessInstanceQuery subCaseInstanceId(String subCaseInstanceId)
HistoricProcessInstanceQuery tenantIdIn(String... tenantIds)
HistoricProcessInstanceQuery withoutTenantId()
HistoricProcessInstanceQuery orderByTenantId()
Query.asc()
or Query.desc()
).
Note that the ordering of historic process instances without tenant id is database-specific.@Deprecated HistoricProcessInstanceQuery startDateBy(Date date)
startedAfter(Date)
and startedBefore(Date)
instead@Deprecated HistoricProcessInstanceQuery startDateOn(Date date)
startedAfter(Date)
and startedBefore(Date)
instead@Deprecated HistoricProcessInstanceQuery finishDateBy(Date date)
startedAfter(Date)
and startedBefore(Date)
instead@Deprecated HistoricProcessInstanceQuery finishDateOn(Date date)
startedAfter(Date)
and startedBefore(Date)
insteadHistoricProcessInstanceQuery executedActivityAfter(Date date)
HistoricProcessInstanceQuery executedActivityBefore(Date date)
HistoricProcessInstanceQuery executedActivityIdIn(String... ids)
HistoricProcessInstanceQuery activeActivityIdIn(String... ids)
HistoricProcessInstanceQuery executedJobAfter(Date date)
HistoricProcessInstanceQuery executedJobBefore(Date date)
HistoricProcessInstanceQuery active()
HistoricProcessInstanceQuery suspended()
HistoricProcessInstanceQuery completed()
HistoricProcessInstanceQuery externallyTerminated()
HistoricProcessInstanceQuery internallyTerminated()
HistoricProcessInstanceQuery or()
After calling or(), a chain of several filter criteria could follow. Each filter criterion that follows or()
will be linked together with an OR expression until the OR query is terminated. To terminate the OR query right
after the last filter criterion was applied, endOr()
must be invoked.
HistoricProcessInstanceQuery
on which an arbitrary amount of filter criteria could be applied.
The several filter criteria will be linked together by an OR expression.ProcessEngineException
- when or() has been invoked directly after or() or after or() and trailing filter
criteria. To prevent throwing this exception, endOr()
must be invoked after a chain of filter criteria to
mark the end of the OR query.HistoricProcessInstanceQuery endOr()
endOr() terminates an OR query on which an arbitrary amount of filter criteria were applied. To terminate the
OR query which has been started by invoking or()
, endOr() must be invoked. Filter criteria which are
applied after calling endOr() are linked together by an AND expression.
HistoricProcessInstanceQuery
on which an arbitrary amount of filter criteria could be applied.
The filter criteria will be linked together by an AND expression.ProcessEngineException
- when endOr() has been invoked before or()
was invoked. To prevent throwing
this exception, or()
must be invoked first.Copyright © 2021. All rights reserved.