pro.taskana.impl

Class CustomFieldValueReportBuilderImpl

java.lang.Object

pro.taskana.impl.ReportBuilder

pro.taskana.impl.CustomFieldValueReportBuilderImpl

All Implemented Interfaces:

CustomFieldValueReportBuilder

public class CustomFieldValueReportBuilderImpl
extends ReportBuilder
implements CustomFieldValueReportBuilder

The implementation of CustomFieldValueReportBuilder.

Field Summary

Fields

Modifier and Type	Field and Description
CustomField	customField

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
CustomFieldValueReportBuilderImpl(TaskanaEngine taskanaEngine, TaskMonitorMapper taskMonitorMapper, CustomField customField)

Method Summary

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

listCustomAttributeValuesForCustomAttributeName, listTaskIdsForSelectedItems

Field Detail

customField

public CustomField customField

Constructor Detail

CustomFieldValueReportBuilderImpl

public CustomFieldValueReportBuilderImpl(TaskanaEngine taskanaEngine,
                                         TaskMonitorMapper taskMonitorMapper,
                                         CustomField customField)

Method Detail

withColumnHeaders

public CustomFieldValueReportBuilderImpl withColumnHeaders(List<TimeIntervalColumnHeader> columnHeaders)

Description copied from interface: CustomFieldValueReportBuilder

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

Specified by:

withColumnHeaders in interface CustomFieldValueReportBuilder

Parameters:

columnHeaders - the column headers the report should consist of.

Returns:

the CustomFieldValueReportBuilder

inWorkingDays

public CustomFieldValueReportBuilderImpl inWorkingDays()

Description copied from interface: CustomFieldValueReportBuilder

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

Specified by:

inWorkingDays in interface CustomFieldValueReportBuilder

Returns:

the CustomFieldValueReportBuilder

workbasketIdIn

public CustomFieldValueReportBuilderImpl workbasketIdIn(List<String> workbasketIds)

Description copied from interface: CustomFieldValueReportBuilder

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 CustomFieldValueReportBuilder

Parameters:

workbasketIds - a list of workbasket ids

Returns:

the CustomFieldValueReportBuilder

stateIn

public CustomFieldValueReportBuilderImpl stateIn(List<TaskState> states)

Description copied from interface: CustomFieldValueReportBuilder

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 CustomFieldValueReportBuilder

Parameters:

states - a list of states

Returns:

the CustomFieldValueReportBuilder

categoryIn

public CustomFieldValueReportBuilderImpl categoryIn(List<String> categories)

Description copied from interface: CustomFieldValueReportBuilder

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 CustomFieldValueReportBuilder

Parameters:

categories - a list of categories

Returns:

the CustomFieldValueReportBuilder

domainIn

public CustomFieldValueReportBuilderImpl domainIn(List<String> domains)

Description copied from interface: CustomFieldValueReportBuilder

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 CustomFieldValueReportBuilder

Parameters:

domains - a list of domains

Returns:

the CustomFieldValueReportBuilder

classificationIdIn

public CustomFieldValueReportBuilderImpl classificationIdIn(List<String> classificationIds)

Description copied from interface: CustomFieldValueReportBuilder

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 CustomFieldValueReportBuilder

Parameters:

classificationIds - a list of classificationIds

Returns:

the CustomFieldValueReportBuilder

excludedClassificationIdIn

public CustomFieldValueReportBuilderImpl excludedClassificationIdIn(List<String> excludedClassificationIds)

Description copied from interface: CustomFieldValueReportBuilder

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 CustomFieldValueReportBuilder

Parameters:

excludedClassificationIds - a list of excludedClassificationIds

Returns:

the CustomFieldValueReportBuilder

customAttributeFilterIn

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

Description copied from interface: CustomFieldValueReportBuilder

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 CustomFieldValueReportBuilder

Parameters:

customAttributeFilter - a map of custom attributes and custom attribute value

Returns:

the CustomFieldValueReportBuilder

buildReport

public CustomFieldValueReport buildReport()
                                   throws InvalidArgumentException,
                                          NotAuthorizedException

Description copied from interface: CustomFieldValueReportBuilder

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

Specified by:

buildReport in interface CustomFieldValueReportBuilder

Returns:

the CustomFieldValueReportBuilder

Throws:

InvalidArgumentException - if the column headers are not initialized

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

getCustomField

public CustomField getCustomField()

Description copied from interface: CustomFieldValueReportBuilder

Gets the customField property of the CustomFieldValueReportBuilder.

Specified by:

getCustomField in interface CustomFieldValueReportBuilder

Returns:

the customField property