com.ibm.task.spi

Interface APIEventHandlerPlugin

All known subinterfaces:
APIEventHandlerPlugin2, APIEventHandlerPlugin3, APIEventHandlerPlugin4, APIEventHandlerPlugin5, APIEventHandlerPlugin6
All known implementing classes:
APIEventHandler

  1. public interface APIEventHandlerPlugin
This interface supports the creation of API event handlers.

API events occur when a human task changes its state or when a task property is updated. These events can be used by other components and applications to participate in state transitions of human tasks. Use the APIEventHandlerPlugin service provider interface (SPI) to create plug-ins to get informed about events send by the API or the internal events that have equivalent API events.

To handle API events, the event handler is invoked directly before a modification is done (pre-event method) and after the modification is done (post-event method).

This interface provides methods that are called when an API pre event or post event occurs.

Since:
6.0
Version:
7.0.0

Field Summary

Modifier and Type Field and Description
  1. static
  2. java.lang.String
COPYRIGHT

Method Summary

Modifier and Type Method and Description
  1. 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.
  1. void
postCancelClaim(Task task,TaskException taskException)
This method is called after a "CANCEL CLAIM" request was executed.
  1. void
postClaim(Task task,java.lang.Object inputMessage,TaskException taskException)
Deprecated. since v6.0.2 - use postClaim(Task, Serializable, TaskException)
  1. 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.
  1. void
postCompleteWithFollowOnTask(Task task,Task previousTask,TaskException taskException)
This method is called after a "COMPLETE WITH FOLLOW-ON TASK" request was executed.
  1. 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.
  1. 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.
  1. 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.
  1. 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.
  1. 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.
  1. void
postCreateWorkItem(Task task,int assignmentReason,java.lang.String id,TaskException taskException)
This method is called after a "CREATE WORKITEM" request was executed.
  1. void
postDeleteTask(Task task,TaskException taskException)
This method is called after a 2DELETE TASK" request was executed.
  1. void
postDeleteWorkItem(Task task,int assignmentReason,java.lang.String id,TaskException taskException)
This method is called after a "DELETE WORKITEM" request was executed.
  1. void
postReplaceWorkItem(Task task,int assignmentReason,java.lang.String staffQuery,TaskException taskException)
Deprecated. since v7.0 - this method is not used.
  1. void
postRestartTask(Task task,TaskException taskException)
This method is called after a "RESTART TASK" request was executed.
  1. void
postResumeTask(Task task,TaskException taskException)
This method is called after a "RESUME TASK" request was executed.
  1. 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)
  1. 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.
  1. 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.
  1. void
postSetOutputMessage(Task task,java.io.Serializable outputMessage,TaskException taskException)
This method is called after a "SET OUTPUT MESSAGE" request was executed.
  1. void
postStartTask(Task task,java.io.Serializable inputMessage,ReplyHandler replyHandler,TaskException taskException)
This method is called after a "START TASK" request was executed.
  1. 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.
  1. void
postSuspendTask(Task task,TaskException taskException)
This method is called after a "SUSPEND TASK" request was executed.
  1. void
postTerminateTask(Task task,TaskException taskException)
This method is called after a "TERMINATE TASK" request was executed.
  1. void
postTransferWorkItem(Task task,int assignmentReason,java.lang.String fromUserId,java.lang.String toUserId,TaskException taskException)
This method is called after a "TRANSFER WORKITEM" request was executed.
  1. void
postUpdateInactiveTask(Task task,java.io.Serializable inputMessage,ReplyHandler replyHandler,TaskException taskException)
This method is called after a "UPDATE INACTIVE TASK" request was executed.
  1. void
postUpdateTask(Task task,TaskException taskException)
This method is called after a "UPDATE TASK" request was executed.
  1. void
preCallTask(Task task,java.io.Serializable inputMessage)
This method is called before a "CALL TASK" request is executed.
  1. void
preCancelClaim(Task task)
This method is called before a "CANCEL CLAIM" request is executed.
  1. void
preClaim(Task task)
This method is called before a "CLAIM" request is executed.
  1. void
preComplete(Task task)
This method is called before a "COMPLETE" request is executed.
  1. void
preCompleteWithFollowOnTask(Task task,Task previousTask)
This method is called before a "COMPLETE WITH FOLLOW-ON TASK" request is executed.
  1. void
preCompleteWithNewFollowOnTask(TaskModel newTaskModel,TaskTemplate template,Task previousTask)
This method is called before a "COMPLETE WITH NEW FOLLOW-ON TASK" request is executed.
  1. void
preCreateAndCallTask(TaskModel newTaskModel,TaskTemplate template,java.io.Serializable inputMessage)
This method is called before a "CREATE AND CALL TASK" request is executed.
  1. 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.
  1. 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.
  1. void
preCreateTask(TaskModel newTaskModel,TaskTemplate template,java.io.Serializable inputMessage,ReplyHandler replyHandler)
This method is called before a "CREATE TASK" request is executed.
  1. void
preCreateWorkItem(Task task,int assignmentReason,java.lang.String id)
This method is called before a "CREATE WORKITEM" request is executed.
  1. void
preDeleteTask(Task task)
This method is called before a "DELETE TASK" request is executed.
  1. void
preDeleteWorkItem(Task task,int assignmentReason,java.lang.String id)
This method is called before a "DELETE WORKITEM" request is executed.
  1. void
preReplaceWorkItem(Task task,int assignmentReason,java.lang.String staffQuery)
Deprecated. since v7.0 - this method is not used.
  1. void
preRestartTask(Task task)
This method is called before a "RESTART TASK" request is executed.
  1. void
preResumeTask(Task task)
This method is called before a "RESUME TASK" request is executed.
  1. 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)
  1. void
preSetCustomProperty(Task task,java.lang.String propertyName,java.lang.String propertyValue)
This method is called before a "SET CUSTOM PROPERTY" request is executed.
  1. void
preSetFaultMessage(Task task,java.lang.String faultName,java.io.Serializable faultMessage)
This method is called before a "SET FAULT MESSAGE" request is executed.
  1. void
preSetOutputMessage(Task task,java.io.Serializable outputMessage)
This method is called before a "SET OUTPUT MESSAGE" request is executed.
  1. void
preStartTask(Task task,java.io.Serializable inputMessage,ReplyHandler replyHandler)
This method is called before a "START TASK" request is executed.
  1. void
preStartTaskAsSubTask(Task task,Task parentTask,java.io.Serializable inputMessage)
This method is called before a "START TASK AS SUBTASK" request is executed.
  1. void
preSuspendTask(Task task)
This method is called before a "SUSPEND TASK" request is executed.
  1. void
preTerminateTask(Task task)
This method is called before a "TERMINATE TASK" request is executed.
  1. void
preTransferWorkItem(Task task,int assignmentReason,java.lang.String fromUserId,java.lang.String toUserId)
This method is called before a "TRANSFER WORKITEM" request is executed.
  1. void
preUpdateInactiveTask(Task task,TaskModel model,java.io.Serializable inputMessage,ReplyHandler replyHandler)
This method is called before a "UPDATE INACTIVE TASK" request is executed.
  1. void
preUpdateTask(Task task)
This method is called before a "UPDATE TASK" request is executed.

Field Detail

  1. static final java.lang.String COPYRIGHT
See Also:

Method Detail

preCallTask

  1. void preCallTask(Task task,
  2. java.io.Serializable inputMessage)
  3. throws ApplicationVetoException
This method is called before a "CALL TASK" request is executed.
Parameters:
task - The task to be called.
inputMessage - The input message - may be null.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postCallTask

  1. void postCallTask(Task task,
  2. java.io.Serializable inputMessage,
  3. java.io.Serializable returnMessage,
  4. TaskException taskException)
This method is called after a "CALL TASK" request was executed.
Parameters:
task - task that has been 'called'
inputMessage - The input message - may be null.
returnMessage - The return message - may be null.
taskException - The TaskException that occurred or null if no exception occurred.

preCancelClaim

  1. void preCancelClaim(Task task)
  2. throws ApplicationVetoException
This method is called before a "CANCEL CLAIM" request is executed.
Parameters:
task - The task that has been claimed and where the claim is to be canceled.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postCancelClaim

  1. void postCancelClaim(Task task,
  2. TaskException taskException)
This method is called after a "CANCEL CLAIM" request was executed.
Parameters:
task - The task that has been claimed and where the claim was requested to be canceled.
taskException - The TaskException that occurred or null if no exception occurred.

