pro.taskana

Interface TaskMonitorService

All Known Implementing Classes:

TaskMonitorServiceImpl

public interface TaskMonitorService

The Task Monitor Service manages operations on tasks regarding the monitoring.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DIMENSION_CLASSIFICATION_CATEGORY
static String	DIMENSION_CLASSIFICATION_KEY
static String	DIMENSION_WORKBASKET_KEY

Method Summary

Modifier and Type	Method and Description
CategoryReport	getCategoryReport(List<String> workbasketIds, List<TaskState> states, List<String> categories, List<String> domains, CustomField customField, List<String> customFieldValues) Returns a CategoryReport grouped by categories.
CategoryReport	getCategoryReport(List<String> workbasketIds, List<TaskState> states, List<String> categories, List<String> domains, CustomField customField, List<String> customFieldValues, List<TimeIntervalColumnHeader> columnHeaders) Returns a CategoryReport grouped by categories.
CategoryReport	getCategoryReport(List<String> workbasketIds, List<TaskState> states, List<String> categories, List<String> domains, CustomField customField, List<String> customFieldValues, List<TimeIntervalColumnHeader> columnHeaders, boolean inWorkingDays) Returns a CategoryReport grouped by categories.
ClassificationReport	getClassificationReport(List<String> workbasketIds, List<TaskState> states, List<String> categories, List<String> domains, CustomField customField, List<String> customFieldValues) Returns a ClassificationReport grouped by classifications.
ClassificationReport	getClassificationReport(List<String> workbasketIds, List<TaskState> states, List<String> categories, List<String> domains, CustomField customField, List<String> customFieldValues, List<TimeIntervalColumnHeader> columnHeaders) Returns a ClassificationReport grouped by classifications.
ClassificationReport	getClassificationReport(List<String> workbasketIds, List<TaskState> states, List<String> categories, List<String> domains, CustomField customField, List<String> customFieldValues, List<TimeIntervalColumnHeader> columnHeaders, boolean inWorkingDays) Returns a ClassificationReport grouped by classification.
List<String>	getCustomAttributeValuesForReport(List<String> workbasketIds, List<TaskState> states, List<String> categories, List<String> domains, List<String> classificationIds, List<String> excludedClassificationIds, Map<String,String> customAttributeFilter, String customAttributeName) Returns a list of distinct custom attribute values for the selection from the entire task pool.
CustomFieldValueReport	getCustomFieldValueReport(List<String> workbasketIds, List<TaskState> states, List<String> categories, List<String> domains, CustomField customField, List<String> customFieldValues) Returns a CustomFieldValueReport grouped by the value of a certain CustomField.
CustomFieldValueReport	getCustomFieldValueReport(List<String> workbasketIds, List<TaskState> states, List<String> categories, List<String> domains, CustomField customField, List<String> customFieldValues, List<TimeIntervalColumnHeader> columnHeaders) Returns a CustomFieldValueReport grouped by the value of a certain CustomField.
CustomFieldValueReport	getCustomFieldValueReport(List<String> workbasketIds, List<TaskState> states, List<String> categories, List<String> domains, CustomField customField, List<String> customFieldValues, List<TimeIntervalColumnHeader> columnHeaders, boolean inWorkingDays) Returns a CustomFieldValueReport grouped by the value of a certain CustomField.
DetailedClassificationReport	getDetailedClassificationReport(List<String> workbasketIds, List<TaskState> states, List<String> categories, List<String> domains, CustomField customField, List<String> customFieldValues) Returns a DetailedClassificationReport.
DetailedClassificationReport	getDetailedClassificationReport(List<String> workbasketIds, List<TaskState> states, List<String> categories, List<String> domains, CustomField customField, List<String> customFieldValues, List<TimeIntervalColumnHeader> columnHeaders) Returns a DetailedClassificationReport.
DetailedClassificationReport	getDetailedClassificationReport(List<String> workbasketIds, List<TaskState> states, List<String> categories, List<String> domains, CustomField customField, List<String> customFieldValues, List<TimeIntervalColumnHeader> columnHeaders, boolean inWorkingDays) Returns a DetailedClassificationReport.
List<String>	getTaskIdsForSelectedItems(List<String> workbasketIds, List<TaskState> states, List<String> categories, List<String> domains, List<String> classificationKeys, List<String> excludedClassificationKeys, CustomField customField, List<String> customFieldValues, List<TimeIntervalColumnHeader> columnHeaders, boolean inWorkingDays, List<SelectedItem> selectedItems, String dimension) Returns a list of all task ids in the selected items of a Report.
TaskStatusReport	getTaskStatusReport() Overloaded method for getTaskStatusReport(List, List).
TaskStatusReport	getTaskStatusReport(List<String> domains) Overloaded method for getTaskStatusReport(List, List).
TaskStatusReport	getTaskStatusReport(List<String> domains, List<TaskState> states) Returns a TaskStatusReport.
WorkbasketLevelReport	getWorkbasketLevelReport(List<String> workbasketIds, List<TaskState> states, List<String> categories, List<String> domains, CustomField customField, List<String> customFieldValues, List<CombinedClassificationFilter> combinedClassificationFilter) Returns a WorkbasketLevelReport grouped by workbaskets.
WorkbasketLevelReport	getWorkbasketLevelReport(List<String> workbasketIds, List<TaskState> states, List<String> categories, List<String> domains, CustomField customField, List<String> customFieldValues, List<CombinedClassificationFilter> combinedClassificationFilter, List<TimeIntervalColumnHeader> columnHeaders) Returns a WorkbasketLevelReport grouped by workbaskets.
WorkbasketLevelReport	getWorkbasketLevelReport(List<String> workbasketIds, List<TaskState> states, List<String> categories, List<String> domains, CustomField customField, List<String> customFieldValues, List<CombinedClassificationFilter> combinedClassificationFilter, List<TimeIntervalColumnHeader> columnHeaders, boolean inWorkingDays) Returns a WorkbasketLevelReport for specific classifications grouped by workbaskets.

Field Detail

DIMENSION_CLASSIFICATION_CATEGORY

static final String DIMENSION_CLASSIFICATION_CATEGORY

See Also:

Constant Field Values

DIMENSION_CLASSIFICATION_KEY

static final String DIMENSION_CLASSIFICATION_KEY

See Also:

Constant Field Values

DIMENSION_WORKBASKET_KEY

static final String DIMENSION_WORKBASKET_KEY

See Also:

Constant Field Values

Method Detail

getWorkbasketLevelReport

WorkbasketLevelReport getWorkbasketLevelReport(List<String> workbasketIds,
                                               List<TaskState> states,
                                               List<String> categories,
                                               List<String> domains,
                                               CustomField customField,
                                               List<String> customFieldValues,
                                               List<CombinedClassificationFilter> combinedClassificationFilter)
                                        throws InvalidArgumentException,
                                               NotAuthorizedException

Returns a WorkbasketLevelReport grouped by workbaskets. The report contains the total numbers of tasks of the respective workbasket as well as the total number of all tasks. If no filter is required, the respective parameter should be null. The tasks of the report are filtered by workbaskets, states, categories, domains and values of a custom field. Tasks with Timestamp DUE = null are not considered.

Parameters:

workbasketIds - a list of workbasket ids to filter by workbaskets. To omit this filter, use null for this parameter

states - a list of states to filter by states. To omit this filter, use null for this parameter

categories - a list of categories to filter by categories. To omit this filter, use null for this parameter

domains - a list of domains to filter by domains. To omit this filter, use null for this parameter

customField - a custom field to filter by the values of the custom field. To omit this filter, use null for this parameter

customFieldValues - a list of custom field values to filter by the values of the custom field. To omit this filter, use null for this parameter

combinedClassificationFilter - a list of pairs of a classificationId for a task and a classificationId for the corresponding attachment that is used to filter by the classification of the attachment. To filter by the classification of the task, the classificationId of the attachment should be null. To omit this filter, use null for this parameter

Returns:

the report

Throws:

InvalidArgumentException - thrown if DaysToWorkingDaysConverter is initialized with null

NotAuthorizedException - if the current user is not member of role MONITOR

getWorkbasketLevelReport

WorkbasketLevelReport getWorkbasketLevelReport(List<String> workbasketIds,
                                               List<TaskState> states,
                                               List<String> categories,
                                               List<String> domains,
                                               CustomField customField,
                                               List<String> customFieldValues,
                                               List<CombinedClassificationFilter> combinedClassificationFilter,
                                               List<TimeIntervalColumnHeader> columnHeaders)
                                        throws InvalidArgumentException,
                                               NotAuthorizedException

Returns a WorkbasketLevelReport grouped by workbaskets. For each workbasket the report contains the total number of tasks and the number of tasks of the respective cluster that are specified by the TimeIntervalColumnHeaders. By default the age of the tasks is counted in working days. Furthermore the Report contains a sum line that contains the total numbers of the different clusters and the total number of all tasks in this report. The tasks of the report are filtered by workbaskets, states, categories, domains and values of a custom field. If no filter is required, the respective parameter should be null. Tasks with Timestamp DUE = null are not considered.

Parameters:

workbasketIds - a list of workbasket ids objects to filter by workbaskets. To omit this filter, use null for this parameter

states - a list of states objects to filter by states. To omit this filter, use null for this parameter

categories - a list of categories to filter by categories. To omit this filter, use null for this parameter

domains - a list of domains to filter by domains. To omit this filter, use null for this parameter

customField - a custom field to filter by the values of the custom field. To omit this filter, use null for this parameter

customFieldValues - a list of custom field values to filter by the values of the custom field. To omit this filter, use null for this parameter

combinedClassificationFilter - a list of pairs of a classificationId for a task and a classificationId for the corresponding attachment that is used to filter by the classification of the attachment. To filter by the classification of the task, the classificationId of the attachment should be null. To omit this filter, use null for this parameter

columnHeaders - a list of columnHeaders that specify the subdivision into different cluster of due dates. Days in past are represented as negative values and days in the future are represented as positive values. To avoid tasks are counted multiple times or not be listed in the report, these columnHeaders should not overlap and should not have gaps. If the ReportLineDefinition should represent a single day, lowerLimit and upperLimit have to be equal. The outer cluster of a report should have open ends. These open ends are represented with Integer.MIN_VALUE and Integer.MAX_VALUE.

