pro.taskana

Interface TaskMonitorService

All Known Implementing Classes:

TaskMonitorServiceImpl

public interface TaskMonitorService

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

Method Summary

Modifier and Type	Method and Description
Report	getCategoryReport(List<Workbasket> workbaskets, List<TaskState> states) Returns a Report with categories for a given list of Workbaskets and for a given list of TaskStates.
Report	getCategoryReport(List<Workbasket> workbaskets, List<TaskState> states, List<ReportLineItemDefinition> reportLineItemDefinitions) Returns a Report with categories for a given list of Workbaskets, a given list of TaskStates and a given list of ReportLineItemDefinitions.
List<DueWorkbasketCounter>	getTaskCountByWorkbasketAndDaysInPastAndState(long daysInPast, List<TaskState> states) Count all Tasks for all work basket objects where the due date is after "daysInPast" days from today in the past and the tasks are in specified states.
List<TaskStateCounter>	getTaskCountForState(List<TaskState> states) This method counts all tasks with a given state.
long	getTaskCountForWorkbasketByDaysInPastAndState(String workbasketId, long daysInPast, List<TaskState> states) Count all Tasks in a given work basket where the due date is after "daysInPast" days from today in the past and the tasks are in specified states.
Report	getWorkbasketLevelReport(List<Workbasket> workbaskets, List<TaskState> states) Returns a Report for a given list of Workbaskets and for a given list of TaskStates.
Report	getWorkbasketLevelReport(List<Workbasket> workbaskets, List<TaskState> states, List<ReportLineItemDefinition> reportLineItemDefinitions) Returns a Report for a given list of Workbaskets, a given list of TaskStates and a given list of ReportLineItemDefinitions.

Method Detail

getTaskCountForState

List<TaskStateCounter> getTaskCountForState(List<TaskState> states)

This method counts all tasks with a given state.

Parameters:

states - the countable states

Returns:

a List of TaskStateCounter objects that specifies how many tasks in the specified states exist in the available work baskets

getTaskCountForWorkbasketByDaysInPastAndState

long getTaskCountForWorkbasketByDaysInPastAndState(String workbasketId,
                                                   long daysInPast,
                                                   List<TaskState> states)

Count all Tasks in a given work basket where the due date is after "daysInPast" days from today in the past and the tasks are in specified states.

Parameters:

workbasketId - the id of the work basket

daysInPast - identifies the days in the past from today

states - List of TaskState that identifies the states of the tasks to be searched for

Returns:

the number of Task objects in the given work basket that match the query parameters

getTaskCountByWorkbasketAndDaysInPastAndState

List<DueWorkbasketCounter> getTaskCountByWorkbasketAndDaysInPastAndState(long daysInPast,
                                                                         List<TaskState> states)

Count all Tasks for all work basket objects where the due date is after "daysInPast" days from today in the past and the tasks are in specified states.

Parameters:

daysInPast - identifies the days in the past from today

states - List of TaskState objects that identifies the states of the tasks searched

Returns:

a list of of DueWorkbasketCounter objects that specifies how many tasks in the requested states with appropriate due date exist in the various work baskets

getWorkbasketLevelReport

Report getWorkbasketLevelReport(List<Workbasket> workbaskets,
                                List<TaskState> states)

Returns a Report for a given list of Workbaskets and for a given list of TaskStates. The report only contains the number of all tasks of the respective workbasket as well as the total sum of all tasks. Only tasks with a state in the list of TaskStates are provided. Task with Timestamp DUE = null are not considered.

Parameters:

workbaskets - a list of Workbasket objects that should be listed in the report

states - a list of TaskState objects that specify the states of the tasks that are provided

Returns:

a Report object that only contains the number of all tasks of the respective workbasket as well as the total number of all tasks

getWorkbasketLevelReport

Report getWorkbasketLevelReport(List<Workbasket> workbaskets,
                                List<TaskState> states,
                                List<ReportLineItemDefinition> reportLineItemDefinitions)

Returns a Report for a given list of Workbaskets, a given list of TaskStates and a given list of ReportLineItemDefinitions. For each workbasket the report contains a list of ReportLineItems that subdivides the report in to different cluster grouped by the due date. Only tasks with a state in the list of TaskStates are provided. Tasks with Timestamp DUE = null are not considered.

Parameters:

workbaskets - a list of Workbasket objects that should be listed in the report

states - a list of TaskState objects that specify the states of the tasks that are provided

reportLineItemDefinitions - a list of ReportLineItemDefinition objects 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 reportLineItemDefinitions should not overlap and should not have gaps. If the ReportLineDefinition should represent a single day, lowerLimit and upperLimit have to be equal.

Returns:

a Report object that represents an overview of all tasks in the

getCategoryReport

Report getCategoryReport(List<Workbasket> workbaskets,
                         List<TaskState> states)

Returns a Report with categories for a given list of Workbaskets and for a given list of TaskStates. The report only contains the number of all tasks of the respective category as well as the total sum of all tasks. Only tasks with a state in the list of TaskStates are provided. Task with Timestamp DUE = null are not considered.

Parameters:

workbaskets - a list of Workbasket objects that whose task should be counted in the report

states - a list of TaskState objects that specify the states of the tasks that are provided

Returns:

a Report object that only contains the number of all tasks of the respective category as well as the total number of all tasks

getCategoryReport

Report getCategoryReport(List<Workbasket> workbaskets,
                         List<TaskState> states,
                         List<ReportLineItemDefinition> reportLineItemDefinitions)

Returns a Report with categories for a given list of Workbaskets, a given list of TaskStates and a given list of ReportLineItemDefinitions. For each category the report contains a list of ReportLineItems that subdivides the report in to different cluster grouped by the due date. Only tasks with a state in the list of TaskStates are provided. Tasks with Timestamp DUE = null are not considered.

Parameters:

workbaskets - a list of Workbasket objects that should be listed in the report

states - a list of TaskState objects that specify the states of the tasks that are provided

reportLineItemDefinitions - a list of ReportLineItemDefinition objects 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 reportLineItemDefinitions should not overlap and should not have gaps. If the ReportLineDefinition should represent a single day, lowerLimit and upperLimit have to be equal.

Returns:

a Report object that represents an overview of all tasks of the respective category