HistoricProcessInstanceQueryImpl (Activiti

java.lang.Object
- org.activiti.engine.impl.db.ListQueryParameterObject
- - org.activiti.engine.impl.AbstractQuery<T,U>
  - - org.activiti.engine.impl.AbstractVariableQueryImpl<HistoricProcessInstanceQuery,HistoricProcessInstance>
    - - org.activiti.engine.impl.HistoricProcessInstanceQueryImpl

All Implemented Interfaces:

Serializable, HistoricProcessInstanceQuery, Command<Object>, Query<HistoricProcessInstanceQuery,HistoricProcessInstance>
```
public class HistoricProcessInstanceQueryImpl
extends AbstractVariableQueryImpl<HistoricProcessInstanceQuery,HistoricProcessInstance>
implements HistoricProcessInstanceQuery
```
Author:

Tom Baeyens, Falko Menge, Bernd Ruecker

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`businessKey`
`protected boolean`	`excludeSubprocesses`
`protected boolean`	`finished`
`protected Date`	`finishedAfter`
`protected Date`	`finishedBefore`
`protected boolean`	`includeProcessVariables`
`protected String`	`involvedUser`
`protected String`	`processDefinitionId`
`protected String`	`processDefinitionKey`
`protected String`	`processInstanceId`
`protected Set<String>`	`processInstanceIds`
`protected List<String>`	`processKeyNotIn`
`protected Date`	`startedAfter`
`protected Date`	`startedBefore`
`protected String`	`startedBy`
`protected String`	`superProcessInstanceId`
`protected String`	`tenantId`
`protected String`	`tenantIdLike`
`protected boolean`	`unfinished`
`protected boolean`	`withoutTenantId`

Fields inherited from class org.activiti.engine.impl.AbstractVariableQueryImpl
queryVariableValues

Fields inherited from class org.activiti.engine.impl.AbstractQuery
commandContext, commandExecutor, orderBy, orderProperty, resultType, SORTORDER_ASC, SORTORDER_DESC

Fields inherited from class org.activiti.engine.impl.db.ListQueryParameterObject
databaseType, firstResult, maxResults, parameter

Constructor Summary

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

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`checkQueryOk()`
`HistoricProcessInstanceQuery`	`excludeSubprocesses(boolean excludeSubprocesses)` Exclude sub processes from the query result;
`long`	`executeCount(CommandContext commandContext)`
`List<HistoricProcessInstance>`	`executeList(CommandContext commandContext, Page page)` Executes the actual query to retrieve the list of results.
`HistoricProcessInstanceQuery`	`finished()` Only select historic process instances that are completely finished.
`HistoricProcessInstanceQuery`	`finishedAfter(Date date)` Only select historic process instances that were started after the given date.
`HistoricProcessInstanceQuery`	`finishedBefore(Date date)` Only select historic process instances that were started before the given date.
`String`	`getBusinessKey()`
`Date`	`getFinishedAfter()`
`Date`	`getFinishedBefore()`
`String`	`getInvolvedUser()`
`String`	`getMssqlOrDB2OrderBy()`
`String`	`getProcessDefinitionId()`
`String`	`getProcessDefinitionIdLike()`
`String`	`getProcessDefinitionKey()`
`String`	`getProcessInstanceId()`
`Set<String>`	`getProcessInstanceIds()`
`List<String>`	`getProcessKeyNotIn()`
`Date`	`getStartedAfter()`
`Date`	`getStartedBefore()`
`String`	`getStartedBy()`
`String`	`getSuperProcessInstanceId()`
`HistoricProcessInstanceQuery`	`includeProcessVariables()` Include process variables in the process query result
`HistoricProcessInstanceQuery`	`involvedUser(String userId)` Only select the historic process instances with which the user with the given id is involved.
`boolean`	`isExcludeSubprocesses()`
`boolean`	`isOpen()`
`HistoricProcessInstanceQuery`	`orderByProcessDefinitionId()` Order by the process definition id (needs to be followed by `Query.asc()` or `Query.desc()`).
`HistoricProcessInstanceQuery`	`orderByProcessInstanceBusinessKey()` Order by the business key (needs to be followed by `Query.asc()` or `Query.desc()`).
`HistoricProcessInstanceQuery`	`orderByProcessInstanceDuration()` Order by the duration of the process instance (needs to be followed by `Query.asc()` or `Query.desc()`).
`HistoricProcessInstanceQuery`	`orderByProcessInstanceEndTime()` Order by the end time (needs to be followed by `Query.asc()` or `Query.desc()`).
`HistoricProcessInstanceQuery`	`orderByProcessInstanceId()` Order by the process instance id (needs to be followed by `Query.asc()` or `Query.desc()`).
`HistoricProcessInstanceQuery`	`orderByProcessInstanceStartTime()` Order by the start time (needs to be followed by `Query.asc()` or `Query.desc()`).
`HistoricProcessInstanceQuery`	`orderByTenantId()` Order by tenant id (needs to be followed by `Query.asc()` or `Query.desc()`).
`HistoricProcessInstanceQueryImpl`	`processDefinitionId(String processDefinitionId)` Only select historic process instances for the given process definition
`HistoricProcessInstanceQuery`	`processDefinitionKey(String processDefinitionKey)` Only select historic process instances that are defined by a process definition with the given key.
`HistoricProcessInstanceQuery`	`processDefinitionKeyNotIn(List<String> processDefinitionKeys)` Only select historic process instances that don't have a process-definition of which the key is present in the given list
`HistoricProcessInstanceQuery`	`processInstanceBusinessKey(String businessKey)` Only select historic process instances with the given business key
`HistoricProcessInstanceQueryImpl`	`processInstanceId(String processInstanceId)` Only select historic process instances with the given process instance.
`HistoricProcessInstanceQuery`	`processInstanceIds(Set<String> processInstanceIds)` Only select historic process instances whose id is in the given set of ids.
`HistoricProcessInstanceQuery`	`processInstanceTenantId(String tenantId)` Only select process instances that have the given tenant id.
`HistoricProcessInstanceQuery`	`processInstanceTenantIdLike(String tenantIdLike)` Only select process instances with a tenant id like the given one.
`HistoricProcessInstanceQuery`	`processInstanceWithoutTenantId()` Only select process instances that do not have a tenant id.
`HistoricProcessInstanceQuery`	`startedAfter(Date date)` Only select historic process instances that were started after the given date.
`HistoricProcessInstanceQuery`	`startedBefore(Date date)` Only select historic process instances that were started before the given date.
`HistoricProcessInstanceQuery`	`startedBy(String userId)` Only select historic process instance that are started by the given user.
`HistoricProcessInstanceQuery`	`superProcessInstanceId(String superProcessInstanceId)` Only select historic process instances started by the given process instance.
`HistoricProcessInstanceQuery`	`unfinished()` Only select historic process instance that are not yet finished.

Methods inherited from class org.activiti.engine.impl.AbstractQuery
addOrder, asc, count, desc, direction, execute, executeSingleResult, getOrderBy, list, listPage, orderBy, setCommandExecutor, singleResult

Methods inherited from class org.activiti.engine.impl.db.ListQueryParameterObject
getDatabaseType, getFirstResult, getFirstRow, getLastRow, getMaxResults, getParameter, setDatabaseType, setFirstResult, setMaxResults, setParameter

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

Methods inherited from interface org.activiti.engine.history.HistoricProcessInstanceQuery
variableValueEquals, variableValueEquals, variableValueEqualsIgnoreCase, variableValueGreaterThan, variableValueGreaterThanOrEqual, variableValueLessThan, variableValueLessThanOrEqual, variableValueLike, variableValueNotEquals

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

- Field Detail
  - processInstanceId
```
protected String processInstanceId
```
  - processDefinitionId
```
protected String processDefinitionId
```
  - businessKey
```
protected String businessKey
```
  - finished
```
protected boolean finished
```
  - unfinished
```
protected boolean unfinished
```
  - startedBy
```
protected String startedBy
```
  - superProcessInstanceId
```
protected String superProcessInstanceId
```
  - excludeSubprocesses
```
protected boolean excludeSubprocesses
```
  - processKeyNotIn
```
protected List<String> processKeyNotIn
```
  - startedBefore
```
protected Date startedBefore
```
  - startedAfter
```
protected Date startedAfter
```
  - finishedBefore
```
protected Date finishedBefore
```
  - finishedAfter
```
protected Date finishedAfter
```
  - processDefinitionKey
```
protected String processDefinitionKey
```
  - processInstanceIds
```
protected Set<String> processInstanceIds
```
  - involvedUser
```
protected String involvedUser
```
  - includeProcessVariables
```
protected boolean includeProcessVariables
```
  - tenantId
```
protected String tenantId
```
  - tenantIdLike
```
protected String tenantIdLike
```
  - withoutTenantId
```
protected boolean withoutTenantId
```
- Constructor Detail
  - HistoricProcessInstanceQueryImpl
```
public HistoricProcessInstanceQueryImpl()
```
  - HistoricProcessInstanceQueryImpl
```
public HistoricProcessInstanceQueryImpl(CommandContext commandContext)
```
  - HistoricProcessInstanceQueryImpl
```
public HistoricProcessInstanceQueryImpl(CommandExecutor commandExecutor)
```
- Method Detail
  - processInstanceId
```
public HistoricProcessInstanceQueryImpl processInstanceId(String processInstanceId)
```
    Description copied from interface: HistoricProcessInstanceQuery
    
    Only select historic process instances with the given process instance. ProcessInstance) ids and {@link HistoricProcessInstance} ids match.
    
    Specified by:
    
    processInstanceId in interface HistoricProcessInstanceQuery
  - processInstanceIds
