Interface HistoricProcessInstanceQuery
- All Superinterfaces:
Query<HistoricProcessInstanceQuery,
HistoricProcessInstance>
- All Known Implementing Classes:
HistoricProcessInstanceQueryImpl
HistoricProcessInstance
s.- Author:
- Tom Baeyens, Joram Barrez, Falko Menge
-
Method Summary
Modifier and TypeMethodDescriptionactive()
Only select historic process instances that are active.activeActivityIdIn
(String... ids) Only select historic process instances that have active activities with given ids.activityIdIn
(String... ids) Only select historic process instances with an active activity with one of the given ids.caseInstanceId
(String caseInstanceId) Only select historic process instances which are associated with the given case instance id.Only select historic process instances that are completed.endOr()
endOr() terminates an OR query on which an arbitrary amount of filter criteria were applied.executedActivityAfter
(Date date) Only select historic process instances that executed an activity after the given date.executedActivityBefore
(Date date) Only select historic process instances that executed an activity before the given date.executedActivityIdIn
(String... ids) Only select historic process instances that executed activities with given ids.executedJobAfter
(Date date) Only select historic process instances that executed an job after the given date.executedJobBefore
(Date date) Only select historic process instances that executed an job before the given date.Only select historic process instances that are externallyTerminated.finishDateBy
(Date date) Deprecated.finishDateOn
(Date date) Deprecated.usestartedAfter(Date)
andstartedBefore(Date)
insteadfinished()
Only select historic process instances that are completely finished.finishedAfter
(Date date) Only select historic process instances that were started after the given date.finishedBefore
(Date date) Only select historic process instances that were started before the given date.incidentIdIn
(String... incidentIds) Only select historic process instances that have incidents with given ids.incidentMessage
(String incidentMessage) Only select historic process instances with the given incident message.incidentMessageLike
(String incidentMessageLike) Only select historic process instances which had an incident message like the given value.incidentStatus
(String status) Only select historic process instances with incident status either 'open' or 'resolved'.incidentType
(String incidentType) Only selects process instances with the given incident type.Only select historic process instances that are internallyTerminated.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.or()
After calling or(), a chain of several filter criteria could follow.Order by the process definition id (needs to be followed byQuery.asc()
orQuery.desc()
).Order by the process definition key (needs to be followed byQuery.asc()
orQuery.desc()
).Order by the process definition name (needs to be followed byQuery.asc()
orQuery.desc()
).Order by the process definition version (needs to be followed byQuery.asc()
orQuery.desc()
).Order by the business key (needs to be followed byQuery.asc()
orQuery.desc()
).Order by the duration of the process instance (needs to be followed byQuery.asc()
orQuery.desc()
).Order by the end time (needs to be followed byQuery.asc()
orQuery.desc()
).Order by the process instance id (needs to be followed byQuery.asc()
orQuery.desc()
).Order by the start time (needs to be followed byQuery.asc()
orQuery.desc()
).Order by tenant id (needs to be followed byQuery.asc()
orQuery.desc()
).processDefinitionId
(String processDefinitionId) Only select historic process instances for the given process definitionprocessDefinitionKey
(String processDefinitionKey) Only select historic process instances that are defined by a process definition with the given key.processDefinitionKeyIn
(String... processDefinitionKeys) Only select historic process instances that are defined by any given process definition key.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 listprocessDefinitionName
(String processDefinitionName) Only select historic process instances that are defined by a process definition with the given name.processDefinitionNameLike
(String nameLike) Only select historic process instances that are defined by process definition which name is like the given value.processInstanceBusinessKey
(String processInstanceBusinessKey) Only select historic process instances with the given business keyprocessInstanceBusinessKeyIn
(String... processInstanceBusinessKeyIn) Only select historic process instances whose business key is in the given set.processInstanceBusinessKeyLike
(String processInstanceBusinessKeyLike) Only select historic process instances which had a business key like the given value.processInstanceId
(String processInstanceId) Only select historic process instances with the given process instance.processInstanceIds
(Set<String> processInstanceIds) Only select historic process instances whose id is in the given set of ids.Only select historic process instances that are top level process instances.startDateBy
(Date date) Deprecated.usestartedAfter(Date)
andstartedBefore(Date)
insteadstartDateOn
(Date date) Deprecated.usestartedAfter(Date)
andstartedBefore(Date)
insteadstartedAfter
(Date date) Only select historic process instances that were started after the given date.startedBefore
(Date date) Only select historic process instances that were started before the given date.Only select historic process instance that are started by the given user.subCaseInstanceId
(String subCaseInstanceId) Only select historic process instances having a sub case instance with the given case instance id.subProcessInstanceId
(String subProcessInstanceId) Only select historic process instances having a sub process instance with the given process instance id.superCaseInstanceId
(String superCaseInstanceId) Only select historic process instances started by the given case instance.superProcessInstanceId
(String superProcessInstanceId) Only select historic process instances started by the given process instance.Only select historic process instances that are suspended.tenantIdIn
(String... tenantIds) Only select historic process instances with one of the given tenant ids.Only select historic process instance that are not yet finished.variableValueEquals
(String name, Object value) Only select process instances which had a global variable with the given value when they ended.variableValueGreaterThan
(String name, Object value) Only select process instances which had a global variable value greater than the passed value when they ended.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.variableValueLessThan
(String name, Object value) Only select process instances which had a global variable value less than the passed value when the ended.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.variableValueLike
(String name, String value) Only select process instances which had global variable value like the given value when they ended.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.Only select historic process instances with incidentsOnly selects historic process instances which have no tenant id.Only select historic process instances with root incidentsMethods inherited from interface org.camunda.bpm.engine.query.Query
asc, count, desc, list, listPage, singleResult, unlimitedList
-
Method Details
-
processInstanceId
Only select historic process instances with the given process instance. {@link ProcessInstance) ids and {@link HistoricProcessInstance} ids match. -
processInstanceIds
Only select historic process instances whose id is in the given set of ids. {@link ProcessInstance) ids and {@link HistoricProcessInstance} ids match. -
processDefinitionId
Only select historic process instances for the given process definition -
processDefinitionKey
Only select historic process instances that are defined by a process definition with the given key. -
processDefinitionKeyIn
Only select historic process instances that are defined by any given process definition key. -
processDefinitionKeyNotIn
Only select historic process instances that don't have a process-definition of which the key is present in the given list -
processDefinitionName
Only select historic process instances that are defined by a process definition with the given name. -
processDefinitionNameLike
Only select historic process instances that are defined by process definition which name is like the given value.- Parameters:
nameLike
- The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%).
-
processInstanceBusinessKey
Only select historic process instances with the given business key -
processInstanceBusinessKeyIn
Only select historic process instances whose business key is in the given set. -
processInstanceBusinessKeyLike
Only select historic process instances which had a business key like the given value.- Parameters:
processInstanceBusinessKeyLike
- The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%).
-
finished
HistoricProcessInstanceQuery finished()Only select historic process instances that are completely finished. -
unfinished
HistoricProcessInstanceQuery unfinished()Only select historic process instance that are not yet finished. -
withIncidents
HistoricProcessInstanceQuery withIncidents()Only select historic process instances with incidents- Returns:
- HistoricProcessInstanceQuery
-
withRootIncidents
HistoricProcessInstanceQuery withRootIncidents()Only select historic process instances with root incidents- Returns:
- HistoricProcessInstanceQuery
-
incidentIdIn
Only select historic process instances that have incidents with given ids. -
incidentStatus
Only select historic process instances with incident status either 'open' or 'resolved'. To get all process instances with incidents, usewithIncidents()
.- Parameters:
status
- indicates the incident status, which is either 'open' or 'resolved'- Returns:
HistoricProcessInstanceQuery
-
incidentType
Only selects process instances with the given incident type. -
incidentMessage
Only select historic process instances with the given incident message.- Parameters:
incidentMessage
- Incidents Message for which the historic process instances should be selected- Returns:
- HistoricProcessInstanceQuery
-
incidentMessageLike
Only select historic process instances which had an incident message like the given value.- Parameters:
incidentMessageLike
- The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%).- Returns:
- HistoricProcessInstanceQuery
-
caseInstanceId
Only select historic process instances which are associated with the given case instance id. -
matchVariableNamesIgnoreCase
HistoricProcessInstanceQuery matchVariableNamesIgnoreCase()The query will match the names of variables in a case-insensitive way. -
matchVariableValuesIgnoreCase
HistoricProcessInstanceQuery matchVariableValuesIgnoreCase()The query will match the values of variables in a case-insensitive way. -
variableValueEquals
Only select process instances which had a global variable with the given value when they ended. Only select process instances which have a variable value greater than the passed value. The type only applies to already ended process instances, otherwise use aProcessInstanceQuery
instead! The type of the 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
- of the variable, cannot be null.
-
variableValueNotEquals
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. Only select process instances which have a variable value greater than the passed value. Byte-arrays andSerializable
objects (which are not primitive type wrappers) are not supported.- Parameters:
name
- of the variable, cannot be null.
-
variableValueGreaterThan
Only select process instances which had a global variable value greater than the passed value when they ended. Booleans, Byte-arrays andSerializable
objects (which are not primitive type wrappers) are not supported. Only select process instances which have a variable value greater than the passed value.- Parameters:
name
- cannot be null.value
- cannot be null.
-
variableValueGreaterThanOrEqual
Only select process instances which had a global variable value greater than or equal to the passed value when they ended. Booleans, Byte-arrays andSerializable
objects (which are not primitive type wrappers) are not supported. Only applies to already ended process instances, otherwise use aProcessInstanceQuery
instead!- Parameters:
name
- cannot be null.value
- cannot be null.
-
variableValueLessThan
Only select process instances which had a global variable value less than the passed value when the ended. Only applies to already ended process instances, otherwise use aProcessInstanceQuery
instead! Booleans, Byte-arrays andSerializable
objects (which are not primitive type wrappers) are not supported.- Parameters:
name
- cannot be null.value
- cannot be null.
-
variableValueLessThanOrEqual
Only select process instances which has a global variable value less than or equal to the passed value when they ended. Only applies to already ended process instances, otherwise use aProcessInstanceQuery
instead! Booleans, Byte-arrays andSerializable
objects (which are not primitive type wrappers) are not supported.- Parameters:
name
- cannot be null.value
- cannot be null.
-
variableValueLike
Only select process instances which had global variable value like the given value when they ended. Only applies to already ended process instances, otherwise use aProcessInstanceQuery
instead! This can be used on string variables only.- Parameters:
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%).
-
startedBefore
Only select historic process instances that were started before the given date. -
startedAfter
Only select historic process instances that were started after the given date. -
finishedBefore
Only select historic process instances that were started before the given date. -
finishedAfter
Only select historic process instances that were started after the given date. -
startedBy
Only select historic process instance that are started by the given user. -
orderByProcessInstanceId
HistoricProcessInstanceQuery orderByProcessInstanceId()Order by the process instance id (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByProcessDefinitionId
HistoricProcessInstanceQuery orderByProcessDefinitionId()Order by the process definition id (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByProcessDefinitionKey
HistoricProcessInstanceQuery orderByProcessDefinitionKey()Order by the process definition key (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByProcessDefinitionName
HistoricProcessInstanceQuery orderByProcessDefinitionName()Order by the process definition name (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByProcessDefinitionVersion
HistoricProcessInstanceQuery orderByProcessDefinitionVersion()Order by the process definition version (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByProcessInstanceBusinessKey
HistoricProcessInstanceQuery orderByProcessInstanceBusinessKey()Order by the business key (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByProcessInstanceStartTime
HistoricProcessInstanceQuery orderByProcessInstanceStartTime()Order by the start time (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByProcessInstanceEndTime
HistoricProcessInstanceQuery orderByProcessInstanceEndTime()Order by the end time (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByProcessInstanceDuration
HistoricProcessInstanceQuery orderByProcessInstanceDuration()Order by the duration of the process instance (needs to be followed byQuery.asc()
orQuery.desc()
). -
rootProcessInstances
HistoricProcessInstanceQuery rootProcessInstances()Only select historic process instances that are top level process instances. -
superProcessInstanceId
Only select historic process instances started by the given process instance. {@link ProcessInstance) ids and {@link HistoricProcessInstance} ids match. -
subProcessInstanceId
Only select historic process instances having a sub process instance with the given process instance id.Note that there will always be maximum only one such process instance that can be the result of this query.
-
superCaseInstanceId
Only select historic process instances started by the given case instance. -
subCaseInstanceId
Only select historic process instances having a sub case instance with the given case instance id.Note that there will always be maximum only one such process instance that can be the result of this query.
-
tenantIdIn
Only select historic process instances with one of the given tenant ids. -
withoutTenantId
HistoricProcessInstanceQuery withoutTenantId()Only selects historic process instances which have no tenant id. -
orderByTenantId
HistoricProcessInstanceQuery orderByTenantId()Order by tenant id (needs to be followed byQuery.asc()
orQuery.desc()
). Note that the ordering of historic process instances without tenant id is database-specific. -
startDateBy
Deprecated.usestartedAfter(Date)
andstartedBefore(Date)
insteadOnly select historic process instances that were started as of the provided date. (Date will be adjusted to reflect midnight) -
startDateOn
Deprecated.usestartedAfter(Date)
andstartedBefore(Date)
insteadOnly select historic process instances that were started on the provided date. -
finishDateBy
Deprecated.usestartedAfter(Date)
andstartedBefore(Date)
insteadOnly select historic process instances that were finished as of the provided date. (Date will be adjusted to reflect one second before midnight) -
finishDateOn
Deprecated.usestartedAfter(Date)
andstartedBefore(Date)
insteadOnly select historic process instances that were finished on provided date. -
executedActivityAfter
Only select historic process instances that executed an activity after the given date. -
executedActivityBefore
Only select historic process instances that executed an activity before the given date. -
executedActivityIdIn
Only select historic process instances that executed activities with given ids. -
activeActivityIdIn
Only select historic process instances that have active activities with given ids. -
activityIdIn
Only select historic process instances with an active activity with one of the given ids. This filter behaves differently as `activeActivityIdIn` since it also yields results when filtering for activities with an incident. -
executedJobAfter
Only select historic process instances that executed an job after the given date. -
executedJobBefore
Only select historic process instances that executed an job before the given date. -
active
HistoricProcessInstanceQuery active()Only select historic process instances that are active. -
suspended
HistoricProcessInstanceQuery suspended()Only select historic process instances that are suspended. -
completed
HistoricProcessInstanceQuery completed()Only select historic process instances that are completed. -
externallyTerminated
HistoricProcessInstanceQuery externallyTerminated()Only select historic process instances that are externallyTerminated. -
internallyTerminated
HistoricProcessInstanceQuery internallyTerminated()Only select historic process instances that are internallyTerminated. -
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.- Returns:
- an object of the type
HistoricProcessInstanceQuery
on which an arbitrary amount of filter criteria could be applied. The several filter criteria will be linked together by an OR expression. - Throws:
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.
-
endOr
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.- Returns:
- an object of the type
HistoricProcessInstanceQuery
on which an arbitrary amount of filter criteria could be applied. The filter criteria will be linked together by an AND expression. - Throws:
ProcessEngineException
- when endOr() has been invoked beforeor()
was invoked. To prevent throwing this exception,or()
must be invoked first.
-
startedAfter(Date)
andstartedBefore(Date)
instead