com.ibm.task.spi
Interface APIEventHandlerPlugin2
All Superinterfaces:
All known subinterfaces:
All known implementing classes:
- public interface APIEventHandlerPlugin2
- extends APIEventHandlerPlugin
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 APIEventHandlerPlugin2 service provider interface (SPI) to create plug-ins to get informed about events sent 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 for methods that are called as API pre- or
post-events (extends APIEventHandlerPlugin
).
Since:
6.0.2
Version:
6.0.2
Field Summary
Modifier and Type | Field and Description |
---|---|
|
COPYRIGHT
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
postClaim(Task task,java.io.Serializable inputMessage,TaskException taskException)
This method is called after a "CLAIM" request was executed.
|
|
postCreateWorkItem(Escalation escalation,int assignmentReason,java.lang.String id,TaskException taskException)
This method is called after a "CREATE WORKITEM" request was executed.
|
|
postDeleteWorkItem(Escalation escalation,int assignmentReason,java.lang.String id,TaskException taskException)
This method is called after a "DELETE WORKITEM" request was executed.
|
|
postSetBinaryCustomProperty(Escalation escalation,BinaryCustomProperty property,TaskException taskException)
This method is called after a "SET BINARY CUSTOM PROPERTY" for an escalation request was
executed.
|
|
postSetBinaryCustomProperty(Task task,BinaryCustomProperty property,TaskException taskException)
This method is called after a "SET BINARY CUSTOM PROPERTY" for a task request was
executed.
|
|
postSuspendTaskUntil(Task task,java.lang.String duration,TaskException taskException)
This method is called after a "SUSPEND TASK UNTIL" request was executed.
|
|
postSuspendTaskWithCancelClaim(Task task,java.lang.String duration,TaskException taskException)
This method is called after a "SUSPEND TASK WITH CANCEL CLAIM" request was executed.
|
|
postTransferWorkItem(Escalation escalation,int assignmentReason,java.lang.String fromUserId,java.lang.String toUserId,TaskException taskException)
This method is called after a "TRANSFER WORKITEM" request was executed.
|
|
preCreateWorkItem(Escalation escalation,int assignmentReason,java.lang.String id)
This method is called before a "CREATE WORKITEM" request is executed.
|
|
preDeleteWorkItem(Escalation escalation,int assignmentReason,java.lang.String id)
This method is called before a "DELETE WORKITEM" request is executed.
|
|
preSetBinaryCustomProperty(Escalation escalation,BinaryCustomProperty property)
This method is called before a "SET BINARY CUSTOM PROPERTY" for an escalation request is
executed.
|
|
preSetBinaryCustomProperty(Task task,BinaryCustomProperty property)
This method is called before a "SET BINARY CUSTOM PROPERTY" for a task request is
executed.
|
|
preSuspendTaskUntil(Task task,java.lang.String duration)
This method is called before a "SUSPEND TASK UNTIL" request is executed.
|
|
preSuspendTaskWithCancelClaim(Task task,java.lang.String duration)
This method is called before a "SUSPEND TASK WITH CANCEL CLAIM" request is
executed.
|
|
preTransferWorkItem(Escalation escalation,int assignmentReason,java.lang.String fromUserId,java.lang.String toUserId)
This method is called before a "TRANSFER WORKITEM" request is executed.
|
Field Detail
COPYRIGHT
- static final java.lang.String COPYRIGHT
See Also:
Method Detail
postClaim
- void postClaim(Task task,
- java.io.Serializable inputMessage,
- TaskException 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. preCreateWorkItem
- void preCreateWorkItem(Escalation escalation,
- int assignmentReason,
- java.lang.String id)
- throws ApplicationVetoException
This method is called before a "CREATE WORKITEM" request is executed.
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
- void postCreateWorkItem(Escalation escalation,
- int assignmentReason,
- java.lang.String id,
- TaskException taskException)
This method is called after a "CREATE WORKITEM" request was executed.
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. preDeleteWorkItem
- void preDeleteWorkItem(Escalation escalation,
- int assignmentReason,
- java.lang.String id)
- throws ApplicationVetoException
This method is called before a "DELETE WORKITEM" request is executed.
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
- void postDeleteWorkItem(Escalation escalation,
- int assignmentReason,
- java.lang.String id,
- TaskException taskException)
This method is called after a "DELETE WORKITEM" request was executed.
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. preSetBinaryCustomProperty
- void preSetBinaryCustomProperty( Escalation escalation,
- BinaryCustomProperty property)
- throws ApplicationVetoException
This method is called before a "SET BINARY CUSTOM PROPERTY" for an escalation request is
executed.
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
- void postSetBinaryCustomProperty( Escalation escalation,
- BinaryCustomProperty property,
- TaskException taskException)
This method is called after a "SET BINARY CUSTOM PROPERTY" for an escalation request was
executed.
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
- void preSetBinaryCustomProperty( Task task,
- BinaryCustomProperty property)
- throws ApplicationVetoException
This method is called before a "SET BINARY CUSTOM PROPERTY" for a task request is
executed.
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
- void postSetBinaryCustomProperty( Task task,
- BinaryCustomProperty property,
- TaskException taskException)
This method is called after a "SET BINARY CUSTOM PROPERTY" for a task request was
executed.
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. preSuspendTaskUntil
- void preSuspendTaskUntil(Task task,
- java.lang.String duration)
- throws ApplicationVetoException
This method is called before a "SUSPEND TASK UNTIL" request is executed.
Parameters:
task
- The task to be suspended. duration
- The duration of the suspension. Throws:
ApplicationVetoException
- if the subsequent execution is to be aborted postSuspendTaskUntil
- void postSuspendTaskUntil(Task task,
- java.lang.String duration,
- TaskException taskException)
This method is called after a "SUSPEND TASK UNTIL" request was executed.
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
- void preSuspendTaskWithCancelClaim( Task task,
- java.lang.String duration)
- throws ApplicationVetoException
This method is called before a "SUSPEND TASK WITH CANCEL CLAIM" request is
executed.
Parameters:
task
- The task to be suspended. duration
- The duration of the suspension. Throws:
ApplicationVetoException
- if the subsequent execution is to be aborted postSuspendTaskWithCancelClaim
- void postSuspendTaskWithCancelClaim( Task task,
- java.lang.String duration,
- TaskException taskException)
This method is called after a "SUSPEND TASK WITH CANCEL CLAIM" request was executed.
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. preTransferWorkItem
- void preTransferWorkItem(Escalation escalation,
- int assignmentReason,
- java.lang.String fromUserId,
- java.lang.String toUserId)
- throws ApplicationVetoException
This method is called before a "TRANSFER WORKITEM" request is executed.
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
- void postTransferWorkItem(Escalation escalation,
- int assignmentReason,
- java.lang.String fromUserId,
- java.lang.String toUserId,
- TaskException taskException)
This method is called after a "TRANSFER WORKITEM" request was executed.
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.