```
public HistoricProcessInstanceQuery processInstanceIds(Set<String> processInstanceIds)
```
    Description copied from interface: HistoricProcessInstanceQuery
    
    Only select historic process instances whose id is in the given set of ids. ProcessInstance) ids and {@link HistoricProcessInstance} ids match.
    
    Specified by:
    
    processInstanceIds in interface HistoricProcessInstanceQuery
  - processDefinitionId
```
public HistoricProcessInstanceQueryImpl processDefinitionId(String processDefinitionId)
```
    Description copied from interface: HistoricProcessInstanceQuery
    
    Only select historic process instances for the given process definition
    
    Specified by:
    
    processDefinitionId in interface HistoricProcessInstanceQuery
  - processDefinitionKey
```
public HistoricProcessInstanceQuery processDefinitionKey(String processDefinitionKey)
```
    Description copied from interface: HistoricProcessInstanceQuery
    
    Only select historic process instances that are defined by a process definition with the given key.
    
    Specified by:
    
    processDefinitionKey in interface HistoricProcessInstanceQuery
  - processInstanceBusinessKey
```
public HistoricProcessInstanceQuery processInstanceBusinessKey(String businessKey)
```
    Description copied from interface: HistoricProcessInstanceQuery
    
    Only select historic process instances with the given business key
    
    Specified by:
    
    processInstanceBusinessKey in interface HistoricProcessInstanceQuery
  - finished
