org.camunda.bpm.engine.impl

Class HistoricProcessInstanceReportImpl

java.lang.Object

org.camunda.bpm.engine.impl.HistoricProcessInstanceReportImpl

All Implemented Interfaces:

HistoricProcessInstanceReport, Report

public class HistoricProcessInstanceReportImpl
extends Object
implements HistoricProcessInstanceReport

Author:

Roman Smirnov

Field Summary

Fields

Modifier and Type	Field and Description
protected CommandExecutor	commandExecutor
protected PeriodUnit	durationPeriodUnit
protected String[]	processDefinitionIdIn
protected String[]	processDefinitionKeyIn
protected Date	startedAfter
protected Date	startedBefore
protected TenantCheck	tenantCheck

Constructor Summary

Constructors

Constructor and Description
HistoricProcessInstanceReportImpl(CommandExecutor commandExecutor)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doAuthCheck(CommandContext commandContext)
List<DurationReportResult>	duration(PeriodUnit periodUnit) Executes the duration report query and returns a list of DurationReportResults.
List<DurationReportResult>	executeDurationReport(CommandContext commandContext)
String[]	getProcessDefinitionIdIn()
String[]	getProcessDefinitionKeyIn()
String	getReportPeriodUnitName()
Date	getStartedAfter()
Date	getStartedBefore()
TenantCheck	getTenantCheck()
HistoricProcessInstanceReport	processDefinitionIdIn(String... processDefinitionIds) Only takes historic process instances into account for the given process definition ids.
HistoricProcessInstanceReport	processDefinitionKeyIn(String... processDefinitionKeys) Only takes historic process instances into account for the given process definition keys.
HistoricProcessInstanceReport	startedAfter(Date startedAfter) Only takes historic process instances into account that were started after the given date.
HistoricProcessInstanceReport	startedBefore(Date startedBefore) Only takes historic process instances into account that were started before the given date.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

startedAfter

protected Date startedAfter

startedBefore

protected Date startedBefore

processDefinitionIdIn

protected String[] processDefinitionIdIn

processDefinitionKeyIn

protected String[] processDefinitionKeyIn

durationPeriodUnit

protected PeriodUnit durationPeriodUnit

commandExecutor

protected CommandExecutor commandExecutor

tenantCheck

protected TenantCheck tenantCheck

Constructor Detail

HistoricProcessInstanceReportImpl

public HistoricProcessInstanceReportImpl(CommandExecutor commandExecutor)

Method Detail

startedAfter

public HistoricProcessInstanceReport startedAfter(Date startedAfter)

Description copied from interface: HistoricProcessInstanceReport

Only takes historic process instances into account that were started after the given date.

Specified by:

startedAfter in interface HistoricProcessInstanceReport

startedBefore

public HistoricProcessInstanceReport startedBefore(Date startedBefore)

Description copied from interface: HistoricProcessInstanceReport

Only takes historic process instances into account that were started before the given date.

Specified by:

startedBefore in interface HistoricProcessInstanceReport

processDefinitionIdIn

public HistoricProcessInstanceReport processDefinitionIdIn(String... processDefinitionIds)

Description copied from interface: HistoricProcessInstanceReport

Only takes historic process instances into account for the given process definition ids.

Specified by:

processDefinitionIdIn in interface HistoricProcessInstanceReport

processDefinitionKeyIn

public HistoricProcessInstanceReport processDefinitionKeyIn(String... processDefinitionKeys)

Description copied from interface: HistoricProcessInstanceReport

Only takes historic process instances into account for the given process definition keys.

Specified by:

processDefinitionKeyIn in interface HistoricProcessInstanceReport

duration

public List<DurationReportResult> duration(PeriodUnit periodUnit)

Description copied from interface: Report

Executes the duration report query and returns a list of DurationReportResults.

Be aware that the resulting report must be interpreted by the caller itself.

Specified by:

duration in interface Report

Parameters:

periodUnit - A period unit to define the granularity of the report.

Returns:

a list of DurationReportResults

executeDurationReport

public List<DurationReportResult> executeDurationReport(CommandContext commandContext)

doAuthCheck

protected void doAuthCheck(CommandContext commandContext)

getStartedAfter

public Date getStartedAfter()

getStartedBefore

public Date getStartedBefore()

getProcessDefinitionIdIn

public String[] getProcessDefinitionIdIn()

getProcessDefinitionKeyIn

public String[] getProcessDefinitionKeyIn()

getTenantCheck

public TenantCheck getTenantCheck()

getReportPeriodUnitName

public String getReportPeriodUnitName()