Uses of Interface
org.flowable.engine.runtime.ProcessInstanceQuery
Package
Description
Public API of the Flowable engine.
Typical usage of the API starts by the creation of a
Through the services obtained from such a
Typical usage of the API starts by the creation of a
ProcessEngineConfiguration
(typically based on a configuration file), from which a ProcessEngine
can be obtained.Through the services obtained from such a
ProcessEngine
, BPM and workflow operation
can be executed:RepositoryService
: Manages Deployment
s.RuntimeService
: For starting and searching ProcessInstance
s.TaskService
: Exposes operations to manage human (standalone) tasks, such as claiming, completing and assigning tasks.IdentityService
: Used for managing users, groups and the relations between them.ManagementService
: Exposes engine administration and maintenance operations,
which have no relation to the runtime exection of business processes.HistoryService
: Exposes information about ongoing and past process instances.FormService
: Access to form data and rendered forms for starting new process instances and completing tasks.API implementation classes, which shouldn't directly be used by end-users.
Classes related to the
RuntimeService
.-
Uses of ProcessInstanceQuery in org.flowable.engine
Modifier and TypeMethodDescriptionRuntimeService.createProcessInstanceQuery()
Creates a newProcessInstanceQuery
instance, that can be used to query process instances. -
Uses of ProcessInstanceQuery in org.flowable.engine.impl
Modifier and TypeMethodDescriptionProcessInstanceQueryImpl.active()
ProcessInstanceQueryImpl.activeActivityId
(String activityId) ProcessInstanceQueryImpl.activeActivityIds
(Set<String> activityIds) RuntimeServiceImpl.createProcessInstanceQuery()
ProcessInstanceQueryImpl.endOr()
ProcessInstanceQueryImpl.excludeSubprocesses
(boolean excludeSubprocesses) ProcessInstanceQueryImpl.includeProcessVariables()
ProcessInstanceQueryImpl.involvedGroup
(String groupId, String identityLinkType) ProcessInstanceQueryImpl.involvedGroups
(Set<String> involvedGroups) ProcessInstanceQueryImpl.involvedUser
(String involvedUser) ProcessInstanceQueryImpl.involvedUser
(String userId, String identityLinkType) ProcessInstanceQueryImpl.or()
ProcessInstanceQueryImpl.orderByProcessDefinitionId()
ProcessInstanceQueryImpl.orderByProcessDefinitionKey()
ProcessInstanceQueryImpl.orderByProcessInstanceId()
ProcessInstanceQueryImpl.orderByStartTime()
ProcessInstanceQueryImpl.orderByTenantId()
ProcessInstanceQueryImpl.processDefinitionCategory
(String processDefinitionCategory) ProcessInstanceQueryImpl.processDefinitionCategoryLike
(String processDefinitionCategoryLike) ProcessInstanceQueryImpl.processDefinitionCategoryLikeIgnoreCase
(String processDefinitionCategoryLikeIgnoreCase) ProcessInstanceQueryImpl.processDefinitionEngineVersion
(String processDefinitionEngineVersion) ProcessInstanceQueryImpl.processDefinitionIds
(Set<String> processDefinitionIds) ProcessInstanceQueryImpl.processDefinitionKeys
(Set<String> processDefinitionKeys) ProcessInstanceQueryImpl.processDefinitionName
(String processDefinitionName) ProcessInstanceQueryImpl.processDefinitionNameLike
(String processDefinitionNameLike) ProcessInstanceQueryImpl.processDefinitionNameLikeIgnoreCase
(String processDefinitionNameLikeIgnoreCase) ProcessInstanceQueryImpl.processDefinitionVersion
(Integer processDefinitionVersion) ProcessInstanceQueryImpl.processInstanceBusinessKey
(String businessKey) ProcessInstanceQueryImpl.processInstanceBusinessKey
(String businessKey, String processDefinitionKey) ProcessInstanceQueryImpl.processInstanceBusinessKeyLike
(String businessKeyLike) ProcessInstanceQueryImpl.processInstanceBusinessKeyLikeIgnoreCase
(String businessKeyLikeIgnoreCase) ProcessInstanceQueryImpl.processInstanceBusinessStatus
(String businessStatus) ProcessInstanceQueryImpl.processInstanceBusinessStatusLike
(String businessStatusLike) ProcessInstanceQueryImpl.processInstanceBusinessStatusLikeIgnoreCase
(String businessStatusLikeIgnoreCase) ProcessInstanceQueryImpl.processInstanceCallbackId
(String callbackId) ProcessInstanceQueryImpl.processInstanceCallbackType
(String callbackType) ProcessInstanceQueryImpl.processInstanceIds
(Set<String> processInstanceIds) ProcessInstanceQueryImpl.processInstanceName
(String name) ProcessInstanceQueryImpl.processInstanceNameLike
(String nameLike) ProcessInstanceQueryImpl.processInstanceNameLikeIgnoreCase
(String nameLikeIgnoreCase) ProcessInstanceQueryImpl.processInstanceParentScopeId
(String parentId) ProcessInstanceQueryImpl.processInstanceReferenceId
(String referenceId) ProcessInstanceQueryImpl.processInstanceReferenceType
(String referenceType) ProcessInstanceQueryImpl.processInstanceRootScopeId
(String rootId) ProcessInstanceQueryImpl.processInstanceTenantId
(String tenantId) ProcessInstanceQueryImpl.processInstanceTenantIdLike
(String tenantIdLike) ProcessInstanceQueryImpl.processInstanceTenantIdLikeIgnoreCase
(String tenantIdLikeIgnoreCase) ProcessInstanceQueryImpl.processInstanceWithoutTenantId()
ProcessInstanceQueryImpl.startedAfter
(Date afterTime) ProcessInstanceQueryImpl.startedBefore
(Date beforeTime) ProcessInstanceQueryImpl.subProcessInstanceId
(String subProcessInstanceId) ProcessInstanceQueryImpl.superProcessInstanceId
(String superProcessInstanceId) ProcessInstanceQueryImpl.suspended()
ProcessInstanceQueryImpl.variableExists
(String name) ProcessInstanceQueryImpl.variableNotExists
(String name) ProcessInstanceQueryImpl.variableValueEquals
(Object variableValue) ProcessInstanceQueryImpl.variableValueEquals
(String variableName, Object variableValue) ProcessInstanceQueryImpl.variableValueEqualsIgnoreCase
(String name, String value) ProcessInstanceQueryImpl.variableValueGreaterThan
(String name, Object value) ProcessInstanceQueryImpl.variableValueGreaterThanOrEqual
(String name, Object value) ProcessInstanceQueryImpl.variableValueLessThan
(String name, Object value) ProcessInstanceQueryImpl.variableValueLessThanOrEqual
(String name, Object value) ProcessInstanceQueryImpl.variableValueLike
(String name, String value) ProcessInstanceQueryImpl.variableValueLikeIgnoreCase
(String name, String value) ProcessInstanceQueryImpl.variableValueNotEquals
(String variableName, Object variableValue) ProcessInstanceQueryImpl.variableValueNotEqualsIgnoreCase
(String name, String value) ProcessInstanceQueryImpl.withJobException()
ProcessInstanceQueryImpl.withLocalizationFallback()
-
Uses of ProcessInstanceQuery in org.flowable.engine.interceptor
Modifier and TypeMethodDescriptionvoid
ProcessInstanceQueryInterceptor.afterProcessInstanceQueryExecute
(ProcessInstanceQuery processInstanceQuery, List<ProcessInstance> processInstances) void
ProcessInstanceQueryInterceptor.beforeProcessInstanceQueryExecute
(ProcessInstanceQuery processInstanceQuery) -
Uses of ProcessInstanceQuery in org.flowable.engine.runtime
Modifier and TypeMethodDescriptionProcessInstanceQuery.active()
Only select process instances which are active, which means that neither the process instance nor the corresponding process definition are suspended.ProcessInstanceQuery.activeActivityId
(String activityId) Select the process instances which have an active activity instance like the provided id.ProcessInstanceQuery.activeActivityIds
(Set<String> activityIds) Select the process instances which have an active activity instance like the provided ids.ProcessInstanceQuery.deploymentId
(String deploymentId) Select the process instances which are defined by a deployment with the given id.ProcessInstanceQuery.deploymentIdIn
(List<String> deploymentIds) Select the process instances which are defined by one of the given deployment idsProcessInstanceQuery.endOr()
End an OR statement.ProcessInstanceQuery.excludeSubprocesses
(boolean excludeSubprocesses) Exclude sub processes from the query result;ProcessInstanceQuery.includeProcessVariables()
Include process variables in the process query resultProcessInstanceQuery.involvedGroup
(String groupId, String identityLinkType) Select the process instances with which the group with the given id and identity link type is involved.ProcessInstanceQuery.involvedGroups
(Set<String> groupIds) Select the process instances with which theGroup
s with the given ids are involved.ProcessInstanceQuery.involvedUser
(String userId) Select the process instances with which the user with the given id is involved.ProcessInstanceQuery.involvedUser
(String userId, String identityLinkType) Select the process instances with which the user with the given id and identity link type is involved.Localize process name and description to specified locale.ProcessInstanceQuery.or()
Begin an OR statement.ProcessInstanceQuery.orderByProcessDefinitionId()
Order by process definition id (needs to be followed byQuery.asc()
orQuery.desc()
).ProcessInstanceQuery.orderByProcessDefinitionKey()
Order by process definition key (needs to be followed byQuery.asc()
orQuery.desc()
).ProcessInstanceQuery.orderByProcessInstanceId()
Order by id (needs to be followed byQuery.asc()
orQuery.desc()
).ProcessInstanceQuery.orderByStartTime()
Order by start time (needs to be followed byQuery.asc()
orQuery.desc()
).ProcessInstanceQuery.orderByTenantId()
Order by tenant id (needs to be followed byQuery.asc()
orQuery.desc()
).ProcessInstanceQuery.processDefinitionCategory
(String processDefinitionCategory) Only select process instances whose process definition category is processDefinitionCategory.ProcessInstanceQuery.processDefinitionCategoryLike
(String processDefinitionCategoryLike) Only select process instances whose process definition category is like the given value.ProcessInstanceQuery.processDefinitionCategoryLikeIgnoreCase
(String processDefinitionCategoryLikeIgnoreCase) Only select process instances whose process definition category is like the given value, ignoring upper/lower case.ProcessInstanceQuery.processDefinitionEngineVersion
(String processDefinitionEngineVersion) Select the process instances which are defined by a process definition with the given engine version.ProcessInstanceQuery.processDefinitionId
(String processDefinitionId) Select the process instances which are defined by a process definition with the given id.ProcessInstanceQuery.processDefinitionIds
(Set<String> processDefinitionIds) Select the process instances which are defined by process definitions with the given ids.ProcessInstanceQuery.processDefinitionKey
(String processDefinitionKey) Select the process instances which are defined by a process definition with the given key.ProcessInstanceQuery.processDefinitionKeyLike
(String processDefinitionKeyLike) Select process instances whose process definition key is like the given valueProcessInstanceQuery.processDefinitionKeyLikeIgnoreCase
(String processDefinitionKeyLikeIgnoreCase) Select process instances whose process definition key is like the given value, ignoring upper/lower case.ProcessInstanceQuery.processDefinitionKeys
(Set<String> processDefinitionKeys) Select the process instances which are defined by process definitions with the given keys.ProcessInstanceQuery.processDefinitionName
(String processDefinitionName) Select process instances whose process definition name is processDefinitionNameProcessInstanceQuery.processDefinitionNameLike
(String processDefinitionNameLike) Select process instances whose process definition name is like the given valueProcessInstanceQuery.processDefinitionNameLikeIgnoreCase
(String processDefinitionNameLikeIgnoreCase) Select process instances whose process definition name is like the given value, ignoring upper/lower case.ProcessInstanceQuery.processDefinitionVersion
(Integer processDefinitionVersion) Only select process instances with a certain process definition version.ProcessInstanceQuery.processInstanceBusinessKey
(String processInstanceBusinessKey) Select process instances with the given business keyProcessInstanceQuery.processInstanceBusinessKey
(String processInstanceBusinessKey, String processDefinitionKey) Select process instance with the given business key, unique for the given process definitionProcessInstanceQuery.processInstanceBusinessKeyLike
(String businessKeyLike) Select process instances with a business key like the given value.ProcessInstanceQuery.processInstanceBusinessKeyLikeIgnoreCase
(String businessKeyLikeIgnoreCase) Select process instances with a business key like the given value, ignoring upper/lower case.ProcessInstanceQuery.processInstanceBusinessStatus
(String businessStatus) Select process instances with the given business statusProcessInstanceQuery.processInstanceBusinessStatusLike
(String businessStatusLike) Select process instances with a business status like the given value.ProcessInstanceQuery.processInstanceBusinessStatusLikeIgnoreCase
(String businessStatusLikeIgnoreCase) Select process instances with a business status like the given value, ignoring upper/lower case.ProcessInstanceQuery.processInstanceCallbackId
(String callbackId) Only select process instances with the given callback id.ProcessInstanceQuery.processInstanceCallbackType
(String callbackType) Only select process instances with the given callback type.ProcessInstanceQuery.processInstanceId
(String processInstanceId) Select the process instance with the given idProcessInstanceQuery.processInstanceIds
(Set<String> processInstanceIds) Select process instances whose id is in the given set of idsProcessInstanceQuery.processInstanceName
(String name) Only select process instances with the given name.ProcessInstanceQuery.processInstanceNameLike
(String nameLike) Only select process instances with a name like the given value.ProcessInstanceQuery.processInstanceNameLikeIgnoreCase
(String nameLikeIgnoreCase) Only select process instances with a name like the given value, ignoring upper/lower case.ProcessInstanceQuery.processInstanceParentScopeId
(String parentScopeId) Only select process instances with the given parent process instance id.ProcessInstanceQuery.processInstanceReferenceId
(String referenceId) Only select process instances with the given reference id.ProcessInstanceQuery.processInstanceReferenceType
(String referenceType) Only select process instances with the given callback type.ProcessInstanceQuery.processInstanceRootScopeId
(String rootScopeId) Only select process instances with a root instance with a name like the given value.ProcessInstanceQuery.processInstanceTenantId
(String tenantId) Only select process instances that have the given tenant id.ProcessInstanceQuery.processInstanceTenantIdLike
(String tenantIdLike) Only select process instances with a tenant id like the given one.ProcessInstanceQuery.processInstanceTenantIdLikeIgnoreCase
(String tenantIdLikeIgnoreCase) Only select process instances with a tenant id like the given one, ignoring upper/lower case.ProcessInstanceQuery.processInstanceWithoutTenantId()
Only select process instances that do not have a tenant id.ProcessInstanceQuery.startedAfter
(Date afterTime) Only select process instances started after the given timeProcessInstanceQuery.startedBefore
(Date beforeTime) Only select process instances started before the given timeOnly select process instances started by the given user idProcessInstanceQuery.subProcessInstanceId
(String subProcessInstanceId) Select the process instance that have as sub process instance the given process instance.ProcessInstanceQuery.superProcessInstanceId
(String superProcessInstanceId) Select the process instances which are a sub process instance of the given super process instance.ProcessInstanceQuery.suspended()
Only select process instances which are suspended, either because the process instance itself is suspended or because the corresponding process definition is suspendedProcessInstanceQuery.variableExists
(String name) Only select process instances which have a variable with the given name.ProcessInstanceQuery.variableNotExists
(String name) Only select process instances which does not have a variable with the given name.ProcessInstanceQuery.variableValueEquals
(Object value) Only select process instances which have at least one global variable with the given value.ProcessInstanceQuery.variableValueEquals
(String name, Object value) Only select process instances which have a global variable with the given value.ProcessInstanceQuery.variableValueEqualsIgnoreCase
(String name, String value) Only select process instances which have a local string variable with the given value, case insensitive.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.variableValueLikeIgnoreCase
(String name, String value) Only select process instances which have a global variable value like the given value (case insensitive).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.variableValueNotEqualsIgnoreCase
(String name, String value) Only select process instances which have a local string variable which is not the given value, case insensitive.ProcessInstanceQuery.withJobException()
Only select process instances that failed due to an exception happening during a job execution.ProcessInstanceQuery.withLocalizationFallback()
Instruct localization to fallback to more general locales including the default locale of the JVM if the specified locale is not found.