Returns:

the report

Throws:

InvalidArgumentException - thrown if DaysToWorkingDaysConverter is initialized with null

NotAuthorizedException - if the current user is not member of role MONITOR

getWorkbasketLevelReport

WorkbasketLevelReport getWorkbasketLevelReport(List<String> workbasketIds,
                                               List<TaskState> states,
                                               List<String> categories,
                                               List<String> domains,
                                               CustomField customField,
                                               List<String> customFieldValues,
                                               List<CombinedClassificationFilter> combinedClassificationFilter,
                                               List<TimeIntervalColumnHeader> columnHeaders,
                                               boolean inWorkingDays)
                                        throws InvalidArgumentException,
                                               NotAuthorizedException

Returns a WorkbasketLevelReport for specific classifications grouped by workbaskets. For each workbasket the report contains the total number of tasks and the number of tasks of the respective cluster that are specified by the TimeIntervalColumnHeaders. It can be specified whether the age of the tasks is counted in days or in working days. Furthermore the report contains a sum line that contains the total numbers of the different clusters and the total number of all tasks. The tasks of the report are filtered by workbaskets, states, categories, domains and values of a custom field. If no filter is required, the respective parameter should be null. Tasks with Timestamp DUE = null are not considered.

Parameters:

workbasketIds - a list of workbasket ids objects to filter by workbaskets. To omit this filter, use null for this parameter

states - a list of states objects to filter by states. To omit this filter, use null for this parameter

categories - a list of categories to filter by categories. To omit this filter, use null for this parameter

domains - a list of domains to filter by domains. To omit this filter, use null for this parameter

customField - a custom field to filter by the values of the custom field. To omit this filter, use null for this parameter

customFieldValues - a list of custom field values to filter by the values of the custom field. To omit this filter, use null for this parameter

combinedClassificationFilter - a list of pairs of a classificationId for a task and a classificationId for the corresponding attachment that is used to filter by the classification of the attachment. To filter by the classification of the task, the classificationId of the attachment should be null. To omit this filter, use null for this parameter

columnHeaders - a list of columnHeaders that specify the subdivision into different cluster of due dates. Days in past are represented as negative values and days in the future are represented as positive values. To avoid tasks are counted multiple times or not be listed in the report, these columnHeaders should not overlap and should not have gaps. If the ReportLineDefinition should represent a single day, lowerLimit and upperLimit have to be equal. The outer cluster of a report should have open ends. These open ends are represented with Integer.MIN_VALUE and Integer.MAX_VALUE.

inWorkingDays - a boolean parameter that specifies whether the age of the tasks should be counted in days or in working days

Returns:

the report

Throws:

InvalidArgumentException - thrown if DaysToWorkingDaysConverter is initialized with null

NotAuthorizedException - if the current user is not member of role MONITOR

getCategoryReport

CategoryReport getCategoryReport(List<String> workbasketIds,
                                 List<TaskState> states,
                                 List<String> categories,
                                 List<String> domains,
                                 CustomField customField,
                                 List<String> customFieldValues)
                          throws InvalidArgumentException,
                                 NotAuthorizedException

Returns a CategoryReport grouped by categories. The report contains the total numbers of tasks of the respective category as well as the total number of all tasks. The tasks of the report are filtered by workbaskets, states, categories, domains and values of a custom field and values of a custom field. If no filter is required, the respective parameter should be null. Tasks with Timestamp DUE = null are not considered.

Parameters:

workbasketIds - a list of workbasket ids to filter by workbaskets. To omit this filter, use null for this parameter

states - a list of states to filter by states. To omit this filter, use null for this parameter

categories - a list of categories to filter by categories. To omit this filter, use null for this parameter

domains - a list of domains to filter by domains. To omit this filter, use null for this parameter

customField - a custom field to filter by the values of the custom field. To omit this filter, use null for this parameter

customFieldValues - a list of custom field values to filter by the values of the custom field. To omit this filter, use null for this parameter

Returns:

the report

Throws:

InvalidArgumentException - thrown if DaysToWorkingDaysConverter is initialized with null

NotAuthorizedException - if the current user is not member of role MONITOR

getCategoryReport

CategoryReport getCategoryReport(List<String> workbasketIds,
                                 List<TaskState> states,
                                 List<String> categories,
                                 List<String> domains,
                                 CustomField customField,
                                 List<String> customFieldValues,
                                 List<TimeIntervalColumnHeader> columnHeaders)
                          throws InvalidArgumentException,
                                 NotAuthorizedException

Returns a CategoryReport grouped by categories. For each category the report contains the total number of tasks and the number of tasks of the respective cluster that are specified by the TimeIntervalColumnHeaders. By default the age of the tasks is counted in working days. Furthermore the Report contains a sum line that contains the total numbers of the different clusters and the total number of all tasks in this report. The tasks of the report are filtered by workbaskets, states, categories, domains and values of a custom field. If no filter is required, the respective parameter should be null. Tasks with Timestamp DUE = null are not considered.

