|
IBM WebSphere Application ServerTM Release 7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.task.spi.APIEventHandler
public class APIEventHandler
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.
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 |
---|
public static final java.lang.String COPYRIGHT
Constructor Detail |
---|
public APIEventHandler()
Method Detail |
---|
public void preCallTask(Task task, java.io.Serializable inputMessage) throws ApplicationVetoException
preCallTask
in interface APIEventHandlerPlugin
task
- The task that will be called.inputMessage
- The optional input message - may be null.
ApplicationVetoException
- if the subsequent execution is to be abortedpublic void postCallTask(Task task, java.io.Serializable inputMessage, java.io.Serializable returnMessage, TaskException taskException)
postCallTask
in interface APIEventHandlerPlugin
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.public void preCancelClaim(Task task) throws ApplicationVetoException
preCancelClaim
in interface APIEventHandlerPlugin
task
- The task that has been claimed and that is to be canceled.
ApplicationVetoException
- if the subsequent execution is to be aborted.public void postCancelClaim(Task task, TaskException taskException)
postCancelClaim
in interface APIEventHandlerPlugin
task
- The task where the claim was requested to be canceled.taskException
- The TaskException that occurred or null if no exception occurred.public void preClaim(Task task) throws ApplicationVetoException
preClaim
in interface APIEventHandlerPlugin
task
- The task that is to be claimed.
ApplicationVetoException
- if the subsequent execution is to be aborted.public void postClaim(Task task, java.lang.Object inputMessage, TaskException taskException)
postClaim
in interface APIEventHandlerPlugin
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.public void postClaim(Task task, java.io.Serializable inputMessage, TaskException taskException)
postClaim
in interface APIEventHandlerPlugin2
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.public void preComplete(Task task) throws ApplicationVetoException
preComplete
in interface APIEventHandlerPlugin
task
- The task to be completed.
ApplicationVetoException
- if the subsequent execution is to be aborted.public void postComplete(Task task, java.io.Serializable outputMessage, java.lang.String faultName, java.io.Serializable faultMessage, TaskException taskException)
postComplete
in interface APIEventHandlerPlugin
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.public void preCompleteWithFollowOnTask(Task task, Task previousTask) throws ApplicationVetoException
preCompleteWithFollowOnTask
in interface APIEventHandlerPlugin
task
- The task to be started.previousTask
- The predecessor task to be completed.
ApplicationVetoException
- if the subsequent execution is to be abortedpublic void postCompleteWithFollowOnTask(Task task, Task previousTask, TaskException taskException)
postCompleteWithFollowOnTask
in interface APIEventHandlerPlugin
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.public void preCompleteWithNewFollowOnTask(TaskModel newTaskModel, TaskTemplate template, Task previousTask) throws ApplicationVetoException
Note: Either the newTaskModel parameter or the template parameter must be set.
preCompleteWithNewFollowOnTask
in interface APIEventHandlerPlugin
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.
ApplicationVetoException
- if the subsequent execution is to be abortedpublic void postCompleteWithNewFollowOnTask(Task newTask, TaskModel newTaskModel, TaskTemplate template, Task previousTask, java.io.Serializable inputMessage, TaskException taskException)
Note: Either the newTaskModel parameter or the template parameter must be set.
postCompleteWithNewFollowOnTask
in interface APIEventHandlerPlugin
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.public void preCreateAndCallTask(TaskModel newTaskModel, TaskTemplate template, java.io.Serializable inputMessage) throws ApplicationVetoException
Note: Either the newTaskModel parameter or the template parameter must be set.
preCreateAndCallTask
in interface APIEventHandlerPlugin
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.
ApplicationVetoException
- if the subsequent execution is to be aborted.public void postCreateAndCallTask(Task task, TaskModel newTaskModel, TaskTemplate template, java.io.Serializable inputMessage, TaskException taskException)
Note: Either the newTaskModel parameter or the template parameter must be set.
postCreateAndCallTask
in interface APIEventHandlerPlugin
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.public void preCreateAndStartTask(TaskModel newTaskModel, TaskTemplate template, java.io.Serializable inputMessage, ReplyHandler replyHandler) throws ApplicationVetoException
Note: Either the newTaskModel parameter or the template parameter must be set.
preCreateAndStartTask
in interface APIEventHandlerPlugin
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.
ApplicationVetoException
- if the subsequent execution is to be abortedpublic void postCreateAndStartTask(Task newTask, TaskModel newTaskModel, TaskTemplate template, java.io.Serializable inputMessage, ReplyHandler replyHandler, TaskException taskException)
Note: Either the newTaskModel parameter or the template parameter must be set.
postCreateAndStartTask
in interface APIEventHandlerPlugin
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.public void preCreateAndStartTaskAsSubTask(TaskModel newTaskModel, TaskTemplate template, Task parentTask, java.io.Serializable inputMessage) throws ApplicationVetoException
Note: Either the newTaskModel parameter or the template parameter must be set.
preCreateAndStartTaskAsSubTask
in interface APIEventHandlerPlugin
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.
ApplicationVetoException
- if the subsequent execution is to be abortedpublic void postCreateAndStartTaskAsSubTask(Task newTask, TaskModel newTaskModel, TaskTemplate template, Task parentTask, java.io.Serializable inputMessage, TaskException taskException)
Note: Either the newTaskModel parameter or the template parameter must be set.
postCreateAndStartTaskAsSubTask
in interface APIEventHandlerPlugin
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.public void preCreateTask(TaskModel newTaskModel, TaskTemplate template, java.io.Serializable inputMessage, ReplyHandler replyHandler) throws ApplicationVetoException
preCreateTask
in interface APIEventHandlerPlugin
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.
ApplicationVetoException
- if the subsequent execution is to be abortedpublic void postCreateTask(Task newTask, TaskModel newTaskModel, TaskTemplate template, java.io.Serializable inputMessage, ReplyHandler replyHandler, TaskException taskException)
postCreateTask
in interface APIEventHandlerPlugin
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.public void preCreateWorkItem(Escalation escalation, int assignmentReason, java.lang.String id) throws ApplicationVetoException
preCreateWorkItem
in interface APIEventHandlerPlugin2
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.
ApplicationVetoException
- if the subsequent execution is to be abortedpublic void postCreateWorkItem(Escalation escalation, int assignmentReason, java.lang.String id, TaskException taskException)
postCreateWorkItem
in interface APIEventHandlerPlugin2
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.public void preCreateWorkItem(Task task, int assignmentReason, java.lang.String id) throws ApplicationVetoException
preCreateWorkItem
in interface APIEventHandlerPlugin
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.
ApplicationVetoException
- if the subsequent execution is to be abortedpublic void postCreateWorkItem(Task task, int assignmentReason, java.lang.String id, TaskException taskException)
postCreateWorkItem
in interface APIEventHandlerPlugin
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.public void preDeleteTask(Task task) throws ApplicationVetoException
preDeleteTask
in interface APIEventHandlerPlugin
task
- The task that is to be deleted.
ApplicationVetoException
- if the subsequent execution is to be abortedpublic void postDeleteTask(Task task, TaskException taskException)
postDeleteTask
in interface APIEventHandlerPlugin
task
- The task that was requested to be deleted.taskException
- The TaskException that occurred or null if no exception occurred.public void preDeleteWorkItem(Escalation escalation, int assignmentReason, java.lang.String id) throws ApplicationVetoException
preDeleteWorkItem
in interface APIEventHandlerPlugin2
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.
ApplicationVetoException
- if the subsequent execution is to be abortedpublic void postDeleteWorkItem(Escalation escalation, int assignmentReason, java.lang.String id, TaskException taskException)
postDeleteWorkItem
in interface APIEventHandlerPlugin2
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.public void preDeleteWorkItem(Task task, int assignmentReason, java.lang.String id) throws ApplicationVetoException
preDeleteWorkItem
in interface APIEventHandlerPlugin
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.
ApplicationVetoException
- if the subsequent execution is to be abortedpublic void postDeleteWorkItem(Task task, int assignmentReason, java.lang.String id, TaskException taskException)
postDeleteWorkItem
in interface APIEventHandlerPlugin
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.public void preGetTaskAndMarkRead(Task task) throws ApplicationVetoException
preGetTaskAndMarkRead
in interface APIEventHandlerPlugin5
task
- The task whose read property is to be set and returned.
ApplicationVetoException
- if the subsequent execution is to be aborted.public void postGetTaskAndMarkRead(Task task, TaskException taskException)
postGetTaskAndMarkRead
in interface APIEventHandlerPlugin5
task
- The task whose read property was to be set and returned.taskException
- The TaskException that occurred or null if no exception occurred.public void preReplaceWorkItem(Task task, int assignmentReason, java.lang.String staffQuery) throws ApplicationVetoException
preReplaceWorkItem
in interface APIEventHandlerPlugin
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.
ApplicationVetoException
- if the subsequent execution is to be abortedpublic void postReplaceWorkItem(Task task, int assignmentReason, java.lang.String staffQuery, TaskException taskException)
postReplaceWorkItem
in interface APIEventHandlerPlugin
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. sontaskException
- The TaskException that occurred or null if no exception occurred.public void preRestartTask(Task task) throws ApplicationVetoException
preRestartTask
in interface APIEventHandlerPlugin
task
- The task that is to be restarted.
ApplicationVetoException
- if the subsequent execution is to be abortedpublic void postRestartTask(Task task, TaskException taskException)
postRestartTask
in interface APIEventHandlerPlugin
task
- The task that was requested to be restarted.taskException
- The TaskException that occurred or null if no exception occurred.public void preResumeTask(Task task) throws ApplicationVetoException
preResumeTask
in interface APIEventHandlerPlugin
task
- The task that is to be resumed.
ApplicationVetoException
- if the subsequent execution is to be abortedpublic void postResumeTask(Task task, TaskException taskException)
postResumeTask
in interface APIEventHandlerPlugin
task
- The task that was requested to be resumed.taskException
- The TaskException that occurred or null if no exception occurred.public void preSetBinaryCustomProperty(Escalation escalation, BinaryCustomProperty property) throws ApplicationVetoException
preSetBinaryCustomProperty
in interface APIEventHandlerPlugin2
escalation
- The escalation for which the custom property is to be set.property
- The binary custom property object.
ApplicationVetoException
- if the subsequent execution is to be abortedpublic void postSetBinaryCustomProperty(Escalation escalation, BinaryCustomProperty property, TaskException taskException)
postSetBinaryCustomProperty
in interface APIEventHandlerPlugin2
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.public void preSetBinaryCustomProperty(Task task, BinaryCustomProperty property) throws ApplicationVetoException
preSetBinaryCustomProperty
in interface APIEventHandlerPlugin2
task
- The task for which the custom property is to be set.property
- The binary custom property object.
ApplicationVetoException
- if the subsequent execution is to be abortedpublic void postSetBinaryCustomProperty(Task task, BinaryCustomProperty property, TaskException taskException)
postSetBinaryCustomProperty
in interface APIEventHandlerPlugin2
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.public void preSetBinaryCustomProperty(Task task, java.lang.String propertyName, java.lang.String dataType, java.io.Serializable propertyValue) throws ApplicationVetoException
preSetBinaryCustomProperty
in interface APIEventHandlerPlugin
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.
ApplicationVetoException
- if the subsequent execution is to be abortedpublic void postSetBinaryCustomProperty(Task task, java.lang.String propertyName, java.lang.String dataType, java.io.Serializable propertyValue, TaskException taskException)
postSetBinaryCustomProperty
in interface APIEventHandlerPlugin
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.public void preSetCustomProperties(Task task, java.util.List customProperties) throws ApplicationVetoException
preSetCustomProperties
in interface APIEventHandlerPlugin5
task
- The task for which the custom properties are to be set.customProperties
- The list of custom properties
.
ApplicationVetoException
- if the subsequent execution is to be aborted.public void postSetCustomProperties(Task task, java.util.List customProperties, TaskException taskException)
postSetCustomProperties
in interface APIEventHandlerPlugin5
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.public void preSetCustomProperty(Task task, java.lang.String propertyName, java.lang.String propertyValue) throws ApplicationVetoException
preSetCustomProperty
in interface APIEventHandlerPlugin
task
- The task for which the custom property is to be set.propertyName
- The property name.propertyValue
- The property value.
ApplicationVetoException
- if the subsequent execution is to be abortedpublic void postSetCustomProperty(Task task, java.lang.String propertyName, java.lang.String propertyValue, TaskException taskException)
postSetCustomProperty
in interface APIEventHandlerPlugin
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.public void preSetFaultMessage(Task task, java.lang.String faultName, java.io.Serializable faultMessage) throws ApplicationVetoException
preSetFaultMessage
in interface APIEventHandlerPlugin
task
- The task for which the fault message is to be set.faultName
- The fault name.faultMessage
- The fault message.
ApplicationVetoException
- if the subsequent execution is to be abortedpublic void postSetFaultMessage(Task task, java.lang.String faultName, java.io.Serializable faultMessage, TaskException taskException)
postSetFaultMessage
in interface APIEventHandlerPlugin
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.public void preSetInputMessage(Task task, java.io.Serializable inputMessage) throws ApplicationVetoException
preSetInputMessage
in interface APIEventHandlerPlugin4
task
- The task whose input message is to be set.inputMessage
- The input message.
ApplicationVetoException
- if the subsequent execution is to be abortedpublic void postSetInputMessage(Task task, java.io.Serializable inputMessage, TaskException taskException)
postSetInputMessage
in interface APIEventHandlerPlugin4
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.public void preSetOutputMessage(Task task, java.io.Serializable outputMessage) throws ApplicationVetoException
preSetOutputMessage
in interface APIEventHandlerPlugin
task
- The task for which the output message is to be set.outputMessage
- The output message.
ApplicationVetoException
- if the subsequent execution is to be abortedpublic void postSetOutputMessage(Task task, java.io.Serializable outputMessage, TaskException taskException)
postSetOutputMessage
in interface APIEventHandlerPlugin
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.public void preSetTaskRead(Task task, boolean taskRead) throws ApplicationVetoException
preSetTaskRead
in interface APIEventHandlerPlugin5
task
- The task whose read property is to be set.taskRead
- The new value of the read flag.
ApplicationVetoException
- if the subsequent execution is to be aborted.public void postSetTaskRead(Task task, boolean taskRead, TaskException taskException)
postSetTaskRead
in interface APIEventHandlerPlugin5
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.public void preStartTask(Task task, java.io.Serializable inputMessage, ReplyHandler replyHandler) throws ApplicationVetoException
preStartTask
in interface APIEventHandlerPlugin
task
- The task to be started.inputMessage
- The optional input message - may be null.replyHandler
- An optional reply handler - may be null.
ApplicationVetoException
- if the subsequent execution is to be abortedpublic void postStartTask(Task task, java.io.Serializable inputMessage, ReplyHandler replyHandler, TaskException taskException)
postStartTask
in interface APIEventHandlerPlugin
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.public void preStartTaskAsSubTask(Task task, Task parentTask, java.io.Serializable inputMessage) throws ApplicationVetoException
preStartTaskAsSubTask
in interface APIEventHandlerPlugin
task
- The task to be started.parentTask
- The parent task.inputMessage
- The optional input message - may be null.
ApplicationVetoException
- if the subsequent execution is to be abortedpublic void postStartTaskAsSubTask(Task task, Task parentTask, java.io.Serializable inputMessage, TaskException taskException)
postStartTaskAsSubTask
in interface APIEventHandlerPlugin
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.public void preSuspendTask(Task task) throws ApplicationVetoException
preSuspendTask
in interface APIEventHandlerPlugin
task
- The task to be suspended.
ApplicationVetoException
- if the subsequent execution is to be abortedpublic void postSuspendTask(Task task, TaskException taskException)
postSuspendTask
in interface APIEventHandlerPlugin
task
- The task that was requested to be suspended.taskException
- The TaskException that occurred or null if no exception occurred.public void preSuspendTaskUntil(Task task, java.lang.String duration) throws ApplicationVetoException
preSuspendTaskUntil
in interface APIEventHandlerPlugin2
task
- The task to be suspended.duration
- The duration of the suspension.
ApplicationVetoException
- if the subsequent execution is to be abortedpublic void postSuspendTaskUntil(Task task, java.lang.String duration, TaskException taskException)
postSuspendTaskUntil
in interface APIEventHandlerPlugin2
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.public void preSuspendTaskUntil(Task task, int duration) throws ApplicationVetoException
preSuspendTaskUntil
in interface APIEventHandlerPlugin3
task
- The task to be suspended.duration
- The duration of the suspension.
ApplicationVetoException
- if the subsequent execution is to be abortedpublic void postSuspendTaskUntil(Task task, java.util.Calendar timeStamp, TaskException taskException)
postSuspendTaskUntil
in interface APIEventHandlerPlugin3
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.public void preSuspendTaskUntil(Task task, java.util.Calendar timeStamp) throws ApplicationVetoException
preSuspendTaskUntil
in interface APIEventHandlerPlugin3
task
- The task to be suspended.timeStamp
- The point in time until then the task is suspended
ApplicationVetoException
- if the subsequent execution is to be abortedpublic void postSuspendTaskUntil(Task task, int duration, TaskException taskException)
postSuspendTaskUntil
in interface APIEventHandlerPlugin3
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.public void preSuspendTaskWithCancelClaim(Task task, java.lang.String duration) throws ApplicationVetoException
preSuspendTaskWithCancelClaim
in interface APIEventHandlerPlugin2
task
- The task to be suspended.duration
- The duration of the suspension.
ApplicationVetoException
- if the subsequent execution is to be abortedpublic void postSuspendTaskWithCancelClaim(Task task, java.lang.String duration, TaskException taskException)
postSuspendTaskWithCancelClaim
in interface APIEventHandlerPlugin2
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.public void preSuspendTaskWithCancelClaim(Task task, int duration) throws ApplicationVetoException
preSuspendTaskWithCancelClaim
in interface APIEventHandlerPlugin3
task
- The task to be suspended.duration
- The duration of the suspension.
ApplicationVetoException
- if the subsequent execution is to be abortedpublic void postSuspendTaskWithCancelClaim(Task task, int duration, TaskException taskException)
postSuspendTaskWithCancelClaim
in interface APIEventHandlerPlugin3
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.public void preSuspendTaskWithCancelClaim(Task task, java.util.Calendar timeStamp) throws ApplicationVetoException
preSuspendTaskWithCancelClaim
in interface APIEventHandlerPlugin3
task
- The task to be suspended.timeStamp
- The point in time until then the task is suspended
ApplicationVetoException
- if the subsequent execution is to be abortedpublic void postSuspendTaskWithCancelClaim(Task task, java.util.Calendar timeStamp, TaskException taskException)
postSuspendTaskWithCancelClaim
in interface APIEventHandlerPlugin3
task
- The task that was requested to be suspended.timeStamp
- The point in time until then the task is suspendedtaskException
- The TaskException that occurred or null if no exception occurred.public void preTerminateTask(Task task) throws ApplicationVetoException
preTerminateTask
in interface APIEventHandlerPlugin
task
- The task to be terminated.
ApplicationVetoException
- if the subsequent execution is to be abortedpublic void postTerminateTask(Task task, TaskException taskException)
postTerminateTask
in interface APIEventHandlerPlugin
task
- The task that was requested to be terminated.taskException
- The TaskException that occurred or null if no exception occurred.public void preTransferToWorkBasket(Task task, java.lang.String workBasketName, boolean preserveTransferState) throws ApplicationVetoException
preTransferToWorkBasket
in interface APIEventHandlerPlugin5
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.
ApplicationVetoException
- if the subsequent execution is to be aborted.public void postTransferToWorkBasket(Task task, java.lang.String workBasketName, boolean preserveTransferState, TaskException taskException)
postTransferToWorkBasket
in interface APIEventHandlerPlugin5
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.public void preTransferWorkItem(Escalation escalation, int assignmentReason, java.lang.String fromUserId, java.lang.String toUserId) throws ApplicationVetoException
preTransferWorkItem
in interface APIEventHandlerPlugin2
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.
ApplicationVetoException
- if the subsequent execution is to be abortedpublic void postTransferWorkItem(Escalation escalation, int assignmentReason, java.lang.String fromUserId, java.lang.String toUserId, TaskException taskException)
postTransferWorkItem
in interface APIEventHandlerPlugin2
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.public void preTransferWorkItem(Task task, int assignmentReason, java.lang.String fromUserId, java.lang.String toUserId) throws ApplicationVetoException
preTransferWorkItem
in interface APIEventHandlerPlugin
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.
ApplicationVetoException
- if the subsequent execution is to be abortedpublic void postTransferWorkItem(Task task, int assignmentReason, java.lang.String fromUserId, java.lang.String toUserId, TaskException taskException)
postTransferWorkItem
in interface APIEventHandlerPlugin
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.public void preTriggerEscalation(Escalation escalation) throws ApplicationVetoException
preTriggerEscalation
in interface APIEventHandlerPlugin5
escalation
- The escalation that will be triggered.
ApplicationVetoException
- if the subsequent execution is to be abortedpublic void postTriggerEscalation(Escalation escalation, TaskException taskException)
postTriggerEscalation
in interface APIEventHandlerPlugin5
escalation
- The escalation that was triggered.taskException
- The TaskException that occurred or null if no exception occurred.public void preUpdateTask(Task task) throws ApplicationVetoException
preUpdateTask
in interface APIEventHandlerPlugin
task
- The task to be updated.
ApplicationVetoException
- if the subsequent execution is to be abortedpublic void postUpdateTask(Task task, TaskException taskException)
postUpdateTask
in interface APIEventHandlerPlugin
task
- The task that was requested to be updated.taskException
- The TaskException that occurred or null if no exception occurred.public void preUpdateInactiveTask(Task task, TaskModel model, java.io.Serializable inputMessage, ReplyHandler replyHandler) throws ApplicationVetoException
preUpdateInactiveTask
in interface APIEventHandlerPlugin
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.
ApplicationVetoException
- if the subsequent execution is to be abortedpublic void postUpdateInactiveTask(Task task, java.io.Serializable inputMessage, ReplyHandler replyHandler, TaskException taskException)
postUpdateInactiveTask
in interface APIEventHandlerPlugin
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.public void preUpdateEscalation(Escalation escalation) throws ApplicationVetoException
preUpdateEscalation
in interface APIEventHandlerPlugin4
escalation
- The escalation that will be updated.
ApplicationVetoException
- if the subsequent execution is to be abortedpublic void postUpdateEscalation(Escalation escalation, TaskException taskException)
postUpdateEscalation
in interface APIEventHandlerPlugin4
escalation
- The escalation that was requested to be updated.taskException
- The TaskException that occurred or null if no exception occurred.
|
IBM WebSphere Application ServerTM Release 7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |