HistoricActivityInstanceQuery (Camunda BPM Javadocs 7.9.19-ee)

All Superinterfaces:

Query<HistoricActivityInstanceQuery,HistoricActivityInstance>

All Known Implementing Classes:

HistoricActivityInstanceQueryImpl
```
public interface HistoricActivityInstanceQuery
extends Query<HistoricActivityInstanceQuery,HistoricActivityInstance>
```
Programmatic querying for HistoricActivityInstances.

Author:

Tom Baeyens

Method Summary

Methods
Modifier and Type	Method and Description
`HistoricActivityInstanceQuery`	`activityId(String activityId)` Only select historic activity instances for the given activity (id from BPMN 2.0 XML)
`HistoricActivityInstanceQuery`	`activityInstanceId(String activityInstanceId)` Only select historic activity instances with the given id (primary key within history tables).
`HistoricActivityInstanceQuery`	`activityName(String activityName)` Only select historic activity instances for activities with the given name
`HistoricActivityInstanceQuery`	`activityType(String activityType)` Only select historic activity instances for activities with the given activity type
`HistoricActivityInstanceQuery`	`canceled()` Only select historic activity instances that got canceled
`HistoricActivityInstanceQuery`	`completeScope()` Only select historic activity instances that complete a BPMN scope
`HistoricActivityInstanceQuery`	`executionId(String executionId)` Only select historic activity instances for the given execution
`HistoricActivityInstanceQuery`	`finished()` Only select historic activity instances that are finished.
`HistoricActivityInstanceQuery`	`finishedAfter(Date date)` Only select historic activity instances that were started after the given date.
`HistoricActivityInstanceQuery`	`finishedBefore(Date date)` Only select historic activity instances that were started before the given date.
`HistoricActivityInstanceQuery`	`orderByActivityId()` Order by activityId (needs to be followed by `Query.asc()` or `Query.desc()`).
`HistoricActivityInstanceQuery`	`orderByActivityName()` Order by activityName (needs to be followed by `Query.asc()` or `Query.desc()`).
`HistoricActivityInstanceQuery`	`orderByActivityType()` Order by activityType (needs to be followed by `Query.asc()` or `Query.desc()`).
`HistoricActivityInstanceQuery`	`orderByExecutionId()` Order by executionId (needs to be followed by `Query.asc()` or `Query.desc()`).
`HistoricActivityInstanceQuery`	`orderByHistoricActivityInstanceDuration()` Order by duration (needs to be followed by `Query.asc()` or `Query.desc()`).
`HistoricActivityInstanceQuery`	`orderByHistoricActivityInstanceEndTime()` Order by end (needs to be followed by `Query.asc()` or `Query.desc()`).
`HistoricActivityInstanceQuery`	`orderByHistoricActivityInstanceId()` Order by id (needs to be followed by `Query.asc()` or `Query.desc()`).
`HistoricActivityInstanceQuery`	`orderByHistoricActivityInstanceStartTime()` Order by start (needs to be followed by `Query.asc()` or `Query.desc()`).
`HistoricActivityInstanceQuery`	`orderByProcessDefinitionId()` Order by processDefinitionId (needs to be followed by `Query.asc()` or `Query.desc()`).
`HistoricActivityInstanceQuery`	`orderByProcessInstanceId()` Order by processInstanceId (needs to be followed by `Query.asc()` or `Query.desc()`).
`HistoricActivityInstanceQuery`	`orderByTenantId()` Order by tenant id (needs to be followed by `Query.asc()` or `Query.desc()`).
`HistoricActivityInstanceQuery`	`orderPartiallyByOccurrence()` Sort the `activity instances` in the order in which they occurred (ie.
`HistoricActivityInstanceQuery`	`processDefinitionId(String processDefinitionId)` Only select historic activity instances for the given process definition
`HistoricActivityInstanceQuery`	`processInstanceId(String processInstanceId)` Only select historic activity instances with the given process instance.
`HistoricActivityInstanceQuery`	`startedAfter(Date date)` Only select historic activity instances that were started after the given date.
`HistoricActivityInstanceQuery`	`startedBefore(Date date)` Only select historic activity instances that were started before the given date.
`HistoricActivityInstanceQuery`	`taskAssignee(String userId)` Only select historic activity instances for userTask activities assigned to the given user
`HistoricActivityInstanceQuery`	`tenantIdIn(String... tenantIds)` Only select historic activity instances with one of the given tenant ids.
`HistoricActivityInstanceQuery`	`unfinished()` Only select historic activity instances that are not finished yet.

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

- Method Detail
  - activityInstanceId
```
HistoricActivityInstanceQuery activityInstanceId(String activityInstanceId)
```
    Only select historic activity instances with the given id (primary key within history tables).
  - processInstanceId
```
HistoricActivityInstanceQuery processInstanceId(String processInstanceId)
```
    Only select historic activity instances with the given process instance. ProcessInstance) ids and {@link HistoricProcessInstance} ids match.
  - processDefinitionId
```
HistoricActivityInstanceQuery processDefinitionId(String processDefinitionId)
```
    Only select historic activity instances for the given process definition
  - executionId
```
HistoricActivityInstanceQuery executionId(String executionId)
```
    Only select historic activity instances for the given execution
  - activityId
```
HistoricActivityInstanceQuery activityId(String activityId)
```
    Only select historic activity instances for the given activity (id from BPMN 2.0 XML)
  - activityName
