com.ibm.task.spi
Interface APIEventHandlerPlugin3
All Superinterfaces:
All known subinterfaces:
All known implementing classes:
- public interface APIEventHandlerPlugin3
- extends APIEventHandlerPlugin2
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 APIEventHandlerPlugin3 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 APIEventHandlerPlugin2
).
Since:
6.0.2
Version:
6.1.0
Field Summary
Modifier and Type | Field and Description |
---|---|
|
COPYRIGHT
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
postSuspendTaskUntil(Task task,java.util.Calendar timeStamp,TaskException taskException)
This method is called after a "SUSPEND TASK UNTIL" request was executed.
|
|
postSuspendTaskUntil(Task task,int duration,TaskException taskException)
This method is called after a "SUSPEND TASK UNTIL" request was executed.
|
|
postSuspendTaskWithCancelClaim(Task task,java.util.Calendar timeStamp,TaskException taskException)
This method is called after a "SUSPEND TASK WITH CANCEL CLAIM" request was executed.
|
|
postSuspendTaskWithCancelClaim(Task task,int duration,TaskException taskException)
This method is called after a "SUSPEND TASK WITH CANCEL CLAIM" request was executed.
|
|
preSuspendTaskUntil(Task task,java.util.Calendar timeStamp)
This method is called before a "SUSPEND TASK UNTIL" request is executed.
|
|
preSuspendTaskUntil(Task task,int duration)
This method is called before a "SUSPEND TASK UNTIL" request is executed.
|
|
preSuspendTaskWithCancelClaim(Task task,java.util.Calendar timeStamp)
This method is called before a "SUSPEND TASK WITH CANCEL CLAIM" request is
executed.
|
|
preSuspendTaskWithCancelClaim(Task task,int duration)
This method is called before a "SUSPEND TASK WITH CANCEL CLAIM" request is
executed.
|
Field Detail
COPYRIGHT
- static final java.lang.String COPYRIGHT
See Also:
Method Detail
preSuspendTaskUntil
- void preSuspendTaskUntil(Task task,
- int 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,
- int 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. preSuspendTaskUntil
- void preSuspendTaskUntil(Task task,
- java.util.Calendar timeStamp)
- throws ApplicationVetoException
This method is called before a "SUSPEND TASK UNTIL" request is executed.
Parameters:
task
- The task to be suspended. timeStamp
- The point in time until then the task is suspended Throws:
ApplicationVetoException
- if the subsequent execution is to be aborted postSuspendTaskUntil
- void postSuspendTaskUntil(Task task,
- java.util.Calendar timeStamp,
- TaskException taskException)
This method is called after a "SUSPEND TASK UNTIL" request was executed.
Parameters:
task
- The task that was requested to be suspended. timeStamp
- The point in time until then the task is suspended taskException
- The TaskException that occurred or null if no exception occurred. preSuspendTaskWithCancelClaim
- void preSuspendTaskWithCancelClaim( Task task,
- int 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,
- int 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. preSuspendTaskWithCancelClaim
- void preSuspendTaskWithCancelClaim( Task task,
- java.util.Calendar timeStamp)
- throws ApplicationVetoException
This method is called before a "SUSPEND TASK WITH CANCEL CLAIM" request is
executed.
Parameters:
task
- The task to be suspended. timeStamp
- The point in time until then the task is suspended Throws:
ApplicationVetoException
- if the subsequent execution is to be aborted postSuspendTaskWithCancelClaim
- void postSuspendTaskWithCancelClaim( Task task,
- java.util.Calendar timeStamp,
- 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. timeStamp
- The point in time until then the task is suspended taskException
- The TaskException that occurred or null if no exception occurred.