ProcessInstanceQueryImpl (Flowable

java.lang.Object
- org.flowable.common.engine.impl.db.ListQueryParameterObject
- - org.flowable.common.engine.impl.AbstractQuery<T,U>
  - - org.flowable.variable.service.impl.AbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>
    - - org.flowable.engine.impl.ProcessInstanceQueryImpl

All Implemented Interfaces:

Serializable, Query<ProcessInstanceQuery,ProcessInstance>, Command<Object>, ProcessInstanceQuery
```
public class ProcessInstanceQueryImpl
extends AbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>
implements ProcessInstanceQuery, Serializable
```
Author:

Tom Baeyens, Joram Barrez, Tijs Rademakers, Frederik Heremans, Falko Menge, Daniel Meyer

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject
  ListQueryParameterObject.ResultType
- Nested classes/interfaces inherited from interface org.flowable.common.engine.api.query.Query
  Query.NullHandlingOnOrder

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`activityId`
`protected String`	`businessKey`
`protected String`	`callbackId`
`protected String`	`callbackType`
`protected ProcessInstanceQueryImpl`	`currentOrQueryObject`
`protected String`	`deploymentId`
`protected List<String>`	`deploymentIds`
`protected List<EventSubscriptionQueryValue>`	`eventSubscriptions`
`protected boolean`	`excludeSubprocesses`
`protected String`	`executionId`
`protected boolean`	`includeChildExecutionsWithBusinessKeyQuery`
`protected boolean`	`includeProcessVariables`
`protected boolean`	`inOrStatement`
`protected Set<String>`	`involvedGroups`
`protected String`	`involvedUser`
`protected String`	`locale`
`protected String`	`name`
`protected String`	`nameLike`
`protected String`	`nameLikeIgnoreCase`
`protected boolean`	`onlyChildExecutions`
`protected boolean`	`onlyProcessInstanceExecutions`
`protected boolean`	`onlySubProcessExecutions`
`protected List<ProcessInstanceQueryImpl>`	`orQueryObjects`
`protected String`	`processDefinitionCategory`
`protected String`	`processDefinitionEngineVersion`
`protected String`	`processDefinitionId`
`protected Set<String>`	`processDefinitionIds`
`protected String`	`processDefinitionKey`
`protected Set<String>`	`processDefinitionKeys`
`protected String`	`processDefinitionName`
`protected Integer`	`processDefinitionVersion`
`protected Set<String>`	`processInstanceIds`
`protected Integer`	`processInstanceVariablesLimit`
`protected String`	`rootProcessInstanceId`
`protected Date`	`startedAfter`
`protected Date`	`startedBefore`
`protected String`	`startedBy`
`protected String`	`subProcessInstanceId`
`protected String`	`superProcessInstanceId`
`protected SuspensionState`	`suspensionState`
`protected String`	`tenantId`
`protected String`	`tenantIdLike`
`protected boolean`	`withJobException`
`protected boolean`	`withLocalizationFallback`
`protected boolean`	`withoutTenantId`

Fields inherited from class org.flowable.variable.service.impl.AbstractVariableQueryImpl
queryVariableValues

Fields inherited from class org.flowable.common.engine.impl.AbstractQuery
commandContext, commandExecutor

Fields inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject
databaseType, firstResult, maxResults, nullHandlingColumn, nullHandlingOnOrder, orderByColumnMap, orderByColumns, orderProperty, parameter, resultType, SORTORDER_ASC, SORTORDER_DESC

Constructor Summary

Constructors
Constructor and Description
`ProcessInstanceQueryImpl()`
`ProcessInstanceQueryImpl(CommandContext commandContext)`
`ProcessInstanceQueryImpl(CommandExecutor commandExecutor)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ProcessInstanceQuery`	`active()` Only select process instances which are active, which means that neither the process instance nor the corresponding process definition are suspended.
`ProcessInstanceQueryImpl`	`deploymentId(String deploymentId)` Select the process instances which are defined by a deployment with the given id.
`ProcessInstanceQueryImpl`	`deploymentIdIn(List<String> deploymentIds)` Select the process instances which are defined by one of the given deployment ids
`ProcessInstanceQuery`	`endOr()` End an OR statement.
`protected void`	`ensureVariablesInitialized()`
`ProcessInstanceQuery`	`excludeSubprocesses(boolean excludeSubprocesses)` Exclude sub processes from the query result;
`long`	`executeCount(CommandContext commandContext)`
`List<ProcessInstance>`	`executeList(CommandContext commandContext)`
`String`	`getActivityId()`
`String`	`getBusinessKey()`
`String`	`getCallbackId()`
`String`	`getCallbackType()`
`String`	`getDeploymentId()`
`List<String>`	`getDeploymentIds()`
`List<EventSubscriptionQueryValue>`	`getEventSubscriptions()`
`String`	`getExecutionId()`
`Set<String>`	`getInvolvedGroups()`
`String`	`getInvolvedUser()`
`String`	`getMssqlOrDB2OrderBy()`
`String`	`getName()`
`String`	`getNameLike()`
`String`	`getNameLikeIgnoreCase()`
`boolean`	`getOnlyProcessInstances()`
`List<ProcessInstanceQueryImpl>`	`getOrQueryObjects()`
`String`	`getParentId()` Methods needed for ibatis because of re-use of query-xml for executions.
`String`	`getProcessDefinitionCategory()`
`String`	`getProcessDefinitionEngineVersion()`
`String`	`getProcessDefinitionId()`
`Set<String>`	`getProcessDefinitionIds()`
`String`	`getProcessDefinitionKey()`
`Set<String>`	`getProcessDefinitionKeys()`
`String`	`getProcessDefinitionName()`
`Integer`	`getProcessDefinitionVersion()`
`String`	`getProcessInstanceId()`
`Set<String>`	`getProcessInstanceIds()`
`Integer`	`getProcessInstanceVariablesLimit()`
`String`	`getRootProcessInstanceId()`
`Date`	`getStartedAfter()`
`Date`	`getStartedBefore()`
`String`	`getStartedBy()`
`String`	`getSubProcessInstanceId()`
`String`	`getSuperProcessInstanceId()`
`SuspensionState`	`getSuspensionState()`
`String`	`getTenantId()`
`String`	`getTenantIdLike()`
`ProcessInstanceQuery`	`includeProcessVariables()` Include process variables in the process query result
`ProcessInstanceQuery`	`involvedGroups(Set<String> involvedGroups)` Select the process instances with which the `Group`s with the given ids are involved.
`ProcessInstanceQuery`	`involvedUser(String involvedUser)` Select the process instances with which the user with the given id is involved.
`boolean`	`isExcludeSubprocesses()`
`boolean`	`isIncludeChildExecutionsWithBusinessKeyQuery()`
`boolean`	`isIncludeProcessVariables()`
`boolean`	`isOnlyChildExecutions()`
`boolean`	`isOnlyProcessInstanceExecutions()`
`boolean`	`isOnlySubProcessExecutions()`
`boolean`	`iswithException()`
`boolean`	`isWithoutTenantId()`
`ProcessInstanceQuery`	`limitProcessInstanceVariables(Integer processInstanceVariablesLimit)` Limit process instance variables
`ProcessInstanceQuery`	`locale(String locale)` Localize process name and description to specified locale.
`protected void`	`localize(ProcessInstance processInstance)`
`ProcessInstanceQuery`	`or()` Begin an OR statement.
`ProcessInstanceQuery`	`orderByProcessDefinitionId()` Order by process definition id (needs to be followed by `Query.asc()` or `Query.desc()`).
`ProcessInstanceQuery`	`orderByProcessDefinitionKey()` Order by process definition key (needs to be followed by `Query.asc()` or `Query.desc()`).
`ProcessInstanceQuery`	`orderByProcessInstanceId()` Order by id (needs to be followed by `Query.asc()` or `Query.desc()`).
`ProcessInstanceQuery`	`orderByTenantId()` Order by tenant id (needs to be followed by `Query.asc()` or `Query.desc()`).
`ProcessInstanceQuery`	`processDefinitionCategory(String processDefinitionCategory)` Only select process instances whose process definition category is processDefinitionCategory.
`ProcessInstanceQuery`	`processDefinitionEngineVersion(String processDefinitionEngineVersion)` Select the process instances which are defined by a process definition with the given engine version.
`ProcessInstanceQueryImpl`	`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.
`ProcessInstanceQueryImpl`	`processDefinitionKey(String processDefinitionKey)` Select the process instances which are defined by a process definition with the given key.
`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 processDefinitionName
`ProcessInstanceQuery`	`processDefinitionVersion(Integer processDefinitionVersion)` Only select process instances with a certain process definition version.
`ProcessInstanceQuery`	`processInstanceBusinessKey(String businessKey)` Select process instances with the given business key
`ProcessInstanceQuery`	`processInstanceBusinessKey(String businessKey, String processDefinitionKey)` Select process instance with the given business key, unique for the given process definition
`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.
`ProcessInstanceQueryImpl`	`processInstanceId(String processInstanceId)` Select the process instance with the given id
`ProcessInstanceQuery`	`processInstanceIds(Set<String> processInstanceIds)` Select process instances whose id is in the given set of ids
`ProcessInstanceQuery`	`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`	`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`	`processInstanceWithoutTenantId()` Only select process instances that do not have a tenant id.
`void`	`setEventSubscriptions(List<EventSubscriptionQueryValue> eventSubscriptions)`
`void`	`setName(String name)`
`void`	`setNameLike(String nameLike)`
`void`	`setStartedAfter(Date startedAfter)`
`void`	`setStartedBefore(Date startedBefore)`
`void`	`setStartedBy(String startedBy)`
`void`	`setSuspensionState(SuspensionState suspensionState)`
`ProcessInstanceQuery`	`startedAfter(Date afterTime)` Only select process instances started after the given time
`ProcessInstanceQuery`	`startedBefore(Date beforeTime)` Only select process instances started before the given time
`ProcessInstanceQuery`	`startedBy(String userId)` Only select process instances started by the given user id
`ProcessInstanceQuery`	`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 suspended
`ProcessInstanceQuery`	`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 variableValue)` Only select process instances which have at least one global variable with the given value.
`ProcessInstanceQuery`	`variableValueEquals(String variableName, Object variableValue)` 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 variableName, Object variableValue)` 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.

Methods inherited from class org.flowable.common.engine.impl.AbstractQuery
asc, checkQueryOk, count, desc, direction, execute, executeSingleResult, list, listPage, orderBy, orderBy, setCommandExecutor, singleResult

Methods inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject
addOrder, getDatabaseType, getFirstResult, getFirstRow, getLastRow, getMaxResults, getNullHandlingColumn, getOrderBy, getOrderByColumnMap, getOrderByColumns, getParameter, setDatabaseType, setFirstResult, setMaxResults, setNullHandlingColumn, setOrderByColumns, setParameter

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.flowable.common.engine.api.query.Query
asc, count, desc, list, listPage, orderBy, orderBy, singleResult

- Field Detail
  - executionId
```
protected String executionId
```
  - businessKey
```
protected String businessKey
```
  - includeChildExecutionsWithBusinessKeyQuery
```
protected boolean includeChildExecutionsWithBusinessKeyQuery
```
  - processDefinitionId
```
protected String processDefinitionId
```
  - processDefinitionIds
```
protected Set<String> processDefinitionIds
```
  - processDefinitionCategory
```
protected String processDefinitionCategory
```
  - processDefinitionName
```
protected String processDefinitionName
```
  - processDefinitionVersion
```
protected Integer processDefinitionVersion
```
  - processInstanceIds
```
protected Set<String> processInstanceIds
```
  - processDefinitionKey
```
protected String processDefinitionKey
```
  - processDefinitionKeys
```
protected Set<String> processDefinitionKeys
```
  - processDefinitionEngineVersion
```
protected String processDefinitionEngineVersion
```
  - deploymentId
```
protected String deploymentId
```
  - deploymentIds
```
protected List<String> deploymentIds
```
  - superProcessInstanceId
```
protected String superProcessInstanceId
```
  - subProcessInstanceId
```
protected String subProcessInstanceId
```
  - excludeSubprocesses
```
protected boolean excludeSubprocesses
```
  - involvedUser
```
protected String involvedUser
```
  - involvedGroups
```
protected Set<String> involvedGroups
```
  - suspensionState
```
protected SuspensionState suspensionState
```
  - includeProcessVariables
```
protected boolean includeProcessVariables
```
  - processInstanceVariablesLimit
```
protected Integer processInstanceVariablesLimit
```
  - withJobException
```
protected boolean withJobException
```
  - name
```
protected String name
```
  - nameLike
```
protected String nameLike
```
  - nameLikeIgnoreCase
```
protected String nameLikeIgnoreCase
```
  - callbackId
```
protected String callbackId
```
  - callbackType
```
protected String callbackType
```
  - locale
```
protected String locale
```
  - withLocalizationFallback
```
protected boolean withLocalizationFallback
```
  - tenantId
```
protected String tenantId
```
  - tenantIdLike
```
protected String tenantIdLike
```
  - withoutTenantId
```
protected boolean withoutTenantId
```
  - orQueryObjects
```
protected List<ProcessInstanceQueryImpl> orQueryObjects
```
  - currentOrQueryObject
```
protected ProcessInstanceQueryImpl currentOrQueryObject
```
  - inOrStatement
```
protected boolean inOrStatement
```
  - startedBefore
```
protected Date startedBefore
```
  - startedAfter
```
protected Date startedAfter
```
  - startedBy
```
protected String startedBy
```
  - activityId
```
protected String activityId
```
  - eventSubscriptions
```
protected List<EventSubscriptionQueryValue> eventSubscriptions
```
  - onlyChildExecutions
```
protected boolean onlyChildExecutions
```
  - onlyProcessInstanceExecutions
```
protected boolean onlyProcessInstanceExecutions
```
  - onlySubProcessExecutions
```
protected boolean onlySubProcessExecutions
```
  - rootProcessInstanceId
```
protected String rootProcessInstanceId
```
- Constructor Detail
  - ProcessInstanceQueryImpl
```
public ProcessInstanceQueryImpl()
```
  - ProcessInstanceQueryImpl
```
public ProcessInstanceQueryImpl(CommandContext commandContext)
```
  - ProcessInstanceQueryImpl
```
public ProcessInstanceQueryImpl(CommandExecutor commandExecutor)
```
- Method Detail
  - processInstanceId
```
public ProcessInstanceQueryImpl processInstanceId(String processInstanceId)
```
    Description copied from interface: ProcessInstanceQuery
    
    Select the process instance with the given id
    
    Specified by:
    
    processInstanceId in interface ProcessInstanceQuery
  - processInstanceIds
```
public ProcessInstanceQuery processInstanceIds(Set<String> processInstanceIds)
```
    Description copied from interface: ProcessInstanceQuery
    
    Select process instances whose id is in the given set of ids
    
    Specified by:
    
    processInstanceIds in interface ProcessInstanceQuery
  - processInstanceBusinessKey
```
public ProcessInstanceQuery processInstanceBusinessKey(String businessKey)
```
    Description copied from interface: ProcessInstanceQuery
    
    Select process instances with the given business key
    
    Specified by:
    
    processInstanceBusinessKey in interface ProcessInstanceQuery
  - processInstanceBusinessKey
```
public ProcessInstanceQuery processInstanceBusinessKey(String businessKey,
                                                       String processDefinitionKey)
