Package org.camunda.bpm.engine.history
Interface ReportResult
- All Known Subinterfaces:
DurationReportResult
- All Known Implementing Classes:
DurationReportResultEntity
,ReportResultEntity
public interface ReportResult
This interface defines basic methods for resulting reports.
- Author:
- Roman Smirnov
-
Method Summary
Modifier and TypeMethodDescriptionint
Returns a period which specifies a time span within a year.Returns the unit of the period.
-
Method Details
-
getPeriod
int getPeriod()Returns a period which specifies a time span within a year.
The returned period must be interpreted in conjunction with the returned
For example:PeriodUnit
ofgetPeriodUnit()
.getPeriodUnit()
returnsPeriodUnit.MONTH
getPeriod()
returns3
The returned period
3
must be interpreted as the thirdmonth
of the year (i.e. it represents the month March).If the
getPeriodUnit()
returnsPeriodUnit.QUARTER
, then the returned period3
must be interpreted as the thirdquarter
of the year.- Returns:
- an integer representing span of time within a year
-
getPeriodUnit
PeriodUnit getPeriodUnit()Returns the unit of the period.
- Returns:
- a
PeriodUnit
- See Also:
-