```
HistoricActivityInstanceQuery activityName(String activityName)
```
    Only select historic activity instances for activities with the given name
  - activityType
```
HistoricActivityInstanceQuery activityType(String activityType)
```
    Only select historic activity instances for activities with the given activity type
  - taskAssignee
```
HistoricActivityInstanceQuery taskAssignee(String userId)
```
    Only select historic activity instances for userTask activities assigned to the given user
  - finished
```
HistoricActivityInstanceQuery finished()
```
    Only select historic activity instances that are finished.
  - unfinished
```
HistoricActivityInstanceQuery unfinished()
```
    Only select historic activity instances that are not finished yet.
  - completeScope
```
HistoricActivityInstanceQuery completeScope()
```
    Only select historic activity instances that complete a BPMN scope
  - canceled
```
HistoricActivityInstanceQuery canceled()
```
    Only select historic activity instances that got canceled
  - startedBefore
```
HistoricActivityInstanceQuery startedBefore(Date date)
```
    Only select historic activity instances that were started before the given date.
  - startedAfter
```
HistoricActivityInstanceQuery startedAfter(Date date)
```
    Only select historic activity instances that were started after the given date.
  - finishedBefore
```
HistoricActivityInstanceQuery finishedBefore(Date date)
```
    Only select historic activity instances that were started before the given date.
  - finishedAfter
```
HistoricActivityInstanceQuery finishedAfter(Date date)
```
    Only select historic activity instances that were started after the given date.
  - orderByHistoricActivityInstanceId
```
HistoricActivityInstanceQuery orderByHistoricActivityInstanceId()
```
    Order by id (needs to be followed by Query.asc() or Query.desc()).
  - orderByProcessInstanceId
```
HistoricActivityInstanceQuery orderByProcessInstanceId()
```
    Order by processInstanceId (needs to be followed by Query.asc() or Query.desc()).
  - orderByExecutionId
```
HistoricActivityInstanceQuery orderByExecutionId()
```
    Order by executionId (needs to be followed by Query.asc() or Query.desc()).
  - orderByActivityId
```
HistoricActivityInstanceQuery orderByActivityId()
```
    Order by activityId (needs to be followed by Query.asc() or Query.desc()).
  - orderByActivityName
```
HistoricActivityInstanceQuery orderByActivityName()
```
    Order by activityName (needs to be followed by Query.asc() or Query.desc()).
  - orderByActivityType
```
HistoricActivityInstanceQuery orderByActivityType()
```
    Order by activityType (needs to be followed by Query.asc() or Query.desc()).
  - orderByHistoricActivityInstanceStartTime
```
HistoricActivityInstanceQuery orderByHistoricActivityInstanceStartTime()
```
    Order by start (needs to be followed by Query.asc() or Query.desc()).
  - orderByHistoricActivityInstanceEndTime
```
HistoricActivityInstanceQuery orderByHistoricActivityInstanceEndTime()
```
    Order by end (needs to be followed by Query.asc() or Query.desc()).
  - orderByHistoricActivityInstanceDuration
```
HistoricActivityInstanceQuery orderByHistoricActivityInstanceDuration()
```
    Order by duration (needs to be followed by Query.asc() or Query.desc()).
  - orderByProcessDefinitionId
```
HistoricActivityInstanceQuery orderByProcessDefinitionId()
```
    Order by processDefinitionId (needs to be followed by Query.asc() or Query.desc()).
  - orderPartiallyByOccurrence
```
HistoricActivityInstanceQuery orderPartiallyByOccurrence()
```
    Sort the activity instances in the order in which they occurred (ie. started) and needs to be followed by Query.asc() or Query.desc().
    
    The set of all activity instances is a partially ordered set. At a BPMN level this means that instances of concurrent activities (example: activities on different parallel branched after a parallel gateway) cannot be compared to each other. Instances of activities which are part of happens-before relation at the BPMN level will be ordered in respect to that relation.
    
    Technically this means that activity instances with different execution ids are incomparable. Only activity instances with the same execution id can be totally ordered by using executionId(String) and orderPartiallyByOccurrence() which will return a result set ordered by its occurrence.
    
    Since:
    
    7.3
  - tenantIdIn
```
HistoricActivityInstanceQuery tenantIdIn(String... tenantIds)
```
    Only select historic activity instances with one of the given tenant ids.
  - orderByTenantId
```
HistoricActivityInstanceQuery orderByTenantId()
```
    Order by tenant id (needs to be followed by Query.asc() or Query.desc()). Note that the ordering of historic activity instances without tenant id is database-specific.

Interface HistoricActivityInstanceQuery

Method Summary

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

Method Detail

activityInstanceId

processInstanceId

processDefinitionId

executionId

activityId

activityName

activityType

taskAssignee

finished

unfinished

completeScope

canceled

startedBefore

startedAfter

finishedBefore

finishedAfter

orderByHistoricActivityInstanceId

orderByProcessInstanceId

orderByExecutionId

orderByActivityId

orderByActivityName

orderByActivityType

orderByHistoricActivityInstanceStartTime

orderByHistoricActivityInstanceEndTime

orderByHistoricActivityInstanceDuration

orderByProcessDefinitionId

orderPartiallyByOccurrence

tenantIdIn

orderByTenantId