ReportResult (Camunda Platform Javadocs 7.19.0-SNAPSHOT)

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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`int`	`getPeriod()`	Returns a period which specifies a time span within a year.
`PeriodUnit`	`getPeriodUnit()`	Returns the unit of the period.

- Method Detail
  - 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 PeriodUnit of getPeriodUnit().
    
    For example:
    
    getPeriodUnit() returns PeriodUnit.MONTH
    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 getPeriodUnit() returns PeriodUnit.QUARTER, then the returned period 3 must be interpreted as the third quarter 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:
    
    getPeriod()