curam.util.workflow.intf

Interface WorkflowDeadlineAdmin

@AccessLevel(value=EXTERNAL)
public interface WorkflowDeadlineAdmin

The WorkflowDeadline entity stores details of the length of time that a Task or EventWait is allowed to remain unprocessed. This API provides functions to manipulate the data on the WorkflowDeadline 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 activityInstanceID, curam.util.type.DateTime deadlineTime, java.lang.String deadlineType, boolean suspended, long taskID) Creates a workflow deadline.
void	modify(long deadlineID, long activityInstanceID, curam.util.type.DateTime deadlineTime, java.lang.String deadlineType, boolean suspended, long taskID, int versionNo) Modifies the details of a workflow deadline.
void	modifyDeadline(long taskID, curam.util.type.DateTime deadlineTime, int versionNo) Changes the deadline time of a workflow deadline record for a specified task.
void	modifySuspended(long deadlineID, boolean suspended, int versionNo) Updates the suspended flag of the specified workflow deadline record.
WorkflowDeadlineInfo	read(long deadlineID) Returns the details of the specified workflow deadline.
WorkflowDeadlineInfo	readDeadlineDetailsByActivityInstanceID(long activityInstanceID) Returns the workflow deadline details for a specified activity instance identifier.
WorkflowDeadlineInfo	readDeadlineDetailsByTaskID(long taskID) Returns the details of a workflow deadline for a specified task.
void	remove(long deadlineID) Removes a workflow deadline.
ScanWorkflowDeadlineDetailsList	scanWorkflowDeadlines(curam.util.type.DateTime currentTime) Returns a list of all the task deadlines that have timed out.

Method Detail

read

WorkflowDeadlineInfo read(long deadlineID)
                   throws curam.util.exception.AppException,
                          curam.util.exception.InformationalException

Returns the details of the specified workflow deadline. A valid workflow deadline identifier must be supplied.

Parameters:

deadlineID - The unique identifier of the workflow deadline.

Returns:

The details of the specified workflow deadline.

Throws:

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

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

create

long create(long activityInstanceID,
            curam.util.type.DateTime deadlineTime,
            java.lang.String deadlineType,
            boolean suspended,
            long taskID)
     throws curam.util.exception.AppException,
            curam.util.exception.InformationalException

Creates a workflow deadline.

Parameters:

activityInstanceID - The unique identifier of the activity instance associated with this workflow deadline.

deadlineTime - The time at which the workflow deadline times out. For a manual activity or a decision activity workflow deadline, this time is calculated by adding the deadline duration specified to the time that the associated manual activity task was created. For an event wait workflow deadline, the time is calculated by adding the deadline duration specified to the time that the associated event wait activity was executed.

deadlineType - The type of the workflow deadline (as deadlines may be associated with a number of activity types including manual activities, event wait activities and decision activities).

suspended - NOTE: This flag provides no functional benefit at present. In the future, if the functionality becomes available, this flag could set to true to indicate that the handler function associated with the workflow deadline was invoked but failed. This flag may be then be used to filter out deadlines that were previously handled but failed when scanning for workflow deadlines.

taskID - The unique identifier of a task associated with a workflow deadline. This field is not set for deadlines associated with event wait activities.

Returns:

The unique identifier of the newly created workflow deadline.

Throws:

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

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

modify

void modify(long deadlineID,
            long activityInstanceID,
            curam.util.type.DateTime deadlineTime,
            java.lang.String deadlineType,
            boolean suspended,
            long taskID,
            int versionNo)
     throws curam.util.exception.AppException,
            curam.util.exception.InformationalException

Modifies the details of a workflow deadline.

Parameters:

deadlineID - The unique identifier of the workflow deadline.

activityInstanceID - The unique identifier of the activity instance associated with this workflow deadline.

deadlineTime - The time at which the workflow deadline times out. For a manual activity or a decision activity workflow deadline, this time is calculated by adding the deadline duration specified to the time that the associated manual activity task was created. For an event wait workflow deadline, the time is calculated by adding the deadline duration specified to the time that the associated event wait activity was executed.

deadlineType - The type of the workflow deadline (as deadlines may be associated with a number of activity types including manual activities, event wait activities and decision activities).

suspended - NOTE: This flag provides no functional benefit at present. In the future, if the functionality becomes available, this flag could set to true to indicate that the handler function associated with the workflow deadline was invoked but failed. This flag may be then be used to filter out deadlines that were previously handled but failed when scanning for workflow deadlines.

taskID - The unique identifier of a task associated with a workflow deadline. This field is not set for deadlines associated with event wait activities.

versionNo - The version number for optimistic locking.

Throws:

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

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

remove

void remove(long deadlineID)
     throws curam.util.exception.AppException,
            curam.util.exception.InformationalException

Removes a workflow deadline. If the record does not exist, the RecordNotFoundException is caught and the function does nothing.

Parameters:

deadlineID - The unique identifier of the workflow deadline.

Throws:

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

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

modifySuspended

void modifySuspended(long deadlineID,
                     boolean suspended,
                     int versionNo)
              throws curam.util.exception.AppException,
                     curam.util.exception.InformationalException

Updates the suspended flag of the specified workflow deadline record.

Parameters:

deadlineID - The unique identifier of the workflow deadline.

suspended - NOTE: This flag provides no functional benefit at present. In the future, if the functionality becomes available, this flag could set to true to indicate that the handler function associated with the workflow deadline was invoked but failed. This flag may be then be used to filter out deadlines that were previously handled but failed when scanning for workflow deadlines.

versionNo - The version number for optimistic locking.

Throws:

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

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

readDeadlineDetailsByActivityInstanceID

WorkflowDeadlineInfo readDeadlineDetailsByActivityInstanceID(long activityInstanceID)
                                                      throws curam.util.exception.AppException,
                                                             curam.util.exception.InformationalException

Returns the workflow deadline details for a specified activity instance identifier.

Parameters:

activityInstanceID - The unique identifier of the activity instance associated with this workflow deadline.

Returns:

The workflow deadline details for a specified activity instance identifier.

Throws:

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

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

readDeadlineDetailsByTaskID

WorkflowDeadlineInfo readDeadlineDetailsByTaskID(long taskID)
                                          throws curam.util.exception.AppException,
                                                 curam.util.exception.InformationalException

Returns the details of a workflow deadline for a specified task.

Parameters:

taskID - The unique identifier of a task associated with a workflow deadline.

Returns:

The details of a workflow deadline for a specified task.

Throws:

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

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

scanWorkflowDeadlines

ScanWorkflowDeadlineDetailsList scanWorkflowDeadlines(curam.util.type.DateTime currentTime)
                                               throws curam.util.exception.AppException,
                                                      curam.util.exception.InformationalException

Returns a list of all the task deadlines that have timed out. A task deadline times out when the deadline time stored as part of the workflow deadline record has been exceeded by the current date time.

Parameters:

currentTime - The current date and time that will be used to scan the workflow deadline table for expired deadlines.

Returns:

A list of all the task deadlines that have timed out. A task deadline times out when the deadline time stored as part of the deadline record has been exceeded by the current date time.

Throws:

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

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

modifyDeadline

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

Changes the deadline time of a workflow deadline record for a specified task.

Parameters:

taskID - The unique identifier of a task associated with a workflow deadline.

deadlineTime - The time at which the workflow deadline times out.

versionNo - The version number for optimistic locking.

Throws:

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

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