com.ibm.task.spi
Class APIEventHandler

java.lang.Object
  extended by com.ibm.task.spi.APIEventHandler
All Implemented Interfaces:
APIEventHandlerPlugin, APIEventHandlerPlugin2, APIEventHandlerPlugin3, APIEventHandlerPlugin4, APIEventHandlerPlugin5

public class APIEventHandler
extends java.lang.Object
implements APIEventHandlerPlugin, APIEventHandlerPlugin2, APIEventHandlerPlugin3, APIEventHandlerPlugin4, APIEventHandlerPlugin5

This class provides a default implementation for the Human Task Manager APIEventHandlerPlugin interfaces.

Note that it is best practice to inherit from this class instead of implementing the interfaces directly. This helps to ensure upward compatibility of your code.

Since:
6.0.2

Field Summary
static java.lang.String COPYRIGHT
           
 
Constructor Summary
APIEventHandler()
           
 
Method Summary
 void postCallTask(Task task, java.io.Serializable inputMessage, java.io.Serializable returnMessage, TaskException taskException)
          This method is called after a "CALL TASK" request was executed.
 void postCancelClaim(Task task, TaskException taskException)
          This method is called after a "CANCEL CLAIM" request was executed.
 void postClaim(Task task, java.lang.Object inputMessage, TaskException taskException)
          Deprecated. since v6.0.2 - use postClaim(Task, Serializable, TaskException)
 void postClaim(Task task, java.io.Serializable inputMessage, TaskException taskException)
          This method is called after a "CLAIM" request was executed.
 void postComplete(Task task, java.io.Serializable outputMessage, java.lang.String faultName, java.io.Serializable faultMessage, TaskException taskException)
          This method is called after a "COMPLETE" request was executed.
 void postCompleteWithFollowOnTask(Task task, Task previousTask, TaskException taskException)
          This method is called after a "COMPLETE WITH FOLLOW-ON TASK" request was executed.
 void postCompleteWithNewFollowOnTask(Task newTask, TaskModel newTaskModel, TaskTemplate template, Task previousTask, java.io.Serializable inputMessage, TaskException taskException)
          This method is called after a "COMPLETE WITH NEW FOLLOW-ON TASK" request was executed.
 void postCreateAndCallTask(Task task, TaskModel newTaskModel, TaskTemplate template, java.io.Serializable inputMessage, TaskException taskException)
          This method is called after a CREATE AND CALL TASK request was executed.
 void postCreateAndStartTask(Task newTask, TaskModel newTaskModel, TaskTemplate template, java.io.Serializable inputMessage, ReplyHandler replyHandler, TaskException taskException)
          This method is called after a CREATE AND START TASK request was executed.
 void postCreateAndStartTaskAsSubTask(Task newTask, TaskModel newTaskModel, TaskTemplate template, Task parentTask, java.io.Serializable inputMessage, TaskException taskException)
          This method is called after a "CREATE AND START TASK AS SUBTASK" request was executed.
 void postCreateTask(Task newTask, TaskModel newTaskModel, TaskTemplate template, java.io.Serializable inputMessage, ReplyHandler replyHandler, TaskException taskException)
          This method is called after a "CREATE TASK" request was executed.
 void postCreateWorkItem(Escalation escalation, int assignmentReason, java.lang.String id, TaskException taskException)
          This method is called after a "CREATE WORKITEM" for escalation request was executed.
 void postCreateWorkItem(Task task, int assignmentReason, java.lang.String id, TaskException taskException)
          This method is called after a "CREATE WORKITEM" for task request was executed.
 void postDeleteTask(Task task, TaskException taskException)
          This method is called after a "DELETE TASK" request was executed.
 void postDeleteWorkItem(Escalation escalation, int assignmentReason, java.lang.String id, TaskException taskException)
          This method is called after a "DELETE WORKITEM" of escalation request was executed.
 void postDeleteWorkItem(Task task, int assignmentReason, java.lang.String id, TaskException taskException)
          This method is called after a "DELETE WORKITEM" of task request was executed.
 void postGetTaskAndMarkRead(Task task, TaskException taskException)
          This method is called after a "GET TASK AND MARK READ" request was executed.
 void postReplaceWorkItem(Task task, int assignmentReason, java.lang.String staffQuery, TaskException taskException)
          This method is called after a "REPLACE WORKITEM" request was executed.
 void postRestartTask(Task task, TaskException taskException)
          This method is called after a "RESTART TASK" request was executed.
 void postResumeTask(Task task, TaskException taskException)
          This method is called after a "RESUME TASK" request was executed.
 void postSetBinaryCustomProperty(Escalation escalation, BinaryCustomProperty property, TaskException taskException)
          This method is called after a "SET BINARY CUSTOM PROPERTY" for an escalation request was executed.
 void postSetBinaryCustomProperty(Task task, BinaryCustomProperty property, TaskException taskException)
          This method is called after a "SET BINARY CUSTOM PROPERTY" for a task request was executed.
 void postSetBinaryCustomProperty(Task task, java.lang.String propertyName, java.lang.String dataType, java.io.Serializable propertyValue, TaskException taskException)
          Deprecated. since v6.0.2 - use postSetBinaryCustomProperty(Task, BinaryCustomProperty)
 void postSetCustomProperties(Task task, java.util.List customProperties, TaskException taskException)
          This method is called after a "SET CUSTOM PROPERTIES" request was executed.
 void postSetCustomProperty(Task task, java.lang.String propertyName, java.lang.String propertyValue, TaskException taskException)
          This method is called after a "SET CUSTOM PROPERTY" request was executed.
 void postSetFaultMessage(Task task, java.lang.String faultName, java.io.Serializable faultMessage, TaskException taskException)
          This method is called after a "SET FAULT MESSAGE" request was executed.
 void postSetInputMessage(Task task, java.io.Serializable inputMessage, TaskException taskException)
          This method is called after a "SET INPUT MESSAGE" request was executed.
 void postSetOutputMessage(Task task, java.io.Serializable outputMessage, TaskException taskException)
          This method is called after a "SET OUTPUT MESSAGE" request was executed.
 void postSetTaskRead(Task task, boolean taskRead, TaskException taskException)
          This method is called after a "SET TASK READ" request was executed.
 void postStartTask(Task task, java.io.Serializable inputMessage, ReplyHandler replyHandler, TaskException taskException)
          This method is called after a "START TASK" request was executed.
 void postStartTaskAsSubTask(Task task, Task parentTask, java.io.Serializable inputMessage, TaskException taskException)
          This method is called after a "START TASK AS SUBTASK" request was executed.
 void postSuspendTask(Task task, TaskException taskException)
          This method is called after a "SUSPEND TASK" request was executed.
 void postSuspendTaskUntil(Task task, java.util.Calendar timeStamp, TaskException taskException)
          This method is called after a "SUSPEND TASK UNTIL" request was executed.
 void postSuspendTaskUntil(Task task, int duration, TaskException taskException)
          This method is called after a "SUSPEND TASK UNTIL" request was executed.
 void postSuspendTaskUntil(Task task, java.lang.String duration, TaskException taskException)
          This method is called after a "SUSPEND TASK UNTIL" request was executed.
 void postSuspendTaskWithCancelClaim(Task task, java.util.Calendar timeStamp, TaskException taskException)
          This method is called after a "SUSPEND TASK WITH CANCEL CLAIM" request was executed.
 void postSuspendTaskWithCancelClaim(Task task, int duration, TaskException taskException)
          This method is called after a "SUSPEND TASK WITH CANCEL CLAIM" request was executed.
 void postSuspendTaskWithCancelClaim(Task task, java.lang.String duration, TaskException taskException)
          This method is called after a "SUSPEND TASK WITH CANCEL CLAIM" request was executed.
 void postTerminateTask(Task task, TaskException taskException)
          This method is called after a "TERMINATE TASK" request was executed.
 void postTransferToWorkBasket(Task task, java.lang.String workBasketName, boolean preserveTransferState, TaskException taskException)
          This method is called after a "TRANSFER TO WORK BASKET" request was executed.
 void postTransferWorkItem(Escalation escalation, int assignmentReason, java.lang.String fromUserId, java.lang.String toUserId, TaskException taskException)
          This method is called after a "TRANSFER WORKITEM" of an escalation request was executed.
 void postTransferWorkItem(Task task, int assignmentReason, java.lang.String fromUserId, java.lang.String toUserId, TaskException taskException)
          This method is called after a "TRANSFER WORKITEM" of a task request was executed.
 void postTriggerEscalation(Escalation escalation, TaskException taskException)
          This method is called after a "TRIGGER ESCALATION" request was executed.
 void postUpdateEscalation(Escalation escalation, TaskException taskException)
          This method is called after an "UPDATE ESCALATION" request was executed.
 void postUpdateInactiveTask(Task task, java.io.Serializable inputMessage, ReplyHandler replyHandler, TaskException taskException)
          This method is called after a "UPDATE INACTIVE TASK" request was executed.
 void postUpdateTask(Task task, TaskException taskException)
          This method is called after an "UPDATE TASK" request was executed.
 void preCallTask(Task task, java.io.Serializable inputMessage)
          This method is called before a "CALL TASK" request is executed.
 void preCancelClaim(Task task)
          This method is called before a "CANCEL CLAIM" request is executed.
 void preClaim(Task task)
          This method is called before a "CLAIM" request is executed.
 void preComplete(Task task)
          This method is called before a "COMPLETE" request is executed.
 void preCompleteWithFollowOnTask(Task task, Task previousTask)
          This method is called before a "COMPLETE WITH FOLLOW-ON TASK" request is executed.
 void preCompleteWithNewFollowOnTask(TaskModel newTaskModel, TaskTemplate template, Task previousTask)
          This method is called before a "COMPLETE WITH NEW FOLLOW-ON TASK" request is executed.
 void preCreateAndCallTask(TaskModel newTaskModel, TaskTemplate template, java.io.Serializable inputMessage)
          This method is called before a "CREATE AND CALL TASK" request is executed.
 void preCreateAndStartTask(TaskModel newTaskModel, TaskTemplate template, java.io.Serializable inputMessage, ReplyHandler replyHandler)
          This method is called before a "CREATE AND START TASK" request is executed.
 void preCreateAndStartTaskAsSubTask(TaskModel newTaskModel, TaskTemplate template, Task parentTask, java.io.Serializable inputMessage)
          This method is called before a "CREATE AND START TASK AS SUBTASK" request is executed.
 void preCreateTask(TaskModel newTaskModel, TaskTemplate template, java.io.Serializable inputMessage, ReplyHandler replyHandler)
          This method is called before a "CREATE TASK" request is executed.
 void preCreateWorkItem(Escalation escalation, int assignmentReason, java.lang.String id)
          This method is called before a "CREATE WORKITEM" for escalation request is executed.
 void preCreateWorkItem(Task task, int assignmentReason, java.lang.String id)
          This method is called before a "CREATE WORKITEM" for task request is executed.
 void preDeleteTask(Task task)
          This method is called before a "DELETE TASK" request is executed.
 void preDeleteWorkItem(Escalation escalation, int assignmentReason, java.lang.String id)
          This method is called before a "DELETE WORKITEM" of escalation request is executed.
 void preDeleteWorkItem(Task task, int assignmentReason, java.lang.String id)
          This method is called before a "DELETE WORKITEM" of task request is executed.
 void preGetTaskAndMarkRead(Task task)
          This method is called before a "GET TASK AND MARK READ" request is executed.
 void preReplaceWorkItem(Task task, int assignmentReason, java.lang.String staffQuery)
          This method is called before a "REPLACE WORKITEM" request is executed.
 void preRestartTask(Task task)
          This method is called before a "RESTART TASK" request is executed.
 void preResumeTask(Task task)
          This method is called before a "RESUME TASK" request is executed.
 void preSetBinaryCustomProperty(Escalation escalation, BinaryCustomProperty property)
          This method is called before a "SET BINARY CUSTOM PROPERTY" for an escalation request is executed.
 void preSetBinaryCustomProperty(Task task, BinaryCustomProperty property)
          This method is called before a "SET BINARY CUSTOM PROPERTY" for a task request is executed.
 void preSetBinaryCustomProperty(Task task, java.lang.String propertyName, java.lang.String dataType, java.io.Serializable propertyValue)
          Deprecated. since v6.0.2 - use preSetBinaryCustomProperty(Task, BinaryCustomProperty)
 void preSetCustomProperties(Task task, java.util.List customProperties)
          This method is called before a "SET CUSTOM PROPERTIES" request is executed.
 void preSetCustomProperty(Task task, java.lang.String propertyName, java.lang.String propertyValue)
          This method is called before a "SET CUSTOM PROPERTY" request is executed.
 void preSetFaultMessage(Task task, java.lang.String faultName, java.io.Serializable faultMessage)
          This method is called before a "SET FAULT MESSAGE" request is executed.
 void preSetInputMessage(Task task, java.io.Serializable inputMessage)
          This method is called before a "SET INPUT MESSAGE" request is executed.
 void preSetOutputMessage(Task task, java.io.Serializable outputMessage)
          This method is called before a "SET OUTPUT MESSAGE" request is executed.
 void preSetTaskRead(Task task, boolean taskRead)
          This method is called before a "SET TASK READ" request is executed.
 void preStartTask(Task task, java.io.Serializable inputMessage, ReplyHandler replyHandler)
          This method is called before a "START TASK" request is executed.
 void preStartTaskAsSubTask(Task task, Task parentTask, java.io.Serializable inputMessage)
          This method is called before a "START TASK AS SUBTASK" request is executed.
 void preSuspendTask(Task task)
          This method is called before a "SUSPEND TASK" request is executed.
 void preSuspendTaskUntil(Task task, java.util.Calendar timeStamp)
          This method is called before a "SUSPEND TASK UNTIL" request is executed.
 void preSuspendTaskUntil(Task task, int duration)
          This method is called before a "SUSPEND TASK UNTIL" request is executed.
 void preSuspendTaskUntil(Task task, java.lang.String duration)
          This method is called before a "SUSPEND TASK UNTIL" request is executed.
 void preSuspendTaskWithCancelClaim(Task task, java.util.Calendar timeStamp)
          This method is called before a "SUSPEND TASK WITH CANCEL CLAIM" request is executed.
 void preSuspendTaskWithCancelClaim(Task task, int duration)
          This method is called before a "SUSPEND TASK WITH CANCEL CLAIM" request is executed.
 void preSuspendTaskWithCancelClaim(Task task, java.lang.String duration)
          This method is called before a "SUSPEND TASK WITH CANCEL CLAIM" request is executed.
 void preTerminateTask(Task task)
          This method is called before a "TERMINATE TASK" request is executed.
 void preTransferToWorkBasket(Task task, java.lang.String workBasketName, boolean preserveTransferState)
          This method is called before a "TRANSFER TO WORK BASKET" request is executed.
 void preTransferWorkItem(Escalation escalation, int assignmentReason, java.lang.String fromUserId, java.lang.String toUserId)
          This method is called before a "TRANSFER WORKITEM" of an escalation request is executed.
 void preTransferWorkItem(Task task, int assignmentReason, java.lang.String fromUserId, java.lang.String toUserId)
          This method is called before a T"RANSFER WORKITEM" of a task request is executed.
 void preTriggerEscalation(Escalation escalation)
          This method is called before a "TRIGGER ESCALATION" request is executed.
 void preUpdateEscalation(Escalation escalation)
          This method is called before an "UPDATE ESCALATION" request is executed.
 void preUpdateInactiveTask(Task task, TaskModel model, java.io.Serializable inputMessage, ReplyHandler replyHandler)
          This method is called before a "UPDATE INACTIVE TASK" request is executed.
 void preUpdateTask(Task task)
          This method is called before an "UPDATE TASK" request is executed.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
See Also:
Constant Field Values
Constructor Detail

APIEventHandler

public APIEventHandler()
Method Detail

preCallTask

public void preCallTask(Task task,
                        java.io.Serializable inputMessage)
                 throws ApplicationVetoException
This method is called before a "CALL TASK" request is executed.

Specified by:
preCallTask in interface APIEventHandlerPlugin
Parameters:
task - The task that will be called.
inputMessage - The optional input message - may be null.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postCallTask

public void postCallTask(Task task,
                         java.io.Serializable inputMessage,
                         java.io.Serializable returnMessage,
                         TaskException taskException)
This method is called after a "CALL TASK" request was executed.

Specified by:
postCallTask in interface APIEventHandlerPlugin
Parameters:
task - The task that has been called.
inputMessage - The optional input message - may be null.
returnMessage - The optional return message - may be null.
taskException - The TaskException that occurred or null if no exception occurred.

preCancelClaim

public void preCancelClaim(Task task)
                    throws ApplicationVetoException
This method is called before a "CANCEL CLAIM" request is executed.

Specified by:
preCancelClaim in interface APIEventHandlerPlugin
Parameters:
task - The task that has been claimed and that is to be canceled.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted.

postCancelClaim

public void postCancelClaim(Task task,
                            TaskException taskException)
