Package 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	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 Report for the specified TaskTimestamp.

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

classificationCategoryIn, classificationIdIn, customAttributeIn, customAttributeLike, customAttributeNotIn, customIntAttributeIn, customIntAttributeNotIn, customIntAttributeNotWithin, customIntAttributeWithin, domainIn, excludedClassificationIdIn, inWorkingDays, listCustomAttributeValuesForCustomAttributeName, listTaskIdsForSelectedItems, stateIn, withColumnHeaders, workbasketIdIn

Method Detail

buildReport

ClassificationReport buildReport()
                          throws InvalidArgumentException,
                                 NotAuthorizedException

Specified by:

buildReport in interface Report.Builder<MonitorQueryItem,TimeIntervalColumnHeader>

Throws:

InvalidArgumentException

NotAuthorizedException

buildReport

ClassificationReport buildReport(TaskTimestamp timestamp)
                          throws InvalidArgumentException,
                                 NotAuthorizedException

Description copied from interface: TimeIntervalReportBuilder

Builds the Report for the specified TaskTimestamp.

Specified by:

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

Parameters:

timestamp - The TaskTimestamp of interest

Returns:

The build Report

Throws:

InvalidArgumentException - if an error occurs

NotAuthorizedException - if the current user is not member of TaskanaRole.MONITOR or TaskanaRole.ADMIN

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 current user is not member of TaskanaRole.MONITOR or TaskanaRole.ADMIN

buildDetailedReport

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

Throws:

InvalidArgumentException

NotAuthorizedException