pro.taskana

Interface CustomFieldValueReportBuilder

All Known Implementing Classes:

CustomFieldValueReportBuilderImpl

public interface CustomFieldValueReportBuilder

The CustomFieldValueReportBuilder is used to build a CustomFieldValueReport and list the values of a entered custom field. A CustomFieldValueReport contains the total numbers of tasks of the respective custom field as well as the total number of all 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
CustomFieldValueReport	buildReport() Returns a CustomFieldValueReportBuilder containing all tasks after applying the filters.
CustomFieldValueReportBuilder	categoryIn(List<String> categories) Adds a list of categories to the builder.
CustomFieldValueReportBuilder	classificationIdIn(List<String> classificationIds) Adds a list of classificationIds to the builder.
CustomFieldValueReportBuilder	customAttributeFilterIn(Map<CustomField,String> customAttributeFilter) Adds a map of custom attributes and custom attribute values to the builder.
CustomFieldValueReportBuilder	domainIn(List<String> domains) Adds a list of domains to the builder.
CustomFieldValueReportBuilder	excludedClassificationIdIn(List<String> excludedClassificationIds) Adds a list of excludedClassificationIds to the builder.
CustomField	getCustomField() Gets the customField property of the CustomFieldValueReportBuilder.
CustomFieldValueReportBuilder	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.
CustomFieldValueReportBuilder	stateIn(List<TaskState> states) Adds a list of states to the builder.
CustomFieldValueReportBuilder	withColumnHeaders(List<TimeIntervalColumnHeader> columnHeaders) Adds a list TimeIntervalColumnHeaders to the builder to subdivide the report into clusters.
CustomFieldValueReportBuilder	workbasketIdIn(List<String> workbasketIds) Adds a list of workbasket ids to the builder.

Method Detail

withColumnHeaders

CustomFieldValueReportBuilder 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 CustomFieldValueReportBuilder

inWorkingDays

CustomFieldValueReportBuilder inWorkingDays()

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

Returns:

the CustomFieldValueReportBuilder

workbasketIdIn

CustomFieldValueReportBuilder 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 CustomFieldValueReportBuilder

stateIn

CustomFieldValueReportBuilder 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 CustomFieldValueReportBuilder

categoryIn

CustomFieldValueReportBuilder 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 CustomFieldValueReportBuilder

classificationIdIn

CustomFieldValueReportBuilder 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 CustomFieldValueReportBuilder

excludedClassificationIdIn

CustomFieldValueReportBuilder 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 CustomFieldValueReportBuilder

domainIn

CustomFieldValueReportBuilder 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 CustomFieldValueReportBuilder

customAttributeFilterIn

CustomFieldValueReportBuilder 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 CustomFieldValueReportBuilder

buildReport

CustomFieldValueReport buildReport()
                            throws InvalidArgumentException,
                                   NotAuthorizedException

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

Returns:

the CustomFieldValueReportBuilder

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

getCustomField

CustomField getCustomField()

Gets the customField property of the CustomFieldValueReportBuilder.

Returns:

the customField property