pro.taskana.monitor.api.reports

Interface ClassificationReport.Builder

All Superinterfaces:

Report.Builder<MonitorQueryItem,TimeIntervalColumnHeader>, TimeIntervalReportBuilder<ClassificationReport.Builder,MonitorQueryItem,TimeIntervalColumnHeader>

All Known Implementing Classes:

ClassificationReportBuilderImpl

Enclosing class:

ClassificationReport

public static interface ClassificationReport.Builder
extends TimeIntervalReportBuilder<ClassificationReport.Builder,MonitorQueryItem,TimeIntervalColumnHeader>

Builder for ClassificationReport.

Method Summary

Modifier and Type	Method and Description
ClassificationReport.DetailedClassificationReport	buildDetailedReport() Returns a ClassificationReport.DetailedClassificationReport containing all tasks after applying the filters.
ClassificationReport.DetailedClassificationReport	buildDetailedReport(TaskTimestamp timestamp)
ClassificationReport	buildReport()
ClassificationReport	buildReport(TaskTimestamp timestamp) Builds the given report.

Methods inherited from interface pro.taskana.monitor.api.reports.TimeIntervalReportBuilder

classificationCategoryIn, classificationIdIn, customAttributeFilterIn, domainIn, excludedClassificationIdIn, inWorkingDays, listCustomAttributeValuesForCustomAttributeName, listTaskIdsForSelectedItems, stateIn, withColumnHeaders, workbasketIdIn

Method Detail

buildReport

ClassificationReport buildReport()
                          throws NotAuthorizedException,
                                 InvalidArgumentException

Specified by:

buildReport in interface Report.Builder<MonitorQueryItem,TimeIntervalColumnHeader>

Throws:

NotAuthorizedException

InvalidArgumentException

buildReport

ClassificationReport buildReport(TaskTimestamp timestamp)
                          throws NotAuthorizedException,
                                 InvalidArgumentException

Description copied from interface: TimeIntervalReportBuilder

Builds the given report.

Specified by:

buildReport in interface TimeIntervalReportBuilder<ClassificationReport.Builder,MonitorQueryItem,TimeIntervalColumnHeader>

Parameters:

timestamp - The task timestamp of interest

Returns:

The build report

Throws:

NotAuthorizedException - if the user has no rights to access the monitor

InvalidArgumentException - when an error occurs

buildDetailedReport

ClassificationReport.DetailedClassificationReport buildDetailedReport()
                                                               throws InvalidArgumentException,
                                                                      NotAuthorizedException

Returns a ClassificationReport.DetailedClassificationReport containing all tasks after applying the filters. If the column headers are set the report is subdivided into clusters. Its FoldableRows contain an additional list of Rows for the classifications of the attachments of the tasks.

Returns:

the DetailedClassificationReport

Throws:

InvalidArgumentException - if the column headers are not initialized

NotAuthorizedException - if the user has no rights to access the monitor

buildDetailedReport

ClassificationReport.DetailedClassificationReport buildDetailedReport(TaskTimestamp timestamp)
                                                               throws InvalidArgumentException,
                                                                      NotAuthorizedException

Throws:

InvalidArgumentException

NotAuthorizedException