curam.util.workflow.impl

Class DeadlineScanner

java.lang.Object

curam.util.workflow.impl.DeadlineScanner

@AccessLevel(value=EXTERNAL)
public final class DeadlineScanner
extends java.lang.Object

Contains the operations that scan for workflow deadlines that have expired and invokes the associated handler function to process such deadlines.

A workflow deadline pertains to Manual, Event Wait , Decision, Parallel Manual and Parallel Decision activities and it is composed of a deadline duration and an associated handler function. For manual and decision activities, the deadline time is calculated by adding the duration specified in the deadline metadata to the time that the associated task for these activities was created. For event wait activities, the deadline duration is added to the time that the activity was executed and this then becomes the deadline time. Once the activity is executed, it must be completed before the specified deadline time. Otherwise the scanDeadlines() function in this class may be called to determine which deadlines have timed out. The associated handler function specified for the deadline is then invoked for each deadline that has expired.

Method Summary

Modifier and Type	Method and Description
static void	deliverReminders() Delivers each reminder and then removes it from the reminder entity so it can't be sent twice.
static WorkflowDeadlineDetailsList	getExpiredDeadlines() Returns a list of expired deadline details.
static void	processOneExpiredDeadline(long workflowDeadlineID) Processes one expired deadline record.
static void	processOneExpiredDeadline(WorkflowDeadlineDetails workflowDeadlineDetails) Processes one expired workflow deadline record.
static void	scanDeadlines() Scans for workflow deadlines that have expired.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

scanDeadlines

public static void scanDeadlines()
                          throws curam.util.exception.AppException,
                                 curam.util.exception.InformationalException

Scans for workflow deadlines that have expired. If a deadline handler function has been specified in the associated workflow process definition for the deadline, then this handler is invoked. Otherwise, if the complete activity indicator has been set to true, then the workflow engine completes the activity associated with the deadline and progresses the workflow.

Throws:

curam.util.exception.AppException - Generic application exceptions.

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

processOneExpiredDeadline

public static void processOneExpiredDeadline(long workflowDeadlineID)
                                      throws curam.util.exception.AppException,
                                             curam.util.exception.InformationalException

Processes one expired deadline record. In this instance, the deadline details are first read using the specified workflow deadline identifier and then a call is made to the processOneExpiredDeadline to process the workflow deadline details.

Parameters:

workflowDeadlineID - The unique identifier of the expired workflow deadline.

Throws:

curam.util.exception.AppException - Exceptions that could occur when processing one expired workflow deadline record.

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

processOneExpiredDeadline

public static void processOneExpiredDeadline(WorkflowDeadlineDetails workflowDeadlineDetails)

Processes one expired workflow deadline record. The activity associated with the expired deadline is retrieved. This is then checked to see if an associated deadline handler function is available and if so, the data is mapped into the function and it is invoked. If no deadline handler function has been specified and the complete activity flag has been set to true, the activity instance is completed and the workflow is progressed.

The deadline that has been processed is removed to ensure it is not processed again.

The data associated with the Context_Deadline workflow data object attribute is persisted.

If there is a task associated with the deadline that has expired, a task history record is written detailing this fact.

Parameters:

workflowDeadlineDetails - The details of the workflow deadline record that has expired.

deliverReminders

public static void deliverReminders()
                             throws curam.util.exception.AppException,
                                    curam.util.exception.InformationalException

Delivers each reminder and then removes it from the reminder entity so it can't be sent twice.

Throws:

curam.util.exception.AppException - Generic application exceptions.

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

getExpiredDeadlines

public static WorkflowDeadlineDetailsList getExpiredDeadlines()
                                                       throws curam.util.exception.AppException,
                                                              curam.util.exception.InformationalException

Returns a list of expired deadline details. A scan is done on the WorkflowDeadline table and the deadline date of each record is compared with the current date time. The details of any deadlines that have expired relative to the current date time are added to a list and returned.

Returns:

A list of expired deadlines.

Throws:

curam.util.exception.AppException - Exceptions that may occur when retrieving the list of expired deadline details.

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