curam.util.workflow.intf

Interface TaskAdmin

@AccessLevel(value=EXTERNAL)
public interface TaskAdmin

The Task entity stores details of a set of instructions to enable a user to perform the manual work required by an activity in a workflow. This API provides functions to manipulate the data on the Task and its functions should be used rather than direct access to the functions present on the actual entity.

Method Summary

Modifier and Type	Method and Description
TaskPriorityAndCountList	countByUserAndPriority(java.lang.String userName, java.lang.String statusToIgnore) Returns a list of counts for the number of tasks reserved by a specified user and grouped by priority.
TaskStatusCountList	countByUserAndStatus(java.lang.String userName) Returns a list of counts for the number of tasks reserved by a specified user and grouped by status.
Count	countByUserDueDateAndStatus(java.lang.String userName, java.lang.String statusToIgnore, curam.util.type.DateTime fromDateTime, curam.util.type.DateTime toDateTime) Returns the number of tasks reserved by a specified user and between a specified due date.
Count	countReservedByStatus(java.lang.String userName, java.lang.String status) Returns the number of tasks with a specified status and reserved by a specified user.
Count	countTasksForReservedByUser(java.lang.String userName) Returns the number of task records reserved by a specified user.
TaskFullDetails	listAll(long bizObjectID, java.lang.String bizObjectType, curam.util.type.DateTime fromDateTime, curam.util.type.DateTime toDateTime, int maxListSize, boolean includeSubject) Returns the details of both the assigned and reserved tasks associated with a specified business object type and identifier and due within the supplied date range.
TaskFullDetails	listAll(long bizObjectID, java.lang.String bizObjectType, int maxListSize, boolean includeSubject) Returns the details of both the reserved and assigned tasks associated with a specified business object type and identifier.
TaskFullDetails	listAssigned(long bizObjectID, java.lang.String bizObjectType, java.lang.String status, curam.util.type.DateTime fromDateTime, curam.util.type.DateTime toDateTime, int maxListSize, boolean includeSubject) Returns the details of all of the assigned tasks associated with a specified business object type and identifier and due within the specified date range.
TaskFullDetails	listAssigned(long bizObjectID, java.lang.String bizObjectType, java.lang.String status, int maxListSize, boolean includeSubject) Returns the details of all of the assigned tasks associated with a specified business object type and identifier.
TaskFullDetails	listReserved(java.lang.String userName, curam.util.type.DateTime fromDateTime, curam.util.type.DateTime toDateTime, int maxListSize, boolean includeSubject) Returns the details of all of the reserved tasks for a user and due within the specified date range.
TaskFullDetails	listReserved(java.lang.String userName, int maxListSize, boolean includeSubject) Returns the details of all of the reserved tasks for a user.
TaskFullDetails	listReserved(java.lang.String userName, int maxListSize, boolean includeSubject, java.lang.String priority) Returns the details of all of the reserved tasks for a user associated with a specified priority.
TaskFullDetails	listReserved(java.lang.String userName, int maxListSize, java.lang.String status, boolean includeSubject) Returns the details of all of the reserved tasks for a user that have a specified status.
TaskFullDetails	listReserved(java.lang.String userName, long bizObjectID, java.lang.String bizObjectType, java.lang.String status, curam.util.type.DateTime fromDateTime, curam.util.type.DateTime toDateTime, int maxListSize, boolean includeSubject) Returns the details of all of the reserved tasks for a user associated with a specified business object type and identifier and due within the specified date range.
TaskFullDetails	listReserved(java.lang.String userName, long bizObjectID, java.lang.String bizObjectType, java.lang.String status, int maxListSize, boolean includeSubject) Returns the details of all of the reserved tasks for a user associated with a specified business object type and identifier.
TaskFullDetails	listReserved(java.lang.String userName, java.lang.String category, int maxListSize, boolean includeSubject) Returns the details of all of the reserved tasks for a user associated with a specified category.
void	modify(long taskID, java.lang.String administrationSID, boolean allowForwardInd, curam.util.type.DateTime assignedDateTime, java.lang.String category, curam.util.type.DateTime creationTime, boolean deadTimeOverInd, boolean overflowInd, java.lang.String priority, java.lang.String reservedBy, curam.util.type.DateTime restartTime, java.lang.String status, int totalTimeWorked, java.lang.String wdoSnapshot, int versionNo) Modifies all of the details of the specified task.
void	modifyAssignedDateTime(long taskID, curam.util.type.DateTime assignedDateTime, int versionNo) Modifies the assigned date time for the specified task.
void	modifyPriority(long taskID, java.lang.String priority, int versionNo) Modifies the priority of a task.
void	modifyReservedBy(long taskID, java.lang.String reservedBy, curam.util.type.DateTime assignedDateTime, int versionNo) Modifies the reserved by user and the assigned date time for a specified task.
void	modifyRestartTime(long taskID, curam.util.type.DateTime restartTime, int versionNo) Modifies the restart time on a task.
void	modifyStatus(long taskID, java.lang.String status, int versionNo) Modifies the status of a task.
void	modifyTotalTimeWorked(long taskID, int totalTimeWorked, int versionNo) Modifies the total time worked on a task.
TaskInfo	read(long taskID) Returns the details of the specified task.
TaskDetailsWithoutSnapshot	readDetails(long taskID) Returns all of the task details except for the WDO snapshot.
TaskDetailsWithSnapshot	readDetailsWithSnapshot(long taskID) Returns all of the task details including the WDO snapshot.
TaskOptimisticLockingDetails	readOptimisticLockingVersionNo(long taskID) Returns the optimistic locking version number details for a specified task.
TaskDetailsWithDueDate	readTaskDetailsWithDueDate(long taskID) Returns the full details of a specified task including the date and time that the task is due on.

Method Detail

read

TaskInfo read(long taskID)
       throws curam.util.exception.AppException,
              curam.util.exception.InformationalException

Returns the details of the specified task.

Parameters:

taskID - The unique identifier of a task.

Returns:

The details of the specified task.

Throws:

curam.util.exception.AppException - Exceptions that may occur when invoking this function.

curam.util.exception.InformationalException - Generic Exception Signature.

modify

void modify(long taskID,
            java.lang.String administrationSID,
            boolean allowForwardInd,
            curam.util.type.DateTime assignedDateTime,
            java.lang.String category,
            curam.util.type.DateTime creationTime,
            boolean deadTimeOverInd,
            boolean overflowInd,
            java.lang.String priority,
            java.lang.String reservedBy,
            curam.util.type.DateTime restartTime,
            java.lang.String status,
            int totalTimeWorked,
            java.lang.String wdoSnapshot,
            int versionNo)
     throws curam.util.exception.AppException,
            curam.util.exception.InformationalException

Modifies all of the details of the specified task. A valid task identifier must be specified.

Parameters:

taskID - The unique identifier associated with a task.

administrationSID - The administration security identifier associated with a manual activity.

allowForwardInd - A boolean flag to indicate if the task can be forwarded.

assignedDateTime - The date and time at which the task was assigned.

category - The category of the activity associated with this task.

creationTime - The date and time at which the task was created.

deadTimeOverInd - A boolean flag to indicate if the time associated with a deadline may be overridden.

overflowInd - A boolean flag that indicates if the WDO snapshot XML string requires access to the TaskWDOOverflow overflow table.

priority - The priority of the task.

reservedBy - The name of the user that has reserved the task.

restartTime - The date and time at which the task was restarted.

status - The status of the task.

totalTimeWorked - The total time spent on this task (in seconds).

wdoSnapshot - A snapshot of the WDO data mapped to the parameters of the task subject and actions taken when a task record is created.

versionNo - The optimistic locking version number.

Throws:

curam.util.exception.AppException - Exceptions that may occur when invoking this function.

curam.util.exception.InformationalException - Generic Exception Signature.

countTasksForReservedByUser

Count countTasksForReservedByUser(java.lang.String userName)
                           throws curam.util.exception.AppException,
                                  curam.util.exception.InformationalException

Returns the number of task records reserved by a specified user.

Parameters:

userName - The name of the user whose count of reserved tasks will be returned.