This method is called after a "CANCEL CLAIM" request was executed.

Specified by:
postCancelClaim in interface APIEventHandlerPlugin
Parameters:
task - The task where the claim was requested to be canceled.
taskException - The TaskException that occurred or null if no exception occurred.

preClaim

public void preClaim(Task task)
              throws ApplicationVetoException
This method is called before a "CLAIM" request is executed.

Specified by:
preClaim in interface APIEventHandlerPlugin
Parameters:
task - The task that is to be claimed.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted.

postClaim

public void postClaim(Task task,
                      java.lang.Object inputMessage,
                      TaskException taskException)
Deprecated. since v6.0.2 - use postClaim(Task, Serializable, TaskException)

This method is called after a "CLAIM" request was executed.

Specified by:
postClaim in interface APIEventHandlerPlugin
Parameters:
task - The task that was requested to be claimed.
inputMessage - The input message of the claim request.
taskException - The TaskException that occurred or null if no exception occurred.

postClaim

public void postClaim(Task task,
                      java.io.Serializable inputMessage,
                      TaskException taskException)
This method is called after a "CLAIM" request was executed.

Specified by:
postClaim in interface APIEventHandlerPlugin2
Parameters:
task - The task that was requested to be claimed.
inputMessage - The input message of the claim request.
taskException - The TaskException that occurred or null if no exception occurred.

preComplete

public void preComplete(Task task)
                 throws ApplicationVetoException
This method is called before a "COMPLETE" request is executed.

Specified by:
preComplete in interface APIEventHandlerPlugin
Parameters:
task - The task to be completed.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted.

postComplete

public void postComplete(Task task,
                         java.io.Serializable outputMessage,
                         java.lang.String faultName,
                         java.io.Serializable faultMessage,
                         TaskException taskException)
This method is called after a "COMPLETE" request was executed.

Specified by:
postComplete in interface APIEventHandlerPlugin
Parameters:
task - The task that was requested to be completed.
outputMessage - The optional output message - may be null.
faultName - The faultname if a fault message is provided - may be null.
faultMessage - The optional fault message - may be null.
taskException - The TaskException that occurred or null if no exception occurred.

preCompleteWithFollowOnTask

public void preCompleteWithFollowOnTask(Task task,
                                        Task previousTask)
                                 throws ApplicationVetoException
This method is called before a "COMPLETE WITH FOLLOW-ON TASK" request is executed.

Specified by:
preCompleteWithFollowOnTask in interface APIEventHandlerPlugin
Parameters:
task - The task to be started.
previousTask - The predecessor task to be completed.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postCompleteWithFollowOnTask

public void postCompleteWithFollowOnTask(Task task,
                                         Task previousTask,
                                         TaskException taskException)
This method is called after a "COMPLETE WITH FOLLOW-ON TASK" request was executed.

Specified by:
postCompleteWithFollowOnTask in interface APIEventHandlerPlugin
Parameters:
task - The task that was requested to be started.
previousTask - The predecessor task that was requested to be completed.
taskException - The TaskException that occurred or null if no exception occurred.

preCompleteWithNewFollowOnTask

public void preCompleteWithNewFollowOnTask(TaskModel newTaskModel,
                                           TaskTemplate template,
                                           Task previousTask)
                                    throws ApplicationVetoException
This method is called before a "COMPLETE WITH NEW FOLLOW-ON TASK" request is executed.

Note: Either the newTaskModel parameter or the template parameter must be set.

Specified by:
preCompleteWithNewFollowOnTask in interface APIEventHandlerPlugin
Parameters:
newTaskModel - The task model from which a follow-on task is to be created.
template - The task template from which a follow-on task is to be created.
previousTask - The predecessor task that is to be completed.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postCompleteWithNewFollowOnTask

public void postCompleteWithNewFollowOnTask(Task newTask,
                                            TaskModel newTaskModel,
                                            TaskTemplate template,
                                            Task previousTask,
                                            java.io.Serializable inputMessage,
                                            TaskException taskException)
This method is called after a "COMPLETE WITH NEW FOLLOW-ON TASK" request was executed.

Note: Either the newTaskModel parameter or the template parameter must be set.

Specified by:
postCompleteWithNewFollowOnTask in interface APIEventHandlerPlugin
Parameters:
newTask - The task that was requested to be created.
newTaskModel - The task model data from which the task was requested to be created.
template - The task template from which the task was requested to be created.
previousTask - The the predecessor task that was requested to be completed.
inputMessage - An optional input message - may be null.
taskException - The TaskException that occurred or null if no exception occurred.

