Package org.flowable.engine.history
Interface HistoricProcessInstanceQuery
-
- All Superinterfaces:
BatchDeleteQuery<HistoricProcessInstanceQuery>,DeleteQuery<HistoricProcessInstanceQuery,HistoricProcessInstance>,Query<HistoricProcessInstanceQuery,HistoricProcessInstance>
- All Known Implementing Classes:
HistoricProcessInstanceQueryImpl
public interface HistoricProcessInstanceQuery extends Query<HistoricProcessInstanceQuery,HistoricProcessInstance>, DeleteQuery<HistoricProcessInstanceQuery,HistoricProcessInstance>, BatchDeleteQuery<HistoricProcessInstanceQuery>
Allows programmatic querying ofHistoricProcessInstances.- Author:
- Tom Baeyens, Joram Barrez, Tijs Rademakers, Falko Menge
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.flowable.common.engine.api.query.Query
Query.NullHandlingOnOrder
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description HistoricProcessInstanceQueryactiveActivityId(String activityId)Select the historic process instances which have an active activity instance like the provided id.HistoricProcessInstanceQueryactiveActivityIds(Set<String> activityIds)Select the historic process instances which have an active activity instance like the provided ids.HistoricProcessInstanceQuerydeleted()Only select historic process instances that are deleted.HistoricProcessInstanceQuerydeploymentId(String deploymentId)Only select historic process instances that are defined by a process definition with the given deployment identifier.HistoricProcessInstanceQuerydeploymentIdIn(List<String> deploymentIds)Only select historic process instances that are defined by a process definition with one of the given deployment identifiers.HistoricProcessInstanceQueryendOr()End an OR statement.HistoricProcessInstanceQueryexcludeSubprocesses(boolean excludeSubprocesses)Exclude sub processes from the query result;HistoricProcessInstanceQueryfinished()Only select historic process instances that are completely finished.HistoricProcessInstanceQueryfinishedAfter(Date date)Only select historic process instances that were finished after the given date.HistoricProcessInstanceQueryfinishedBefore(Date date)Only select historic process instances that were finished before the given date.HistoricProcessInstanceQueryincludeProcessVariables()Include process variables in the process query resultHistoricProcessInstanceQueryinvolvedGroup(String groupId, String identityLinkType)Only select the historic process instances with which the group with the given id and link type is involved.HistoricProcessInstanceQueryinvolvedGroups(Set<String> groups)Only select the historic process instances with which the group with the given ids are involved.HistoricProcessInstanceQueryinvolvedUser(String userId)Only select the historic process instances with which the user with the given id is involved.HistoricProcessInstanceQueryinvolvedUser(String userId, String identityLinkType)Only select the historic process instances with which the user with the given id and link type is involved.HistoricProcessInstanceQuerylimitProcessInstanceVariables(Integer processInstanceVariablesLimit)Deprecated.no longer needed, this is a noopHistoricProcessInstanceQuerylocale(String locale)Localize historic process name and description to specified locale.HistoricProcessInstanceQuerylocalVariableExists(String name)Only select process instances which have a local variable with the given name.HistoricProcessInstanceQuerylocalVariableNotExists(String name)Only select process instances which does not have a local variable with the given name.HistoricProcessInstanceQuerylocalVariableValueEquals(Object value)Only select process instances which had at least one local variable with the given value when they ended.HistoricProcessInstanceQuerylocalVariableValueEquals(String name, Object value)Only select process instances which had a local variable with the given value when they ended.HistoricProcessInstanceQuerylocalVariableValueEqualsIgnoreCase(String name, String value)Only select historic process instances which have a local string variable with the given value, case insensitive.HistoricProcessInstanceQuerylocalVariableValueGreaterThan(String name, Object value)Only select process instances which had a local variable value greater than the passed value when they ended.HistoricProcessInstanceQuerylocalVariableValueGreaterThanOrEqual(String name, Object value)Only select process instances which had a local variable value greater than or equal to the passed value when they ended.HistoricProcessInstanceQuerylocalVariableValueLessThan(String name, Object value)Only select process instances which had a local variable value less than the passed value when the ended.HistoricProcessInstanceQuerylocalVariableValueLessThanOrEqual(String name, Object value)Only select process instances which has a local variable value less than or equal to the passed value when they ended.HistoricProcessInstanceQuerylocalVariableValueLike(String name, String value)Only select process instances which had a local variable value like the given value when they ended.HistoricProcessInstanceQuerylocalVariableValueLikeIgnoreCase(String name, String value)Only select process instances which had a local variable value like (case insensitive) the given value when they ended.HistoricProcessInstanceQuerylocalVariableValueNotEquals(String name, Object value)Only select process instances which had a local variable with the given name, but with a different value than the passed value when they ended.HistoricProcessInstanceQuerylocalVariableValueNotEqualsIgnoreCase(String name, String value)Only select historic process instances which have a local string variable not matching the given value, case insensitive.HistoricProcessInstanceQuerynotDeleted()Only select historic process instance that are not deleted.HistoricProcessInstanceQueryor()Begin an OR statement.HistoricProcessInstanceQueryorderByProcessDefinitionId()Order by the process definition id (needs to be followed byQuery.asc()orQuery.desc()).HistoricProcessInstanceQueryorderByProcessInstanceBusinessKey()Order by the business key (needs to be followed byQuery.asc()orQuery.desc()).HistoricProcessInstanceQueryorderByProcessInstanceDuration()Order by the duration of the process instance (needs to be followed byQuery.asc()orQuery.desc()).HistoricProcessInstanceQueryorderByProcessInstanceEndTime()Order by the end time (needs to be followed byQuery.asc()orQuery.desc()).HistoricProcessInstanceQueryorderByProcessInstanceId()Order by the process instance id (needs to be followed byQuery.asc()orQuery.desc()).HistoricProcessInstanceQueryorderByProcessInstanceStartTime()Order by the start time (needs to be followed byQuery.asc()orQuery.desc()).HistoricProcessInstanceQueryorderByTenantId()Order by tenant id (needs to be followed byQuery.asc()orQuery.desc()).HistoricProcessInstanceQueryprocessDefinitionCategory(String processDefinitionCategory)Only select historic process instances whose process definition category is processDefinitionCategory.HistoricProcessInstanceQueryprocessDefinitionId(String processDefinitionId)Only select historic process instances for the given process definitionHistoricProcessInstanceQueryprocessDefinitionKey(String processDefinitionKey)Only select historic process instances that are defined by a process definition with the given key.HistoricProcessInstanceQueryprocessDefinitionKeyIn(List<String> processDefinitionKeys)Only select historic process instances that are defined by a process definition with one of the given process definition keys.HistoricProcessInstanceQueryprocessDefinitionKeyNotIn(List<String> processDefinitionKeys)Only select historic process instances that don't have a process-definition of which the key is present in the given listHistoricProcessInstanceQueryprocessDefinitionName(String processDefinitionName)Select process historic instances whose process definition name is processDefinitionNameHistoricProcessInstanceQueryprocessDefinitionVersion(Integer processDefinitionVersion)Only select historic process instances with a certain process definition version.HistoricProcessInstanceQueryprocessInstanceBusinessKey(String processInstanceBusinessKey)Only select historic process instances with the given business keyHistoricProcessInstanceQueryprocessInstanceBusinessKeyLike(String businessKeyLike)Only select historic process instances with a business key like the given value.HistoricProcessInstanceQueryprocessInstanceBusinessStatus(String businessStatus)Only select historic process instances with the given business statusHistoricProcessInstanceQueryprocessInstanceBusinessStatusLike(String businessStatusLike)Only select historic process instances with a business status like the given value.HistoricProcessInstanceQueryprocessInstanceCallbackId(String callbackId)Only select process instances with the given callback identifier.HistoricProcessInstanceQueryprocessInstanceCallbackType(String callbackType)Only select process instances with the given callback type.HistoricProcessInstanceQueryprocessInstanceId(String processInstanceId)Only select historic process instances with the given process instance.HistoricProcessInstanceQueryprocessInstanceIds(Set<String> processInstanceIds)Only select historic process instances whose id is in the given set of ids.HistoricProcessInstanceQueryprocessInstanceName(String name)Only select process instances with the given name.HistoricProcessInstanceQueryprocessInstanceNameLike(String nameLike)Only select process instances with a name like the given value.HistoricProcessInstanceQueryprocessInstanceNameLikeIgnoreCase(String nameLikeIgnoreCase)Only select process instances with a name like the given value, ignoring upper/lower case.HistoricProcessInstanceQueryprocessInstanceReferenceId(String referenceId)Only select process instances with the given reference identifier.HistoricProcessInstanceQueryprocessInstanceReferenceType(String referenceType)Only select process instances with the given reference type.HistoricProcessInstanceQueryprocessInstanceTenantId(String tenantId)Only select process instances that have the given tenant id.HistoricProcessInstanceQueryprocessInstanceTenantIdLike(String tenantIdLike)Only select process instances with a tenant id like the given one.HistoricProcessInstanceQueryprocessInstanceWithoutTenantId()Only select process instances that do not have a tenant id.HistoricProcessInstanceQuerystartedAfter(Date date)Only select historic process instances that were started after the given date.HistoricProcessInstanceQuerystartedBefore(Date date)Only select historic process instances that were started before the given date.HistoricProcessInstanceQuerystartedBy(String userId)Only select historic process instance that are started by the given user.HistoricProcessInstanceQuerysuperProcessInstanceId(String superProcessInstanceId)Only select historic process instances started by the given process instance.HistoricProcessInstanceQueryunfinished()Only select historic process instance that are not yet finished.HistoricProcessInstanceQueryvariableExists(String name)Only select process instances which have a global variable with the given name.HistoricProcessInstanceQueryvariableNotExists(String name)Only select process instances which does not have a global variable with the given name.HistoricProcessInstanceQueryvariableValueEquals(Object value)Only select process instances which had at least one global variable with the given value when they ended.HistoricProcessInstanceQueryvariableValueEquals(String name, Object value)Only select process instances which had a global variable with the given value when they ended.HistoricProcessInstanceQueryvariableValueEqualsIgnoreCase(String name, String value)Only select historic process instances which have a global string variable with the given value, case insensitive.HistoricProcessInstanceQueryvariableValueGreaterThan(String name, Object value)Only select process instances which had a global variable value greater than the passed value when they ended.HistoricProcessInstanceQueryvariableValueGreaterThanOrEqual(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.HistoricProcessInstanceQueryvariableValueLessThan(String name, Object value)Only select process instances which had a global variable value less than the passed value when the ended.HistoricProcessInstanceQueryvariableValueLessThanOrEqual(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.HistoricProcessInstanceQueryvariableValueLike(String name, String value)Only select process instances which had a global variable value like the given value when they ended.HistoricProcessInstanceQueryvariableValueLikeIgnoreCase(String name, String value)Only select process instances which had a global variable value like (case insensitive) the given value when they ended.HistoricProcessInstanceQueryvariableValueNotEquals(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.HistoricProcessInstanceQueryvariableValueNotEqualsIgnoreCase(String name, String value)Only select historic process instances which have a global string variable not matching the given value, case insensitive.HistoricProcessInstanceQuerywithJobException()Only select process instances that failed due to an exception happening during a job execution.HistoricProcessInstanceQuerywithLocalizationFallback()Instruct localization to fallback to more general locales including the default locale of the JVM if the specified locale is not found.HistoricProcessInstanceQuerywithoutProcessInstanceCallbackId()Only select process instances that do not have a callback identifier.-
Methods inherited from interface org.flowable.common.engine.api.query.BatchDeleteQuery
deleteInParallelUsingBatch, deleteSequentiallyUsingBatch
-
Methods inherited from interface org.flowable.common.engine.api.query.DeleteQuery
delete, deleteWithRelatedData
-
-
-
-
Method Detail
-
processInstanceId
HistoricProcessInstanceQuery processInstanceId(String processInstanceId)
Only select historic process instances with the given process instance.ProcessInstanceids andHistoricProcessInstanceids match.
-
processInstanceIds
HistoricProcessInstanceQuery processInstanceIds(Set<String> processInstanceIds)
Only select historic process instances whose id is in the given set of ids.ProcessInstanceids andHistoricProcessInstanceids match.
-
processDefinitionId
HistoricProcessInstanceQuery processDefinitionId(String processDefinitionId)
Only select historic process instances for the given process definition
-
processDefinitionKey
HistoricProcessInstanceQuery processDefinitionKey(String processDefinitionKey)
Only select historic process instances that are defined by a process definition with the given key.
-
processDefinitionKeyIn
HistoricProcessInstanceQuery processDefinitionKeyIn(List<String> processDefinitionKeys)
Only select historic process instances that are defined by a process definition with one of the given process definition keys.
-
processDefinitionKeyNotIn
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
-
processDefinitionCategory
HistoricProcessInstanceQuery processDefinitionCategory(String processDefinitionCategory)
Only select historic process instances whose process definition category is processDefinitionCategory.
-
processDefinitionName
HistoricProcessInstanceQuery processDefinitionName(String processDefinitionName)
Select process historic instances whose process definition name is processDefinitionName
-
processDefinitionVersion
HistoricProcessInstanceQuery processDefinitionVersion(Integer processDefinitionVersion)
Only select historic process instances with a certain process definition version. Particularly useful when used in combination withprocessDefinitionKey(String)
-
processInstanceBusinessKey
HistoricProcessInstanceQuery processInstanceBusinessKey(String processInstanceBusinessKey)
Only select historic process instances with the given business key
-
processInstanceBusinessKeyLike
HistoricProcessInstanceQuery processInstanceBusinessKeyLike(String businessKeyLike)
Only select historic process instances with a business key like the given value.
-
processInstanceBusinessStatus
HistoricProcessInstanceQuery processInstanceBusinessStatus(String businessStatus)
Only select historic process instances with the given business status
-
processInstanceBusinessStatusLike
HistoricProcessInstanceQuery processInstanceBusinessStatusLike(String businessStatusLike)
Only select historic process instances with a business status like the given value.
-
deploymentId
HistoricProcessInstanceQuery deploymentId(String deploymentId)
Only select historic process instances that are defined by a process definition with the given deployment identifier.
-
deploymentIdIn
HistoricProcessInstanceQuery deploymentIdIn(List<String> deploymentIds)
Only select historic process instances that are defined by a process definition with one of the given deployment identifiers.
-
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.
-
deleted
HistoricProcessInstanceQuery deleted()
Only select historic process instances that are deleted.
-
notDeleted
HistoricProcessInstanceQuery notDeleted()
Only select historic process instance that are not deleted.
-
activeActivityId
HistoricProcessInstanceQuery activeActivityId(String activityId)
Select the historic process instances which have an active activity instance like the provided id.
-
activeActivityIds
HistoricProcessInstanceQuery activeActivityIds(Set<String> activityIds)
Select the historic process instances which have an active activity instance like the provided ids.
-
involvedUser
HistoricProcessInstanceQuery involvedUser(String userId)
Only select the historic process instances with which the user with the given id is involved.
-
involvedUser
HistoricProcessInstanceQuery involvedUser(String userId, String identityLinkType)
Only select the historic process instances with which the user with the given id and link type is involved.
-
involvedGroup
HistoricProcessInstanceQuery involvedGroup(String groupId, String identityLinkType)
Only select the historic process instances with which the group with the given id and link type is involved.
-
involvedGroups
HistoricProcessInstanceQuery involvedGroups(Set<String> groups)
Only select the historic process instances with which the group with the given ids are involved.
-
variableValueEquals
HistoricProcessInstanceQuery variableValueEquals(String name, Object value)
Only select process instances which had a global variable with the given value when they ended. The type only applies to already ended process instances, otherwise use aProcessInstanceQueryinstead! A variable type is determined based on the value, using types configured inProcessEngineConfigurationImpl.getVariableTypes(). Byte-arrays andSerializableobjects (which are not primitive type wrappers) are not supported.- Parameters:
name- of the variable, cannot be null.
-
localVariableValueEquals
HistoricProcessInstanceQuery localVariableValueEquals(String name, Object value)
Only select process instances which had a local variable with the given value when they ended. The type only applies to already ended process instances, otherwise use aProcessInstanceQueryinstead! A variable type is determined based on the value, using types configured inProcessEngineConfigurationImpl.getVariableTypes(). Byte-arrays andSerializableobjects (which are not primitive type wrappers) are not supported.- Parameters:
name- of the variable, cannot be null.
-
variableValueEquals
HistoricProcessInstanceQuery variableValueEquals(Object value)
Only select process instances which had at least one global variable with the given value when they ended. The type only applies to already ended process instances, otherwise use aProcessInstanceQueryinstead! A variable type is determined based on the value, using types configured inProcessEngineConfigurationImpl.getVariableTypes(). Byte-arrays andSerializableobjects (which are not primitive type wrappers) are not supported.
-
localVariableValueEquals
HistoricProcessInstanceQuery localVariableValueEquals(Object value)
Only select process instances which had at least one local variable with the given value when they ended. The type only applies to already ended process instances, otherwise use aProcessInstanceQueryinstead! A variable type is determined based on the value, using types configured inProcessEngineConfigurationImpl.getVariableTypes(). Byte-arrays andSerializableobjects (which are not primitive type wrappers) are not supported.
-
variableValueEqualsIgnoreCase
HistoricProcessInstanceQuery variableValueEqualsIgnoreCase(String name, String value)
Only select historic process instances which have a global string variable with the given value, case insensitive.- Parameters:
name- name of the variable, cannot be null.value- value of the variable, cannot be null.
-
localVariableValueEqualsIgnoreCase
HistoricProcessInstanceQuery localVariableValueEqualsIgnoreCase(String name, String value)
Only select historic process instances which have a local string variable with the given value, case insensitive.- Parameters:
name- name of the variable, cannot be null.value- value of the variable, cannot be null.
-
variableValueNotEqualsIgnoreCase
HistoricProcessInstanceQuery variableValueNotEqualsIgnoreCase(String name, String value)
Only select historic process instances which have a global string variable not matching the given value, case insensitive.- Parameters:
name- name of the variable, cannot be null.value- value of the variable, cannot be null.
-
localVariableValueNotEqualsIgnoreCase
HistoricProcessInstanceQuery localVariableValueNotEqualsIgnoreCase(String name, String value)
Only select historic process instances which have a local string variable not matching the given value, case insensitive.- Parameters:
name- name of the variable, cannot be null.value- value of the variable, cannot be null.
-
variableValueNotEquals
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. Only select process instances which have a variable value greater than the passed value. Byte-arrays andSerializableobjects (which are not primitive type wrappers) are not supported.- Parameters:
name- of the variable, cannot be null.
-
localVariableValueNotEquals
HistoricProcessInstanceQuery localVariableValueNotEquals(String name, Object value)
Only select process instances which had a local 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 andSerializableobjects (which are not primitive type wrappers) are not supported.- Parameters:
name- of the variable, cannot be null.
-
variableValueGreaterThan
HistoricProcessInstanceQuery variableValueGreaterThan(String name, Object value)
Only select process instances which had a global variable value greater than the passed value when they ended. Booleans, Byte-arrays andSerializableobjects (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.
-
localVariableValueGreaterThan
HistoricProcessInstanceQuery localVariableValueGreaterThan(String name, Object value)
Only select process instances which had a local variable value greater than the passed value when they ended. Booleans, Byte-arrays andSerializableobjects (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
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. Booleans, Byte-arrays andSerializableobjects (which are not primitive type wrappers) are not supported. Only applies to already ended process instances, otherwise use aProcessInstanceQueryinstead!- Parameters:
name- cannot be null.value- cannot be null.
-
localVariableValueGreaterThanOrEqual
HistoricProcessInstanceQuery localVariableValueGreaterThanOrEqual(String name, Object value)
Only select process instances which had a local variable value greater than or equal to the passed value when they ended. Booleans, Byte-arrays andSerializableobjects (which are not primitive type wrappers) are not supported. Only applies to already ended process instances, otherwise use aProcessInstanceQueryinstead!- Parameters:
name- cannot be null.value- cannot be null.
-
variableValueLessThan
HistoricProcessInstanceQuery variableValueLessThan(String name, Object value)
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 aProcessInstanceQueryinstead! Booleans, Byte-arrays andSerializableobjects (which are not primitive type wrappers) are not supported.- Parameters:
name- cannot be null.value- cannot be null.
-
localVariableValueLessThan
HistoricProcessInstanceQuery localVariableValueLessThan(String name, Object value)
Only select process instances which had a local variable value less than the passed value when the ended. Only applies to already ended process instances, otherwise use aProcessInstanceQueryinstead! Booleans, Byte-arrays andSerializableobjects (which are not primitive type wrappers) are not supported.- Parameters:
name- cannot be null.value- cannot be null.
-
variableValueLessThanOrEqual
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. Only applies to already ended process instances, otherwise use aProcessInstanceQueryinstead! Booleans, Byte-arrays andSerializableobjects (which are not primitive type wrappers) are not supported.- Parameters:
name- cannot be null.value- cannot be null.
-
localVariableValueLessThanOrEqual
HistoricProcessInstanceQuery localVariableValueLessThanOrEqual(String name, Object value)
Only select process instances which has a local variable value less than or equal to the passed value when they ended. Only applies to already ended process instances, otherwise use aProcessInstanceQueryinstead! Booleans, Byte-arrays andSerializableobjects (which are not primitive type wrappers) are not supported.- Parameters:
name- cannot be null.value- cannot be null.
-
variableValueLike
HistoricProcessInstanceQuery variableValueLike(String name, String value)
Only select process instances which had a global variable value like the given value when they ended. Only applies to already ended process instances, otherwise use aProcessInstanceQueryinstead! 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%).
-
localVariableValueLike
HistoricProcessInstanceQuery localVariableValueLike(String name, String value)
Only select process instances which had a local variable value like the given value when they ended. Only applies to already ended process instances, otherwise use aProcessInstanceQueryinstead! 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%).
-
variableValueLikeIgnoreCase
HistoricProcessInstanceQuery variableValueLikeIgnoreCase(String name, String value)
Only select process instances which had a global variable value like (case insensitive) the given value when they ended. Only applies to already ended process instances, otherwise use aProcessInstanceQueryinstead! 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%).
-
localVariableValueLikeIgnoreCase
HistoricProcessInstanceQuery localVariableValueLikeIgnoreCase(String name, String value)
Only select process instances which had a local variable value like (case insensitive) the given value when they ended. Only applies to already ended process instances, otherwise use aProcessInstanceQueryinstead! 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%).
-
variableExists
HistoricProcessInstanceQuery variableExists(String name)
Only select process instances which have a global variable with the given name.- Parameters:
name- cannot be null.
-
localVariableExists
HistoricProcessInstanceQuery localVariableExists(String name)
Only select process instances which have a local variable with the given name.- Parameters:
name- cannot be null.
-
variableNotExists
HistoricProcessInstanceQuery variableNotExists(String name)
Only select process instances which does not have a global variable with the given name.- Parameters:
name- cannot be null.
-
localVariableNotExists
HistoricProcessInstanceQuery localVariableNotExists(String name)
Only select process instances which does not have a local variable with the given name.- Parameters:
name- cannot be null.
-
startedBefore
HistoricProcessInstanceQuery startedBefore(Date date)
Only select historic process instances that were started before the given date.
-
startedAfter
HistoricProcessInstanceQuery startedAfter(Date date)
Only select historic process instances that were started after the given date.
-
finishedBefore
HistoricProcessInstanceQuery finishedBefore(Date date)
Only select historic process instances that were finished before the given date.
-
finishedAfter
HistoricProcessInstanceQuery finishedAfter(Date date)
Only select historic process instances that were finished after the given date.
-
startedBy
HistoricProcessInstanceQuery startedBy(String userId)
Only select historic process instance that are started by the given user.
-
processInstanceTenantId
HistoricProcessInstanceQuery processInstanceTenantId(String tenantId)
Only select process instances that have the given tenant id.
-
processInstanceTenantIdLike
HistoricProcessInstanceQuery processInstanceTenantIdLike(String tenantIdLike)
Only select process instances with a tenant id like the given one.
-
processInstanceWithoutTenantId
HistoricProcessInstanceQuery processInstanceWithoutTenantId()
Only select process instances that do not have a tenant id.
-
or
HistoricProcessInstanceQuery or()
Begin an OR statement. Make sure you invoke the endOr method at the end of your OR statement. Only one OR statement is allowed, for the second call to this method an exception will be thrown.
-
endOr
HistoricProcessInstanceQuery endOr()
End an OR statement. Only one OR statement is allowed, for the second call to this method an exception will be thrown.
-
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()).
-
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()).
-
orderByTenantId
HistoricProcessInstanceQuery orderByTenantId()
Order by tenant id (needs to be followed byQuery.asc()orQuery.desc()).
-
superProcessInstanceId
HistoricProcessInstanceQuery superProcessInstanceId(String superProcessInstanceId)
Only select historic process instances started by the given process instance.ProcessInstanceids andHistoricProcessInstanceids match.
-
excludeSubprocesses
HistoricProcessInstanceQuery excludeSubprocesses(boolean excludeSubprocesses)
Exclude sub processes from the query result;
-
includeProcessVariables
HistoricProcessInstanceQuery includeProcessVariables()
Include process variables in the process query result
-
limitProcessInstanceVariables
@Deprecated HistoricProcessInstanceQuery limitProcessInstanceVariables(Integer processInstanceVariablesLimit)
Deprecated.no longer needed, this is a noopLimit process instance variables
-
withJobException
HistoricProcessInstanceQuery withJobException()
Only select process instances that failed due to an exception happening during a job execution.
-
processInstanceName
HistoricProcessInstanceQuery processInstanceName(String name)
Only select process instances with the given name.
-
processInstanceNameLike
HistoricProcessInstanceQuery processInstanceNameLike(String nameLike)
Only select process instances with a name like the given value.
-
processInstanceNameLikeIgnoreCase
HistoricProcessInstanceQuery processInstanceNameLikeIgnoreCase(String nameLikeIgnoreCase)
Only select process instances with a name like the given value, ignoring upper/lower case.
-
processInstanceCallbackId
HistoricProcessInstanceQuery processInstanceCallbackId(String callbackId)
Only select process instances with the given callback identifier.
-
processInstanceCallbackType
HistoricProcessInstanceQuery processInstanceCallbackType(String callbackType)
Only select process instances with the given callback type.
-
withoutProcessInstanceCallbackId
HistoricProcessInstanceQuery withoutProcessInstanceCallbackId()
Only select process instances that do not have a callback identifier.
-
processInstanceReferenceId
HistoricProcessInstanceQuery processInstanceReferenceId(String referenceId)
Only select process instances with the given reference identifier.
-
processInstanceReferenceType
HistoricProcessInstanceQuery processInstanceReferenceType(String referenceType)
Only select process instances with the given reference type.
-
locale
HistoricProcessInstanceQuery locale(String locale)
Localize historic process name and description to specified locale.
-
withLocalizationFallback
HistoricProcessInstanceQuery withLocalizationFallback()
Instruct localization to fallback to more general locales including the default locale of the JVM if the specified locale is not found.
-
-