Returns:

The number of task records reserved by a specified user.

Throws:

curam.util.exception.AppException - Exceptions that may occur when invoking this function.

curam.util.exception.InformationalException - Generic Exception Signature.

modifyAssignedDateTime

void modifyAssignedDateTime(long taskID,
                            curam.util.type.DateTime assignedDateTime,
                            int versionNo)
                     throws curam.util.exception.AppException,
                            curam.util.exception.InformationalException

Modifies the assigned date time for the specified task. A valid task identifier must be specified.

Parameters:

taskID - The unique identifier of a task.

assignedDateTime - The task assigned date time.

versionNo - The optimistic locking version number of the task record.

Throws:

curam.util.exception.AppException - Exceptions that may occur when invoking this function.

curam.util.exception.InformationalException - Generic Exception Signature.

modifyPriority

void modifyPriority(long taskID,
                    java.lang.String priority,
                    int versionNo)
             throws curam.util.exception.AppException,
                    curam.util.exception.InformationalException

Modifies the priority of a task. A valid task identifier must be specified.

Parameters:

taskID - The unique identifier of a task.

priority - The priority of a task.

versionNo - The optimistic locking version number of the task record.

Throws:

curam.util.exception.AppException - Exceptions that may occur when invoking this function.

curam.util.exception.InformationalException - Generic Exception Signature.

modifyReservedBy

void modifyReservedBy(long taskID,
                      java.lang.String reservedBy,
                      curam.util.type.DateTime assignedDateTime,
                      int versionNo)
               throws curam.util.exception.AppException,
                      curam.util.exception.InformationalException

Modifies the reserved by user and the assigned date time for a specified task. A valid task identifier must be specified.

Parameters:

taskID - The unique identifier of a task.

reservedBy - The name of the user reserving the task.

assignedDateTime - The date and time that a task was reserved.

versionNo - The optimistic locking version number of the task record.

Throws:

curam.util.exception.AppException - Exceptions that may occur when invoking this function.

curam.util.exception.InformationalException - Generic Exception Signature.

modifyRestartTime

void modifyRestartTime(long taskID,
                       curam.util.type.DateTime restartTime,
                       int versionNo)
                throws curam.util.exception.AppException,
                       curam.util.exception.InformationalException

Modifies the restart time on a task. A valid task identifier must be specified.

Parameters:

taskID - The unique identifier of a task.

restartTime - The time that the task was restarted.

versionNo - The optimistic locking version number of the task record.

Throws:

curam.util.exception.AppException - Exceptions that may occur when invoking this function.

curam.util.exception.InformationalException - Generic Exception Signature.

modifyStatus

void modifyStatus(long taskID,
                  java.lang.String status,
                  int versionNo)
           throws curam.util.exception.AppException,
                  curam.util.exception.InformationalException

Modifies the status of a task. A valid task identifier must be specified.

Parameters:

taskID - The unique identifier of a task.

status - The status of the task.

versionNo - The optimistic locking version number of the task record.

Throws:

curam.util.exception.AppException - Exceptions that may occur when invoking this function.

curam.util.exception.InformationalException - Generic Exception Signature.

modifyTotalTimeWorked

void modifyTotalTimeWorked(long taskID,
                           int totalTimeWorked,
                           int versionNo)
                    throws curam.util.exception.AppException,
                           curam.util.exception.InformationalException

Modifies the total time worked on a task. A valid task identifier must be specified.

Parameters:

taskID - The unique identifier of a task.

totalTimeWorked - The total time worked on a task in seconds.

versionNo - The optimistic locking version number of the task record.

Throws:

curam.util.exception.AppException - Exceptions that may occur when invoking this function.

curam.util.exception.InformationalException - Generic Exception Signature.

readDetails

TaskDetailsWithoutSnapshot readDetails(long taskID)
                                throws curam.util.exception.AppException,
                                       curam.util.exception.InformationalException

Returns all of the task details except for the WDO snapshot.

Parameters:

taskID - The unique identifier of a task.

Returns:

All of the task details except for the WDO snapshot.

Throws:

curam.util.exception.AppException - Exceptions that may occur when invoking this function.

