pro.taskana.monitor.api.reports

Interface WorkbasketReport.Builder

All Superinterfaces:

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

All Known Implementing Classes:

WorkbasketReportBuilderImpl

Enclosing class:

WorkbasketReport

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

Builder for WorkbasketReport.

Method Summary

Modifier and Type	Method and Description
WorkbasketReport	buildReport()
WorkbasketReport	buildReport(TaskTimestamp timestamp) Builds the given report.
WorkbasketReport.Builder	combinedClassificationFilterIn(List<CombinedClassificationFilter> combinedClassificationFilter) Adds a list of CombinedClassificationFilter to the builder.

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

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

Method Detail

buildReport

WorkbasketReport buildReport()
                      throws NotAuthorizedException,
                             InvalidArgumentException

Specified by:

buildReport in interface Report.Builder<MonitorQueryItem,TimeIntervalColumnHeader>

Throws:

NotAuthorizedException

InvalidArgumentException

buildReport

WorkbasketReport buildReport(TaskTimestamp timestamp)
                      throws NotAuthorizedException,
                             InvalidArgumentException

Description copied from interface: TimeIntervalReportBuilder

Builds the given report.

Specified by:

buildReport in interface TimeIntervalReportBuilder<WorkbasketReport.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

combinedClassificationFilterIn

WorkbasketReport.Builder combinedClassificationFilterIn(List<CombinedClassificationFilter> combinedClassificationFilter)

Adds a list of CombinedClassificationFilter to the builder. The created report contains only tasks with a pair of a classificationId for a task and a classificationId for the corresponding attachment in this list.

Parameters:

combinedClassificationFilter - a list of combinedClassificationFilter

Returns:

the WorkbasketReportBuilder