ProcessInstanceQueryImpl (Camunda BPM Javadocs 7.13.0-SNAPSHOT)

java.lang.Object
- org.camunda.bpm.engine.impl.db.ListQueryParameterObject
- - org.camunda.bpm.engine.impl.AbstractQuery<T,U>
  - - org.camunda.bpm.engine.impl.AbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>
    - - org.camunda.bpm.engine.impl.ProcessInstanceQueryImpl

All Implemented Interfaces:

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

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

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class org.camunda.bpm.engine.impl.AbstractQuery
  AbstractQuery.ResultType

Field Summary

Fields
Modifier and Type	Field and Description
`protected String[]`	`activityIds`
`protected String`	`businessKey`
`protected String`	`businessKeyLike`
`protected String`	`caseInstanceId`
`protected String`	`deploymentId`
`protected String`	`incidentId`
`protected String`	`incidentMessage`
`protected String`	`incidentMessageLike`
`protected String`	`incidentType`
`protected boolean`	`isLeafProcessInstances`
`protected boolean`	`isOrQueryActive`
`protected boolean`	`isProcessDefinitionWithoutTenantId`
`protected boolean`	`isRootProcessInstances`
`protected boolean`	`isTenantIdSet`
`protected String`	`processDefinitionId`
`protected String`	`processDefinitionKey`
`protected String[]`	`processDefinitionKeyNotIn`
`protected String[]`	`processDefinitionKeys`
`protected String`	`processInstanceId`
`protected Set<String>`	`processInstanceIds`
`protected List<ProcessInstanceQueryImpl>`	`queries`
`protected String`	`subCaseInstanceId`
`protected String`	`subProcessInstanceId`
`protected String`	`superCaseInstanceId`
`protected String`	`superProcessInstanceId`
`protected SuspensionState`	`suspensionState`
`protected String[]`	`tenantIds`
`protected boolean`	`withIncident`

Fields inherited from class org.camunda.bpm.engine.impl.AbstractVariableQueryImpl
queryVariableValues, variableNamesIgnoreCase, variableValuesIgnoreCase

Fields inherited from class org.camunda.bpm.engine.impl.AbstractQuery
commandExecutor, expressions, maxResultsLimitEnabled, resultType, SORTORDER_ASC, SORTORDER_DESC, validators

Fields inherited from class org.camunda.bpm.engine.impl.db.ListQueryParameterObject
authCheck, databaseType, firstResult, maxResults, orderingProperties, parameter, tenantCheck

Constructor Summary

Constructors
Constructor and Description

ProcessInstanceQueryImpl()

