pro.taskana.impl

Class ClassificationReportBuilderImpl

java.lang.Object

pro.taskana.impl.ReportBuilder

pro.taskana.impl.ClassificationReportBuilderImpl

All Implemented Interfaces:

ClassificationReportBuilder

public class ClassificationReportBuilderImpl
extends ReportBuilder
implements ClassificationReportBuilder

The implementation of ClassificationReportBuilder.

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
ClassificationReportBuilderImpl(TaskanaEngine taskanaEngine, TaskMonitorMapper taskMonitorMapper)

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

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.ClassificationReportBuilder

listCustomAttributeValuesForCustomAttributeName, listTaskIdsForSelectedItems

Constructor Detail

ClassificationReportBuilderImpl

public ClassificationReportBuilderImpl(TaskanaEngine taskanaEngine,
                                       TaskMonitorMapper taskMonitorMapper)

Method Detail

withColumnHeaders

public ClassificationReportBuilder withColumnHeaders(List<TimeIntervalColumnHeader> columnHeaders)

Description copied from interface: ClassificationReportBuilder

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

Specified by:

withColumnHeaders in interface ClassificationReportBuilder

Parameters:

columnHeaders - the column headers the report should consist of.

Returns:

the ClassificationReportBuilder

inWorkingDays

public ClassificationReportBuilder inWorkingDays()

Description copied from interface: ClassificationReportBuilder

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

Specified by:

inWorkingDays in interface ClassificationReportBuilder

Returns:

the ClassificationReportBuilder

workbasketIdIn

public ClassificationReportBuilder workbasketIdIn(List<String> workbasketIds)

Description copied from interface: ClassificationReportBuilder

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

Specified by:

workbasketIdIn in interface ClassificationReportBuilder

Parameters:

workbasketIds - a list of workbasket ids

Returns:

the ClassificationReportBuilder

stateIn

public ClassificationReportBuilder stateIn(List<TaskState> states)

Description copied from interface: ClassificationReportBuilder

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 ClassificationReportBuilder

Parameters:

states - a list of states

Returns:

the ClassificationReportBuilder

categoryIn

public ClassificationReportBuilder categoryIn(List<String> categories)

Description copied from interface: ClassificationReportBuilder

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 ClassificationReportBuilder

Parameters:

categories - a list of categories

Returns:

the ClassificationReportBuilder

domainIn

public ClassificationReportBuilder domainIn(List<String> domains)

Description copied from interface: ClassificationReportBuilder

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 ClassificationReportBuilder

Parameters:

domains - a list of domains

Returns:

the ClassificationReportBuilder

customAttributeFilterIn

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

Description copied from interface: ClassificationReportBuilder

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 ClassificationReportBuilder

Parameters:

customAttributeFilter - a map of custom attributes and custom attribute value

Returns:

the ClassificationReportBuilder

classificationIdIn

public ClassificationReportBuilder classificationIdIn(List<String> classificationIds)

Description copied from interface: ClassificationReportBuilder

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 ClassificationReportBuilder

Parameters:

classificationIds - a list of classificationIds

Returns:

the ClassificationReportBuilder

excludedClassificationIdIn

public ClassificationReportBuilder excludedClassificationIdIn(List<String> excludedClassificationIds)

Description copied from interface: ClassificationReportBuilder

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 ClassificationReportBuilder

Parameters:

excludedClassificationIds - a list of excludedClassificationIds

Returns:

the ClassificationReportBuilder

buildReport

public ClassificationReport buildReport()
                                 throws InvalidArgumentException,
                                        NotAuthorizedException

Description copied from interface: ClassificationReportBuilder

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

Specified by:

buildReport in interface ClassificationReportBuilder

Returns:

the ClassificationReport

Throws:

InvalidArgumentException - if the column headers are not initialized

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

buildDetailedReport

public DetailedClassificationReport buildDetailedReport()
                                                 throws InvalidArgumentException,
                                                        NotAuthorizedException

Description copied from interface: ClassificationReportBuilder

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.

Specified by:

buildDetailedReport in interface ClassificationReportBuilder

Returns:

the DetailedClassificationReport

Throws:

InvalidArgumentException - if the column headers are not initialized

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