curam.util.workflow.intf

Interface TaskHistoryAdmin

@AccessLevel(value=EXTERNAL)
public interface TaskHistoryAdmin

The TaskHistory entity stores details of the lifecycle events that occur for a Task. This API provides functions to manipulate the data on the TaskHistory 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
long	create(long taskID, curam.util.type.DateTime changeDateTime, java.lang.String changeType, java.lang.String comments, java.lang.String newValue, java.lang.String oldValue, java.lang.String userName) Creates a task history record for the specified task and for the specified task history change type.
TaskHistoryInfo	read(long taskHistoryID) Returns the details of the specified task history record.
TaskHistoryInfoList	searchByTaskIDOrderByChangeDateTimeFirst(long taskID) Returns a list of all the task history records associated with the specified task.
TaskHistoryInfoList	searchByTaskIDOrderByChangeDateTimeLast(long taskID) Returns a list of all the task history records associated with the specified task.

Method Detail

create

long create(long taskID,
            curam.util.type.DateTime changeDateTime,
            java.lang.String changeType,
            java.lang.String comments,
            java.lang.String newValue,
            java.lang.String oldValue,
            java.lang.String userName)
     throws curam.util.exception.AppException,
            curam.util.exception.InformationalException

Creates a task history record for the specified task and for the specified task history change type.

Parameters:

taskID - The unique identifier of the task.

changeDateTime - The date and time that the task life cycle event occurred.

changeType - The type of change associated with this task history record.

comments - A comment on the change made to the task.

newValue - The new value of the task item being modifie .

oldValue - The old value of the task item being modified.

userName - The user making the change to the task.

Returns:

The unique identifier of the newly created task history record.

Throws:

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

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

read

TaskHistoryInfo read(long taskHistoryID)
              throws curam.util.exception.AppException,
                     curam.util.exception.InformationalException

Returns the details of the specified task history record. A valid task history identifier must be supplied.

Parameters:

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

Returns:

The details of the specified task history record.

Throws:

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

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

searchByTaskIDOrderByChangeDateTimeLast

TaskHistoryInfoList searchByTaskIDOrderByChangeDateTimeLast(long taskID)
                                                     throws curam.util.exception.AppException,
                                                            curam.util.exception.InformationalException

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

Parameters:

taskID - 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 - Exceptions that may occur when invoking this function.

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

searchByTaskIDOrderByChangeDateTimeFirst

TaskHistoryInfoList searchByTaskIDOrderByChangeDateTimeFirst(long taskID)
                                                      throws curam.util.exception.AppException,
                                                             curam.util.exception.InformationalException

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

Parameters:

taskID - 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, earliest first.

Throws:

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

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