```
    Description copied from interface: ProcessInstanceQuery
    
    Select process instance with the given business key, unique for the given process definition
    
    Specified by:
    
    processInstanceBusinessKey in interface ProcessInstanceQuery
  - processInstanceTenantId
```
public ProcessInstanceQuery processInstanceTenantId(String tenantId)
```
    Description copied from interface: ProcessInstanceQuery
    
    Only select process instances that have the given tenant id.
    
    Specified by:
    
    processInstanceTenantId in interface ProcessInstanceQuery
  - processInstanceTenantIdLike
```
public ProcessInstanceQuery processInstanceTenantIdLike(String tenantIdLike)
```
    Description copied from interface: ProcessInstanceQuery
    
    Only select process instances with a tenant id like the given one.
    
    Specified by:
    
    processInstanceTenantIdLike in interface ProcessInstanceQuery
  - processInstanceWithoutTenantId
```
public ProcessInstanceQuery processInstanceWithoutTenantId()
```
    Description copied from interface: ProcessInstanceQuery
    
    Only select process instances that do not have a tenant id.
    
    Specified by:
    
    processInstanceWithoutTenantId in interface ProcessInstanceQuery
  - processDefinitionCategory
```
public ProcessInstanceQuery processDefinitionCategory(String processDefinitionCategory)
```
    Description copied from interface: ProcessInstanceQuery
    
    Only select process instances whose process definition category is processDefinitionCategory.
    
    Specified by:
    
    processDefinitionCategory in interface ProcessInstanceQuery
  - processDefinitionName
```
public ProcessInstanceQuery processDefinitionName(String processDefinitionName)
```
    Description copied from interface: ProcessInstanceQuery
    
    Select process instances whose process definition name is processDefinitionName
    
    Specified by:
    
    processDefinitionName in interface ProcessInstanceQuery
  - processDefinitionVersion
```
public ProcessInstanceQuery processDefinitionVersion(Integer processDefinitionVersion)
```
    Description copied from interface: ProcessInstanceQuery
    
    Only select process instances with a certain process definition version. Particularly useful when used in combination with ProcessInstanceQuery.processDefinitionKey(String)
    
    Specified by:
    
    processDefinitionVersion in interface ProcessInstanceQuery
  - processDefinitionId
```
public ProcessInstanceQueryImpl processDefinitionId(String processDefinitionId)
```
    Description copied from interface: ProcessInstanceQuery
    
    Select the process instances which are defined by a process definition with the given id.
    
    Specified by:
    
    processDefinitionId in interface ProcessInstanceQuery
  - processDefinitionIds
```
public ProcessInstanceQuery processDefinitionIds(Set<String> processDefinitionIds)
```
    Description copied from interface: ProcessInstanceQuery
    
    Select the process instances which are defined by process definitions with the given ids.
    
    Specified by:
    
    processDefinitionIds in interface ProcessInstanceQuery
  - processDefinitionKey
```
public ProcessInstanceQueryImpl processDefinitionKey(String processDefinitionKey)
```
    Description copied from interface: ProcessInstanceQuery
    
    Select the process instances which are defined by a process definition with the given key.
    
    Specified by:
    
    processDefinitionKey in interface ProcessInstanceQuery
  - processDefinitionKeys
```
public ProcessInstanceQuery processDefinitionKeys(Set<String> processDefinitionKeys)
```
    Description copied from interface: ProcessInstanceQuery
    
    Select the process instances which are defined by process definitions with the given keys.
    
    Specified by:
    
    processDefinitionKeys in interface ProcessInstanceQuery
  - processDefinitionEngineVersion
```
public ProcessInstanceQuery processDefinitionEngineVersion(String processDefinitionEngineVersion)
```
    Description copied from interface: ProcessInstanceQuery
    
    Select the process instances which are defined by a process definition with the given engine version.
    
    Specified by:
    
    processDefinitionEngineVersion in interface ProcessInstanceQuery
  - deploymentId
```
public ProcessInstanceQueryImpl deploymentId(String deploymentId)
```
    Description copied from interface: ProcessInstanceQuery
    
    Select the process instances which are defined by a deployment with the given id.
    
    Specified by:
    
    deploymentId in interface ProcessInstanceQuery
  - deploymentIdIn
```
public ProcessInstanceQueryImpl deploymentIdIn(List<String> deploymentIds)
```
    Description copied from interface: ProcessInstanceQuery
    
    Select the process instances which are defined by one of the given deployment ids
    
    Specified by:
    
    deploymentIdIn in interface ProcessInstanceQuery
  - superProcessInstanceId
```
public ProcessInstanceQuery superProcessInstanceId(String superProcessInstanceId)
```
    Description copied from interface: ProcessInstanceQuery
    
    Select the process instances which are a sub process instance of the given super process instance.
    
    Specified by:
    
    superProcessInstanceId in interface ProcessInstanceQuery
  - subProcessInstanceId
```
public ProcessInstanceQuery subProcessInstanceId(String subProcessInstanceId)
```
    Description copied from interface: ProcessInstanceQuery
    
    Select the process instance that have as sub process instance the given process instance. Note that there will always be maximum only one such process instance that can be the result of this query.
    
    Specified by:
    
    subProcessInstanceId in interface ProcessInstanceQuery
  - excludeSubprocesses
```
public ProcessInstanceQuery excludeSubprocesses(boolean excludeSubprocesses)
```
    Description copied from interface: ProcessInstanceQuery
    
    Exclude sub processes from the query result;
    
    Specified by:
    
    excludeSubprocesses in interface ProcessInstanceQuery
  - involvedUser
```
public ProcessInstanceQuery involvedUser(String involvedUser)
```
    Description copied from interface: ProcessInstanceQuery
    
    Select the process instances with which the user with the given id is involved.
    
    Specified by:
    
    involvedUser in interface ProcessInstanceQuery
  - involvedGroups
```
public ProcessInstanceQuery involvedGroups(Set<String> involvedGroups)
```
    Description copied from interface: ProcessInstanceQuery
    
    Select the process instances with which the Groups with the given ids are involved.
    
    Specified by:
    
    involvedGroups in interface ProcessInstanceQuery
  - active
```
public ProcessInstanceQuery active()
```
    Description copied from interface: ProcessInstanceQuery
    
    Only select process instances which are active, which means that neither the process instance nor the corresponding process definition are suspended.
    
    Specified by:
    
    active in interface ProcessInstanceQuery
  - suspended
```
public ProcessInstanceQuery suspended()
```
    Description copied from interface: ProcessInstanceQuery
    
    Only select process instances which are suspended, either because the process instance itself is suspended or because the corresponding process definition is suspended
    
    Specified by:
    
    suspended in interface ProcessInstanceQuery
  - includeProcessVariables
```
public ProcessInstanceQuery includeProcessVariables()
```
    Description copied from interface: ProcessInstanceQuery
    
    Include process variables in the process query result
    
    Specified by:
    
    includeProcessVariables in interface ProcessInstanceQuery
  - limitProcessInstanceVariables
```
public ProcessInstanceQuery limitProcessInstanceVariables(Integer processInstanceVariablesLimit)
```
    Description copied from interface: ProcessInstanceQuery
    
    Limit process instance variables
    
    Specified by:
    
    limitProcessInstanceVariables in interface ProcessInstanceQuery
  - getProcessInstanceVariablesLimit
```
public Integer getProcessInstanceVariablesLimit()
```
  - withJobException
```
public ProcessInstanceQuery withJobException()
```
    Description copied from interface: ProcessInstanceQuery
    
    Only select process instances that failed due to an exception happening during a job execution.
    
    Specified by:
    
    withJobException in interface ProcessInstanceQuery
  - processInstanceName
```
public ProcessInstanceQuery processInstanceName(String name)
```
    Description copied from interface: ProcessInstanceQuery
    
    Only select process instances with the given name.
    
    Specified by:
    
    processInstanceName in interface ProcessInstanceQuery
  - processInstanceNameLike
```
public ProcessInstanceQuery processInstanceNameLike(String nameLike)
```
    Description copied from interface: ProcessInstanceQuery
    
    Only select process instances with a name like the given value.
    
    Specified by:
    
    processInstanceNameLike in interface ProcessInstanceQuery
  - processInstanceNameLikeIgnoreCase
```
public ProcessInstanceQuery processInstanceNameLikeIgnoreCase(String nameLikeIgnoreCase)
```
    Description copied from interface: ProcessInstanceQuery
    
    Only select process instances with a name like the given value, ignoring upper/lower case.
    
    Specified by:
    
    processInstanceNameLikeIgnoreCase in interface ProcessInstanceQuery
  - processInstanceCallbackId
```
public ProcessInstanceQuery processInstanceCallbackId(String callbackId)
```
    Description copied from interface: ProcessInstanceQuery
    
    Only select process instances with the given callback id.
    
    Specified by:
    
    processInstanceCallbackId in interface ProcessInstanceQuery
  - processInstanceCallbackType
```
public ProcessInstanceQuery processInstanceCallbackType(String callbackType)
```
    Description copied from interface: ProcessInstanceQuery
    
    Only select process instances with the given callback type.
    
    Specified by:
    
    processInstanceCallbackType in interface ProcessInstanceQuery
  - or
```
public ProcessInstanceQuery or()
```
    Description copied from interface: ProcessInstanceQuery
    
    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.
    
    Specified by:
    
    or in interface ProcessInstanceQuery
  - endOr
```
public ProcessInstanceQuery endOr()
```
    Description copied from interface: ProcessInstanceQuery
    
    End an OR statement. Only one OR statement is allowed, for the second call to this method an exception will be thrown.
    
    Specified by:
    
    endOr in interface ProcessInstanceQuery
  - variableValueEquals
```
public ProcessInstanceQuery variableValueEquals(String variableName,
                                                Object variableValue)