preClaim

  1. void preClaim(Task task)
  2. throws ApplicationVetoException
This method is called before a "CLAIM" request is executed.
Parameters:
task - The task to be claimed.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postClaim

  1. void postClaim(Task task,
  2. java.lang.Object inputMessage,
  3. TaskException taskException)
Deprecated. since v6.0.2 - use postClaim(Task, Serializable, TaskException)
This method is called after a "CLAIM" request was executed.
Parameters:
task - The task that was requested to be claimed.
inputMessage - The input message.
taskException - The TaskException that occurred or null if no exception occurred.

preComplete

  1. void preComplete(Task task)
  2. throws ApplicationVetoException
This method is called before a "COMPLETE" request is executed.
Parameters:
task - The task to be completed.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postComplete

  1. void postComplete(Task task,
  2. java.io.Serializable outputMessage,
  3. java.lang.String faultName,
  4. java.io.Serializable faultMessage,
  5. TaskException taskException)
This method is called after a "COMPLETE" request was executed.
Parameters:
task - The task that was requested to be completed.
outputMessage - The output message - may be null.
faultName - The fault name if a fault message is passed.
faultMessage - The fault message -may be null.
taskException - The TaskException that occurred or null if no exception occurred.

preCompleteWithFollowOnTask

  1. void preCompleteWithFollowOnTask( Task task,
  2. Task previousTask)
  3. throws ApplicationVetoException
This method is called before a "COMPLETE WITH FOLLOW-ON TASK" request is executed.
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

  1. void postCompleteWithFollowOnTask( Task task,
  2. Task previousTask,
  3. TaskException taskException)
This method is called after a "COMPLETE WITH FOLLOW-ON TASK" request was executed.
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

  1. void preCompleteWithNewFollowOnTask( TaskModel newTaskModel,
  2. TaskTemplate template,
  3. Task previousTask)
  4. 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.

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

  1. void postCompleteWithNewFollowOnTask( Task newTask,
  2. TaskModel newTaskModel,
  3. TaskTemplate template,
  4. Task previousTask,
  5. java.io.Serializable inputMessage,
  6. 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.

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

  1. void preCreateAndCallTask(TaskModel newTaskModel,
  2. TaskTemplate template,
  3. java.io.Serializable inputMessage)
  4. 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.

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

  1. void postCreateAndCallTask(Task task,
  2. TaskModel newTaskModel,
  3. TaskTemplate template,
  4. java.io.Serializable inputMessage,
  5. 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.

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

  1. void preCreateAndStartTask(TaskModel newTaskModel,
  2. TaskTemplate template,
  3. java.io.Serializable inputMessage,
  4. ReplyHandler replyHandler)
  5. 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.

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

  1. void postCreateAndStartTask(Task newTask,
  2. TaskModel newTaskModel,
  3. TaskTemplate template,
  4. java.io.Serializable inputMessage,
  5. ReplyHandler replyHandler,
  6. 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.

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

  1. void preCreateAndStartTaskAsSubTask( TaskModel newTaskModel,
  2. TaskTemplate template,
  3. Task parentTask,
  4. java.io.Serializable inputMessage)
  5. 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.

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

  1. void postCreateAndStartTaskAsSubTask( Task newTask,
  2. TaskModel newTaskModel,
  3. TaskTemplate template,
  4. Task parentTask,
  5. java.io.Serializable inputMessage,
  6. 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.

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

  1. void preCreateTask(TaskModel newTaskModel,
  2. TaskTemplate template,
  3. java.io.Serializable inputMessage,
  4. ReplyHandler replyHandler)
  5. throws ApplicationVetoException
This method is called before a "CREATE TASK" request is executed.
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

  1. void postCreateTask(Task newTask,
  2. TaskModel newTaskModel,
  3. TaskTemplate template,
  4. java.io.Serializable inputMessage,
  5. ReplyHandler replyHandler,
  6. TaskException taskException)
This method is called after a "CREATE TASK" request was executed.
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

  1. void preCreateWorkItem(Task task,
  2. int assignmentReason,
  3. java.lang.String id)
  4. throws ApplicationVetoException
This method is called before a "CREATE WORKITEM" request is executed.
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

  1. void postCreateWorkItem(Task task,
  2. int assignmentReason,
  3. java.lang.String id,
  4. TaskException taskException)
This method is called after a "CREATE WORKITEM" request was executed.
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

  1. void preDeleteTask(Task task)
  2. throws ApplicationVetoException
This method is called before a "DELETE TASK" request is executed.
Parameters:
task - The task that is to be deleted.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postDeleteTask

  1. void postDeleteTask(Task task,
  2. TaskException taskException)
This method is called after a 2DELETE TASK" request was executed.
Parameters:
task - The task that was requested to be deleted.
taskException - The TaskException that occurred or null if no exception occurred.

preDeleteWorkItem

  1. void preDeleteWorkItem(Task task,
  2. int assignmentReason,
  3. java.lang.String id)
  4. throws ApplicationVetoException
This method is called before a "DELETE WORKITEM" request is executed.
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

  1. void postDeleteWorkItem(Task task,
  2. int assignmentReason,
  3. java.lang.String id,
  4. TaskException taskException)
This method is called after a "DELETE WORKITEM" request was executed.
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.

preReplaceWorkItem

  1. void preReplaceWorkItem(Task task,
  2. int assignmentReason,
  3. java.lang.String staffQuery)
  4. throws ApplicationVetoException
Deprecated. since v7.0 - this method is not used.
This method is called before a "REPLACE WORKITEM" request is executed.
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

  1. void postReplaceWorkItem(Task task,
  2. int assignmentReason,
  3. java.lang.String staffQuery,
  4. TaskException taskException)
Deprecated. since v7.0 - this method is not used.
This method is called after a "REPLACE WORKITEM" request was executed.
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

  1. void preRestartTask(Task task)
  2. throws ApplicationVetoException
This method is called before a "RESTART TASK" request is executed.
Parameters:
task - The task that is to be restarted.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postRestartTask

  1. void postRestartTask(Task task,
  2. TaskException taskException)
This method is called after a "RESTART TASK" request was executed.
Parameters:
task - The task that was requested to be restarted.
taskException - The TaskException that occurred or null if no exception occurred.

preResumeTask

  1. void preResumeTask(Task task)
  2. throws ApplicationVetoException
This method is called before a "RESUME TASK" request is executed.
Parameters:
task - The task that is to be resumed.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postResumeTask

  1. void postResumeTask(Task task,
  2. TaskException taskException)
This method is called after a "RESUME TASK" request was executed.
Parameters:
task - The task that was requested to be resumed.
taskException - The TaskException that occurred or null if no exception occurred.

preSetBinaryCustomProperty

  1. void preSetBinaryCustomProperty( Task task,
  2. java.lang.String propertyName,
  3. java.lang.String dataType,
  4. java.io.Serializable propertyValue)
  5. throws ApplicationVetoException
Deprecated. since v6.0.2 - use preSetBinaryCustomProperty(Task, BinaryCustomProperty)
This method is called before a "SET BINARY CUSTOM PROPERTY" request is executed.
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

  1. void postSetBinaryCustomProperty( Task task,
  2. java.lang.String propertyName,
  3. java.lang.String dataType,
  4. java.io.Serializable propertyValue,
  5. TaskException taskException)
Deprecated. since v6.0.2 - use postSetBinaryCustomProperty(Task, BinaryCustomProperty)
This method is called after a "SET BINARY CUSTOM PROPERTY" request was executed.
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.

preSetCustomProperty

  1. void preSetCustomProperty(Task task,
  2. java.lang.String propertyName,
  3. java.lang.String propertyValue)
  4. throws ApplicationVetoException
This method is called before a "SET CUSTOM PROPERTY" request is executed.
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

  1. void postSetCustomProperty(Task task,
  2. java.lang.String propertyName,
  3. java.lang.String propertyValue,
  4. TaskException taskException)
This method is called after a "SET CUSTOM PROPERTY" request was executed.
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

  1. void preSetFaultMessage(Task task,
  2. java.lang.String faultName,
  3. java.io.Serializable faultMessage)
  4. throws ApplicationVetoException
This method is called before a "SET FAULT MESSAGE" request is executed.
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

  1. void postSetFaultMessage(Task task,
  2. java.lang.String faultName,
  3. java.io.Serializable faultMessage,
  4. TaskException taskException)
This method is called after a "SET FAULT MESSAGE" request was executed.
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.

preSetOutputMessage

  1. void preSetOutputMessage(Task task,
  2. java.io.Serializable outputMessage)
  3. throws ApplicationVetoException
This method is called before a "SET OUTPUT MESSAGE" request is executed.
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

  1. void postSetOutputMessage(Task task,
  2. java.io.Serializable outputMessage,
  3. TaskException taskException)
This method is called after a "SET OUTPUT MESSAGE" request was executed.
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.

preStartTask

  1. void preStartTask(Task task,
  2. java.io.Serializable inputMessage,
  3. ReplyHandler replyHandler)
  4. throws ApplicationVetoException
This method is called before a "START TASK" request is executed.
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

  1. void postStartTask(Task task,
  2. java.io.Serializable inputMessage,
  3. ReplyHandler replyHandler,
  4. TaskException taskException)
This method is called after a "START TASK" request was executed.
Parameters:
task - The task that was requested to be started.
inputMessage - the optional input message - may be null.
replyHandler - An optiona reply handler - may be null.
taskException - The TaskException that occurred or null if no exception occurred.

preStartTaskAsSubTask

  1. void preStartTaskAsSubTask(Task task,
  2. Task parentTask,
  3. java.io.Serializable inputMessage)
  4. throws ApplicationVetoException
This method is called before a "START TASK AS SUBTASK" request is executed.
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

  1. void postStartTaskAsSubTask(Task task,
  2. Task parentTask,
  3. java.io.Serializable inputMessage,
  4. TaskException taskException)
This method is called after a "START TASK AS SUBTASK" request was executed.
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

  1. void preSuspendTask(Task task)
  2. throws ApplicationVetoException
This method is called before a "SUSPEND TASK" request is executed.
Parameters:
task - The task to be suspended.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postSuspendTask

  1. void postSuspendTask(Task task,
  2. TaskException taskException)
This method is called after a "SUSPEND TASK" request was executed.
Parameters:
task - The task that was requested to be suspended.
taskException - The TaskException that occurred or null if no exception occurred.

preTerminateTask

  1. void preTerminateTask(Task task)
  2. throws ApplicationVetoException
This method is called before a "TERMINATE TASK" request is executed.
Parameters:
task - The task to be terminated.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postTerminateTask

  1. void postTerminateTask(Task task,
  2. TaskException taskException)
This method is called after a "TERMINATE TASK" request was executed.
Parameters:
task - The task that was requested to be terminated.
taskException - The TaskException that occurred or null if no exception occurred.

preTransferWorkItem

  1. void preTransferWorkItem(Task task,
  2. int assignmentReason,
  3. java.lang.String fromUserId,
  4. java.lang.String toUserId)
  5. throws ApplicationVetoException
This method is called before a "TRANSFER WORKITEM" request is executed.
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

  1. void postTransferWorkItem(Task task,
  2. int assignmentReason,
  3. java.lang.String fromUserId,
  4. java.lang.String toUserId,
  5. TaskException taskException)
This method is called after a "TRANSFER WORKITEM" request was executed.
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.

preUpdateTask

  1. void preUpdateTask(Task task)
  2. throws ApplicationVetoException
This method is called before a "UPDATE TASK" request is executed.
Parameters:
task - The task to be updated.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted

postUpdateTask

  1. void postUpdateTask(Task task,
  2. TaskException taskException)
This method is called after a "UPDATE TASK" request was executed.
Parameters:
task - The task that was requested to be updated.
taskException - The TaskException that occurred or null if no exception occurred.

preUpdateInactiveTask

  1. void preUpdateInactiveTask(Task task,
  2. TaskModel model,
  3. java.io.Serializable inputMessage,
  4. ReplyHandler replyHandler)
  5. throws ApplicationVetoException
This method is called before a "UPDATE INACTIVE TASK" request is executed.
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

  1. void postUpdateInactiveTask(Task task,
  2. java.io.Serializable inputMessage,
  3. ReplyHandler replyHandler,
  4. TaskException taskException)
This method is called after a "UPDATE INACTIVE TASK" request was executed.
Parameters:
task - The task that was requested to be updated.
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.