ProcessInstanceQueryImpl(CommandExecutor commandExecutor)

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ProcessInstanceQuery`	`active()` Only selects process instances which are active, which means that neither the process instance nor the corresponding process definition are suspended.
`ProcessInstanceQuery`	`activityIdIn(String... activityIds)` Only selects process instances with leaf activity instances or transition instances (async before, async after) in at least one of the given activity ids.
`void`	`addOrQuery(ProcessInstanceQueryImpl orQuery)`
`ProcessInstanceQuery`	`caseInstanceId(String caseInstanceId)` Selects the process instances which are associated with the given case instance id.
`protected void`	`checkQueryOk()`
`ProcessInstanceQuery`	`deploymentId(String deploymentId)` Selects the process instances which belong to the given deployment id.
`ProcessInstanceQuery`	`endOr()` endOr() terminates an OR query on which an arbitrary amount of filter criteria were applied.
`protected void`	`ensureVariablesInitialized()`
`long`	`executeCount(CommandContext commandContext)`
`List<String>`	`executeIdsList(CommandContext commandContext)`
`List<ProcessInstance>`	`executeList(CommandContext commandContext, Page page)` Executes the actual query to retrieve the list of results.
`String[]`	`getActivityIds()`
`String`	`getBusinessKey()`
`String`	`getBusinessKeyLike()`
`String`	`getCaseInstanceId()`
`String`	`getDeploymentId()`
`String`	`getIncidentId()`
`String`	`getIncidentMessage()`
`String`	`getIncidentMessageLike()`
`String`	`getIncidentType()`
`String`	`getProcessDefinitionId()`
`String`	`getProcessDefinitionKey()`
`String[]`	`getProcessDefinitionKeyNotIn()`
`String[]`	`getProcessDefinitionKeys()`
`String`	`getProcessInstanceId()`
`Set<String>`	`getProcessInstanceIds()`
`List<ProcessInstanceQueryImpl>`	`getQueries()`
`String`	`getSubCaseInstanceId()`
`String`	`getSubProcessInstanceId()`
`String`	`getSuperCaseInstanceId()`
`String`	`getSuperProcessInstanceId()`
`SuspensionState`	`getSuspensionState()`
`String[]`	`getTenantIds()`
`ProcessInstanceQuery`	`incidentId(String incidentId)` Only selects process instances with the given incident id.
`ProcessInstanceQuery`	`incidentMessage(String incidentMessage)` Only selects process instances with the given incident message.
`ProcessInstanceQuery`	`incidentMessageLike(String incidentMessageLike)` Only selects process instances with an incident message like the given.
`ProcessInstanceQuery`	`incidentType(String incidentType)` Only selects process instances with the given incident type.
`boolean`	`isLeafProcessInstances()`
`boolean`	`isOrQueryActive()`
`boolean`	`isProcessDefinitionWithoutTenantId()`
`boolean`	`isRootProcessInstances()`
`boolean`	`isTenantIdSet()`
`boolean`	`isWithIncident()`
`ProcessInstanceQuery`	`leafProcessInstances()` Only selects process instances which don't have subprocesses and thus are leaves of the execution tree.
`ProcessInstanceQuery`	`or()` After calling or(), a chain of several filter criteria could follow.
`ProcessInstanceQuery`	`orderByBusinessKey()` Order by the business key (needs to be followed by `Query.asc()` or `Query.desc()`).
`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()`).
`ProcessInstanceQueryImpl`	`processDefinitionId(String processDefinitionId)` Selects the process instances which are defined by a process definition with the given id.
`ProcessInstanceQueryImpl`	`processDefinitionKey(String processDefinitionKey)` Select the process instances which are defined by a process definition with the given key.
`ProcessInstanceQuery`	`processDefinitionKeyIn(String... processDefinitionKeys)` Select the process instances for any given process definition keys.
`ProcessInstanceQuery`	`processDefinitionKeyNotIn(String... processDefinitionKeys)` Select historic process instances that don't have a process-definition of which the key is present in the given list
`ProcessInstanceQuery`	`processDefinitionWithoutTenantId()` Only selects process instances which process definition has no tenant id.
`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`	`processInstanceBusinessKeyLike(String businessKeyLike)` Select process instances with a business key like the given value.
`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`	`rootProcessInstances()` Only selects process instances which are top level process instances.
`void`	`setOrQueryActive()`
`void`	`setSuspensionState(SuspensionState suspensionState)`
`ProcessInstanceQuery`	`subCaseInstanceId(String subCaseInstanceId)` Select the process instance that has as sub case instance the given case instance.
`ProcessInstanceQuery`	`subProcessInstanceId(String subProcessInstanceId)` Select the process instance that have as sub process instance the given process instance.
`ProcessInstanceQuery`	`superCaseInstanceId(String superCaseInstanceId)` Select the process instances which are a sub process instance of the given super case instance.
`ProcessInstanceQuery`	`superProcessInstanceId(String superProcessInstanceId)` Select the process instances which are a sub process instance of the given super process instance.
`ProcessInstanceQuery`	`suspended()` Only selects process instances which are suspended, either because the process instance itself is suspended or because the corresponding process definition is suspended
`ProcessInstanceQuery`	`tenantIdIn(String... tenantIds)` Only select process instances with one of the given tenant ids.
`ProcessInstanceQuery`	`withIncident()` Only selects process instances with at least one incident.
`ProcessInstanceQuery`	`withoutTenantId()` Only selects process instances which have no tenant id.

Methods inherited from class org.camunda.bpm.engine.impl.AbstractVariableQueryImpl
addVariable, getQueryVariableValues, isVariableNamesIgnoreCase, isVariableValuesIgnoreCase, matchVariableNamesIgnoreCase, matchVariableValuesIgnoreCase, variableValueEquals, variableValueGreaterThan, variableValueGreaterThanOrEqual, variableValueLessThan, variableValueLessThanOrEqual, variableValueLike, variableValueNotEquals

Methods inherited from class org.camunda.bpm.engine.impl.AbstractQuery
addExpression, addValidator, asc, checkMaxResultsLimit, count, desc, direction, disableMaxResultsLimit, enableMaxResultsLimit, evaluateExpressions, evaluateExpressionsAndExecuteCount, evaluateExpressionsAndExecuteIdsList, evaluateExpressionsAndExecuteList, execute, executeResult, executeSingleResult, extend, getExpressions, getMethod, hasExcludingConditions, list, listIds, listPage, mergeExpressions, mergeOrdering, orderBy, orderBy, removeValidator, setCommandExecutor, setExpressions, singleResult, unlimitedList, validate, validate

Methods inherited from class org.camunda.bpm.engine.impl.db.ListQueryParameterObject
getAuthCheck, getDatabaseType, getFirstResult, getFirstRow, getLastRow, getMaxResults, getOrderingProperties, getParameter, getTenantCheck, setAuthCheck, setDatabaseType, setFirstResult, setMaxResults, setOrderingProperties, setParameter, setTenantCheck

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

Methods inherited from interface org.camunda.bpm.engine.runtime.ProcessInstanceQuery
matchVariableNamesIgnoreCase, matchVariableValuesIgnoreCase, variableValueEquals, variableValueGreaterThan, variableValueGreaterThanOrEqual, variableValueLessThan, variableValueLessThanOrEqual, variableValueLike, variableValueNotEquals

Methods inherited from interface org.camunda.bpm.engine.query.Query
asc, count, desc, list, listPage, singleResult, unlimitedList

- Field Detail
  - processInstanceId
```
protected String processInstanceId
```
  - businessKey
```
protected String businessKey
```
  - businessKeyLike
```
protected String businessKeyLike
```
  - processDefinitionId
```
protected String processDefinitionId
```
  - processInstanceIds
```
protected Set<String> processInstanceIds
```
  - processDefinitionKey
```
protected String processDefinitionKey
```
  - processDefinitionKeys
```
protected String[] processDefinitionKeys
```
  - processDefinitionKeyNotIn
```
protected String[] processDefinitionKeyNotIn
```
  - deploymentId
```
protected String deploymentId
```
  - superProcessInstanceId
```
protected String superProcessInstanceId
```
  - subProcessInstanceId
```
protected String subProcessInstanceId
```
  - suspensionState
```
protected SuspensionState suspensionState
```
  - withIncident
```
protected boolean withIncident
```
  - incidentType
```
protected String incidentType
```
  - incidentId
```
protected String incidentId
```
  - incidentMessage
```
protected String incidentMessage
```
  - incidentMessageLike
```
protected String incidentMessageLike
```
  - caseInstanceId
```
protected String caseInstanceId
```
  - superCaseInstanceId
```
protected String superCaseInstanceId
```
  - subCaseInstanceId
```
protected String subCaseInstanceId
```
  - activityIds
```
protected String[] activityIds
```
  - isRootProcessInstances
```
protected boolean isRootProcessInstances
```
  - isLeafProcessInstances
```
protected boolean isLeafProcessInstances
```
  - isTenantIdSet
```
protected boolean isTenantIdSet
```
  - tenantIds
```
protected String[] tenantIds
```
  - isProcessDefinitionWithoutTenantId
```
protected boolean isProcessDefinitionWithoutTenantId
```
  - queries
```
protected List<ProcessInstanceQueryImpl> queries
```
  - isOrQueryActive
```
protected boolean isOrQueryActive
```
- Constructor Detail
  - ProcessInstanceQueryImpl
```
public ProcessInstanceQueryImpl()
```
  - 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
  - processInstanceBusinessKeyLike
```
public ProcessInstanceQuery processInstanceBusinessKeyLike(String businessKeyLike)
```
    Description copied from interface: ProcessInstanceQuery
    
    Select process instances with a business key like the given value.
    
    Specified by:
    
    processInstanceBusinessKeyLike in interface ProcessInstanceQuery
    
    Parameters:
    
    businessKeyLike - The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%).
  - processDefinitionId
```
public ProcessInstanceQueryImpl processDefinitionId(String processDefinitionId)
```
    Description copied from interface: ProcessInstanceQuery
    
    Selects the process instances which are defined by a process definition with the given id.
    
    Specified by:
    
    processDefinitionId 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
  - processDefinitionKeyIn
```
public ProcessInstanceQuery processDefinitionKeyIn(String... processDefinitionKeys)
```
    Description copied from interface: ProcessInstanceQuery
    
    Select the process instances for any given process definition keys.
    
    Specified by:
    
    processDefinitionKeyIn in interface ProcessInstanceQuery
  - processDefinitionKeyNotIn
```
public ProcessInstanceQuery processDefinitionKeyNotIn(String... processDefinitionKeys)
```
    Description copied from interface: ProcessInstanceQuery
    
    Select historic process instances that don't have a process-definition of which the key is present in the given list
    
    Specified by:
    
    processDefinitionKeyNotIn in interface ProcessInstanceQuery
  - deploymentId
```
public ProcessInstanceQuery deploymentId(String deploymentId)
```
    Description copied from interface: ProcessInstanceQuery
    
    Selects the process instances which belong to the given deployment id.
    
    Specified by:
    
    deploymentId 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
  - caseInstanceId
```
public ProcessInstanceQuery caseInstanceId(String caseInstanceId)
```
    Description copied from interface: ProcessInstanceQuery
    
    Selects the process instances which are associated with the given case instance id.
    
    Specified by:
    
    caseInstanceId in interface ProcessInstanceQuery
  - superCaseInstanceId
```
public ProcessInstanceQuery superCaseInstanceId(String superCaseInstanceId)
```
    Description copied from interface: ProcessInstanceQuery
    
    Select the process instances which are a sub process instance of the given super case instance.
    
    Specified by:
    
    superCaseInstanceId in interface ProcessInstanceQuery
  - subCaseInstanceId
```
public ProcessInstanceQuery subCaseInstanceId(String subCaseInstanceId)
```
    Description copied from interface: ProcessInstanceQuery
    
    Select the process instance that has as sub case instance the given case instance. Note that there will always be at most one such process instance that can be the result of this query.
    
    Specified by:
    
    subCaseInstanceId 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()). Note that the ordering of process instances without tenant id is database-specific.
    
    Specified by:
    
    orderByTenantId in interface ProcessInstanceQuery
  - orderByBusinessKey
```
public ProcessInstanceQuery orderByBusinessKey()
```
    Description copied from interface: ProcessInstanceQuery
    
    Order by the business key (needs to be followed by Query.asc() or Query.desc()).
    
    Specified by:
    
    orderByBusinessKey in interface ProcessInstanceQuery
  - active
```
public ProcessInstanceQuery active()
```
    Description copied from interface: ProcessInstanceQuery
    
    Only selects 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 selects 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
  - withIncident
```
public ProcessInstanceQuery withIncident()
```
    Description copied from interface: ProcessInstanceQuery
    
    Only selects process instances with at least one incident.
    
    Specified by:
    
    withIncident in interface ProcessInstanceQuery
  - incidentType
```
public ProcessInstanceQuery incidentType(String incidentType)
```
    Description copied from interface: ProcessInstanceQuery
    
    Only selects process instances with the given incident type.
    
    Specified by:
    
    incidentType in interface ProcessInstanceQuery
  - incidentId
```
public ProcessInstanceQuery incidentId(String incidentId)
```
    Description copied from interface: ProcessInstanceQuery
    
    Only selects process instances with the given incident id.
    
    Specified by:
    
    incidentId in interface ProcessInstanceQuery
  - incidentMessage
```
public ProcessInstanceQuery incidentMessage(String incidentMessage)
```
    Description copied from interface: ProcessInstanceQuery
    
    Only selects process instances with the given incident message.
    
    Specified by:
    
    incidentMessage in interface ProcessInstanceQuery
  - incidentMessageLike
```
public ProcessInstanceQuery incidentMessageLike(String incidentMessageLike)
```
    Description copied from interface: ProcessInstanceQuery
    
    Only selects process instances with an incident message like the given.
    
    Specified by:
    
    incidentMessageLike in interface ProcessInstanceQuery
  - tenantIdIn
```
public ProcessInstanceQuery tenantIdIn(String... tenantIds)
```
    Description copied from interface: ProcessInstanceQuery
    
    Only select process instances with one of the given tenant ids.
    
    Specified by:
    
    tenantIdIn in interface ProcessInstanceQuery
  - withoutTenantId
```
public ProcessInstanceQuery withoutTenantId()
```
    Description copied from interface: ProcessInstanceQuery
    
    Only selects process instances which have no tenant id.
    
    Specified by:
    
    withoutTenantId in interface ProcessInstanceQuery
  - activityIdIn
```
public ProcessInstanceQuery activityIdIn(String... activityIds)
```
    Description copied from interface: ProcessInstanceQuery
    
    Only selects process instances with leaf activity instances or transition instances (async before, async after) in at least one of the given activity ids.
    Leaf instance means this filter works for instances of a user task is matched, but not the embedded sub process it is contained in.
    
    Specified by:
    
    activityIdIn in interface ProcessInstanceQuery
  - rootProcessInstances
```
public ProcessInstanceQuery rootProcessInstances()
```
    Description copied from interface: ProcessInstanceQuery
    
    Only selects process instances which are top level process instances.
    
    Specified by:
    
    rootProcessInstances in interface ProcessInstanceQuery
  - leafProcessInstances
```
public ProcessInstanceQuery leafProcessInstances()
```
    Description copied from interface: ProcessInstanceQuery
    
    Only selects process instances which don't have subprocesses and thus are leaves of the execution tree.
    
    Specified by:
    
    leafProcessInstances in interface ProcessInstanceQuery
  - processDefinitionWithoutTenantId
```
public ProcessInstanceQuery processDefinitionWithoutTenantId()
```
    Description copied from interface: ProcessInstanceQuery
    
    Only selects process instances which process definition has no tenant id.
    
    Specified by:
    
    processDefinitionWithoutTenantId in interface ProcessInstanceQuery
  - checkQueryOk
```
protected void checkQueryOk()
```
    Overrides:
    
    checkQueryOk in class AbstractQuery<ProcessInstanceQuery,ProcessInstance>
  - executeCount
```
public long executeCount(CommandContext commandContext)
```
    Specified by:
    
    executeCount in class AbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>
  - executeList
```
public List<ProcessInstance> executeList(CommandContext commandContext,
                                         Page page)