Parameters:

workbasketIds - a list of workbasket ids objects to filter by workbaskets. To omit this filter, use null for this parameter

states - a list of states objects to filter by states. To omit this filter, use null for this parameter

categories - a list of categories to filter by categories. To omit this filter, use null for this parameter

domains - a list of domains to filter by domains. To omit this filter, use null for this parameter

customField - a custom field to filter by the values of the custom field. To omit this filter, use null for this parameter

customFieldValues - a list of custom field values to filter by the values of the custom field. To omit this filter, use null for this parameter

columnHeaders - a list of columnHeaders that specify the subdivision into different cluster of due dates. Days in past are represented as negative values and days in the future are represented as positive values. To avoid tasks are counted multiple times or not be listed in the report, these columnHeaders should not overlap and should not have gaps. If the ReportLineDefinition should represent a single day, lowerLimit and upperLimit have to be equal. The outer cluster of a report should have open ends. These open ends are represented with Integer.MIN_VALUE and Integer.MAX_VALUE.

Returns:

the report

Throws:

InvalidArgumentException - thrown if DaysToWorkingDaysConverter is initialized with null

NotAuthorizedException - if the current user is not member of role MONITOR

getCategoryReport

CategoryReport getCategoryReport(List<String> workbasketIds,
                                 List<TaskState> states,
                                 List<String> categories,
                                 List<String> domains,
                                 CustomField customField,
                                 List<String> customFieldValues,
                                 List<TimeIntervalColumnHeader> columnHeaders,
                                 boolean inWorkingDays)
                          throws InvalidArgumentException,
                                 NotAuthorizedException

Returns a CategoryReport grouped by categories. For each category the report contains the total number of tasks and the number of tasks of the respective cluster that are specified by the TimeIntervalColumnHeaders. It can be specified whether the age of the tasks is counted in days or in working days. Furthermore the report contains a sum line that contains the total numbers of the different clusters and the total number of all tasks. The tasks of the report are filtered by workbaskets, states, categories, domains and values of a custom field. If no filter is required, the respective parameter should be null. Tasks with Timestamp DUE = null are not considered.

Parameters:

workbasketIds - a list of workbasket ids objects to filter by workbaskets. To omit this filter, use null for this parameter

states - a list of states objects to filter by states. To omit this filter, use null for this parameter

categories - a list of categories to filter by categories. To omit this filter, use null for this parameter

domains - a list of domains to filter by domains. To omit this filter, use null for this parameter

customField - a custom field to filter by the values of the custom field. To omit this filter, use null for this parameter

customFieldValues - a list of custom field values to filter by the values of the custom field. To omit this filter, use null for this parameter

columnHeaders - a list of columnHeaders that specify the subdivision into different cluster of due dates. Days in past are represented as negative values and days in the future are represented as positive values. To avoid tasks are counted multiple times or not be listed in the report, these columnHeaders should not overlap and should not have gaps. If the ReportLineDefinition should represent a single day, lowerLimit and upperLimit have to be equal. The outer cluster of a report should have open ends. These open ends are represented with Integer.MIN_VALUE and Integer.MAX_VALUE.

inWorkingDays - a boolean parameter that specifies whether the age of the tasks should be counted in days or in working days

Returns:

the report

Throws:

InvalidArgumentException - thrown if DaysToWorkingDaysConverter is initialized with null

NotAuthorizedException - if the current user is not member of role MONITOR

getClassificationReport

ClassificationReport getClassificationReport(List<String> workbasketIds,
                                             List<TaskState> states,
                                             List<String> categories,
                                             List<String> domains,
                                             CustomField customField,
                                             List<String> customFieldValues)
                                      throws InvalidArgumentException,
                                             NotAuthorizedException

Returns a ClassificationReport grouped by classifications. The report contains the total numbers of tasks of the respective classification as well as the total number of all tasks. The tasks of the report are filtered by workbaskets, states, categories, domains and values of a custom field. If no filter is required, the respective parameter should be null. Tasks with Timestamp DUE = null are not considered.

Parameters:

workbasketIds - a list of workbasket ids to filter by workbaskets. To omit this filter, use null for this parameter

states - a list of states to filter by states. To omit this filter, use null for this parameter

categories - a list of categories to filter by categories. To omit this filter, use null for this parameter

domains - a list of domains to filter by domains. To omit this filter, use null for this parameter

customField - a custom field to filter by the values of the custom field. To omit this filter, use null for this parameter

customFieldValues - a list of custom field values to filter by the values of the custom field. To omit this filter, use null for this parameter

Returns:

the ClassificationReport

Throws:

InvalidArgumentException - thrown if DaysToWorkingDaysConverter is initialized with null

NotAuthorizedException - if the current user is not member of role MONITOR

getClassificationReport

ClassificationReport getClassificationReport(List<String> workbasketIds,
                                             List<TaskState> states,
                                             List<String> categories,
                                             List<String> domains,
                                             CustomField customField,
                                             List<String> customFieldValues,
                                             List<TimeIntervalColumnHeader> columnHeaders)
                                      throws InvalidArgumentException,
                                             NotAuthorizedException

Returns a ClassificationReport grouped by classifications. For each classification the report contains the total number of tasks and the number of tasks of the respective cluster that are specified by the TimeIntervalColumnHeaders. By default the age of the tasks is counted in working days. Furthermore the Report contains a sum line that contains the total numbers of the different clusters and the total number of all tasks in this report. The tasks of the report are filtered by workbaskets, states, categories, domains and values of a custom field. If no filter is required, the respective parameter should be null. Tasks with Timestamp DUE = null are not considered.

Parameters:

workbasketIds - a list of workbasket ids objects to filter by workbaskets. To omit this filter, use null for this parameter

states - a list of states objects to filter by states. To omit this filter, use null for this parameter

categories - a list of categories to filter by categories. To omit this filter, use null for this parameter

domains - a list of domains to filter by domains. To omit this filter, use null for this parameter

customField - a custom field to filter by the values of the custom field. To omit this filter, use null for this parameter

customFieldValues - a list of custom field values to filter by the values of the custom field. To omit this filter, use null for this parameter

columnHeaders - a list of columnHeaders that specify the subdivision into different cluster of due dates. Days in past are represented as negative values and days in the future are represented as positive values. To avoid tasks are counted multiple times or not be listed in the report, these columnHeaders should not overlap and should not have gaps. If the ReportLineDefinition should represent a single day, lowerLimit and upperLimit have to be equal. The outer cluster of a report should have open ends. These open ends are represented with Integer.MIN_VALUE and Integer.MAX_VALUE.

Returns:

the ClassificationReport

Throws:

InvalidArgumentException - thrown if DaysToWorkingDaysConverter is initialized with null

NotAuthorizedException - if the current user is not member of role MONITOR

getClassificationReport

ClassificationReport getClassificationReport(List<String> workbasketIds,
                                             List<TaskState> states,
                                             List<String> categories,
                                             List<String> domains,
                                             CustomField customField,
                                             List<String> customFieldValues,
                                             List<TimeIntervalColumnHeader> columnHeaders,
                                             boolean inWorkingDays)
                                      throws InvalidArgumentException,
                                             NotAuthorizedException

Returns a ClassificationReport grouped by classification. For each classification the report contains the total number of tasks and the number of tasks of the respective cluster that are specified by the TimeIntervalColumnHeaders. It can be specified whether the age of the tasks is counted in days or in working days. Furthermore the report contains a sum line that contains the total numbers of the different clusters and the total number of all tasks. The tasks of the report are filtered by workbaskets, states, categories, domains and values of a custom field. If no filter is required, the respective parameter should be null. Tasks with Timestamp DUE = null are not considered.

Parameters:

workbasketIds - a list of workbasket ids objects to filter by workbaskets. To omit this filter, use null for this parameter

states - a list of states objects to filter by states. To omit this filter, use null for this parameter

categories - a list of categories to filter by categories. To omit this filter, use null for this parameter

domains - a list of domains to filter by domains. To omit this filter, use null for this parameter

customField - a custom field to filter by the values of the custom field. To omit this filter, use null for this parameter

customFieldValues - a list of custom field values to filter by the values of the custom field. To omit this filter, use null for this parameter

columnHeaders - a list of columnHeaders that specify the subdivision into different cluster of due dates. Days in past are represented as negative values and days in the future are represented as positive values. To avoid tasks are counted multiple times or not be listed in the report, these columnHeaders should not overlap and should not have gaps. If the ReportLineDefinition should represent a single day, lowerLimit and upperLimit have to be equal. The outer cluster of a report should have open ends. These open ends are represented with Integer.MIN_VALUE and Integer.MAX_VALUE.

inWorkingDays - a boolean parameter that specifies whether the age of the tasks should be counted in days or in working days

Returns:

the ClassificationReport

Throws:

InvalidArgumentException - thrown if DaysToWorkingDaysConverter is initialized with null

NotAuthorizedException - if the current user is not member of role MONITOR

getDetailedClassificationReport

DetailedClassificationReport getDetailedClassificationReport(List<String> workbasketIds,
                                                             List<TaskState> states,
                                                             List<String> categories,
                                                             List<String> domains,
                                                             CustomField customField,
                                                             List<String> customFieldValues)
                                                      throws InvalidArgumentException,
                                                             NotAuthorizedException

Returns a DetailedClassificationReport. The report contains the total numbers of tasks of the respective classification as well as the total number of all tasks. Each ReportLine contains an additional list of ReportLines for the classifications of the attachments of the tasks. The tasks of the report are filtered by workbaskets, states, categories, domains and values of a custom field. If no filter is required, the respective parameter should be null. Tasks with Timestamp DUE = null are not considered.

Parameters:

workbasketIds - a list of workbasket ids to filter by workbaskets. To omit this filter, use null for this parameter

states - a list of states to filter by states. To omit this filter, use null for this parameter

categories - a list of categories to filter by categories. To omit this filter, use null for this parameter

domains - a list of domains to filter by domains. To omit this filter, use null for this parameter

customField - a custom field to filter by the values of the custom field. To omit this filter, use null for this parameter

customFieldValues - a list of custom field values to filter by the values of the custom field. To omit this filter, use null for this parameter