preCreateAndCallTask

public void preCreateAndCallTask(TaskModel newTaskModel,
                                 TaskTemplate template,
                                 java.io.Serializable inputMessage)
                          throws ApplicationVetoException
This method is called before a "CREATE AND CALL TASK" request is executed.

Note: Either the newTaskModel parameter or the template parameter must be set.

Specified by:
preCreateAndCallTask in interface APIEventHandlerPlugin
Parameters:
newTaskModel - The task model data which the task is to be created.
template - The task template from which the new task is to be created.
inputMessage - An optional input message - may be null.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted.

postCreateAndCallTask

public void postCreateAndCallTask(Task task,
                                  TaskModel newTaskModel,
                                  TaskTemplate template,
                                  java.io.Serializable inputMessage,
                                  TaskException taskException)
This method is called after a CREATE AND CALL TASK request was executed.

Note: Either the newTaskModel parameter or the template parameter must be set.

Specified by:
postCreateAndCallTask in interface APIEventHandlerPlugin
Parameters:
task - The task that was requested to be created and called.
newTaskModel - The task model data from which the task was requested to be created.
template - The task template from which the task was requested to be created.
inputMessage - An optional input message - may be null.
taskException - The TaskException that occurred or null if no exception occurred.

preCreateAndStartTask

public void preCreateAndStartTask(TaskModel newTaskModel,
                                  TaskTemplate template,
                                  java.io.Serializable inputMessage,
                                  ReplyHandler replyHandler)
                           throws ApplicationVetoException
This method is called before a "CREATE AND START TASK" request is executed.

Note: Either the newTaskModel parameter or the template parameter must be set.

Specified by:
preCreateAndStartTask in interface APIEventHandlerPlugin
Parameters:
newTaskModel - The task model data which the task is to be created.
template - The task template from which the task is to be created.
inputMessage - An optional input message - may be null.
replyHandler - An optional reply handler - may be null.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postCreateAndStartTask

public void postCreateAndStartTask(Task newTask,
                                   TaskModel newTaskModel,
                                   TaskTemplate template,
                                   java.io.Serializable inputMessage,
                                   ReplyHandler replyHandler,
                                   TaskException taskException)
This method is called after a CREATE AND START TASK request was executed.

Note: Either the newTaskModel parameter or the template parameter must be set.

Specified by:
postCreateAndStartTask in interface APIEventHandlerPlugin
Parameters:
newTask - The task that was requested to be created and called.
newTaskModel - The task model data from which the task was requested to be created.
template - The task template from which the task was requested to be created.
inputMessage - An optional input message - may be null.
replyHandler - An optional reply handler - may be null.
taskException - The TaskException that occurred or null if no exception occurred.

preCreateAndStartTaskAsSubTask

public void preCreateAndStartTaskAsSubTask(TaskModel newTaskModel,
                                           TaskTemplate template,
                                           Task parentTask,
                                           java.io.Serializable inputMessage)
                                    throws ApplicationVetoException
This method is called before a "CREATE AND START TASK AS SUBTASK" request is executed.

Note: Either the newTaskModel parameter or the template parameter must be set.

Specified by:
preCreateAndStartTaskAsSubTask in interface APIEventHandlerPlugin
Parameters:
newTaskModel - The task model data which the subtask is to be created.
template - The task template from which the subtask is to be created.
parentTask - The parent task.
inputMessage - An optional input message - may be null.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postCreateAndStartTaskAsSubTask

public void postCreateAndStartTaskAsSubTask(Task newTask,
                                            TaskModel newTaskModel,
                                            TaskTemplate template,
                                            Task parentTask,
                                            java.io.Serializable inputMessage,
                                            TaskException taskException)
This method is called after a "CREATE AND START TASK AS SUBTASK" request was executed.

Note: Either the newTaskModel parameter or the template parameter must be set.

Specified by:
postCreateAndStartTaskAsSubTask in interface APIEventHandlerPlugin
Parameters:
newTask - The task that was requested to be created and started.
newTaskModel - The task model data from which the task was requested to be created.
template - The task template from which the task was requested to be created.
parentTask - The parent task.
inputMessage - An optional input message - may be null.
taskException - The TaskException that occurred or null if no exception occurred.

preCreateTask

public void preCreateTask(TaskModel newTaskModel,
                          TaskTemplate template,
                          java.io.Serializable inputMessage,
                          ReplyHandler replyHandler)
                   throws ApplicationVetoException
This method is called before a "CREATE TASK" request is executed.

Specified by:
preCreateTask in interface APIEventHandlerPlugin
Parameters:
newTaskModel - The task model data which the task is to be created.
template - The task template from which the task is to be created.
inputMessage - An optional input message - may be null.
replyHandler - An optional reply handler - may be null.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postCreateTask

public void postCreateTask(Task newTask,
                           TaskModel newTaskModel,
                           TaskTemplate template,
                           java.io.Serializable inputMessage,
                           ReplyHandler replyHandler,
                           TaskException taskException)
This method is called after a "CREATE TASK" request was executed.

Specified by:
postCreateTask in interface APIEventHandlerPlugin
Parameters:
newTask - The task that was requested to be created.
newTaskModel - The task model data from which the task was requested to be created.
template - The task template from which the task was requested to be created.
inputMessage - An optional input message - may be null.
replyHandler - An optional reply handler - may be null.
taskException - The TaskException that occurred or null if no exception occurred.

preCreateWorkItem

public void preCreateWorkItem(Escalation escalation,
                              int assignmentReason,
                              java.lang.String id)
                       throws ApplicationVetoException
This method is called before a "CREATE WORKITEM" for escalation request is executed.

Specified by:
preCreateWorkItem in interface APIEventHandlerPlugin2
Parameters:
escalation - The escalation for which a work item is to be created.
assignmentReason - The reason why the work item is assigned.
id - The user or group that is to be associated.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postCreateWorkItem

public void postCreateWorkItem(Escalation escalation,
                               int assignmentReason,
                               java.lang.String id,
                               TaskException taskException)
This method is called after a "CREATE WORKITEM" for escalation request was executed.

Specified by:
postCreateWorkItem in interface APIEventHandlerPlugin2
Parameters:
escalation - The escalation for which a work item was requested to be created.
assignmentReason - The reason why the work item is assigned.
id - The user or group that is to be associated.
taskException - The TaskException that occurred or null if no exception occurred.

preCreateWorkItem

public void preCreateWorkItem(Task task,
                              int assignmentReason,
                              java.lang.String id)
                       throws ApplicationVetoException
This method is called before a "CREATE WORKITEM" for task request is executed.

Specified by:
preCreateWorkItem in interface APIEventHandlerPlugin
Parameters:
task - The task for which a work item is to be created.
assignmentReason - The reason why the work item is assigned.
id - The user or group that is to be associated.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postCreateWorkItem

public void postCreateWorkItem(Task task,
                               int assignmentReason,
                               java.lang.String id,
                               TaskException taskException)
This method is called after a "CREATE WORKITEM" for task request was executed.

Specified by:
postCreateWorkItem in interface APIEventHandlerPlugin
Parameters:
task - The task for which a work item was requested to be created.
assignmentReason - The reason why the work item is assigned.
id - The user or group that is to be associated.
taskException - The TaskException that occurred or null if no exception occurred.

preDeleteTask

public void preDeleteTask(Task task)
                   throws ApplicationVetoException
This method is called before a "DELETE TASK" request is executed.

Specified by:
preDeleteTask in interface APIEventHandlerPlugin
Parameters:
task - The task that is to be deleted.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postDeleteTask

public void postDeleteTask(Task task,
                           TaskException taskException)
This method is called after a "DELETE TASK" request was executed.

Specified by:
postDeleteTask in interface APIEventHandlerPlugin
Parameters:
task - The task that was requested to be deleted.
taskException - The TaskException that occurred or null if no exception occurred.

preDeleteWorkItem

public void preDeleteWorkItem(Escalation escalation,
                              int assignmentReason,
                              java.lang.String id)
                       throws ApplicationVetoException
This method is called before a "DELETE WORKITEM" of escalation request is executed.

Specified by:
preDeleteWorkItem in interface APIEventHandlerPlugin2
Parameters:
escalation - The escalation for which a work item is to be deleted.
assignmentReason - The reason why the work item is assigned.
id - The user or group that is to be associated.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postDeleteWorkItem

public void postDeleteWorkItem(Escalation escalation,
                               int assignmentReason,
                               java.lang.String id,
                               TaskException taskException)
This method is called after a "DELETE WORKITEM" of escalation request was executed.

Specified by:
postDeleteWorkItem in interface APIEventHandlerPlugin2
Parameters:
escalation - The escalation for which a work item was requested to be deleted.
assignmentReason - The reason why the work item is assigned.
id - The user or group that is to be associated.
taskException - The TaskException that occurred or null if no exception occurred.

preDeleteWorkItem

public void preDeleteWorkItem(Task task,
                              int assignmentReason,
                              java.lang.String id)
                       throws ApplicationVetoException
This method is called before a "DELETE WORKITEM" of task request is executed.

Specified by:
preDeleteWorkItem in interface APIEventHandlerPlugin
Parameters:
task - The task for which a work item is to be deleted.
assignmentReason - The reason why the work item is assigned.
id - The user or group that is to be associated.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postDeleteWorkItem

public void postDeleteWorkItem(Task task,
                               int assignmentReason,
                               java.lang.String id,
                               TaskException taskException)
This method is called after a "DELETE WORKITEM" of task request was executed.

Specified by:
postDeleteWorkItem in interface APIEventHandlerPlugin
Parameters:
task - The task for which a work item was requested to be deleted.
assignmentReason - The reason why the work item is assigned.
id - The user or group that is to be associated.
taskException - The TaskException that occurred or null if no exception occurred.

preGetTaskAndMarkRead

public void preGetTaskAndMarkRead(Task task)
                           throws ApplicationVetoException
This method is called before a "GET TASK AND MARK READ" request is executed.

Specified by:
preGetTaskAndMarkRead in interface APIEventHandlerPlugin5
Parameters:
task - The task whose read property is to be set and returned.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted.

postGetTaskAndMarkRead

public void postGetTaskAndMarkRead(Task task,
                                   TaskException taskException)
This method is called after a "GET TASK AND MARK READ" request was executed.

Specified by:
postGetTaskAndMarkRead in interface APIEventHandlerPlugin5
Parameters:
task - The task whose read property was to be set and returned.
taskException - The TaskException that occurred or null if no exception occurred.

preReplaceWorkItem

public void preReplaceWorkItem(Task task,
                               int assignmentReason,
                               java.lang.String staffQuery)
                        throws ApplicationVetoException
This method is called before a "REPLACE WORKITEM" request is executed.

Specified by:
preReplaceWorkItem in interface APIEventHandlerPlugin
Parameters:
task - The task whose work item is to be replaced.
assignmentReason - The reason why the work item is assigned.
staffQuery - The staff query to replace the associated staff.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postReplaceWorkItem

public void postReplaceWorkItem(Task task,
                                int assignmentReason,
                                java.lang.String staffQuery,
                                TaskException taskException)
This method is called after a "REPLACE WORKITEM" request was executed.

Specified by:
postReplaceWorkItem in interface APIEventHandlerPlugin
Parameters:
task - The task whose work item was requested to be replaced.
assignmentReason - The reason why the work item is assigned.
staffQuery - The staff query to replace the associated staff. son
taskException - The TaskException that occurred or null if no exception occurred.

preRestartTask

public void preRestartTask(Task task)
                    throws ApplicationVetoException
This method is called before a "RESTART TASK" request is executed.

Specified by:
preRestartTask in interface APIEventHandlerPlugin
Parameters:
task - The task that is to be restarted.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postRestartTask

public void postRestartTask(Task task,
                            TaskException taskException)
This method is called after a "RESTART TASK" request was executed.

Specified by:
postRestartTask in interface APIEventHandlerPlugin
Parameters:
task - The task that was requested to be restarted.
taskException - The TaskException that occurred or null if no exception occurred.

preResumeTask

public void preResumeTask(Task task)
                   throws ApplicationVetoException
This method is called before a "RESUME TASK" request is executed.

Specified by:
preResumeTask in interface APIEventHandlerPlugin
Parameters:
task - The task that is to be resumed.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postResumeTask

public void postResumeTask(Task task,
                           TaskException taskException)
This method is called after a "RESUME TASK" request was executed.

Specified by:
postResumeTask in interface APIEventHandlerPlugin
Parameters:
task - The task that was requested to be resumed.
taskException - The TaskException that occurred or null if no exception occurred.

preSetBinaryCustomProperty

public void preSetBinaryCustomProperty(Escalation escalation,
                                       BinaryCustomProperty property)
                                throws ApplicationVetoException
This method is called before a "SET BINARY CUSTOM PROPERTY" for an escalation request is executed.

Specified by:
preSetBinaryCustomProperty in interface APIEventHandlerPlugin2
Parameters:
escalation - The escalation for which the custom property is to be set.
property - The binary custom property object.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postSetBinaryCustomProperty

public void postSetBinaryCustomProperty(Escalation escalation,
                                        BinaryCustomProperty property,
                                        TaskException taskException)
This method is called after a "SET BINARY CUSTOM PROPERTY" for an escalation request was executed.

Specified by:
postSetBinaryCustomProperty in interface APIEventHandlerPlugin2
Parameters:
escalation - The escalation for which the custom property was requested to be set.
property - The binary custom property object.
taskException - The TaskException that occurred or null if no exception occurred.

preSetBinaryCustomProperty

public void preSetBinaryCustomProperty(Task task,
                                       BinaryCustomProperty property)
                                throws ApplicationVetoException
This method is called before a "SET BINARY CUSTOM PROPERTY" for a task request is executed.

Specified by:
preSetBinaryCustomProperty in interface APIEventHandlerPlugin2
Parameters:
task - The task for which the custom property is to be set.
property - The binary custom property object.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postSetBinaryCustomProperty

public void postSetBinaryCustomProperty(Task task,
                                        BinaryCustomProperty property,
                                        TaskException taskException)
This method is called after a "SET BINARY CUSTOM PROPERTY" for a task request was executed.

Specified by:
postSetBinaryCustomProperty in interface APIEventHandlerPlugin2
Parameters:
task - The task for which the custom property was requested to be set.
property - The binary custom property object.
taskException - The TaskException that occurred or null if no exception occurred.

preSetBinaryCustomProperty

public void preSetBinaryCustomProperty(Task task,
                                       java.lang.String propertyName,
                                       java.lang.String dataType,
                                       java.io.Serializable propertyValue)
                                throws ApplicationVetoException
Deprecated. since v6.0.2 - use preSetBinaryCustomProperty(Task, BinaryCustomProperty)

This method is called before a "SET BINARY CUSTOM PROPERTY" request is executed.

Specified by:
preSetBinaryCustomProperty in interface APIEventHandlerPlugin
Parameters:
task - The task for that the custom property is to be set.
propertyName - The property name.
dataType - The property data type.
propertyValue - The property value.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postSetBinaryCustomProperty

public void postSetBinaryCustomProperty(Task task,
                                        java.lang.String propertyName,
                                        java.lang.String dataType,
                                        java.io.Serializable propertyValue,
                                        TaskException taskException)
Deprecated. since v6.0.2 - use postSetBinaryCustomProperty(Task, BinaryCustomProperty)

This method is called after a "SET BINARY CUSTOM PROPERTY" request was executed.

Specified by:
postSetBinaryCustomProperty in interface APIEventHandlerPlugin
Parameters:
task - The task for which the custom property was requested to be set.
propertyName - The property name.
dataType - The property data type.
propertyValue - The property value.
taskException - The TaskException that occurred or null if no exception occurred.

preSetCustomProperties

public void preSetCustomProperties(Task task,
                                   java.util.List customProperties)
                            throws ApplicationVetoException
This method is called before a "SET CUSTOM PROPERTIES" request is executed.

Specified by:
preSetCustomProperties in interface APIEventHandlerPlugin5
Parameters:
task - The task for which the custom properties are to be set.
customProperties - The list of custom properties.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted.

postSetCustomProperties

public void postSetCustomProperties(Task task,
                                    java.util.List customProperties,
                                    TaskException taskException)
This method is called after a "SET CUSTOM PROPERTIES" request was executed.

Specified by:
postSetCustomProperties in interface APIEventHandlerPlugin5
Parameters:
task - The task whose custom properties were requested to be set.
customProperties - The list of custom properties.
taskException - The TaskException that occurred or null if no exception occurred.

preSetCustomProperty

public void preSetCustomProperty(Task task,
                                 java.lang.String propertyName,
                                 java.lang.String propertyValue)
                          throws ApplicationVetoException
This method is called before a "SET CUSTOM PROPERTY" request is executed.

Specified by:
preSetCustomProperty in interface APIEventHandlerPlugin
Parameters:
task - The task for which the custom property is to be set.
propertyName - The property name.
propertyValue - The property value.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postSetCustomProperty

public void postSetCustomProperty(Task task,
                                  java.lang.String propertyName,
                                  java.lang.String propertyValue,
                                  TaskException taskException)
This method is called after a "SET CUSTOM PROPERTY" request was executed.

Specified by:
postSetCustomProperty in interface APIEventHandlerPlugin
Parameters:
task - The task for which the custom property was requested to be set.
propertyName - The property name.
propertyValue - The property value.
taskException - The TaskException that occurred or null if no exception occurred.

preSetFaultMessage

public void preSetFaultMessage(Task task,
                               java.lang.String faultName,
                               java.io.Serializable faultMessage)
                        throws ApplicationVetoException
This method is called before a "SET FAULT MESSAGE" request is executed.

Specified by:
preSetFaultMessage in interface APIEventHandlerPlugin
Parameters:
task - The task for which the fault message is to be set.
faultName - The fault name.
faultMessage - The fault message.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postSetFaultMessage

public void postSetFaultMessage(Task task,
                                java.lang.String faultName,
                                java.io.Serializable faultMessage,
                                TaskException taskException)
This method is called after a "SET FAULT MESSAGE" request was executed.

Specified by:
postSetFaultMessage in interface APIEventHandlerPlugin
Parameters:
task - The task for which the fault message was requested to be set.
faultName - The fault name.
faultMessage - The fault message.
taskException - The TaskException that occurred or null if no exception occurred.

preSetInputMessage

public void preSetInputMessage(Task task,
                               java.io.Serializable inputMessage)
                        throws ApplicationVetoException
This method is called before a "SET INPUT MESSAGE" request is executed.

Specified by:
preSetInputMessage in interface APIEventHandlerPlugin4
Parameters:
task - The task whose input message is to be set.
inputMessage - The input message.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postSetInputMessage

public void postSetInputMessage(Task task,
                                java.io.Serializable inputMessage,
                                TaskException taskException)
This method is called after a "SET INPUT MESSAGE" request was executed.

Specified by:
postSetInputMessage in interface APIEventHandlerPlugin4
Parameters:
task - The task whose input message was requested to be set.
inputMessage - The input message.
taskException - The TaskException that occurred or null if no exception occurred.

preSetOutputMessage

public void preSetOutputMessage(Task task,
                                java.io.Serializable outputMessage)
                         throws ApplicationVetoException
This method is called before a "SET OUTPUT MESSAGE" request is executed.

Specified by:
preSetOutputMessage in interface APIEventHandlerPlugin
Parameters:
task - The task for which the output message is to be set.
outputMessage - The output message.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postSetOutputMessage

public void postSetOutputMessage(Task task,
                                 java.io.Serializable outputMessage,
                                 TaskException taskException)
This method is called after a "SET OUTPUT MESSAGE" request was executed.

Specified by:
postSetOutputMessage in interface APIEventHandlerPlugin
Parameters:
task - The task for which the output message was requested to be set.
outputMessage - The output message.
taskException - The TaskException that occurred or null if no exception occurred.

preSetTaskRead

public void preSetTaskRead(Task task,
                           boolean taskRead)
                    throws ApplicationVetoException
This method is called before a "SET TASK READ" request is executed.

Specified by:
preSetTaskRead in interface APIEventHandlerPlugin5
Parameters:
task - The task whose read property is to be set.
taskRead - The new value of the read flag.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted.

postSetTaskRead

public void postSetTaskRead(Task task,
                            boolean taskRead,
                            TaskException taskException)
This method is called after a "SET TASK READ" request was executed.

Specified by:
postSetTaskRead in interface APIEventHandlerPlugin5
Parameters:
task - The task whose read property was to be set.
taskRead - The new value of the read flag.
taskException - The TaskException that occurred or null if no exception occurred.

preStartTask

public void preStartTask(Task task,
                         java.io.Serializable inputMessage,
                         ReplyHandler replyHandler)
                  throws ApplicationVetoException
This method is called before a "START TASK" request is executed.

Specified by:
preStartTask in interface APIEventHandlerPlugin
Parameters:
task - The task to be started.
inputMessage - The optional input message - may be null.
replyHandler - An optional reply handler - may be null.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postStartTask

public void postStartTask(Task task,
                          java.io.Serializable inputMessage,
                          ReplyHandler replyHandler,
                          TaskException taskException)
This method is called after a "START TASK" request was executed.

Specified by:
postStartTask in interface APIEventHandlerPlugin
Parameters:
task - The task that was requested to be started.
inputMessage - the optional input message - may be null.
replyHandler - An optional reply handler - may be null.
taskException - The TaskException that occurred or null if no exception occurred.

preStartTaskAsSubTask

public void preStartTaskAsSubTask(Task task,
                                  Task parentTask,
                                  java.io.Serializable inputMessage)
                           throws ApplicationVetoException
This method is called before a "START TASK AS SUBTASK" request is executed.

Specified by:
preStartTaskAsSubTask in interface APIEventHandlerPlugin
Parameters:
task - The task to be started.
parentTask - The parent task.
inputMessage - The optional input message - may be null.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postStartTaskAsSubTask

public void postStartTaskAsSubTask(Task task,
                                   Task parentTask,
                                   java.io.Serializable inputMessage,
                                   TaskException taskException)
This method is called after a "START TASK AS SUBTASK" request was executed.

Specified by:
postStartTaskAsSubTask in interface APIEventHandlerPlugin
Parameters:
task - The task that was requested to be started.
parentTask - The parent task.
inputMessage - The optional input message - may be null.
taskException - The TaskException that occurred or null if no exception occurred.

preSuspendTask

public void preSuspendTask(Task task)
                    throws ApplicationVetoException
This method is called before a "SUSPEND TASK" request is executed.

Specified by:
preSuspendTask in interface APIEventHandlerPlugin
Parameters:
task - The task to be suspended.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postSuspendTask

public void postSuspendTask(Task task,
                            TaskException taskException)
This method is called after a "SUSPEND TASK" request was executed.

Specified by:
postSuspendTask in interface APIEventHandlerPlugin
Parameters:
task - The task that was requested to be suspended.
taskException - The TaskException that occurred or null if no exception occurred.

preSuspendTaskUntil

public void preSuspendTaskUntil(Task task,
                                java.lang.String duration)
                         throws ApplicationVetoException
This method is called before a "SUSPEND TASK UNTIL" request is executed.

Specified by:
preSuspendTaskUntil in interface APIEventHandlerPlugin2
Parameters:
task - The task to be suspended.
duration - The duration of the suspension.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postSuspendTaskUntil

public void postSuspendTaskUntil(Task task,
                                 java.lang.String duration,
                                 TaskException taskException)
This method is called after a "SUSPEND TASK UNTIL" request was executed.

Specified by:
postSuspendTaskUntil in interface APIEventHandlerPlugin2
Parameters:
task - The task that was requested to be suspended.
duration - The duration of the suspension.
taskException - The TaskException that occurred or null if no exception occurred.

preSuspendTaskUntil

public void preSuspendTaskUntil(Task task,
                                int duration)
                         throws ApplicationVetoException
This method is called before a "SUSPEND TASK UNTIL" request is executed.

Specified by:
preSuspendTaskUntil in interface APIEventHandlerPlugin3
Parameters:
task - The task to be suspended.
duration - The duration of the suspension.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postSuspendTaskUntil

public void postSuspendTaskUntil(Task task,
                                 java.util.Calendar timeStamp,
                                 TaskException taskException)
This method is called after a "SUSPEND TASK UNTIL" request was executed.

Specified by:
postSuspendTaskUntil in interface APIEventHandlerPlugin3
Parameters:
task - The task that was requested to be suspended.
timeStamp - The time up to which the task is to be suspended.
taskException - The TaskException that occurred or null if no exception occurred.

preSuspendTaskUntil

public void preSuspendTaskUntil(Task task,
                                java.util.Calendar timeStamp)
                         throws ApplicationVetoException
This method is called before a "SUSPEND TASK UNTIL" request is executed.

Specified by:
preSuspendTaskUntil in interface APIEventHandlerPlugin3
Parameters:
task - The task to be suspended.
timeStamp - The point in time until then the task is suspended
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postSuspendTaskUntil

public void postSuspendTaskUntil(Task task,
                                 int duration,
                                 TaskException taskException)
This method is called after a "SUSPEND TASK UNTIL" request was executed.

Specified by:
postSuspendTaskUntil in interface APIEventHandlerPlugin3
Parameters:
task - The task that was requested to be suspended.
duration - The duration of the suspension.
taskException - The TaskException that occurred or null if no exception occurred.

preSuspendTaskWithCancelClaim

public void preSuspendTaskWithCancelClaim(Task task,
                                          java.lang.String duration)
                                   throws ApplicationVetoException
This method is called before a "SUSPEND TASK WITH CANCEL CLAIM" request is executed.

Specified by:
preSuspendTaskWithCancelClaim in interface APIEventHandlerPlugin2
Parameters:
task - The task to be suspended.
duration - The duration of the suspension.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postSuspendTaskWithCancelClaim

public void postSuspendTaskWithCancelClaim(Task task,
                                           java.lang.String duration,
                                           TaskException taskException)
This method is called after a "SUSPEND TASK WITH CANCEL CLAIM" request was executed.

Specified by:
postSuspendTaskWithCancelClaim in interface APIEventHandlerPlugin2
Parameters:
task - The task that was requested to be suspended.
duration - The duration of the suspension.
taskException - The TaskException that occurred or null if no exception occurred.

preSuspendTaskWithCancelClaim

public void preSuspendTaskWithCancelClaim(Task task,
                                          int duration)
                                   throws ApplicationVetoException
This method is called before a "SUSPEND TASK WITH CANCEL CLAIM" request is executed.

Specified by:
preSuspendTaskWithCancelClaim in interface APIEventHandlerPlugin3
Parameters:
task - The task to be suspended.
duration - The duration of the suspension.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postSuspendTaskWithCancelClaim

public void postSuspendTaskWithCancelClaim(Task task,
                                           int duration,
                                           TaskException taskException)
This method is called after a "SUSPEND TASK WITH CANCEL CLAIM" request was executed.

Specified by:
postSuspendTaskWithCancelClaim in interface APIEventHandlerPlugin3
Parameters:
task - The task that was requested to be suspended.
duration - The duration of the suspension.
taskException - The TaskException that occurred or null if no exception occurred.

preSuspendTaskWithCancelClaim

public void preSuspendTaskWithCancelClaim(Task task,
                                          java.util.Calendar timeStamp)
                                   throws ApplicationVetoException
This method is called before a "SUSPEND TASK WITH CANCEL CLAIM" request is executed.

Specified by:
preSuspendTaskWithCancelClaim in interface APIEventHandlerPlugin3
Parameters:
task - The task to be suspended.
timeStamp - The point in time until then the task is suspended
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postSuspendTaskWithCancelClaim

public void postSuspendTaskWithCancelClaim(Task task,
                                           java.util.Calendar timeStamp,
                                           TaskException taskException)
This method is called after a "SUSPEND TASK WITH CANCEL CLAIM" request was executed.

Specified by:
postSuspendTaskWithCancelClaim in interface APIEventHandlerPlugin3
Parameters:
task - The task that was requested to be suspended.
timeStamp - The point in time until then the task is suspended
taskException - The TaskException that occurred or null if no exception occurred.

preTerminateTask

public void preTerminateTask(Task task)
                      throws ApplicationVetoException
This method is called before a "TERMINATE TASK" request is executed.

Specified by:
preTerminateTask in interface APIEventHandlerPlugin
Parameters:
task - The task to be terminated.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postTerminateTask

public void postTerminateTask(Task task,
                              TaskException taskException)
This method is called after a "TERMINATE TASK" request was executed.

Specified by:
postTerminateTask in interface APIEventHandlerPlugin
Parameters:
task - The task that was requested to be terminated.
taskException - The TaskException that occurred or null if no exception occurred.

preTransferToWorkBasket

public void preTransferToWorkBasket(Task task,
                                    java.lang.String workBasketName,
                                    boolean preserveTransferState)
                             throws ApplicationVetoException
This method is called before a "TRANSFER TO WORK BASKET" request is executed.

Specified by:
preTransferToWorkBasket in interface APIEventHandlerPlugin5
Parameters:
task - The task that is to be transferred to another work basket.
workBasketName - The target work basket where this task is to be transferred to.
preserveTransferState - The flag indicating if the transferredToWorkBasket property of the task should be changed as part of this transfer operation.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted.

postTransferToWorkBasket

public void postTransferToWorkBasket(Task task,
                                     java.lang.String workBasketName,
                                     boolean preserveTransferState,
                                     TaskException taskException)
This method is called after a "TRANSFER TO WORK BASKET" request was executed.

Specified by:
postTransferToWorkBasket in interface APIEventHandlerPlugin5
Parameters:
task - The task that was transferred to another work basket.
workBasketName - The target work basket where this task was transferred to.
preserveTransferState - The flag indicating if the transferredToWorkBasket property of the task should be changed as part of this transfer operation.
taskException - The TaskException that occurred or null if no exception occurred.

preTransferWorkItem

public void preTransferWorkItem(Escalation escalation,
                                int assignmentReason,
                                java.lang.String fromUserId,
                                java.lang.String toUserId)
                         throws ApplicationVetoException
This method is called before a "TRANSFER WORKITEM" of an escalation request is executed.

Specified by:
preTransferWorkItem in interface APIEventHandlerPlugin2
Parameters:
escalation - The escalation whose work item is to be transferred.
assignmentReason - The reason why the work item is assigned.
fromUserId - The user who is the owner of the work item.
toUserId - The user that is to be associated.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postTransferWorkItem

public void postTransferWorkItem(Escalation escalation,
                                 int assignmentReason,
                                 java.lang.String fromUserId,
                                 java.lang.String toUserId,
                                 TaskException taskException)
This method is called after a "TRANSFER WORKITEM" of an escalation request was executed.

Specified by:
postTransferWorkItem in interface APIEventHandlerPlugin2
Parameters:
escalation - The escalation whose work item was requested to be transferred.
assignmentReason - The reason why the work item is assigned.
fromUserId - The user who is the owner of the work item.
toUserId - The user that is to be associated.
taskException - The TaskException that occurred or null if no exception occurred.

preTransferWorkItem

public void preTransferWorkItem(Task task,
                                int assignmentReason,
                                java.lang.String fromUserId,
                                java.lang.String toUserId)
                         throws ApplicationVetoException
This method is called before a T"RANSFER WORKITEM" of a task request is executed.

Specified by:
preTransferWorkItem in interface APIEventHandlerPlugin
Parameters:
task - The task whose work item is to be transferred.
assignmentReason - The reason why the work item is assigned.
fromUserId - The user who is the owner of the work item.
toUserId - The user that is to be associated.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postTransferWorkItem

public void postTransferWorkItem(Task task,
                                 int assignmentReason,
                                 java.lang.String fromUserId,
                                 java.lang.String toUserId,
                                 TaskException taskException)
This method is called after a "TRANSFER WORKITEM" of a task request was executed.

Specified by:
postTransferWorkItem in interface APIEventHandlerPlugin
Parameters:
task - The task whose work item was requested to be transferred.
assignmentReason - The reason why the work item is assigned.
fromUserId - The user who is the owner of the work item.
toUserId - The user that is to be associated.
taskException - The TaskException that occurred or null if no exception occurred.

preTriggerEscalation

public void preTriggerEscalation(Escalation escalation)
                          throws ApplicationVetoException
This method is called before a "TRIGGER ESCALATION" request is executed.

Specified by:
preTriggerEscalation in interface APIEventHandlerPlugin5
Parameters:
escalation - The escalation that will be triggered.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postTriggerEscalation

public void postTriggerEscalation(Escalation escalation,
                                  TaskException taskException)
This method is called after a "TRIGGER ESCALATION" request was executed.

Specified by:
postTriggerEscalation in interface APIEventHandlerPlugin5
Parameters:
escalation - The escalation that was triggered.
taskException - The TaskException that occurred or null if no exception occurred.

preUpdateTask

public void preUpdateTask(Task task)
                   throws ApplicationVetoException
This method is called before an "UPDATE TASK" request is executed.

Specified by:
preUpdateTask in interface APIEventHandlerPlugin
Parameters:
task - The task to be updated.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postUpdateTask

public void postUpdateTask(Task task,
                           TaskException taskException)
This method is called after an "UPDATE TASK" request was executed.

Specified by:
postUpdateTask in interface APIEventHandlerPlugin
Parameters:
task - The task that was requested to be updated.
taskException - The TaskException that occurred or null if no exception occurred.

preUpdateInactiveTask

public void preUpdateInactiveTask(Task task,
                                  TaskModel model,
                                  java.io.Serializable inputMessage,
                                  ReplyHandler replyHandler)
                           throws ApplicationVetoException
This method is called before a "UPDATE INACTIVE TASK" request is executed.

Specified by:
preUpdateInactiveTask in interface APIEventHandlerPlugin
Parameters:
task - The task to be updated.
model - The task model to be used for the update.
inputMessage - The optional input message - may be null.
replyHandler - An optional reply handler - may be null.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postUpdateInactiveTask

public void postUpdateInactiveTask(Task task,
                                   java.io.Serializable inputMessage,
                                   ReplyHandler replyHandler,
                                   TaskException taskException)
This method is called after a "UPDATE INACTIVE TASK" request was executed.

Specified by:
postUpdateInactiveTask in interface APIEventHandlerPlugin
Parameters:
task - The task that was requested to be updated.
inputMessage - The input message - may be null.
replyHandler - An optional reply handler - may be null.
taskException - The TaskException that occurred or null if no exception occurred.

preUpdateEscalation

public void preUpdateEscalation(Escalation escalation)
                         throws ApplicationVetoException
This method is called before an "UPDATE ESCALATION" request is executed.

Specified by:
preUpdateEscalation in interface APIEventHandlerPlugin4
Parameters:
escalation - The escalation that will be updated.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postUpdateEscalation

public void postUpdateEscalation(Escalation escalation,
                                 TaskException taskException)
This method is called after an "UPDATE ESCALATION" request was executed.

Specified by:
postUpdateEscalation in interface APIEventHandlerPlugin4
Parameters:
escalation - The escalation that was requested to be updated.
taskException - The TaskException that occurred or null if no exception occurred.