curam.util.exception.InformationalException - Generic Exception Signature.

readOptimisticLockingVersionNo

TaskOptimisticLockingDetails readOptimisticLockingVersionNo(long taskID)
                                                     throws curam.util.exception.AppException,
                                                            curam.util.exception.InformationalException

Returns the optimistic locking version number details for a specified task.

Parameters:

taskID - The unique identifier of a task.

Returns:

The optimistic locking version number details of a task.

Throws:

curam.util.exception.AppException - Exceptions that may occur when invoking this function.

curam.util.exception.InformationalException - Generic Exception Signature.

readTaskDetailsWithDueDate

TaskDetailsWithDueDate readTaskDetailsWithDueDate(long taskID)
                                           throws curam.util.exception.AppException,
                                                  curam.util.exception.InformationalException

Returns the full details of a specified task including the date and time that the task is due on.

Parameters:

taskID - The unique identifier of a task.

Returns:

The full details of the specified task including the due date.

Throws:

curam.util.exception.AppException - Exceptions that may occur when invoking this function.

curam.util.exception.InformationalException - Generic Exception Signature.

countByUserAndStatus

TaskStatusCountList countByUserAndStatus(java.lang.String userName)
                                  throws curam.util.exception.AppException,
                                         curam.util.exception.InformationalException

Returns a list of counts for the number of tasks reserved by a specified user and grouped by status.

Parameters:

userName - The name of the user that has reserved the task.

Returns:

A list of counts for the number of tasks reserved by the specified user grouped by status.

Throws:

curam.util.exception.AppException - Exceptions that may occur when invoking this function.

curam.util.exception.InformationalException - Generic Exception Signature.

listReserved

TaskFullDetails listReserved(java.lang.String userName,
                             java.lang.String category,
                             int maxListSize,
                             boolean includeSubject)
                      throws curam.util.exception.AppException,
                             curam.util.exception.InformationalException

Returns the details of all of the reserved tasks for a user associated with a specified category.

The result details include:

• the details of all of the reserved tasks for a user associated with a specified category. The tasks will be ordered by deadline date time, earliest first;
• the information about requested and actual size of the result list.

Parameters:

userName - The name of the user whose reserved tasks will be returned.

category - The activity category associated with the task.

maxListSize - The maximum number of task details to be returned.

includeSubject - If specified to true, the subject of the task will be returned in the results.

Returns:

The details of the reserved tasks.

Throws:

curam.util.exception.AppException - Exceptions that may occur when invoking this function.

curam.util.exception.InformationalException - Generic Exception Signature.

listReserved

TaskFullDetails listReserved(java.lang.String userName,
                             int maxListSize,
                             boolean includeSubject)
                      throws curam.util.exception.AppException,
                             curam.util.exception.InformationalException

Returns the details of all of the reserved tasks for a user.

The result details include:

• all of the reserved tasks for a user. The tasks will be ordered by deadline date time, earliest first;
• the information about requested and actual size of the result list.

Parameters:

userName - The name of the user whose reserved tasks will be returned.

maxListSize - The maximum number of task details to be returned.

includeSubject - If specified to true, the subject of the task will be returned in the results.

Returns:

The details of the reserved tasks.

Throws:

curam.util.exception.AppException - Exceptions that may occur when invoking this function.

curam.util.exception.InformationalException - Generic Exception Signature.

listReserved

TaskFullDetails listReserved(java.lang.String userName,
                             int maxListSize,
                             java.lang.String status,
                             boolean includeSubject)
                      throws curam.util.exception.AppException,
                             curam.util.exception.InformationalException

Returns the details of all of the reserved tasks for a user that have a specified status.

The result details include:

• the reserved tasks for a user that contain a particular status. If status is not specified it will default to NOT STARTED. The tasks will be ordered by deadline date time, earliest first;
• the information about requested and actual size of the result list.

Parameters:

userName - The name of the user whose reserved tasks will be returned.

status - The status of a task.

includeSubject - If specified to true, the subject of the task will be returned in the results.

maxListSize - The maximum number of task details to be returned.

Returns:

A list of the reserved tasks for a user that contain a particular status. The tasks are ordered by deadline.

Throws:

curam.util.exception.AppException - Exceptions that may occur when invoking this function.

curam.util.exception.InformationalException - Generic Exception Signature.

listReserved

TaskFullDetails listReserved(java.lang.String userName,
                             long bizObjectID,
                             java.lang.String bizObjectType,
                             java.lang.String status,
                             int maxListSize,
                             boolean includeSubject)
                      throws curam.util.exception.AppException,
                             curam.util.exception.InformationalException

Returns the details of all of the reserved tasks for a user associated with a specified business object type and identifier.

The result details include:

• the reserved tasks for a user associated with a specified business object type and identifier. If status is not specified it will default to NOT STARTED. The tasks will be ordered by deadline date time, earliest first;
• the information about requested and actual size of the result list.

Parameters:

userName - The name of the user reserving the task.

bizObjectID - Identifies a particular instance of the specified business object type.

bizObjectType - Specifies the business object type.

status - The status of a task.

maxListSize - The maximum number of task details to be returned.

includeSubject - If specified to true, the subject of the task will be returned in the results.

Returns:

A list of the details for all of the reserved tasks associated with a specified business object type and identifier. The tasks will be ordered by deadline date time, earliest first.

Throws:

curam.util.exception.AppException - Exceptions that may occur when invoking this function.

curam.util.exception.InformationalException - Generic Exception Signature.

listReserved

TaskFullDetails listReserved(java.lang.String userName,
                             long bizObjectID,
                             java.lang.String bizObjectType,
                             java.lang.String status,
                             curam.util.type.DateTime fromDateTime,
                             curam.util.type.DateTime toDateTime,
                             int maxListSize,
                             boolean includeSubject)
                      throws curam.util.exception.AppException,
                             curam.util.exception.InformationalException

Returns the details of all of the reserved tasks for a user associated with a specified business object type and identifier and due within the specified date range.

The result details include:

• the reserved tasks for a user associated with a specified business object type and identifier and due within the specified date range. If status is not specified it will default to NOT STARTED. The tasks will be ordered by deadline date time, earliest first;
• the information about requested and actual size of the result list.

Parameters:

userName - The name of the user reserving the task.

bizObjectID - A particular instance of the specified business object type.

bizObjectType - The business object type.

status - The status of a task.

fromDateTime - The task search from date required (inclusive).

toDateTime - The task search to date required (exclusive).

maxListSize - The maximum number of task details to be returned.

includeSubject - If specified to true, the subject of the task will be returned in the results.

Returns:

A list of the details of all of the reserved tasks associated with a specified user, status, business object type and identifier and due within the specified date range. The tasks will be ordered by deadline date time, earliest first.

Throws:

curam.util.exception.AppException - Exceptions that may occur when invoking this function.

curam.util.exception.InformationalException - Generic Exception Signature.

listAssigned

TaskFullDetails listAssigned(long bizObjectID,
                             java.lang.String bizObjectType,
                             java.lang.String status,
                             int maxListSize,
                             boolean includeSubject)
                      throws curam.util.exception.AppException,
                             curam.util.exception.InformationalException

Returns the details of all of the assigned tasks associated with a specified business object type and identifier.

The result details include:

• the assigned tasks associated with a specified business object type and identifier. If status is not specified it will default to NOT STARTED. The tasks will be ordered by deadline date time, earliest first.
• the information about requested and actual size of the result list.

Parameters:

bizObjectID - Identifies a particular instance of the specified business object type.

bizObjectType - The business object type.

status - The status of a task.

maxListSize - The maximum number of task details to be returned.

includeSubject - If specified to true, the subject of the task will be returned in the results.

Returns:

A list of the details for all of the assigned tasks associated with a specified user, status, business object type and identifier. The tasks will be ordered by deadline date time, earliest first.

Throws:

curam.util.exception.AppException - Exceptions that may occur when invoking this function.

curam.util.exception.InformationalException - Generic Exception Signature.

listAssigned