```
    Description copied from class: AbstractQuery
    
    Executes the actual query to retrieve the list of results.
    
    Specified by:
    
    executeList in class AbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>
    
    page - used if the results must be paged. If null, no paging will be applied.
  - executeIdsList
```
public List<String> executeIdsList(CommandContext commandContext)
```
    Overrides:
    
    executeIdsList in class AbstractQuery<ProcessInstanceQuery,ProcessInstance>
  - ensureVariablesInitialized
```
protected void ensureVariablesInitialized()
```
    Overrides:
    
    ensureVariablesInitialized in class AbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>
  - getProcessInstanceId
```
public String getProcessInstanceId()
```
  - getProcessInstanceIds
```
public Set<String> getProcessInstanceIds()
```
  - getQueries
```
public List<ProcessInstanceQueryImpl> getQueries()
```
  - addOrQuery
```
public void addOrQuery(ProcessInstanceQueryImpl orQuery)
```
  - setOrQueryActive
```
public void setOrQueryActive()
```
  - isOrQueryActive
```
public boolean isOrQueryActive()
```
  - getActivityIds
```
public String[] getActivityIds()
```
  - getBusinessKey
```
public String getBusinessKey()
```
  - getBusinessKeyLike
```
public String getBusinessKeyLike()
```
  - getProcessDefinitionId
```
public String getProcessDefinitionId()
```
  - getProcessDefinitionKey
```
public String getProcessDefinitionKey()
```
  - getProcessDefinitionKeys
```
public String[] getProcessDefinitionKeys()
```
  - getProcessDefinitionKeyNotIn
```
public String[] getProcessDefinitionKeyNotIn()
```
  - getDeploymentId
```
public String getDeploymentId()
```
  - getSuperProcessInstanceId
```
public String getSuperProcessInstanceId()
```
  - getSubProcessInstanceId
```
public String getSubProcessInstanceId()
```
  - getSuspensionState
```
public SuspensionState getSuspensionState()
```
  - setSuspensionState
```
public void setSuspensionState(SuspensionState suspensionState)
```
  - isWithIncident
```
public boolean isWithIncident()
```
  - getIncidentId
```
public String getIncidentId()
```
  - getIncidentType
```
public String getIncidentType()
```
  - getIncidentMessage
```
public String getIncidentMessage()
```
  - getIncidentMessageLike
```
public String getIncidentMessageLike()
```
  - getCaseInstanceId
```
public String getCaseInstanceId()
```
  - getSuperCaseInstanceId
```
public String getSuperCaseInstanceId()
```
  - getSubCaseInstanceId
```
public String getSubCaseInstanceId()
```
  - isTenantIdSet
```
public boolean isTenantIdSet()
```
  - isRootProcessInstances
```
public boolean isRootProcessInstances()
```
  - isProcessDefinitionWithoutTenantId
```
public boolean isProcessDefinitionWithoutTenantId()
```
  - isLeafProcessInstances
```
public boolean isLeafProcessInstances()
```
  - getTenantIds
```
public String[] getTenantIds()
```
  - or
```
public ProcessInstanceQuery or()
```
    Description copied from interface: ProcessInstanceQuery
    
    After calling or(), a chain of several filter criteria could follow. Each filter criterion that follows or() will be linked together with an OR expression until the OR query is terminated. To terminate the OR query right after the last filter criterion was applied, ProcessInstanceQuery.endOr() must be invoked.
    
    Specified by:
    
    or in interface ProcessInstanceQuery
    
    Returns:
    
    an object of the type ProcessInstanceQuery on which an arbitrary amount of filter criteria could be applied. The several filter criteria will be linked together by an OR expression.
  - endOr
```
public ProcessInstanceQuery endOr()
```
    Description copied from interface: ProcessInstanceQuery
    
    endOr() terminates an OR query on which an arbitrary amount of filter criteria were applied. To terminate the OR query which has been started by invoking ProcessInstanceQuery.or(), endOr() must be invoked. Filter criteria which are applied after calling endOr() are linked together by an AND expression.
    
    Specified by:
    
    endOr in interface ProcessInstanceQuery
    
    Returns:
    
    an object of the type ProcessInstanceQuery on which an arbitrary amount of filter criteria could be applied. The filter criteria will be linked together by an AND expression.

Class ProcessInstanceQueryImpl

Nested Class Summary

Nested classes/interfaces inherited from class org.camunda.bpm.engine.impl.AbstractQuery

Field Summary

Fields inherited from class org.camunda.bpm.engine.impl.AbstractVariableQueryImpl

Fields inherited from class org.camunda.bpm.engine.impl.AbstractQuery

Fields inherited from class org.camunda.bpm.engine.impl.db.ListQueryParameterObject

Constructor Summary

Method Summary

Methods inherited from class org.camunda.bpm.engine.impl.AbstractVariableQueryImpl

Methods inherited from class org.camunda.bpm.engine.impl.AbstractQuery

Methods inherited from class org.camunda.bpm.engine.impl.db.ListQueryParameterObject

Methods inherited from class java.lang.Object

Methods inherited from interface org.camunda.bpm.engine.runtime.ProcessInstanceQuery

Methods inherited from interface org.camunda.bpm.engine.query.Query

Field Detail

processInstanceId

businessKey

businessKeyLike

processDefinitionId

processInstanceIds

processDefinitionKey

processDefinitionKeys

processDefinitionKeyNotIn

deploymentId

superProcessInstanceId

subProcessInstanceId

suspensionState

withIncident

incidentType

incidentId

incidentMessage

incidentMessageLike

caseInstanceId

superCaseInstanceId

subCaseInstanceId

activityIds

isRootProcessInstances

isLeafProcessInstances

isTenantIdSet

tenantIds

isProcessDefinitionWithoutTenantId

queries

isOrQueryActive

Constructor Detail

ProcessInstanceQueryImpl

ProcessInstanceQueryImpl

Method Detail

processInstanceId

processInstanceIds

processInstanceBusinessKey

processInstanceBusinessKey

processInstanceBusinessKeyLike

processDefinitionId

processDefinitionKey

processDefinitionKeyIn

processDefinitionKeyNotIn

deploymentId

superProcessInstanceId

subProcessInstanceId

caseInstanceId

superCaseInstanceId

subCaseInstanceId

orderByProcessInstanceId

orderByProcessDefinitionId

orderByProcessDefinitionKey

orderByTenantId

orderByBusinessKey

active

suspended

withIncident

incidentType

incidentId

incidentMessage

incidentMessageLike

tenantIdIn

withoutTenantId

activityIdIn

rootProcessInstances

leafProcessInstances