Package org.camunda.bpm.engine.impl

Class HistoricActivityStatisticsQueryImpl

java.lang.Object

org.camunda.bpm.engine.impl.db.ListQueryParameterObject

org.camunda.bpm.engine.impl.AbstractQuery<HistoricActivityStatisticsQuery,HistoricActivityStatistics>

org.camunda.bpm.engine.impl.HistoricActivityStatisticsQueryImpl

All Implemented Interfaces:

Serializable, HistoricActivityStatisticsQuery, Command<Object>, Query<HistoricActivityStatisticsQuery,HistoricActivityStatistics>

public class HistoricActivityStatisticsQueryImpl
extends AbstractQuery<HistoricActivityStatisticsQuery,HistoricActivityStatistics>
implements HistoricActivityStatisticsQuery

Author:

Roman Smirnov

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	Description
protected Date	finishedAfter
protected Date	finishedBefore
protected boolean	includeCanceled
protected boolean	includeCompleteScope
protected boolean	includeFinished
protected boolean	includeIncidents
protected String	processDefinitionId
protected String[]	processInstanceIds
protected Date	startedAfter
protected Date	startedBefore

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	Description
HistoricActivityStatisticsQueryImpl(String processDefinitionId, CommandExecutor commandExecutor)

Method Summary

Modifier and Type	Method	Description
protected void	checkQueryOk()
long	executeCount(CommandContext commandContext)
List<HistoricActivityStatistics>	executeList(CommandContext commandContext, Page page)	Executes the actual query to retrieve the list of results.
HistoricActivityStatisticsQuery	finishedAfter(Date date)	Only select historic activities of process instances that were finished after the given date.
HistoricActivityStatisticsQuery	finishedBefore(Date date)	Only select historic activities of process instances that were finished before the given date.
String	getProcessDefinitionId()
String[]	getProcessInstanceIds()
HistoricActivityStatisticsQuery	includeCanceled()	Include an aggregation of canceled instances in the result.
HistoricActivityStatisticsQuery	includeCompleteScope()	Include an aggregation of instances, which complete a scope (ie.
HistoricActivityStatisticsQuery	includeFinished()	Include an aggregation of finished instances in the result.
HistoricActivityStatisticsQuery	includeIncidents()	Include an aggregation of the incidents in the result.
boolean	isIncludeCanceled()
boolean	isIncludeCompleteScope()
boolean	isIncludeFinished()
boolean	isIncludeIncidents()
HistoricActivityStatisticsQuery	orderByActivityId()	Order by activity id (needs to be followed by Query.asc() or Query.desc()).
HistoricActivityStatisticsQuery	processInstanceIdIn(String... processInstanceIds)	Only select historic activities of process instances with the given IDs
HistoricActivityStatisticsQuery	startedAfter(Date date)	Only select historic activities of process instances that were started after the given date.
HistoricActivityStatisticsQuery	startedBefore(Date date)	Only select historic activities of process instances that were started before the given date.

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

addExpression, addValidator, asc, checkMaxResultsLimit, count, desc, direction, disableMaxResultsLimit, enableMaxResultsLimit, evaluateExpressions, evaluateExpressionsAndExecuteCount, evaluateExpressionsAndExecuteDeploymentIdMappingsList, evaluateExpressionsAndExecuteIdsList, evaluateExpressionsAndExecuteList, execute, executeDeploymentIdMappingsList, executeIdsList, executeResult, executeSingleResult, extend, getExpressions, getMethod, hasExcludingConditions, list, listDeploymentIdMappings, 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.query.Query

asc, count, desc, list, listPage, singleResult, unlimitedList

Field Details

processDefinitionId

protected String processDefinitionId

includeFinished

protected boolean includeFinished

includeCanceled

protected boolean includeCanceled

includeCompleteScope

protected boolean includeCompleteScope

includeIncidents

protected boolean includeIncidents

startedBefore

protected Date startedBefore

startedAfter

protected Date startedAfter

finishedBefore

protected Date finishedBefore

finishedAfter

protected Date finishedAfter

processInstanceIds

protected String[] processInstanceIds

Constructor Details

HistoricActivityStatisticsQueryImpl

public HistoricActivityStatisticsQueryImpl(String processDefinitionId,
 CommandExecutor commandExecutor)

Method Details

includeFinished

public HistoricActivityStatisticsQuery includeFinished()

Description copied from interface: HistoricActivityStatisticsQuery

Include an aggregation of finished instances in the result.

Specified by:

includeFinished in interface HistoricActivityStatisticsQuery

includeCanceled

public HistoricActivityStatisticsQuery includeCanceled()

Description copied from interface: HistoricActivityStatisticsQuery

Include an aggregation of canceled instances in the result.

Specified by:

includeCanceled in interface HistoricActivityStatisticsQuery

includeCompleteScope

public HistoricActivityStatisticsQuery includeCompleteScope()

Description copied from interface: HistoricActivityStatisticsQuery

Include an aggregation of instances, which complete a scope (ie. in bpmn manner: an activity which consumed a token and did not produced a new one), in the result.

Specified by:

includeCompleteScope in interface HistoricActivityStatisticsQuery

includeIncidents

public HistoricActivityStatisticsQuery includeIncidents()

Description copied from interface: HistoricActivityStatisticsQuery

Include an aggregation of the incidents in the result.

Specified by:

includeIncidents in interface HistoricActivityStatisticsQuery

startedAfter

public HistoricActivityStatisticsQuery startedAfter(Date date)

Description copied from interface: HistoricActivityStatisticsQuery

Only select historic activities of process instances that were started after the given date.

Specified by:

startedAfter in interface HistoricActivityStatisticsQuery

startedBefore

public HistoricActivityStatisticsQuery startedBefore(Date date)

Description copied from interface: HistoricActivityStatisticsQuery

Only select historic activities of process instances that were started before the given date.

Specified by:

startedBefore in interface HistoricActivityStatisticsQuery

finishedAfter

public HistoricActivityStatisticsQuery finishedAfter(Date date)

Description copied from interface: HistoricActivityStatisticsQuery

Only select historic activities of process instances that were finished after the given date.

Specified by:

finishedAfter in interface HistoricActivityStatisticsQuery

finishedBefore

public HistoricActivityStatisticsQuery finishedBefore(Date date)

Description copied from interface: HistoricActivityStatisticsQuery

Only select historic activities of process instances that were finished before the given date.

Specified by:

finishedBefore in interface HistoricActivityStatisticsQuery

processInstanceIdIn

public HistoricActivityStatisticsQuery processInstanceIdIn(String... processInstanceIds)

Description copied from interface: HistoricActivityStatisticsQuery

Only select historic activities of process instances with the given IDs

Specified by:

processInstanceIdIn in interface HistoricActivityStatisticsQuery

orderByActivityId

public HistoricActivityStatisticsQuery orderByActivityId()

Description copied from interface: HistoricActivityStatisticsQuery

Order by activity id (needs to be followed by Query.asc() or Query.desc()).

Specified by:

orderByActivityId in interface HistoricActivityStatisticsQuery

executeCount

public long executeCount(CommandContext commandContext)

Specified by:

executeCount in class AbstractQuery<HistoricActivityStatisticsQuery,HistoricActivityStatistics>

executeList

public List<HistoricActivityStatistics> 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 AbstractQuery<HistoricActivityStatisticsQuery,HistoricActivityStatistics>

page - used if the results must be paged. If null, no paging will be applied.

checkQueryOk

protected void checkQueryOk()

Overrides:

checkQueryOk in class AbstractQuery<HistoricActivityStatisticsQuery,HistoricActivityStatistics>

getProcessDefinitionId

public String getProcessDefinitionId()

isIncludeFinished

public boolean isIncludeFinished()

isIncludeCanceled

public boolean isIncludeCanceled()

isIncludeCompleteScope

public boolean isIncludeCompleteScope()

getProcessInstanceIds

public String[] getProcessInstanceIds()

isIncludeIncidents

public boolean isIncludeIncidents()