org.camunda.bpm.engine.impl
Class AbstractReport

java.lang.Object
  org.camunda.bpm.engine.impl.db.AuthorizationCheck
      org.camunda.bpm.engine.impl.AbstractReport

All Implemented Interfaces:

Serializable, Command<Object>, Report

Direct Known Subclasses:

HistoricProcessInstanceReportImpl

public abstract class AbstractReport
extends AuthorizationCheck
implements Command<Object>, Report, Serializable

Author:

Roman Smirnov

See Also:

Serialized Form

Nested Class Summary

static class

AbstractReport.ReportType

Field Summary

protected CommandExecutor	commandExecutor
protected PeriodUnit	reportPeriodUnit
protected AbstractReport.ReportType	reportType

Fields inherited from class org.camunda.bpm.engine.impl.db.AuthorizationCheck

authDefaultPerm, authGroupIds, authUserId, isAuthorizationCheckEnabled, permissionChecks

Constructor Summary

protected	AbstractReport()
protected	AbstractReport(CommandExecutor commandExecutor)

Method Summary

List<DurationReportResult>	duration(PeriodUnit periodUnit) Executes the duration report query and returns a list of DurationReportResults.
Object	execute(CommandContext commandContext)
List<DurationReportResult>	executeDuration(CommandContext commandContext)
abstract List<DurationReportResult>	executeDurationReport(CommandContext commandContext)
CommandExecutor	getCommandExecutor()
PeriodUnit	getReportPeriodUnit()
String	getReportPeriodUnitName()
AbstractReport.ReportType	getReportType()
String	getReportTypeName()
protected boolean	hasExcludingConditions() Whether or not the report query has excluding conditions.
AbstractReport	setCommandExecutor(CommandExecutor commandExecutor)

Methods inherited from class org.camunda.bpm.engine.impl.db.AuthorizationCheck

addAtomicPermissionCheck, getAuthDefaultPerm, getAuthGroupIds, getAuthUserId, getPermissionChecks, isAuthorizationCheckEnabled, setAtomicPermissionChecks, setAuthDefaultPerm, setAuthGroupIds, setAuthorizationCheckEnabled, setAuthUserId, setPermissionChecks

Methods inherited from class java.lang.Object

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

Field Detail

commandExecutor

protected transient CommandExecutor commandExecutor

reportType

protected AbstractReport.ReportType reportType

reportPeriodUnit

protected PeriodUnit reportPeriodUnit

Constructor Detail

AbstractReport

protected AbstractReport()

AbstractReport

protected AbstractReport(CommandExecutor commandExecutor)

Method Detail

execute

public Object execute(CommandContext commandContext)

Specified by:

execute in interface Command<Object>

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

executeDuration

public List<DurationReportResult> executeDuration(CommandContext commandContext)

executeDurationReport

public abstract List<DurationReportResult> executeDurationReport(CommandContext commandContext)

hasExcludingConditions

protected boolean hasExcludingConditions()

Whether or not the report query has excluding conditions. If the query has excluding conditions, (e.g. started before and after are excluding), the SQL query is avoided and a default result is returned. The returned result is the same as if the SQL was executed and there were no entries.

Returns:

true if the report query does have excluding conditions, false otherwise

getCommandExecutor

public CommandExecutor getCommandExecutor()

setCommandExecutor

public AbstractReport setCommandExecutor(CommandExecutor commandExecutor)

getReportPeriodUnit

public PeriodUnit getReportPeriodUnit()

getReportPeriodUnitName

public String getReportPeriodUnitName()

getReportType

public AbstractReport.ReportType getReportType()

getReportTypeName

public String getReportTypeName()