curam.core.hook.task.impl

Interface TaskActions

All Known Implementing Classes:

TaskActionsImpl

@Implementable
public interface TaskActions

Contains a number of hook points which allow for custom specific processing of task management operations.

Method Summary

Modifier and Type	Method and Description
void	addComment(long taskID, java.lang.String comment) Adds a comment to a task by inserting a record into the task history table.
void	close(long taskID) Closes a task.
void	create(java.lang.String subject, java.lang.String priority, java.lang.String assignedTo, java.lang.String assigneeType, curam.util.type.DateTime deadlineDateTime, long participantRoleID, java.lang.String participantType, long caseID, boolean addToMyTasksInd, java.lang.String comment) Creates a new task
void	defer(long taskID, curam.util.type.Date restartDate, java.lang.String comment, int versionNo) Defers a task until a later date.
void	forward(long taskID, java.lang.String forwardToID, java.lang.String forwardToType, java.lang.String comment, int versionNo) Forwards a task to a job, position, organization unit, user, work queue or allocation target.
void	getTask(long taskID, java.lang.String comment, int versionNo) Adds the task to the user's My Tasks task list.
void	makeAvailable(long taskID, java.lang.String comment, int versionNo) Makes the specified task available to the organization object, user or work queue that it was previously available for.
void	modifyDeadline(long taskID, curam.util.type.DateTime deadline, java.lang.String comments, int versionNo) Modifies the deadline of a task.
void	modifyPriority(long taskID, java.lang.String priority, java.lang.String comments, int versionNo) Modifies the priority of a task.
void	modifyTimeWorked(long taskID, curam.util.type.DateTime totalTimeWorked, long timeHoursWorked, long timeMinutesWorked, java.lang.String comment, int versionNo) Modifies the total time worked on the specified task.
void	reallocate(long taskID, java.lang.String comment, int versionNo) Reallocates a task.
void	restart(long taskID, java.lang.String comments, int versionNo) Restarts a deferred task.

Method Detail

addComment

void addComment(long taskID,
                java.lang.String comment)
         throws curam.util.exception.AppException,
                curam.util.exception.InformationalException

Adds a comment to a task by inserting a record into the task history table.

Parameters:

taskID - The identifier of the task which the comment is being added.

comment - The comment to be added.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

close

void close(long taskID)
    throws curam.util.exception.AppException,
           curam.util.exception.InformationalException

Closes a task.

Parameters:

taskID - The identifier of the task to be closed

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

create

void create(java.lang.String subject,
            java.lang.String priority,
            java.lang.String assignedTo,
            java.lang.String assigneeType,
            curam.util.type.DateTime deadlineDateTime,
            long participantRoleID,
            java.lang.String participantType,
            long caseID,
            boolean addToMyTasksInd,
            java.lang.String comment)
     throws curam.util.exception.AppException,
            curam.util.exception.InformationalException

Creates a new task

Parameters:

subject - The task subject.

priority - The task priority.

assignedTo - The object that the task will be assigned to.

assigneeType - The type of the organization object.

deadlineDateTime - The task deadline.

participantRoleID - The participant role identifier.

participantType - The participant type.

caseID - The case identifier.

addToMyTasksInd - A flag to indicate whether the task should be added to the users task list.

comment - The task comment.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

defer

void defer(long taskID,
           curam.util.type.Date restartDate,
           java.lang.String comment,
           int versionNo)
    throws curam.util.exception.AppException,
           curam.util.exception.InformationalException

Defers a task until a later date.

Parameters:

taskID - The identifier of the task to be deferred.

restartDate - The date the task is to be restarted.

comment - A comment indicating why the task is being deferred.

versionNo - The optimistic locking version number of the task.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

restart

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

Restarts a deferred task.

Parameters:

taskID - The identifier of the task to be restarted.

comments - A comment indicating why the task is being restarted.

versionNo - The optimistic locking version number of the task.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

forward

void forward(long taskID,
             java.lang.String forwardToID,
             java.lang.String forwardToType,
             java.lang.String comment,
             int versionNo)
      throws curam.util.exception.AppException,
             curam.util.exception.InformationalException

Forwards a task to a job, position, organization unit, user, work queue or allocation target.

Parameters:

taskID - The identifier of the task to be forwarded.

forwardToID - The identifier of the object who the task is being forwarded.

forwardToType - The type of the object who the task is being forwarded.

comment - A comment indicating why the task is being forwarded.

versionNo - The optimistic locking version number of the task.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

modifyTimeWorked

void modifyTimeWorked(long taskID,
                      curam.util.type.DateTime totalTimeWorked,
                      long timeHoursWorked,
                      long timeMinutesWorked,
                      java.lang.String comment,
                      int versionNo)
               throws curam.util.exception.AppException,
                      curam.util.exception.InformationalException

Modifies the total time worked on the specified task.

Parameters:

taskID - The identifier of the task whose total time worked on will be updated.

totalTimeWorked - The total time worked expressed as a date time.

timeHoursWorked - The number of hours worked.

timeMinutesWorked - The number of minutes worked.

comment - A comment to be added.

versionNo - The optimistic locking version number of the task.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

modifyPriority

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

Modifies the priority of a task.

Parameters:

taskID - The identifier of the task whose priority will be updated.

priority - The priority that the task will be updated to.

comments - The comments associated with the priority modification action. These will be stored in the associated task history record written as a result of this action.

versionNo - The optimistic locking version number of the task.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

modifyDeadline

void modifyDeadline(long taskID,
                    curam.util.type.DateTime deadline,
                    java.lang.String comments,
                    int versionNo)
             throws curam.util.exception.AppException,
                    curam.util.exception.InformationalException

Modifies the deadline of a task.

Parameters:

taskID - The identifier of the task whose deadline will be updated.

deadline - The date and time that the task deadline will be updated to.

comments - The comments associated with the deadline modification action. These will be stored in the associated task history record written as a result of this action.

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

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

reallocate

void reallocate(long taskID,
                java.lang.String comment,
                int versionNo)
         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 group of users, organizational objects or work queues to which it was originally available to.

Parameters:

taskID - The identifier of the task which is being reallocated.

comment - A comment to be added indicating why the task is being reallocated.

versionNo - The optimistic locking version number of the task.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

getTask

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

Adds the task to the user's My Tasks task list.

Parameters:

taskID - The identifier of the task being added to the user's My Tasks list.

comment - A comment to be added.

versionNo - The optimistic locking version number of the task.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

makeAvailable

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

Makes the specified task available to the organization object, user or work queue that it was previously available for.

Parameters:

taskID - The identifier of the task to make available.

comment - A comment to indicate why the task is being made available.

versionNo - The optimistic locking version number of the task.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException