curam.core.facade.intf

Interface TaskManagement

All Known Implementing Classes:

TaskManagement, curam.core.facade.impl.TaskManagement, TaskManagementFactory

@AccessLevel(value=EXTERNAL)
public interface TaskManagement

Tasks are used to assign and track the work of system users. This business interface provides the operations to manage tasks in the Inbox.

Method Summary

Modifier and Type	Method and Description
void	addComment(curam.core.facade.struct.AddTaskCommentDetails addTaskCommentDetails) Adds a comment to a task by inserting a record into the task history table.
void	close(curam.core.facade.struct.TaskManagementTaskKey taskKey) Closes the task by raising the TASK.CLOSED event.
void	create(curam.core.facade.struct.TaskCreateDetails createTaskDetails) Creates a new task by enacting a workflow process.
void	defer(curam.core.facade.struct.DeferTaskDetails deferTaskDetails) Defers a task until a later date.
void	forward(curam.core.facade.struct.TaskForwardDetails forwardTaskDetails) Forwards a task to a job, position, organization unit, user, work queue or allocation target.
curam.core.facade.struct.TaskContextPanelDetails	getTaskContextPanelDetails(curam.core.facade.struct.TaskManagementTaskKey taskKey) Returns the details for the context panel for a specified task.
void	modifyDeadline(curam.core.facade.struct.TaskDeadlineDetails taskDeadlineDetails) Modifies the deadline of the specified task.
void	modifyPriority(curam.core.facade.struct.TaskPriorityDetails taskPriorityDetails) Modifies the priority of the specified task.
void	modifyTimeWorked(curam.core.facade.struct.ModifyTimeWorkedDetails modifyTimeWorkedDetails) Modifies the total time worked on the specified task.
curam.core.facade.struct.TaskManagementContextDescription	readContextDescription(curam.core.facade.struct.TaskManagementTaskKey taskKey) Returns the context description for the specified task.
curam.core.facade.struct.TaskDeadlineDetails	readDeadlineDetails(curam.core.facade.struct.TaskManagementTaskKey taskKey) Returns the deadline details of a task.
curam.core.facade.struct.TaskPriorityDetails	readPriorityDetails(curam.core.facade.struct.TaskManagementTaskKey taskKey) Returns the priority details of a task.
curam.core.sl.struct.TaskVersionNoDetails	readTaskVersionNo(curam.core.sl.struct.TaskManagementTaskKey taskKey) Returns the optimistic locking version number details for the specified task.
curam.core.facade.struct.TaskTimeWorkedDetails	readTimeWorked(curam.core.facade.struct.TaskManagementTaskKey taskKey) Returns the amount of time worked on a specified task represented as a date time.
void	reallocate(curam.core.facade.struct.ReallocateTaskDetails reallocateTaskDetails) Reallocates a task.
void	reserve(curam.core.facade.struct.ReserveTaskDetails reserveTaskDetails) Adds the task to the user's My Tasks list.
void	reserveMultipleTasks(curam.core.facade.struct.MultipleTaskDetails taskList) Adds the specified tasks to the user's My Tasks list.
void	restart(curam.core.facade.struct.RestartTaskDetails taskRestartDetails) Restarts a task that had been previously deferred.
void	unreserve(curam.core.facade.struct.UnreserveTaskDetails unreserveTaskDetails) Makes a task available.
curam.core.facade.struct.TaskAssignmentDetails1	viewAssignmentList1(curam.core.facade.struct.TaskManagementTaskKey taskKey) Returns a list of all the assignments for the specified task.
curam.core.sl.struct.TaskAssigneeDetailsList	viewAssignmentsForTask(curam.core.sl.struct.TaskManagementTaskKey taskKey) Returns a list of all the assignment details for the specified task including the name of the object that task is assigned to and also the type of that object (i.e. user, work queue, organization unit, position or job).
curam.core.sl.struct.TaskHistoryInformationDetailsList	viewHistoryForTaskList(curam.core.sl.struct.TaskManagementTaskKey taskKey) Returns a list of all the task history records associated with the specified task.
curam.core.facade.struct.ListHistoryForTaskDetails	viewHistoryList(curam.core.facade.struct.TaskManagementTaskKey taskKey) Returns a list of all the task history records associated with the specified task.
curam.core.facade.struct.TaskHistoryTextDetails	viewHistoryText(curam.core.facade.struct.TaskManagementTaskKey taskKey) Returns a list of the unformatted task history records for the specified task.
curam.core.sl.struct.TaskHistoryInformationDetails	viewTaskHistoryDetails(curam.core.sl.struct.TaskHistoryKey key) Returns the details of one task history life cycle event.
curam.core.facade.struct.ViewTaskDetails	viewTaskHome(curam.core.facade.struct.TaskManagementTaskKey taskKey) Returns the full details of the specified task including the task subject and also the task deadline date time.
curam.core.facade.pdt.struct.WorkflowGraphDetails	visualiseProcessInstanceForTask(curam.core.facade.struct.TaskManagementTaskKey taskKey) Returns the XML representing the graph of the process instance associated with the specified task.

Method Detail

create

void create(curam.core.facade.struct.TaskCreateDetails createTaskDetails)
     throws curam.util.exception.AppException,
            curam.util.exception.InformationalException

Creates a new task by enacting a workflow process. The workflow process enacted depends on the input criteria specified to create the task.

• If both the participantRoleID and caseID input fields have not been specified, then the MANUAL workflow process is enacted.
• If the participantRoleID input field has been populated and the caseID input field has not, then the MANUALPARTICIPANT workflow process is enacted.
• If the participantRoleID input field has not been populated and the caseID input field has been populated, then the MANUALCASE workflow process is enacted.
• Otherwise the default workflow process that is enacted is the MANUALPARTICIPANTCASE.

An exception is thrown under the following circumstances:

• If the priority field is empty.
• If the subject field is empty.
• If the deadline field contains a date time that is in the past.
• If neither the addToMyTasksInd field nor the assignedTo field are set.
• If both the addToMyTasksInd and assignedTo fields are set.
• If the addToMyTasksInd field has been set and the specified user has an active task redirection or allocation blocking period specified for them.
• If the assignee name does not match the assignee type.

Parameters:

createTaskDetails - The details of the task to create.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

close

void close(curam.core.facade.struct.TaskManagementTaskKey taskKey)
    throws curam.util.exception.AppException,
           curam.util.exception.InformationalException

Closes the task by raising the TASK.CLOSED event.

An exception is thrown in the following circumstances:

• If the task is already closed.
• If the task being closed is part of the My Tasks list of another user.

Parameters:

taskKey - The identifier of the task to be closed.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

modifyTimeWorked

void modifyTimeWorked(curam.core.facade.struct.ModifyTimeWorkedDetails modifyTimeWorkedDetails)
               throws curam.util.exception.AppException,
                      curam.util.exception.InformationalException

Modifies the total time worked on the specified task. The time worked in this default implementation is passed in as a date time (in the totalTimeWorked argument). The hours and minutes of this date time are extracted from the specified date time and converted to seconds. The time worked on for the task is thus stored in seconds.

A task history record is created containing the details of the modification.

An exception is thrown under the following circumstances:

• If the task is already closed.
• If the task is not in the My Tasks list for the specified user.
• If the number of hours or minutes worked is less than 0
• If the number of minutes worked is greater or equal to 60

Parameters:

modifyTimeWorkedDetails - The details to modify the time worked for the specified task.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

viewHistoryList

curam.core.facade.struct.ListHistoryForTaskDetails viewHistoryList(curam.core.facade.struct.TaskManagementTaskKey taskKey)
                                                            throws curam.util.exception.AppException,
                                                                   curam.util.exception.InformationalException

Returns a list of all the task history records associated with the specified task.

Parameters:

taskKey - The unique identifier of the task whose task history details will be returned.

Returns:

A list of all the task history records associated with the specified task. In this case, the records returned are ordered by change date time, latest first.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

defer

void defer(curam.core.facade.struct.DeferTaskDetails deferTaskDetails)
    throws curam.util.exception.AppException,
           curam.util.exception.InformationalException

Defers a task until a later date.

An exception is thrown under the following circumstances:

• If the task is already deferred.
• If the task is already closed.
• If the task is not in the My Tasks list for the specified user.
• If the restart date is today or earlier.
• If the restart date is after the task deadline.

Parameters:

deferTaskDetails - details of the task to be deferred.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

restart

void restart(curam.core.facade.struct.RestartTaskDetails taskRestartDetails)
      throws curam.util.exception.AppException,
             curam.util.exception.InformationalException

Restarts a task that had been previously deferred.

A task history record is written recording the details of the action.

An exception is thrown under the following circumstances:

• If the task is not deferred.
• If the task is not in the My Tasks list for the specified user.

Parameters:

taskRestartDetails - The details of the task to be restarted.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

addComment

void addComment(curam.core.facade.struct.AddTaskCommentDetails addTaskCommentDetails)
         throws curam.util.exception.AppException,
                curam.util.exception.InformationalException

Adds a comment to a task by inserting a record into the task history table. A task does not have to be included in the My Tasks list for a user to comment on it. This allows users to comment on tasks that are included in the My Tasks lists of other users. A task life cycle event TASKLIFECYCLE.COMMENTADDED is raised when a comment is added to a task.

An exception is thrown under the following circumstances:

• If the task is closed

Parameters:

addTaskCommentDetails - The comment details to be added to the specified task.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

viewTaskHome

curam.core.facade.struct.ViewTaskDetails viewTaskHome(curam.core.facade.struct.TaskManagementTaskKey taskKey)
                                               throws curam.util.exception.AppException,
                                                      curam.util.exception.InformationalException

Returns the full details of the specified task including the task subject and also the task deadline date time.

Parameters:

taskKey - The unique identifier of a task.

Returns:

The full details of a task.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

reserve

void reserve(curam.core.facade.struct.ReserveTaskDetails reserveTaskDetails)
      throws curam.util.exception.AppException,
             curam.util.exception.InformationalException

Adds the task to the user's My Tasks list. This indicates that the user is about to work on that task and thus the task will be removed from the Available Task list for all of the others to which it had been assigned. A task history record is created containing the details of the action.

An exception is thrown under the following circumstances:

• If the task is already closed.
• If the task is already contained in the My Tasks list of the specified user or the My Tasks list of some other user.
• If the task is not available to the user.

Parameters:

reserveTaskDetails - The details of the task to be reserved.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

unreserve

void unreserve(curam.core.facade.struct.UnreserveTaskDetails unreserveTaskDetails)
        throws curam.util.exception.AppException,
               curam.util.exception.InformationalException

Makes a task available. A task can be made available if the task is currently is that user's My Tasks list. Once a task is made available it is once again available to the user, organization unit, position, job, allocation target or work queue to which it was previously assigned. The task is available again to be added to another user's task list.

A task history record is created for the action.

An exception is thrown under the following circumstances:

• If the task is already closed.
• If the task is not in the My Tasks list for the specified user.

Parameters:

unreserveTaskDetails - The details of the task to be unreserved.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

forward

void forward(curam.core.facade.struct.TaskForwardDetails forwardTaskDetails)
      throws curam.util.exception.AppException,
             curam.util.exception.InformationalException

Forwards a task to a job, position, organization unit, user, work queue or allocation target. A task history record is inserted for the task being forwarded. All of the previous task assignment records specified for the task are removed and new assignment records created.

An exception is thrown under the following circumstances:

• If the task is already closed.
• If the task is not in the My Tasks list for the specified user.
• If a user is being forwarded the task and they have an active allocation blocking period specified for them.

Parameters:

forwardTaskDetails - The details of the task to be forwarded.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

reallocate

void reallocate(curam.core.facade.struct.ReallocateTaskDetails reallocateTaskDetails)
         throws curam.util.exception.AppException,
                curam.util.exception.InformationalException

Reallocates a task. Reallocation of a task invokes the tasks initial allocation strategy. This results in the task being made available to the organizational objects, users or work queues to which it was originally available to. A task history record is created containing the details of the task reallocation.