```
    Description copied from interface: ProcessInstanceQuery
    
    Only select process instances which have a global variable with the given value. The type of variable is determined based on the value, using types configured in ProcessEngineConfiguration#getVariableTypes(). Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.
    
    Specified by:
    
    variableValueEquals in interface ProcessInstanceQuery
    
    Overrides:
    
    variableValueEquals in class AbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>
    
    Parameters:
    
    variableName - name of the variable, cannot be null.
  - variableValueNotEquals
```
public ProcessInstanceQuery variableValueNotEquals(String variableName,
                                                   Object variableValue)
```
    Description copied from interface: ProcessInstanceQuery
    
    Only select process instances which have a global variable with the given name, but with a different value than the passed value. Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.
    
    Specified by:
    
    variableValueNotEquals in interface ProcessInstanceQuery
    
    Overrides:
    
    variableValueNotEquals in class AbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>
    
    Parameters:
    
    variableName - name of the variable, cannot be null.
  - variableValueEquals
```
public ProcessInstanceQuery variableValueEquals(Object variableValue)
```
    Description copied from interface: ProcessInstanceQuery
    
    Only select process instances which have at least one global variable with the given value. The type of variable is determined based on the value, using types configured in ProcessEngineConfiguration#getVariableTypes(). Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.
    
    Specified by:
    
    variableValueEquals in interface ProcessInstanceQuery
    
    Overrides:
    
    variableValueEquals in class AbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>
  - variableValueEqualsIgnoreCase
```
public ProcessInstanceQuery variableValueEqualsIgnoreCase(String name,
                                                          String value)
