Package 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 java.lang.Object
implements HistoricProcessInstanceReport

Author:

Roman Smirnov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	HistoricProcessInstanceReportImpl.ExecuteDurationReportCmd

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
HistoricProcessInstanceReportImpl(CommandExecutor commandExecutor)

Method Summary

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

startedBefore

protected java.util.Date startedBefore

processDefinitionIdIn

protected java.lang.String[] processDefinitionIdIn

processDefinitionKeyIn

protected java.lang.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(java.util.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(java.util.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(java.lang.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(java.lang.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 java.util.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 java.util.List<DurationReportResult> executeDurationReport(CommandContext commandContext)

doAuthCheck

protected void doAuthCheck(CommandContext commandContext)

getStartedAfter

public java.util.Date getStartedAfter()

getStartedBefore

public java.util.Date getStartedBefore()

getProcessDefinitionIdIn

public java.lang.String[] getProcessDefinitionIdIn()

getProcessDefinitionKeyIn

public java.lang.String[] getProcessDefinitionKeyIn()

getTenantCheck

public TenantCheck getTenantCheck()

getReportPeriodUnitName

public java.lang.String getReportPeriodUnitName()