```
public HistoricProcessInstanceQuery finished()
```
    Description copied from interface: HistoricProcessInstanceQuery
    
    Only select historic process instances that are completely finished.
    
    Specified by:
    
    finished in interface HistoricProcessInstanceQuery
  - unfinished
```
public HistoricProcessInstanceQuery unfinished()
```
    Description copied from interface: HistoricProcessInstanceQuery
    
    Only select historic process instance that are not yet finished.
    
    Specified by:
    
    unfinished in interface HistoricProcessInstanceQuery
  - startedBy
```
public HistoricProcessInstanceQuery startedBy(String userId)
```
    Description copied from interface: HistoricProcessInstanceQuery
    
    Only select historic process instance that are started by the given user.
    
    Specified by:
    
    startedBy in interface HistoricProcessInstanceQuery
  - processDefinitionKeyNotIn
```
public HistoricProcessInstanceQuery processDefinitionKeyNotIn(List<String> processDefinitionKeys)
```
    Description copied from interface: HistoricProcessInstanceQuery
    
    Only 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 HistoricProcessInstanceQuery
  - startedAfter
```
public HistoricProcessInstanceQuery startedAfter(Date date)
```
    Description copied from interface: HistoricProcessInstanceQuery
    
    Only select historic process instances that were started after the given date.
    
    Specified by:
    
    startedAfter in interface HistoricProcessInstanceQuery
  - startedBefore
```
public HistoricProcessInstanceQuery startedBefore(Date date)
```
    Description copied from interface: HistoricProcessInstanceQuery
    
    Only select historic process instances that were started before the given date.
    
    Specified by:
    
    startedBefore in interface HistoricProcessInstanceQuery
  - finishedAfter
```
public HistoricProcessInstanceQuery finishedAfter(Date date)
```
    Description copied from interface: HistoricProcessInstanceQuery
    
    Only select historic process instances that were started after the given date.
    
    Specified by:
    
    finishedAfter in interface HistoricProcessInstanceQuery
  - finishedBefore
```
public HistoricProcessInstanceQuery finishedBefore(Date date)
```
    Description copied from interface: HistoricProcessInstanceQuery
    
    Only select historic process instances that were started before the given date.
    
    Specified by:
    
    finishedBefore in interface HistoricProcessInstanceQuery
  - superProcessInstanceId
```
public HistoricProcessInstanceQuery superProcessInstanceId(String superProcessInstanceId)
```
    Description copied from interface: HistoricProcessInstanceQuery
    
    Only select historic process instances started by the given process instance. ProcessInstance) ids and {@link HistoricProcessInstance} ids match.
    
    Specified by:
    
    superProcessInstanceId in interface HistoricProcessInstanceQuery
  - excludeSubprocesses
```
public HistoricProcessInstanceQuery excludeSubprocesses(boolean excludeSubprocesses)
```
    Description copied from interface: HistoricProcessInstanceQuery
    
    Exclude sub processes from the query result;
    
    Specified by:
    
    excludeSubprocesses in interface HistoricProcessInstanceQuery
  - involvedUser
```
public HistoricProcessInstanceQuery involvedUser(String userId)
```
    Description copied from interface: HistoricProcessInstanceQuery
    
    Only select the historic process instances with which the user with the given id is involved.
    
    Specified by:
    
    involvedUser in interface HistoricProcessInstanceQuery
  - includeProcessVariables
```
public HistoricProcessInstanceQuery includeProcessVariables()
```
    Description copied from interface: HistoricProcessInstanceQuery
    
    Include process variables in the process query result
    
    Specified by:
    
    includeProcessVariables in interface HistoricProcessInstanceQuery
  - processInstanceTenantId
```
public HistoricProcessInstanceQuery processInstanceTenantId(String tenantId)
```
    Description copied from interface: HistoricProcessInstanceQuery
    
    Only select process instances that have the given tenant id.
    
    Specified by:
    
    processInstanceTenantId in interface HistoricProcessInstanceQuery
  - processInstanceTenantIdLike
```
public HistoricProcessInstanceQuery processInstanceTenantIdLike(String tenantIdLike)
```
    Description copied from interface: HistoricProcessInstanceQuery
    
    Only select process instances with a tenant id like the given one.
    
    Specified by:
    
    processInstanceTenantIdLike in interface HistoricProcessInstanceQuery
  - processInstanceWithoutTenantId
```
public HistoricProcessInstanceQuery processInstanceWithoutTenantId()
```
    Description copied from interface: HistoricProcessInstanceQuery
    
    Only select process instances that do not have a tenant id.
    
    Specified by:
    
    processInstanceWithoutTenantId in interface HistoricProcessInstanceQuery
  - orderByProcessInstanceBusinessKey
```
public HistoricProcessInstanceQuery orderByProcessInstanceBusinessKey()
```
    Description copied from interface: HistoricProcessInstanceQuery
    
    Order by the business key (needs to be followed by Query.asc() or Query.desc()).
    
    Specified by:
    
    orderByProcessInstanceBusinessKey in interface HistoricProcessInstanceQuery
  - orderByProcessInstanceDuration
```
public HistoricProcessInstanceQuery orderByProcessInstanceDuration()
```
    Description copied from interface: HistoricProcessInstanceQuery
    
    Order by the duration of the process instance (needs to be followed by Query.asc() or Query.desc()).
    
    Specified by:
    
    orderByProcessInstanceDuration in interface HistoricProcessInstanceQuery
  - orderByProcessInstanceStartTime
```
public HistoricProcessInstanceQuery orderByProcessInstanceStartTime()
```
    Description copied from interface: HistoricProcessInstanceQuery
    
    Order by the start time (needs to be followed by Query.asc() or Query.desc()).
    
    Specified by:
    
    orderByProcessInstanceStartTime in interface HistoricProcessInstanceQuery
  - orderByProcessInstanceEndTime
```
public HistoricProcessInstanceQuery orderByProcessInstanceEndTime()
```
    Description copied from interface: HistoricProcessInstanceQuery
    
    Order by the end time (needs to be followed by Query.asc() or Query.desc()).
    
    Specified by:
    
    orderByProcessInstanceEndTime in interface HistoricProcessInstanceQuery
  - orderByProcessDefinitionId
```
public HistoricProcessInstanceQuery orderByProcessDefinitionId()
```
    Description copied from interface: HistoricProcessInstanceQuery
    
    Order by the process definition id (needs to be followed by Query.asc() or Query.desc()).
    
    Specified by:
    
    orderByProcessDefinitionId in interface HistoricProcessInstanceQuery
  - orderByProcessInstanceId
```
public HistoricProcessInstanceQuery orderByProcessInstanceId()
```
    Description copied from interface: HistoricProcessInstanceQuery
    
    Order by the process instance id (needs to be followed by Query.asc() or Query.desc()).
    
    Specified by:
    
    orderByProcessInstanceId in interface HistoricProcessInstanceQuery
  - orderByTenantId
```
public HistoricProcessInstanceQuery orderByTenantId()
```
    Description copied from interface: HistoricProcessInstanceQuery
    
    Order by tenant id (needs to be followed by Query.asc() or Query.desc()).
    
    Specified by:
    
    orderByTenantId in interface HistoricProcessInstanceQuery
  - getMssqlOrDB2OrderBy
```
public String getMssqlOrDB2OrderBy()
```
  - executeCount
```
public long executeCount(CommandContext commandContext)
```
    Specified by:
    
    executeCount in class AbstractVariableQueryImpl<HistoricProcessInstanceQuery,HistoricProcessInstance>
  - executeList
```
public List<HistoricProcessInstance> 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<HistoricProcessInstanceQuery,HistoricProcessInstance>
    
    page - used if the results must be paged. If null, no paging will be applied.
  - checkQueryOk
```
protected void checkQueryOk()
```
    Overrides:
    
    checkQueryOk in class AbstractQuery<HistoricProcessInstanceQuery,HistoricProcessInstance>
  - getBusinessKey
```
public String getBusinessKey()
```
  - isOpen
```
public boolean isOpen()
```
  - getProcessDefinitionId
```
public String getProcessDefinitionId()
```
  - getProcessDefinitionKey
```
public String getProcessDefinitionKey()
```
  - getProcessDefinitionIdLike
```
public String getProcessDefinitionIdLike()
```
  - getProcessInstanceId
```
public String getProcessInstanceId()
```
  - getProcessInstanceIds
```
public Set<String> getProcessInstanceIds()
```
  - getStartedBy
```
public String getStartedBy()
```
  - getSuperProcessInstanceId
```
public String getSuperProcessInstanceId()
```
  - isExcludeSubprocesses
```
public boolean isExcludeSubprocesses()
```
  - getProcessKeyNotIn
```
public List<String> getProcessKeyNotIn()
```
  - getStartedAfter
```
public Date getStartedAfter()
```
  - getStartedBefore
```
public Date getStartedBefore()
```
  - getFinishedAfter
```
public Date getFinishedAfter()
```
  - getFinishedBefore
```
public Date getFinishedBefore()
```
  - getInvolvedUser
```
public String getInvolvedUser()
```

Class HistoricProcessInstanceQueryImpl

Field Summary

Fields inherited from class org.activiti.engine.impl.AbstractVariableQueryImpl

Fields inherited from class org.activiti.engine.impl.AbstractQuery

Fields inherited from class org.activiti.engine.impl.db.ListQueryParameterObject

Constructor Summary

Method Summary

Methods inherited from class org.activiti.engine.impl.AbstractVariableQueryImpl

Methods inherited from class org.activiti.engine.impl.AbstractQuery

Methods inherited from class org.activiti.engine.impl.db.ListQueryParameterObject

Methods inherited from class java.lang.Object

Methods inherited from interface org.activiti.engine.history.HistoricProcessInstanceQuery

Methods inherited from interface org.activiti.engine.query.Query

Field Detail

processInstanceId

processDefinitionId

businessKey

finished

unfinished

startedBy

superProcessInstanceId

excludeSubprocesses

processKeyNotIn

startedBefore

startedAfter

finishedBefore

finishedAfter

processDefinitionKey

processInstanceIds

involvedUser

includeProcessVariables

tenantId

tenantIdLike

withoutTenantId

Constructor Detail

HistoricProcessInstanceQueryImpl

HistoricProcessInstanceQueryImpl

HistoricProcessInstanceQueryImpl

Method Detail

processInstanceId

processInstanceIds

processDefinitionId

processDefinitionKey

processInstanceBusinessKey

finished

unfinished

startedBy

processDefinitionKeyNotIn

startedAfter

startedBefore

finishedAfter

finishedBefore

superProcessInstanceId

excludeSubprocesses

involvedUser

includeProcessVariables

processInstanceTenantId

processInstanceTenantIdLike

processInstanceWithoutTenantId

orderByProcessInstanceBusinessKey

orderByProcessInstanceDuration

orderByProcessInstanceStartTime

orderByProcessInstanceEndTime

orderByProcessDefinitionId

orderByProcessInstanceId

orderByTenantId

getMssqlOrDB2OrderBy

executeCount

executeList

checkQueryOk

getBusinessKey

isOpen

getProcessDefinitionId

getProcessDefinitionKey

getProcessDefinitionIdLike

getProcessInstanceId

getProcessInstanceIds

getStartedBy

getSuperProcessInstanceId

isExcludeSubprocesses