pro.taskana

Interface ClassificationReportBuilder

All Known Implementing Classes:

ClassificationReportBuilderImpl

public interface ClassificationReportBuilder

The ClassificationReportBuilder is used to build a ClassificationReport or a DetailedClassificationReport. Furthermore the taskIds and values of an entered custom field of these reports can be listed. A ClassificationReport contains the total numbers of tasks of the respective classification as well as the total number of all tasks. A ReportLine of a DetailedClassificationReport contains an additional list of ReportLines for the classifications of the attachments of the tasks. The tasks of the report can be filtered by workbaskets, states, categories, domains, classifications and values of a custom field. Classifications can also be excluded from the report. If the TimeIntervalColumnHeaders are set, the report contains also the number of tasks of the respective cluster. The age of the tasks can be counted in days or in working days. Tasks with Timestamp DUE = null are not considered.

Method Summary

Modifier and Type	Method and Description
DetailedClassificationReport	buildDetailedReport() Returns a DetailedClassificationReport containing all tasks after applying the filters.
ClassificationReport	buildReport() Returns a ClassificationReport containing all tasks after applying the filters.
ClassificationReportBuilder	categoryIn(List<String> categories) Adds a list of categories to the builder.
ClassificationReportBuilder	classificationIdIn(List<String> classificationIds) Adds a list of classificationIds to the builder.
ClassificationReportBuilder	customAttributeFilterIn(Map<CustomField,String> customAttributeFilter) Adds a map of custom attributes and custom attribute values to the builder.
ClassificationReportBuilder	domainIn(List<String> domains) Adds a list of domains to the builder.
ClassificationReportBuilder	excludedClassificationIdIn(List<String> excludedClassificationIds) Adds a list of excludedClassificationIds to the builder.
ClassificationReportBuilder	inWorkingDays() If this filter is used, the days of the report are counted in working days.
List<String>	listCustomAttributeValuesForCustomAttributeName(CustomField customField) Returns a list of all values of an entered custom field that are in the report.
List<String>	listTaskIdsForSelectedItems(List<SelectedItem> selectedItems) Returns a list of all taskIds of the report that are in the list of selected items.
ClassificationReportBuilder	stateIn(List<TaskState> states) Adds a list of states to the builder.
ClassificationReportBuilder	withColumnHeaders(List<TimeIntervalColumnHeader> columnHeaders) Adds a list TimeIntervalColumnHeaders to the builder to subdivide the report into clusters.
ClassificationReportBuilder	workbasketIdIn(List<String> workbasketIds) Adds a list of workbasket ids to the builder.

Method Detail

withColumnHeaders

ClassificationReportBuilder withColumnHeaders(List<TimeIntervalColumnHeader> columnHeaders)

Adds a list TimeIntervalColumnHeaders to the builder to subdivide the report into clusters.

Parameters:

columnHeaders - the column headers the report should consist of.

Returns:

the ClassificationReportBuilder

inWorkingDays

ClassificationReportBuilder inWorkingDays()

If this filter is used, the days of the report are counted in working days.

Returns:

the ClassificationReportBuilder

workbasketIdIn

ClassificationReportBuilder workbasketIdIn(List<String> workbasketIds)

Adds a list of workbasket ids to the builder. The created report contains only tasks with a workbasket id in this list.

Parameters:

workbasketIds - a list of workbasket ids

Returns:

the ClassificationReportBuilder

stateIn

ClassificationReportBuilder stateIn(List<TaskState> states)

Adds a list of states to the builder. The created report contains only tasks with a state in this list.

Parameters:

states - a list of states

Returns:

the ClassificationReportBuilder

categoryIn

ClassificationReportBuilder categoryIn(List<String> categories)

Adds a list of categories to the builder. The created report contains only tasks with a category in this list.

Parameters:

categories - a list of categories

Returns:

the ClassificationReportBuilder

classificationIdIn

ClassificationReportBuilder classificationIdIn(List<String> classificationIds)

Adds a list of classificationIds to the builder. The created report contains only tasks with a classificationId in this list.

Parameters:

classificationIds - a list of classificationIds

Returns:

the ClassificationReportBuilder

excludedClassificationIdIn

ClassificationReportBuilder excludedClassificationIdIn(List<String> excludedClassificationIds)

Adds a list of excludedClassificationIds to the builder. The created report contains only tasks with a classificationId NOT in this list.

Parameters:

excludedClassificationIds - a list of excludedClassificationIds

Returns:

the ClassificationReportBuilder

domainIn

ClassificationReportBuilder domainIn(List<String> domains)

Adds a list of domains to the builder. The created report contains only tasks with a domain in this list.

Parameters:

domains - a list of domains

Returns:

the ClassificationReportBuilder

customAttributeFilterIn

ClassificationReportBuilder customAttributeFilterIn(Map<CustomField,String> customAttributeFilter)

Adds a map of custom attributes and custom attribute values to the builder. The created report contains only tasks with a custom attribute value in this list.

Parameters:

customAttributeFilter - a map of custom attributes and custom attribute value

Returns:

the ClassificationReportBuilder

buildReport

ClassificationReport buildReport()
                          throws InvalidArgumentException,
                                 NotAuthorizedException

Returns a ClassificationReport containing all tasks after applying the filters. If the column headers are set the report is subdivided into clusters.

Returns:

the ClassificationReport

Throws:

InvalidArgumentException - if the column headers are not initialized

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

buildDetailedReport

DetailedClassificationReport buildDetailedReport()
                                          throws InvalidArgumentException,
                                                 NotAuthorizedException

Returns a DetailedClassificationReport containing all tasks after applying the filters. If the column headers are set the report is subdivided into clusters. Its DetailedReportRows contain an additional list of ReportRows 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

listTaskIdsForSelectedItems

List<String> listTaskIdsForSelectedItems(List<SelectedItem> selectedItems)
                                  throws NotAuthorizedException,
                                         InvalidArgumentException

Returns a list of all taskIds of the report that are in the list of selected items.

Parameters:

selectedItems - a list of selectedItems

Returns:

the list of all taskIds

Throws:

InvalidArgumentException - if the column headers are not initialized

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

listCustomAttributeValuesForCustomAttributeName

List<String> listCustomAttributeValuesForCustomAttributeName(CustomField customField)
                                                      throws NotAuthorizedException

Returns a list of all values of an entered custom field that are in the report.

Parameters:

customField - the customField whose values should appear in the list

Returns:

the list of all custom attribute values

Throws:

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