An exception is thrown under the following circumstances:

• If the task is already closed.
• If the task is not in the My Tasks list for the specified user.

Parameters:

reallocateTaskDetails - details of the task to be reallocated.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readContextDescription

curam.core.facade.struct.TaskManagementContextDescription readContextDescription(curam.core.facade.struct.TaskManagementTaskKey taskKey)
                                                                          throws curam.util.exception.AppException,
                                                                                 curam.util.exception.InformationalException

Returns the context description for the specified task. The description includes the name of the workflow activity that was executed to create the task and the task identifier.

Parameters:

taskKey - The unique identifier of the task.

Returns:

The context description for the specified task.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

viewHistoryText

curam.core.facade.struct.TaskHistoryTextDetails viewHistoryText(curam.core.facade.struct.TaskManagementTaskKey taskKey)
                                                         throws curam.util.exception.AppException,
                                                                curam.util.exception.InformationalException

Returns a list of the unformatted task history records for the specified task. The details are returned in reverse chronological order as they are ordered by the change date time of the task history record, latest first.

Parameters:

taskKey - The unique identifier of the task whose history records will be returned.

Returns:

The unformatted task history text details ordered by the change date time of the task history record, latest first.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

visualiseProcessInstanceForTask

curam.core.facade.pdt.struct.WorkflowGraphDetails visualiseProcessInstanceForTask(curam.core.facade.struct.TaskManagementTaskKey taskKey)
                                                                           throws curam.util.exception.AppException,
                                                                                  curam.util.exception.InformationalException

Returns the XML representing the graph of the process instance associated with the specified task. This graph includes the activities and transitions of the workflow process and also highlights the activity that was executed to generate the task.

Parameters:

taskKey - The unique identifier of the task whose graphical representation will be returned.

Returns:

The XML representing the graph of the process instance associated with the specified task.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readTimeWorked

curam.core.facade.struct.TaskTimeWorkedDetails readTimeWorked(curam.core.facade.struct.TaskManagementTaskKey taskKey)
                                                       throws curam.util.exception.AppException,
                                                              curam.util.exception.InformationalException

Returns the amount of time worked on a specified task represented as a date time.

Parameters:

taskKey - The unique identifier of the task.

Returns:

The total time worked on the task to date.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

viewAssignmentList1

curam.core.facade.struct.TaskAssignmentDetails1 viewAssignmentList1(curam.core.facade.struct.TaskManagementTaskKey taskKey)
                                                             throws curam.util.exception.AppException,
                                                                    curam.util.exception.InformationalException

Returns a list of all the assignments for the specified task. This includes user and work queue assignments as well as assignments related to organization units, positions and jobs. All of the assignments are returned in one list.

Parameters:

taskKey - The unique identifier of the task.

Returns:

The list of assignments for the specified task.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

viewAssignmentsForTask

curam.core.sl.struct.TaskAssigneeDetailsList viewAssignmentsForTask(curam.core.sl.struct.TaskManagementTaskKey taskKey)
                                                             throws curam.util.exception.AppException,
                                                                    curam.util.exception.InformationalException

Returns a list of all the assignment details for the specified task including the name of the object that task is assigned to and also the type of that object (i.e. user, work queue, organization unit, position or job). The assignments are returned in multiple lists, one for each type of assignee as described above.

Parameters:

taskKey - The unique identifier of the task.

Returns:

The list of assignments for the specified task.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

reserveMultipleTasks

void reserveMultipleTasks(curam.core.facade.struct.MultipleTaskDetails taskList)
                   throws curam.util.exception.AppException,
                          curam.util.exception.InformationalException

Adds the specified tasks to the user's My Tasks list. This indicates that the user is about to work on those tasks and thus the tasks will be removed from the Available Task list for all of the others to which they had been assigned. Task history records are created containing the details of the action.

An exception is thrown under the following circumstances:

• If the task is already closed.
• If the task is already contained in the My Tasks list of the specified user or the My Tasks list of some other user.
• If the task is not available to the user.

Parameters:

taskList - A tabbed delimited string of task ID and version number pairs to be reserved. The task ID is separated from the version number by the pipe character, while each task ID and version number pair is separated by a tab character e.g. TaskID|VersionNo TaskID|VersionNo TaskID|VersionNo.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readTaskVersionNo

curam.core.sl.struct.TaskVersionNoDetails readTaskVersionNo(curam.core.sl.struct.TaskManagementTaskKey taskKey)
                                                     throws curam.util.exception.AppException,
                                                            curam.util.exception.InformationalException

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

Parameters:

taskKey - The unique identifier of the task.

Returns:

The optimistic locking version number details of the specified task.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readPriorityDetails

curam.core.facade.struct.TaskPriorityDetails readPriorityDetails(curam.core.facade.struct.TaskManagementTaskKey taskKey)
                                                          throws curam.util.exception.AppException,
                                                                 curam.util.exception.InformationalException

Returns the priority details of a task.

Parameters:

taskKey - The identifier of a task whose priority details will be returned.

Returns:

The priority details for the specified task.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

modifyPriority

void modifyPriority(curam.core.facade.struct.TaskPriorityDetails taskPriorityDetails)
             throws curam.util.exception.AppException,
                    curam.util.exception.InformationalException

Modifies the priority of the specified task. A task history record is created containing the details of the modification.

Exceptions are thrown under the following circumstances.

• If the priority has not been specified.
• If the task is already closed.
• If the task is not in the My Tasks list for the specified user.

Parameters:

taskPriorityDetails - The task priority details to be updated.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readDeadlineDetails

curam.core.facade.struct.TaskDeadlineDetails readDeadlineDetails(curam.core.facade.struct.TaskManagementTaskKey taskKey)
                                                          throws curam.util.exception.AppException,
                                                                 curam.util.exception.InformationalException

Returns the deadline details of a task.

Parameters:

taskKey - The identifier of a task whose deadline details will be returned.

Returns:

The deadline details for the specified task.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

modifyDeadline

void modifyDeadline(curam.core.facade.struct.TaskDeadlineDetails taskDeadlineDetails)
             throws curam.util.exception.AppException,
                    curam.util.exception.InformationalException

Modifies the deadline of the specified task. If no deadline exists for the task record, then an exception is thrown stating that this function cannot be used to insert a new deadline. Otherwise the existing deadline details are updated. A task history record is created containing the details of the modification.

An exception is thrown under the following circumstances:

• If there is no deadline specified for this task.

Parameters:

taskDeadlineDetails - The details of the task and associated deadline to modify.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

getTaskContextPanelDetails

curam.core.facade.struct.TaskContextPanelDetails getTaskContextPanelDetails(curam.core.facade.struct.TaskManagementTaskKey taskKey)
                                                                     throws curam.util.exception.AppException,
                                                                            curam.util.exception.InformationalException

Returns the details for the context panel for a specified task. The context panel is displayed at the top of the Task Home page and the task details displayed include the task identifier, status, priority, worked on by, time worked, deadline, last assigned and task subject.

Parameters:

taskKey - The identifier of the task.

Returns:

The context panel details for the specified task.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

viewTaskHistoryDetails

curam.core.sl.struct.TaskHistoryInformationDetails viewTaskHistoryDetails(curam.core.sl.struct.TaskHistoryKey key)
                                                                   throws curam.util.exception.AppException,
                                                                          curam.util.exception.InformationalException

Returns the details of one task history life cycle event.

Parameters:

key - The task history identifier.

Returns:

The task history details for one task life cycle event.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

viewHistoryForTaskList

curam.core.sl.struct.TaskHistoryInformationDetailsList viewHistoryForTaskList(curam.core.sl.struct.TaskManagementTaskKey taskKey)
                                                                       throws curam.util.exception.AppException,
                                                                              curam.util.exception.InformationalException

Returns a list of all the task history records associated with the specified task.

Parameters:

taskKey - The unique identifier of the task whose task history details will be returned.

Returns:

A list of all the task history records associated with the specified task. In this case, the records returned are ordered by change date time, latest first.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException