pro.taskana.impl

Class CategoryReportBuilderImpl

java.lang.Object

pro.taskana.impl.ReportBuilder

pro.taskana.impl.CategoryReportBuilderImpl

All Implemented Interfaces:

CategoryReportBuilder

public class CategoryReportBuilderImpl
extends ReportBuilder
implements CategoryReportBuilder

The implementation of CategoryReportBuilder.

Field Summary

Fields inherited from class pro.taskana.impl.ReportBuilder

categories, classificationIds, columnHeaders, customAttributeFilter, domains, excludedClassificationIds, inWorkingDays, states, taskanaEngine, taskMonitorMapper, workbasketIds

Constructor Summary

Constructors

Constructor and Description
CategoryReportBuilderImpl(TaskanaEngine taskanaEngine, TaskMonitorMapper taskMonitorMapper)

Method Summary

Modifier and Type	Method and Description
CategoryReport	buildReport() Returns a CategoryReport containing all tasks after applying the filters.
CategoryReportBuilder	categoryIn(List<String> categories) Adds a list of categories to the builder.
CategoryReportBuilder	classificationIdIn(List<String> classificationIds) Adds a list of classificationIds to the builder.
CategoryReportBuilder	customAttributeFilterIn(Map<CustomField,String> customAttributeFilter) Adds a map of custom attributes and custom attribute values to the builder.
CategoryReportBuilder	domainIn(List<String> domains) Adds a list of domains to the builder.
CategoryReportBuilder	excludedClassificationIdIn(List<String> excludedClassificationIds) Adds a list of excludedClassificationIds to the builder.
CategoryReportBuilder	inWorkingDays() If this filter is used, the days of the report are counted in working days.
CategoryReportBuilder	stateIn(List<TaskState> states) Adds a list of states to the builder.
CategoryReportBuilder	withColumnHeaders(List<TimeIntervalColumnHeader> columnHeaders) Adds a list TimeIntervalColumnHeaders to the builder to subdivide the report into clusters.
CategoryReportBuilder	workbasketIdIn(List<String> workbasketIds) Adds a list of workbasketIds to the builder.

Methods inherited from class pro.taskana.impl.ReportBuilder

getCategoryIn, getClassificationIdsIn, getColumnHeaders, getCustomAttributeFilter, getDomainIn, getExcludedClassificationIdsIn, getStateIn, getWorkbasketIdIn, isInWorkingDays, listCustomAttributeValuesForCustomAttributeName, listTaskIdsForSelectedItems, subKeyIsSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface pro.taskana.CategoryReportBuilder

listCustomAttributeValuesForCustomAttributeName, listTaskIdsForSelectedItems

Constructor Detail

CategoryReportBuilderImpl

public CategoryReportBuilderImpl(TaskanaEngine taskanaEngine,
                                 TaskMonitorMapper taskMonitorMapper)

Method Detail

withColumnHeaders

public CategoryReportBuilder withColumnHeaders(List<TimeIntervalColumnHeader> columnHeaders)

Description copied from interface: CategoryReportBuilder

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

Specified by:

withColumnHeaders in interface CategoryReportBuilder

Parameters:

columnHeaders - the column headers the report should consist of.

Returns:

the CategoryReportBuilder

inWorkingDays

public CategoryReportBuilder inWorkingDays()

Description copied from interface: CategoryReportBuilder

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

Specified by:

inWorkingDays in interface CategoryReportBuilder

Returns:

the CategoryReportBuilder

workbasketIdIn

public CategoryReportBuilder workbasketIdIn(List<String> workbasketIds)

Description copied from interface: CategoryReportBuilder

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

Specified by:

workbasketIdIn in interface CategoryReportBuilder

Parameters:

workbasketIds - a list of workbasketIds

Returns:

the CategoryReportBuilder

stateIn

public CategoryReportBuilder stateIn(List<TaskState> states)

Description copied from interface: CategoryReportBuilder

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

Specified by:

stateIn in interface CategoryReportBuilder

Parameters:

states - a list of states

Returns:

the CategoryReportBuilder

categoryIn

public CategoryReportBuilder categoryIn(List<String> categories)

Description copied from interface: CategoryReportBuilder

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

Specified by:

categoryIn in interface CategoryReportBuilder

Parameters:

categories - a list of categories

Returns:

the CategoryReportBuilder

classificationIdIn

public CategoryReportBuilder classificationIdIn(List<String> classificationIds)

Description copied from interface: CategoryReportBuilder

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

Specified by:

classificationIdIn in interface CategoryReportBuilder

Parameters:

classificationIds - a list of classificationIds

Returns:

the CategoryReportBuilder

excludedClassificationIdIn

public CategoryReportBuilder excludedClassificationIdIn(List<String> excludedClassificationIds)

Description copied from interface: CategoryReportBuilder

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

Specified by:

excludedClassificationIdIn in interface CategoryReportBuilder

Parameters:

excludedClassificationIds - a list of excludedClassificationIds

Returns:

the CategoryReportBuilder

domainIn

public CategoryReportBuilder domainIn(List<String> domains)

Description copied from interface: CategoryReportBuilder

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

Specified by:

domainIn in interface CategoryReportBuilder

Parameters:

domains - a list of domains

Returns:

the CategoryReportBuilder

customAttributeFilterIn

public CategoryReportBuilder customAttributeFilterIn(Map<CustomField,String> customAttributeFilter)

Description copied from interface: CategoryReportBuilder

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.

Specified by:

customAttributeFilterIn in interface CategoryReportBuilder

Parameters:

customAttributeFilter - a map of custom attributes and custom attribute value

Returns:

the CategoryReportBuilder

buildReport

public CategoryReport buildReport()
                           throws InvalidArgumentException,
                                  NotAuthorizedException

Description copied from interface: CategoryReportBuilder

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

Specified by:

buildReport in interface CategoryReportBuilder

Returns:

the CategoryReport

Throws:

InvalidArgumentException - if the column headers are not initialized

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