pro.taskana.impl

Class WorkbasketReportBuilderImpl

java.lang.Object

pro.taskana.impl.ReportBuilder

pro.taskana.impl.WorkbasketReportBuilderImpl

All Implemented Interfaces:

WorkbasketReportBuilder

public class WorkbasketReportBuilderImpl
extends ReportBuilder
implements WorkbasketReportBuilder

The implementation of WorkbasketReportBuilder.

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

Method Summary

Modifier and Type	Method and Description
WorkbasketReport	buildReport() Returns a WorkbasketReport containing all tasks after applying the filters.
WorkbasketReportBuilderImpl	categoryIn(List<String> categories) Adds a list of categories to the builder.
WorkbasketReportBuilderImpl	classificationIdIn(List<String> classificationIds) Adds a list of classificationIds to the builder.
WorkbasketReportBuilderImpl	combinedClassificationFilterIn(List<CombinedClassificationFilter> combinedClassificationFilter) Adds a list of CombinedClassificationFilter to the builder.
WorkbasketReportBuilderImpl	customAttributeFilterIn(Map<CustomField,String> customAttributeFilter) Adds a map of custom attributes and custom attribute values to the builder.
WorkbasketReportBuilderImpl	domainIn(List<String> domains) Adds a list of domains to the builder.
WorkbasketReportBuilderImpl	excludedClassificationIdIn(List<String> excludedClassificationIds) Adds a list of excludedClassificationIds to the builder.
List<CombinedClassificationFilter>	getCombinedClassificationFilterIn()
WorkbasketReportBuilderImpl	inWorkingDays() If this filter is used, the days of the report are counted in working days.
WorkbasketReportBuilderImpl	stateIn(List<TaskState> states) Adds a list of states to the builder.
WorkbasketReportBuilderImpl	withColumnHeaders(List<TimeIntervalColumnHeader> columnHeaders) Adds a list TimeIntervalColumnHeaders to the builder to subdivide the report into clusters.
WorkbasketReportBuilderImpl	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.WorkbasketReportBuilder

listCustomAttributeValuesForCustomAttributeName, listTaskIdsForSelectedItems

Constructor Detail

WorkbasketReportBuilderImpl

public WorkbasketReportBuilderImpl(TaskanaEngine taskanaEngine,
                                   TaskMonitorMapper taskMonitorMapper)

Method Detail

withColumnHeaders

public WorkbasketReportBuilderImpl withColumnHeaders(List<TimeIntervalColumnHeader> columnHeaders)

Description copied from interface: WorkbasketReportBuilder

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

Specified by:

withColumnHeaders in interface WorkbasketReportBuilder

Parameters:

columnHeaders - the column headers the report should consist of.

Returns:

the WorkbasketReportBuilder

inWorkingDays

public WorkbasketReportBuilderImpl inWorkingDays()

Description copied from interface: WorkbasketReportBuilder

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

Specified by:

inWorkingDays in interface WorkbasketReportBuilder

Returns:

the WorkbasketReportBuilder

workbasketIdIn

public WorkbasketReportBuilderImpl workbasketIdIn(List<String> workbasketIds)

Description copied from interface: WorkbasketReportBuilder

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 WorkbasketReportBuilder

Parameters:

workbasketIds - a list of workbasket ids

Returns:

the WorkbasketReportBuilder

stateIn

public WorkbasketReportBuilderImpl stateIn(List<TaskState> states)

Description copied from interface: WorkbasketReportBuilder

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 WorkbasketReportBuilder

Parameters:

states - a list of states

Returns:

the WorkbasketReportBuilder

categoryIn

public WorkbasketReportBuilderImpl categoryIn(List<String> categories)

Description copied from interface: WorkbasketReportBuilder

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 WorkbasketReportBuilder

Parameters:

categories - a list of categories

Returns:

the WorkbasketReportBuilder

domainIn

public WorkbasketReportBuilderImpl domainIn(List<String> domains)

Description copied from interface: WorkbasketReportBuilder

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 WorkbasketReportBuilder

Parameters:

domains - a list of domains

Returns:

the WorkbasketReportBuilder

classificationIdIn

public WorkbasketReportBuilderImpl classificationIdIn(List<String> classificationIds)

Description copied from interface: WorkbasketReportBuilder

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 WorkbasketReportBuilder

Parameters:

classificationIds - a list of classificationIds

Returns:

the WorkbasketReportBuilder

excludedClassificationIdIn

public WorkbasketReportBuilderImpl excludedClassificationIdIn(List<String> excludedClassificationIds)

Description copied from interface: WorkbasketReportBuilder

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 WorkbasketReportBuilder

Parameters:

excludedClassificationIds - a list of excludedClassificationIds

Returns:

the WorkbasketReportBuilder

customAttributeFilterIn

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

Description copied from interface: WorkbasketReportBuilder

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 WorkbasketReportBuilder

Parameters:

customAttributeFilter - a map of custom attributes and custom attribute value

Returns:

the WorkbasketReportBuilder

combinedClassificationFilterIn

public WorkbasketReportBuilderImpl combinedClassificationFilterIn(List<CombinedClassificationFilter> combinedClassificationFilter)

Description copied from interface: WorkbasketReportBuilder

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.

Specified by:

combinedClassificationFilterIn in interface WorkbasketReportBuilder

Parameters:

combinedClassificationFilter - a list of combinedClassificationFilter

Returns:

the WorkbasketReportBuilder

getCombinedClassificationFilterIn

public List<CombinedClassificationFilter> getCombinedClassificationFilterIn()

buildReport

public WorkbasketReport buildReport()
                             throws InvalidArgumentException,
                                    NotAuthorizedException

Description copied from interface: WorkbasketReportBuilder

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

Specified by:

buildReport in interface WorkbasketReportBuilder

Returns:

the WorkbasketReport

Throws:

InvalidArgumentException - if the column headers are not initialized

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