Returns:

the DetailedClassificationReport

Throws:

InvalidArgumentException - thrown if DaysToWorkingDaysConverter is initialized with null

NotAuthorizedException - if the current user is not member of role MONITOR

getDetailedClassificationReport

DetailedClassificationReport getDetailedClassificationReport(List<String> workbasketIds,
                                                             List<TaskState> states,
                                                             List<String> categories,
                                                             List<String> domains,
                                                             CustomField customField,
                                                             List<String> customFieldValues,
                                                             List<TimeIntervalColumnHeader> columnHeaders)
                                                      throws InvalidArgumentException,
                                                             NotAuthorizedException

Returns a DetailedClassificationReport. For each classification the report contains the total number of tasks and the number of tasks of the respective cluster that are specified by the TimeIntervalColumnHeaders. By default the age of the tasks is counted in working days. Each ReportLine contains an additional list of ReportLines for the classifications of the attachments of the tasks. Furthermore the Report contains a sum line that contains the total numbers of the different clusters and the total number of all tasks in this report. The tasks of the report are filtered by workbaskets, states, categories, domains and values of a custom field. If no filter is required, the respective parameter should be null. Tasks with Timestamp DUE = null are not considered.

Parameters:

workbasketIds - a list of workbasket ids objects to filter by workbaskets. To omit this filter, use null for this parameter

states - a list of states objects to filter by states. To omit this filter, use null for this parameter

categories - a list of categories to filter by categories. To omit this filter, use null for this parameter

domains - a list of domains to filter by domains. To omit this filter, use null for this parameter

customField - a custom field to filter by the values of the custom field. To omit this filter, use null for this parameter

customFieldValues - a list of custom field values to filter by the values of the custom field. To omit this filter, use null for this parameter

columnHeaders - a list of columnHeaders that specify the subdivision into different cluster of due dates. Days in past are represented as negative values and days in the future are represented as positive values. To avoid tasks are counted multiple times or not be listed in the report, these columnHeaders should not overlap and should not have gaps. If the ReportLineDefinition should represent a single day, lowerLimit and upperLimit have to be equal. The outer cluster of a report should have open ends. These open ends are represented with Integer.MIN_VALUE and Integer.MAX_VALUE.

Returns:

the DetailedClassificationReport

Throws:

InvalidArgumentException - thrown if DaysToWorkingDaysConverter is initialized with null

NotAuthorizedException - if the current user is not member of role MONITOR

getDetailedClassificationReport

DetailedClassificationReport getDetailedClassificationReport(List<String> workbasketIds,
                                                             List<TaskState> states,
                                                             List<String> categories,
                                                             List<String> domains,
                                                             CustomField customField,
                                                             List<String> customFieldValues,
                                                             List<TimeIntervalColumnHeader> columnHeaders,
                                                             boolean inWorkingDays)
                                                      throws InvalidArgumentException,
                                                             NotAuthorizedException

Returns a DetailedClassificationReport. For each classification the report contains the total number of tasks and the number of tasks of the respective cluster that are specified by the TimeIntervalColumnHeaders. It can be specified whether the age of the tasks is counted in days or in working days. Each ReportLine contains an additional list of ReportLines for the classifications of the attachments of the tasks. Furthermore the report contains a sum line that contains the total numbers of the different clusters and the total number of all tasks. The tasks of the report are filtered by workbaskets, states, categories, domains and values of a custom field. If no filter is required, the respective parameter should be null. Tasks with Timestamp DUE = null are not considered.

Parameters:

workbasketIds - a list of workbasket ids objects to filter by workbaskets. To omit this filter, use null for this parameter

states - a list of states objects to filter by states. To omit this filter, use null for this parameter

categories - a list of categories to filter by categories. To omit this filter, use null for this parameter

domains - a list of domains to filter by domains. To omit this filter, use null for this parameter

customField - a custom field to filter by the values of the custom field. To omit this filter, use null for this parameter

customFieldValues - a list of custom field values to filter by the values of the custom field. To omit this filter, use null for this parameter

columnHeaders - a list of columnHeaders that specify the subdivision into different cluster of due dates. Days in past are represented as negative values and days in the future are represented as positive values. To avoid tasks are counted multiple times or not be listed in the report, these columnHeaders should not overlap and should not have gaps. If the ReportLineDefinition should represent a single day, lowerLimit and upperLimit have to be equal. The outer cluster of a report should have open ends. These open ends are represented with Integer.MIN_VALUE and Integer.MAX_VALUE.

inWorkingDays - a boolean parameter that specifies whether the age of the tasks should be counted in days or in working days

Returns:

the DetailedClassificationReport

Throws:

InvalidArgumentException - thrown if DaysToWorkingDaysConverter is initialized with null

NotAuthorizedException - if the current user is not member of role MONITOR

getCustomFieldValueReport

CustomFieldValueReport getCustomFieldValueReport(List<String> workbasketIds,
                                                 List<TaskState> states,
                                                 List<String> categories,
                                                 List<String> domains,
                                                 CustomField customField,
                                                 List<String> customFieldValues)
                                          throws InvalidArgumentException,
                                                 NotAuthorizedException

