Interface HistoricActivityInstanceQuery
- All Superinterfaces:
Query<HistoricActivityInstanceQuery,
HistoricActivityInstance>
- All Known Implementing Classes:
HistoricActivityInstanceQueryImpl
HistoricActivityInstance
s.- Author:
- Tom Baeyens
-
Method Summary
Modifier and TypeMethodDescriptionactivityId
(String activityId) Only select historic activity instances for the given activity (id from BPMN 2.0 XML)activityInstanceId
(String activityInstanceId) Only select historic activity instances with the given id (primary key within history tables).activityName
(String activityName) Only select historic activity instances for activities with the given nameactivityNameLike
(String activityNameLike) Only select historic activity instances for activities which activityName is like the given value.activityType
(String activityType) Only select historic activity instances for activities with the given activity typecanceled()
Only select historic activity instances that got canceledOnly select historic activity instances that complete a BPMN scopeexecutionId
(String executionId) Only select historic activity instances for the given executionfinished()
Only select historic activity instances that are finished.finishedAfter
(Date date) Only select historic activity instances that were started after the given date.finishedBefore
(Date date) Only select historic activity instances that were started before the given date.Order by activityId (needs to be followed byQuery.asc()
orQuery.desc()
).Order by activityName (needs to be followed byQuery.asc()
orQuery.desc()
).Order by activityType (needs to be followed byQuery.asc()
orQuery.desc()
).Order by executionId (needs to be followed byQuery.asc()
orQuery.desc()
).Order by duration (needs to be followed byQuery.asc()
orQuery.desc()
).Order by end (needs to be followed byQuery.asc()
orQuery.desc()
).Order by id (needs to be followed byQuery.asc()
orQuery.desc()
).Order by start (needs to be followed byQuery.asc()
orQuery.desc()
).Order by processDefinitionId (needs to be followed byQuery.asc()
orQuery.desc()
).Order by processInstanceId (needs to be followed byQuery.asc()
orQuery.desc()
).Order by tenant id (needs to be followed byQuery.asc()
orQuery.desc()
).Sort theactivity instances
in the order in which they occurred (ie.processDefinitionId
(String processDefinitionId) Only select historic activity instances for the given process definitionprocessInstanceId
(String processInstanceId) Only select historic activity instances with the given process instance.startedAfter
(Date date) Only select historic activity instances that were started after the given date.startedBefore
(Date date) Only select historic activity instances that were started before the given date.taskAssignee
(String userId) Only select historic activity instances for userTask activities assigned to the given usertenantIdIn
(String... tenantIds) Only select historic activity instances with one of the given tenant ids.Only select historic activity instances that are not finished yet.Only selects historic activity instances that have no tenant id.Methods inherited from interface org.camunda.bpm.engine.query.Query
asc, count, desc, list, listPage, singleResult, unlimitedList
-
Method Details
-
activityInstanceId
Only select historic activity instances with the given id (primary key within history tables). -
processInstanceId
Only select historic activity instances with the given process instance.) ids and {@link HistoricProcessInstance} ids match.
-
processDefinitionId
Only select historic activity instances for the given process definition -
executionId
Only select historic activity instances for the given execution -
activityId
Only select historic activity instances for the given activity (id from BPMN 2.0 XML) -
activityName
Only select historic activity instances for activities with the given name -
activityNameLike
Only select historic activity instances for activities which activityName is like the given value.- Parameters:
activityNameLike
- The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%).
-
activityType
Only select historic activity instances for activities with the given activity type -
taskAssignee
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
Only select historic activity instances that were started before the given date. -
startedAfter
Only select historic activity instances that were started after the given date. -
finishedBefore
Only select historic activity instances that were started before the given date. -
finishedAfter
Only select historic activity instances that were started after the given date. -
orderByHistoricActivityInstanceId
HistoricActivityInstanceQuery orderByHistoricActivityInstanceId()Order by id (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByProcessInstanceId
HistoricActivityInstanceQuery orderByProcessInstanceId()Order by processInstanceId (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByExecutionId
HistoricActivityInstanceQuery orderByExecutionId()Order by executionId (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByActivityId
HistoricActivityInstanceQuery orderByActivityId()Order by activityId (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByActivityName
HistoricActivityInstanceQuery orderByActivityName()Order by activityName (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByActivityType
HistoricActivityInstanceQuery orderByActivityType()Order by activityType (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByHistoricActivityInstanceStartTime
HistoricActivityInstanceQuery orderByHistoricActivityInstanceStartTime()Order by start (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByHistoricActivityInstanceEndTime
HistoricActivityInstanceQuery orderByHistoricActivityInstanceEndTime()Order by end (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByHistoricActivityInstanceDuration
HistoricActivityInstanceQuery orderByHistoricActivityInstanceDuration()Order by duration (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByProcessDefinitionId
HistoricActivityInstanceQuery orderByProcessDefinitionId()Order by processDefinitionId (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderPartiallyByOccurrence
HistoricActivityInstanceQuery orderPartiallyByOccurrence()Sort the
activity instances
in the order in which they occurred (ie. started) and needs to be followed byQuery.asc()
orQuery.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 differentexecution ids
are incomparable. Onlyactivity instances
with the sameexecution id
can be totally ordered by usingexecutionId(String)
andorderPartiallyByOccurrence()
which will return a result set ordered by its occurrence.- Since:
- 7.3
-
tenantIdIn
Only select historic activity instances with one of the given tenant ids. -
withoutTenantId
HistoricActivityInstanceQuery withoutTenantId()Only selects historic activity instances that have no tenant id. -
orderByTenantId
HistoricActivityInstanceQuery orderByTenantId()Order by tenant id (needs to be followed byQuery.asc()
orQuery.desc()
). Note that the ordering of historic activity instances without tenant id is database-specific.
-