TaskFullDetails listAssigned(long bizObjectID,
                             java.lang.String bizObjectType,
                             java.lang.String status,
                             curam.util.type.DateTime fromDateTime,
                             curam.util.type.DateTime toDateTime,
                             int maxListSize,
                             boolean includeSubject)
                      throws curam.util.exception.AppException,
                             curam.util.exception.InformationalException

Returns the details of all of the assigned tasks associated with a specified business object type and identifier and due within the specified date range.

The result details include:

• the assigned tasks associated with a specified business object type and identifier and due within the specified date range. If status is not specified it will default to NOT STARTED. The tasks will be ordered by deadline date time, earliest first.
• the information about requested and actual size of the result list.

Parameters:

bizObjectID - Identifies a particular instance of the specified business object type.

bizObjectType - The business object type.

status - The status of a task.

fromDateTime - The from due date.

toDateTime - The to due date.

maxListSize - The maximum number of task details to be returned.

includeSubject - If specified to true, the subject of the task will be returned in the results.

Returns:

A list of the details for all of the assigned tasks associated with a specified business object type and identifier and due within the specified date range. The tasks will be ordered by deadline date time, earliest first.

Throws:

curam.util.exception.AppException - Exceptions that may occur when invoking this function.

curam.util.exception.InformationalException - Generic Exception Signature.

listAll

TaskFullDetails listAll(long bizObjectID,
                        java.lang.String bizObjectType,
                        int maxListSize,
                        boolean includeSubject)
                 throws curam.util.exception.AppException,
                        curam.util.exception.InformationalException

Returns the details of both the reserved and assigned tasks associated with a specified business object type and identifier.

The result details include:

• both the reserved and assigned tasks associated with a specified business object type and identifier. Tasks with a status of CLOSED will be excluded. The tasks will be ordered by deadline date time, earliest first.
• the information about requested and actual size of the result list.

Parameters:

bizObjectID - The identifier of a particular instance of the specified business object type.

bizObjectType - The business object type.

maxListSize - The maximum number of task details to be returned.

includeSubject - If specified to true, the subject of the task will be returned in the results.

Returns:

A list of the details of both the assigned and reserved tasks associated with a specified business object type and identifier. The tasks will be ordered by deadline date time, earliest first.

Throws:

curam.util.exception.AppException - Exceptions that may occur when invoking this function.

curam.util.exception.InformationalException - Generic Exception Signature.

listAll

TaskFullDetails listAll(long bizObjectID,
                        java.lang.String bizObjectType,
                        curam.util.type.DateTime fromDateTime,
                        curam.util.type.DateTime toDateTime,
                        int maxListSize,
                        boolean includeSubject)
                 throws curam.util.exception.AppException,
                        curam.util.exception.InformationalException

Returns the details of both the assigned and reserved tasks associated with a specified business object type and identifier and due within the supplied date range.

The result details include:

• the details of all of the tasks associated with a specified business object type and identifier within the supplied date range. Tasks with status CLOSED will be excluded. The tasks will be ordered by deadline date time, earliest first;
• the information about requested and actual size of the result list.

Parameters:

bizObjectID - The identifier of a particular instance of the specified business object type.

bizObjectType - The business object type.

fromDateTime - The from due date.

toDateTime - The to due date.

maxListSize - The maximum number of task details to be returned.

includeSubject - If specified to true, the subject of the task will be returned in the results.

Returns:

A list of the details for both the reserved and assigned tasks associated with a specified business object type and identifier and due within the specified date range. The tasks will be ordered by deadline date time, earliest first.

Throws:

curam.util.exception.AppException - Exceptions that may occur when invoking this function.

curam.util.exception.InformationalException - Generic Exception Signature.

countReservedByStatus

Count countReservedByStatus(java.lang.String userName,
                            java.lang.String status)
                     throws curam.util.exception.AppException,
                            curam.util.exception.InformationalException

Returns the number of tasks with a specified status and reserved by a specified user.

Parameters:

userName - The name of the user whose count of reserved tasks will be returned.

status - The status of a task.

Returns:

The number of task records reserved by the specified user with the specified status.

Throws:

curam.util.exception.AppException - Exceptions that may occur when invoking this function.

curam.util.exception.InformationalException - Generic Exception Signature.

listReserved

TaskFullDetails listReserved(java.lang.String userName,
                             int maxListSize,
                             boolean includeSubject,
                             java.lang.String priority)
                      throws curam.util.exception.AppException,
                             curam.util.exception.InformationalException

Returns the details of all of the reserved tasks for a user associated with a specified priority.

The result details include:

• the details of all of the reserved tasks for a user associated with a specified priority. The tasks will be ordered by deadline date time, earliest first;
• the information about requested and actual size of the result list.

Parameters:

userName - The name of the user whose reserved tasks will be returned.

maxListSize - The maximum number of task details to be returned.

includeSubject - If specified to true, the subject of the task will be returned in the results.

priority - The priority of a task.

Returns:

The details of the reserved tasks.

Throws:

curam.util.exception.AppException - Exceptions that may occur when invoking this function.

curam.util.exception.InformationalException - Generic Exception Signature.

listReserved

TaskFullDetails listReserved(java.lang.String userName,
                             curam.util.type.DateTime fromDateTime,
                             curam.util.type.DateTime toDateTime,
                             int maxListSize,
                             boolean includeSubject)
                      throws curam.util.exception.AppException,
                             curam.util.exception.InformationalException

Returns the details of all of the reserved tasks for a user and due within the specified date range.

The result details include:

• all of the reserved tasks for a user and due within the specified date range.The tasks will be ordered by deadline date time, earliest first;
• the information about requested and actual size of the result list.

Parameters:

userName - The name of the user reserving the task.

fromDateTime - The task search from date required (inclusive).

toDateTime - The task search to date required (exclusive).

maxListSize - The maximum number of task details to be returned.

includeSubject - If specified to true, the subject of the task will be returned in the results.

Returns:

A list of the task details for all of the reserved tasks associated with a specified user, business object type and identifier and due within the specified date range. The tasks will be ordered by deadline date time, earliest first.

Throws:

curam.util.exception.AppException - Exceptions that may occur when invoking this function.

curam.util.exception.InformationalException - Generic Exception Signature.

readDetailsWithSnapshot

TaskDetailsWithSnapshot readDetailsWithSnapshot(long taskID)
                                         throws curam.util.exception.AppException,
                                                curam.util.exception.InformationalException

Returns all of the task details including the WDO snapshot.

Parameters:

taskID - The unique identifier of a task.

Returns:

All of the task details including the WDO snapshot.

Throws:

curam.util.exception.AppException - Exceptions that may occur when invoking this function.

curam.util.exception.InformationalException - Generic Exception Signature.

countByUserDueDateAndStatus

Count countByUserDueDateAndStatus(java.lang.String userName,
                                  java.lang.String statusToIgnore,
                                  curam.util.type.DateTime fromDateTime,
                                  curam.util.type.DateTime toDateTime)
                           throws curam.util.exception.AppException,
                                  curam.util.exception.InformationalException

Returns the number of tasks reserved by a specified user and between a specified due date. A task status to ignore may also be specified.

Parameters:

userName - The name of the user whose count of reserved tasks will be returned.

statusToIgnore - The status of a task to ignore from the search results.

fromDateTime - The task due date from which the results will begin.

toDateTime - The task due date to which the results will end.

Returns:

A count of the number of tasks that satisfy the search criteria.

Throws:

curam.util.exception.AppException - Exceptions that may occur when invoking this function.

curam.util.exception.InformationalException - Generic Exception Signature.

countByUserAndPriority

TaskPriorityAndCountList countByUserAndPriority(java.lang.String userName,
                                                java.lang.String statusToIgnore)
                                         throws curam.util.exception.AppException,
                                                curam.util.exception.InformationalException

Returns a list of counts for the number of tasks reserved by a specified user and grouped by priority.

Parameters:

userName - The name of the user that has reserved the task.

statusToIgnore - The status of a task that will not be included in the search results.

Returns:

A list of task counts that satisfy the specified criteria.

Throws:

curam.util.exception.AppException - Exceptions that may occur when invoking this function.

curam.util.exception.InformationalException - Generic Exception Signature.