```
    Description copied from interface: ProcessInstanceQuery
    
    Only select process instances which have a local string variable with the given value, case insensitive.
    This method only works if your database has encoding/collation that supports case-sensitive queries. For example, use "collate UTF-8" on MySQL and for MSSQL, select one of the case-sensitive Collations available (MSDN Server Collation Reference).
    
    Specified by:
    
    variableValueEqualsIgnoreCase in interface ProcessInstanceQuery
    
    Overrides:
    
    variableValueEqualsIgnoreCase in class AbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>
    
    Parameters:
    
    name - name of the variable, cannot be null.
    
    value - value of the variable, cannot be null.
  - variableValueNotEqualsIgnoreCase
```
public ProcessInstanceQuery variableValueNotEqualsIgnoreCase(String name,
                                                             String value)
```
    Description copied from interface: ProcessInstanceQuery
    
    Only select process instances which have a local string variable which is not the given value, case insensitive.
    This method only works if your database has encoding/collation that supports case-sensitive queries. For example, use "collate UTF-8" on MySQL and for MSSQL, select one of the case-sensitive Collations available (MSDN Server Collation Reference).
    
    Specified by:
    
    variableValueNotEqualsIgnoreCase in interface ProcessInstanceQuery
    
    Overrides:
    
    variableValueNotEqualsIgnoreCase in class AbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>
    
    Parameters:
    
    name - name of the variable, cannot be null.
    
    value - value of the variable, cannot be null.
  - variableValueGreaterThan
```
public ProcessInstanceQuery variableValueGreaterThan(String name,
                                                     Object value)
```
    Description copied from interface: ProcessInstanceQuery
    
    Only select process instances which have a variable value greater than the passed value. Booleans, Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.
    
    Specified by:
    
    variableValueGreaterThan in interface ProcessInstanceQuery
    
    Overrides:
    
    variableValueGreaterThan in class AbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>
    
    Parameters:
    
    name - variable name, cannot be null.
    
    value - variable value, cannot be null.
  - variableValueGreaterThanOrEqual
```
public ProcessInstanceQuery variableValueGreaterThanOrEqual(String name,
                                                            Object value)
```
    Description copied from interface: ProcessInstanceQuery
    
    Only select process instances which have a global variable value greater than or equal to the passed value. Booleans, Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.
    
    Specified by:
    
    variableValueGreaterThanOrEqual in interface ProcessInstanceQuery
    
    Overrides:
    
    variableValueGreaterThanOrEqual in class AbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>
    
    Parameters:
    
    name - variable name, cannot be null.
    
    value - variable value, cannot be null.
  - variableValueLessThan
```
public ProcessInstanceQuery variableValueLessThan(String name,
                                                  Object value)
```
    Description copied from interface: ProcessInstanceQuery
    
    Only select process instances which have a global variable value less than the passed value. Booleans, Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.
    
    Specified by:
    
    variableValueLessThan in interface ProcessInstanceQuery
    
    Overrides:
    
    variableValueLessThan in class AbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>
    
    Parameters:
    
    name - variable name, cannot be null.
    
    value - variable value, cannot be null.
  - variableValueLessThanOrEqual
```
public ProcessInstanceQuery variableValueLessThanOrEqual(String name,
                                                         Object value)