Returns a CustomFieldValueReport grouped by the value of a certain CustomField. The report 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 are filtered by workbaskets, states, categories, domains and values of a custom field. If no filter is required, the respective parameter should be null. Tasks with Timestamp DUE = null are not considered.

Parameters:

workbasketIds - a list of workbasket ids to filter by workbaskets. To omit this filter, use null for this parameter

states - a list of states to filter by states. To omit this filter, use null for this parameter

categories - a list of categories to filter by categories. To omit this filter, use null for this parameter

domains - a list of domains to filter by domains. To omit this filter, use null for this parameter

customField - a custom field to filter by the values of the custom field

customFieldValues - a list of custom field values to filter by the values of the custom field. To omit this filter, use null for this parameter

Returns:

the report

Throws:

InvalidArgumentException - thrown if customField is null

NotAuthorizedException - if the current user is not member of role MONITOR

getCustomFieldValueReport

CustomFieldValueReport getCustomFieldValueReport(List<String> workbasketIds,
                                                 List<TaskState> states,
                                                 List<String> categories,
                                                 List<String> domains,
                                                 CustomField customField,
                                                 List<String> customFieldValues,
                                                 List<TimeIntervalColumnHeader> columnHeaders)
                                          throws InvalidArgumentException,
                                                 NotAuthorizedException

Returns a CustomFieldValueReport grouped by the value of a certain CustomField. For each value of the custom field the report contains the total number of tasks and the number of tasks of the respective cluster that are specified by the TimeIntervalColumnHeaders. By default the age of the tasks is counted in working days. Furthermore the Report contains a sum line that contains the total numbers of the different clusters and the total number of all tasks in this report. The tasks of the report are filtered by workbaskets, states, categories, domains and values of a custom field. If no filter is required, the respective parameter should be null. Tasks with Timestamp DUE = null are not considered.

Parameters:

workbasketIds - a list of workbasket ids objects to filter by workbaskets. To omit this filter, use null for this parameter

states - a list of states objects to filter by states. To omit this filter, use null for this parameter

categories - a list of categories to filter by categories. To omit this filter, use null for this parameter

domains - a list of domains to filter by domains. To omit this filter, use null for this parameter

customField - a custom field to filter by the values of the custom field

customFieldValues - a list of custom field values to filter by the values of the custom field. To omit this filter, use null for this parameter

columnHeaders - a list of columnHeaders that specify the subdivision into different cluster of due dates. Days in past are represented as negative values and days in the future are represented as positive values. To avoid tasks are counted multiple times or not be listed in the report, these columnHeaders should not overlap and should not have gaps. If the ReportLineDefinition should represent a single day, lowerLimit and upperLimit have to be equal. The outer cluster of a report should have open ends. These open ends are represented with Integer.MIN_VALUE and Integer.MAX_VALUE.

Returns:

the report

Throws:

InvalidArgumentException - thrown if customField is null

NotAuthorizedException - if the current user is not member of role MONITOR

getCustomFieldValueReport

CustomFieldValueReport getCustomFieldValueReport(List<String> workbasketIds,
                                                 List<TaskState> states,
                                                 List<String> categories,
                                                 List<String> domains,
                                                 CustomField customField,
                                                 List<String> customFieldValues,
                                                 List<TimeIntervalColumnHeader> columnHeaders,
                                                 boolean inWorkingDays)
                                          throws InvalidArgumentException,
                                                 NotAuthorizedException

Returns a CustomFieldValueReport grouped by the value of a certain CustomField. For each value of the custom field the report contains the total number of tasks and the number of tasks of the respective cluster that are specified by the TimeIntervalColumnHeaders. It can be specified whether the age of the tasks is counted in days or in working days. Furthermore the report contains a sum line that contains the total numbers of the different clusters and the total number of all tasks. The tasks of the report are filtered by workbaskets, states, categories, domains and values of a custom field. If no filter is required, the respective parameter should be null. Tasks with Timestamp DUE = null are not considered.

Parameters:

workbasketIds - a list of workbasket ids objects to filter by workbaskets. To omit this filter, use null for this parameter

states - a list of states objects to filter by states. To omit this filter, use null for this parameter

categories - a list of categories to filter by categories. To omit this filter, use null for this parameter

domains - a list of domains to filter by domains. To omit this filter, use null for this parameter

customField - a custom field to filter by the values of the custom field

customFieldValues - a list of custom field values to filter by the values of the custom field. To omit this filter, use null for this parameter

columnHeaders - a list of columnHeaders that specify the subdivision into different cluster of due dates. Days in past are represented as negative values and days in the future are represented as positive values. To avoid tasks are counted multiple times or not be listed in the report, these columnHeaders should not overlap and should not have gaps. If the ReportLineDefinition should represent a single day, lowerLimit and upperLimit have to be equal. The outer cluster of a report should have open ends. These open ends are represented with Integer.MIN_VALUE and Integer.MAX_VALUE.

inWorkingDays - a boolean parameter that specifies whether the age of the tasks should be counted in days or in working days

Returns:

the report

Throws:

InvalidArgumentException - thrown if customField is null

