org.camunda.bpm.engine.impl.persistence.entity

Class ReportResultEntity

java.lang.Object

org.camunda.bpm.engine.impl.persistence.entity.ReportResultEntity

All Implemented Interfaces:

ReportResult

Direct Known Subclasses:

DurationReportResultEntity

public abstract class ReportResultEntity
extends Object
implements ReportResult

Author:

Roman Smirnov

Field Summary

Fields

Modifier and Type	Field and Description
protected int	period
protected PeriodUnit	periodUnit

Constructor Summary

Constructors

Constructor and Description
ReportResultEntity()

Method Summary

Methods

Modifier and Type	Method and Description
int	getPeriod() Returns a period which specifies a time span within a year.
PeriodUnit	getPeriodUnit() Returns the unit of the period.
void	setPeriod(int period)
void	setPeriodUnit(String periodUnit)

Methods inherited from class java.lang.Object

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

Field Detail

period

protected int period

periodUnit

protected PeriodUnit periodUnit

Constructor Detail

ReportResultEntity

public ReportResultEntity()

Method Detail

getPeriod

public int getPeriod()

Description copied from interface: ReportResult

Returns a period which specifies a time span within a year.

The returned period must be interpreted in conjunction with the returned PeriodUnit of ReportResult.getPeriodUnit().

For example:

• ReportResult.getPeriodUnit() returns PeriodUnit.MONTH
• ReportResult.getPeriod() returns 3

The returned period 3 must be interpreted as the third month of the year (i.e. it represents the month March).

If the ReportResult.getPeriodUnit() returns PeriodUnit.QUARTER, then the returned period 3 must be interpreted as the third quarter of the year.

Specified by:

getPeriod in interface ReportResult

Returns:

an integer representing span of time within a year

setPeriod

public void setPeriod(int period)

getPeriodUnit

public PeriodUnit getPeriodUnit()

Description copied from interface: ReportResult

Returns the unit of the period.

Specified by:

getPeriodUnit in interface ReportResult

Returns:

a PeriodUnit

See Also:

ReportResult.getPeriod()

setPeriodUnit

public void setPeriodUnit(String periodUnit)