```
    Description copied from interface: ProcessInstanceQuery
    
    Only select process instances which have a global variable value less than or equal to the passed value. Booleans, Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.
    
    Specified by:
    
    variableValueLessThanOrEqual in interface ProcessInstanceQuery
    
    Overrides:
    
    variableValueLessThanOrEqual in class AbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>
    
    Parameters:
    
    name - variable name, cannot be null.
    
    value - variable value, cannot be null.
  - variableValueLike
```
public ProcessInstanceQuery variableValueLike(String name,
                                              String value)
```
    Description copied from interface: ProcessInstanceQuery
    
    Only select process instances which have a global variable value like the given value. This be used on string variables only.
    
    Specified by:
    
    variableValueLike in interface ProcessInstanceQuery
    
    Overrides:
    
    variableValueLike in class AbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>
    
    Parameters:
    
    name - variable name, cannot be null.
    
    value - variable value, cannot be null. The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%).
  - variableValueLikeIgnoreCase
```
public ProcessInstanceQuery variableValueLikeIgnoreCase(String name,
                                                        String value)
```
    Description copied from interface: ProcessInstanceQuery
    
    Only select process instances which have a global variable value like the given value (case insensitive). This be used on string variables only.
    
    Specified by:
    
    variableValueLikeIgnoreCase in interface ProcessInstanceQuery
    
    Overrides:
    
    variableValueLikeIgnoreCase in class AbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>
    
    Parameters:
    
    name - variable name, cannot be null.
    
    value - variable value, cannot be null. The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%).
  - variableExists
```
public ProcessInstanceQuery variableExists(String name)
```
    Description copied from interface: ProcessInstanceQuery
    
    Only select process instances which have a variable with the given name.
    
    Specified by:
    
    variableExists in interface ProcessInstanceQuery
    
    Overrides:
    
    variableExists in class AbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>
    
    Parameters:
    
    name - cannot be null.
  - variableNotExists
```
public ProcessInstanceQuery variableNotExists(String name)
```
    Description copied from interface: ProcessInstanceQuery
    
    Only select process instances which does not have a variable with the given name.
    
    Specified by:
    
    variableNotExists in interface ProcessInstanceQuery
    
    Overrides:
    
    variableNotExists in class AbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>
    
    Parameters:
    
    name - cannot be null.
  - locale
```
public ProcessInstanceQuery locale(String locale)
```
    Description copied from interface: ProcessInstanceQuery
    
    Localize process name and description to specified locale.
    
    Specified by:
    
    locale in interface ProcessInstanceQuery
  - withLocalizationFallback
```
public ProcessInstanceQuery withLocalizationFallback()
```
    Description copied from interface: ProcessInstanceQuery
    
    Instruct localization to fallback to more general locales including the default locale of the JVM if the specified locale is not found.
    
    Specified by:
    
    withLocalizationFallback in interface ProcessInstanceQuery
  - startedBefore
```
public ProcessInstanceQuery startedBefore(Date beforeTime)
```
    Description copied from interface: ProcessInstanceQuery
    
    Only select process instances started before the given time
    
    Specified by:
    
    startedBefore in interface ProcessInstanceQuery
  - startedAfter
```
public ProcessInstanceQuery startedAfter(Date afterTime)
```
    Description copied from interface: ProcessInstanceQuery
    
    Only select process instances started after the given time
    
    Specified by:
    
    startedAfter in interface ProcessInstanceQuery
  - startedBy
```
public ProcessInstanceQuery startedBy(String userId)
```
    Description copied from interface: ProcessInstanceQuery
    
    Only select process instances started by the given user id
    
    Specified by:
    
    startedBy in interface ProcessInstanceQuery
  - orderByProcessInstanceId
```
public ProcessInstanceQuery orderByProcessInstanceId()
```
    Description copied from interface: ProcessInstanceQuery
    
    Order by id (needs to be followed by Query.asc() or Query.desc()).
    
    Specified by:
    
    orderByProcessInstanceId in interface ProcessInstanceQuery
  - orderByProcessDefinitionId
```
public ProcessInstanceQuery orderByProcessDefinitionId()
```
    Description copied from interface: ProcessInstanceQuery
    
    Order by process definition id (needs to be followed by Query.asc() or Query.desc()).
    
    Specified by:
    
    orderByProcessDefinitionId in interface ProcessInstanceQuery
  - orderByProcessDefinitionKey
```
public ProcessInstanceQuery orderByProcessDefinitionKey()
```
    Description copied from interface: ProcessInstanceQuery
    
    Order by process definition key (needs to be followed by Query.asc() or Query.desc()).
    
    Specified by:
    
    orderByProcessDefinitionKey in interface ProcessInstanceQuery
  - orderByTenantId
```
public ProcessInstanceQuery orderByTenantId()
```
    Description copied from interface: ProcessInstanceQuery
    
    Order by tenant id (needs to be followed by Query.asc() or Query.desc()).
    
    Specified by:
    
    orderByTenantId in interface ProcessInstanceQuery
  - getMssqlOrDB2OrderBy
```
public String getMssqlOrDB2OrderBy()
```
  - executeCount
```
public long executeCount(CommandContext commandContext)
```
    Specified by:
    
    executeCount in class AbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>
  - executeList
```
public List<ProcessInstance> executeList(CommandContext commandContext)
```
    Specified by:
    
    executeList in class AbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>
  - ensureVariablesInitialized
```
protected void ensureVariablesInitialized()
```
    Overrides:
    
    ensureVariablesInitialized in class AbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>
  - localize
```
protected void localize(ProcessInstance processInstance)
```
  - getOnlyProcessInstances
```
public boolean getOnlyProcessInstances()
```
  - getProcessInstanceId
```
public String getProcessInstanceId()
```
  - getRootProcessInstanceId
```
public String getRootProcessInstanceId()
```
  - getProcessInstanceIds
```
public Set<String> getProcessInstanceIds()
```
  - getBusinessKey
```
public String getBusinessKey()
```
  - isIncludeChildExecutionsWithBusinessKeyQuery
```
public boolean isIncludeChildExecutionsWithBusinessKeyQuery()
```
  - getProcessDefinitionId
```
public String getProcessDefinitionId()
```
  - getProcessDefinitionIds
```
public Set<String> getProcessDefinitionIds()
```
  - getProcessDefinitionCategory
```
public String getProcessDefinitionCategory()
```
  - getProcessDefinitionName
```
public String getProcessDefinitionName()
```
  - getProcessDefinitionVersion
```
public Integer getProcessDefinitionVersion()
```
  - getProcessDefinitionKey
```
public String getProcessDefinitionKey()
```
  - getProcessDefinitionKeys
```
public Set<String> getProcessDefinitionKeys()
```
  - getProcessDefinitionEngineVersion
```
public String getProcessDefinitionEngineVersion()
```
  - getActivityId
```
public String getActivityId()
```
  - getSuperProcessInstanceId
```
public String getSuperProcessInstanceId()
```
  - getSubProcessInstanceId
```
public String getSubProcessInstanceId()
```
  - isExcludeSubprocesses
```
public boolean isExcludeSubprocesses()
```
  - getInvolvedUser
```
public String getInvolvedUser()
```
  - getInvolvedGroups
```
public Set<String> getInvolvedGroups()
```
  - getSuspensionState
```
public SuspensionState getSuspensionState()
```
  - setSuspensionState
```
public void setSuspensionState(SuspensionState suspensionState)
```
  - getEventSubscriptions
```
public List<EventSubscriptionQueryValue> getEventSubscriptions()
```
  - setEventSubscriptions
```
public void setEventSubscriptions(List<EventSubscriptionQueryValue> eventSubscriptions)
```
  - getTenantId
```
public String getTenantId()
```
  - getTenantIdLike
```
public String getTenantIdLike()
```
  - isWithoutTenantId
```
public boolean isWithoutTenantId()
```
  - getName
```
public String getName()
```
  - getNameLike
```
public String getNameLike()
```
  - setName
```
public void setName(String name)
```
  - setNameLike
```
public void setNameLike(String nameLike)
```
  - getExecutionId
```
public String getExecutionId()
```
  - getDeploymentId
```
public String getDeploymentId()
```
  - getDeploymentIds
```
public List<String> getDeploymentIds()
```
  - isIncludeProcessVariables
```
public boolean isIncludeProcessVariables()
```
  - iswithException
```
public boolean iswithException()
```
  - getNameLikeIgnoreCase
```
public String getNameLikeIgnoreCase()
```
  - getCallbackId
```
public String getCallbackId()
```
  - getCallbackType
```
public String getCallbackType()
```
  - getOrQueryObjects
```
public List<ProcessInstanceQueryImpl> getOrQueryObjects()
```
  - getParentId
```
public String getParentId()
```
    Methods needed for ibatis because of re-use of query-xml for executions. ExecutionQuery contains a parentId property.
  - isOnlyChildExecutions
```
public boolean isOnlyChildExecutions()
```
  - isOnlyProcessInstanceExecutions
```
public boolean isOnlyProcessInstanceExecutions()
```
  - isOnlySubProcessExecutions
```
public boolean isOnlySubProcessExecutions()
```
  - getStartedBefore
```
public Date getStartedBefore()
```
  - setStartedBefore
```
public void setStartedBefore(Date startedBefore)
```
  - getStartedAfter
```
public Date getStartedAfter()
```
  - setStartedAfter
```
public void setStartedAfter(Date startedAfter)
```
  - getStartedBy
```
public String getStartedBy()
```
  - setStartedBy
```
public void setStartedBy(String startedBy)
```

Class ProcessInstanceQueryImpl

Nested Class Summary

Nested classes/interfaces inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject

Nested classes/interfaces inherited from interface org.flowable.common.engine.api.query.Query

Field Summary

Fields inherited from class org.flowable.variable.service.impl.AbstractVariableQueryImpl

Fields inherited from class org.flowable.common.engine.impl.AbstractQuery

Fields inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject

Constructor Summary

Method Summary

Methods inherited from class org.flowable.variable.service.impl.AbstractVariableQueryImpl

Methods inherited from class org.flowable.common.engine.impl.AbstractQuery

Methods inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject

Methods inherited from class java.lang.Object

Methods inherited from interface org.flowable.common.engine.api.query.Query

Field Detail

executionId

businessKey

includeChildExecutionsWithBusinessKeyQuery

processDefinitionId

processDefinitionIds

processDefinitionCategory

processDefinitionName

processDefinitionVersion

processInstanceIds

processDefinitionKey

processDefinitionKeys

processDefinitionEngineVersion

deploymentId

deploymentIds

superProcessInstanceId

subProcessInstanceId

excludeSubprocesses

involvedUser

involvedGroups

suspensionState

includeProcessVariables

processInstanceVariablesLimit

withJobException

name

nameLike

nameLikeIgnoreCase

callbackId

callbackType

locale

withLocalizationFallback

tenantId

tenantIdLike

withoutTenantId

orQueryObjects

currentOrQueryObject

inOrStatement

startedBefore

startedAfter

startedBy

activityId

eventSubscriptions

onlyChildExecutions

onlyProcessInstanceExecutions

onlySubProcessExecutions

rootProcessInstanceId

Constructor Detail

ProcessInstanceQueryImpl

ProcessInstanceQueryImpl

ProcessInstanceQueryImpl

Method Detail

processInstanceId

processInstanceIds

processInstanceBusinessKey

processInstanceBusinessKey

processInstanceTenantId

processInstanceTenantIdLike

processInstanceWithoutTenantId

processDefinitionCategory

processDefinitionName

processDefinitionVersion

processDefinitionId

processDefinitionIds

processDefinitionKey

processDefinitionKeys