NotAuthorizedException - if the current user is not member of role MONITOR

getTaskIdsForSelectedItems

List<String> getTaskIdsForSelectedItems(List<String> workbasketIds,
                                        List<TaskState> states,
                                        List<String> categories,
                                        List<String> domains,
                                        List<String> classificationKeys,
                                        List<String> excludedClassificationKeys,
                                        CustomField customField,
                                        List<String> customFieldValues,
                                        List<TimeIntervalColumnHeader> columnHeaders,
                                        boolean inWorkingDays,
                                        List<SelectedItem> selectedItems,
                                        String dimension)
                                 throws InvalidArgumentException,
                                        NotAuthorizedException

Returns a list of all task ids in the selected items of a Report. By default the age of the tasks is counted in working days. The tasks of the report are filtered by workbaskets, states, categories, domains and values of a custom field. If no filter is required, the respective parameter should be null. Tasks with Timestamp DUE = null are not considered.

Parameters:

workbasketIds - a list of workbasket ids objects to filter by workbaskets. To omit this filter, use null for this parameter

states - a list of states objects to filter by states. To omit this filter, use null for this parameter

categories - a list of categories to filter by categories. To omit this filter, use null for this parameter

domains - a list of domains to filter by domains. To omit this filter, use null for this parameter

customField - a custom field to filter by the values of the custom field. To omit this filter, use null for this parameter

customFieldValues - a list of custom field values to filter by the values of the custom field. To omit this filter, use null for this parameter

columnHeaders - a list of columnHeaders that specify the subdivision into different cluster of due dates. Days in past are represented as negative values and days in the future are represented as positive values. To avoid tasks are counted multiple times or not be listed in the report, these columnHeaders should not overlap and should not have gaps. If the ReportLineDefinition should represent a single day, lowerLimit and upperLimit have to be equal. The outer cluster of a report should have open ends. These open ends are represented with Integer.MIN_VALUE and Integer.MAX_VALUE.

inWorkingDays - a boolean parameter that specifies whether the age of the tasks should be counted in days or in working days

selectedItems - a list of SelectedItems that are selected from the report whose task ids should be determined.

dimension - defines the meaning of the key in the SelectedItems.

Returns:

the list of task ids

Throws:

InvalidArgumentException - thrown if columnHeaders is null or if selectedItems is empty or null

NotAuthorizedException - if the current user is not member of role MONITOR

getCustomAttributeValuesForReport

List<String> getCustomAttributeValuesForReport(List<String> workbasketIds,
                                               List<TaskState> states,
                                               List<String> categories,
                                               List<String> domains,
                                               List<String> classificationIds,
                                               List<String> excludedClassificationIds,
                                               Map<String,String> customAttributeFilter,
                                               String customAttributeName)
                                        throws InvalidArgumentException,
                                               NotAuthorizedException

Returns a list of distinct custom attribute values for the selection from the entire task pool.

Parameters:

workbasketIds - a list of workbasket ids objects to filter by workbaskets. To omit this filter, use null for this parameter

states - a list of states objects to filter by states. To omit this filter, use null for this parameter

categories - a list of categories to filter by categories. To omit this filter, use null for this parameter

domains - a list of domains to filter by domains. To omit this filter, use null for this parameter

classificationIds - a List of all classification ids to include in the selection.

excludedClassificationIds - a List of all classification ids to exclude from the selection.

customAttributeFilter - a Map containing a key value pair for the custom attributes to be applied as a filter criteria

customAttributeName - the name of the custom attribute to determine the existing values from.

Returns:

the list of existing values for the custom attribute with name customAttributeName in the filtered task pool.

Throws:

InvalidArgumentException - thrown if the customAttributeName is invalid/empty.

NotAuthorizedException - if the current user is not member of role MONITOR

getTaskStatusReport

TaskStatusReport getTaskStatusReport()
                              throws NotAuthorizedException

Overloaded method for getTaskStatusReport(List, List). This method omits all filters.

Returns:

the TaskStatusReport

Throws:

NotAuthorizedException - if the current user is not member of role MONITOR or ADMIN

getTaskStatusReport

TaskStatusReport getTaskStatusReport(List<String> domains)
                              throws NotAuthorizedException

Overloaded method for getTaskStatusReport(List, List). This method applies a domain filter and omits the state filter.

Parameters:

domains - a list of domains to filter by domains. To omit this filter, use null for this parameter

Returns:

the TaskStatusReport

Throws:

NotAuthorizedException - if the current user is not member of role MONITOR or ADMIN

getTaskStatusReport

TaskStatusReport getTaskStatusReport(List<String> domains,
                                     List<TaskState> states)
                              throws NotAuthorizedException

Returns a TaskStatusReport. For each domain the report contains the total number of tasks, clustered in their task status. Furthermore the report contains a sum line that contains the total numbers of the different clusters and the total number of all tasks.

Parameters:

states - a list of states objects to filter by states. To omit this filter, use null for this parameter

domains - a list of domains to filter by domains. To omit this filter, use null for this parameter

Returns:

the TaskStatusReport

Throws:

NotAuthorizedException - if the current user is not member of role MONITOR or ADMIN