com.ibm.task.spi
Interface APIEventHandlerPlugin5
All Superinterfaces:
All known subinterfaces:
All known implementing classes:
- public interface APIEventHandlerPlugin5
- extends APIEventHandlerPlugin4
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 APIEventHandlerPlugin5 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 APIEventHandlerPlugin4
).
Since:
7.0.0
Version:
7.0.0
Field Summary
Modifier and Type | Field and Description |
---|---|
|
COPYRIGHT
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
postGetTaskAndMarkRead(Task task,TaskException taskException)
This method is called after a "GET TASK AND MARK READ" request was executed.
|
|
postSetCustomProperties(Task task,java.util.List customProperties,TaskException taskException)
This method is called after a "SET CUSTOM PROPERTIES" request was executed.
|
|
postSetTaskRead(Task task,boolean taskRead,TaskException taskException)
This method is called after a "SET TASK READ" request was executed.
|
|
postTransferToWorkBasket(Task task,java.lang.String workBasketName,boolean preserveTransferState,TaskException taskException)
This method is called after a "TRANSFER TO WORK BASKET" request was executed.
|
|
postTriggerEscalation(Escalation escalation,TaskException taskException)
This method is called after a "TRIGGER ESCALATION" request was executed.
|
|
preGetTaskAndMarkRead(Task task)
This method is called before a "GET TASK AND MARK READ" request is executed.
|
|
preSetCustomProperties(Task task,java.util.List customProperties)
This method is called before a "SET CUSTOM PROPERTIES" request is executed.
|
|
preSetTaskRead(Task task,boolean taskRead)
This method is called before a "SET TASK READ" request is executed.
|
|
preTransferToWorkBasket(Task task,java.lang.String workBasketName,boolean preserveTransferState)
This method is called before a "TRANSFER TO WORK BASKET" request is executed.
|
|
preTriggerEscalation(Escalation escalation)
This method is called before a "TRIGGER ESCALATION" request is executed.
|
Methods inherited from interface com.ibm.task.spi.APIEventHandlerPlugin4 |
---|
postSetInputMessage, postUpdateEscalation, preSetInputMessage, preUpdateEscalation |
Methods inherited from interface com.ibm.task.spi.APIEventHandlerPlugin3 |
---|
postSuspendTaskUntil, postSuspendTaskUntil, postSuspendTaskWithCancelClaim, postSuspendTaskWithCancelClaim, preSuspendTaskUntil, preSuspendTaskUntil, preSuspendTaskWithCancelClaim, preSuspendTaskWithCancelClaim |
Field Detail
COPYRIGHT
- static final java.lang.String COPYRIGHT
See Also:
Method Detail
preGetTaskAndMarkRead
- void preGetTaskAndMarkRead(Task task)
- throws ApplicationVetoException
This method is called before a "GET TASK AND MARK READ" request is executed.
Parameters:
task
- The task whose read property is to be set and returned. Throws:
ApplicationVetoException
- if the subsequent execution is to be aborted. postGetTaskAndMarkRead
- void postGetTaskAndMarkRead(Task task,
- TaskException taskException)
This method is called after a "GET TASK AND MARK READ" request was executed.
Parameters:
task
- The task whose read property was to be set and returned. taskException
- The TaskException that occurred or null if no exception occurred. preSetCustomProperties
- void preSetCustomProperties(Task task,
- java.util.List customProperties)
- throws ApplicationVetoException
This method is called before a "SET CUSTOM PROPERTIES" request is executed.
Parameters:
task
- The task for which the custom properties are to be set. customProperties
- The list of custom properties
. Throws:
ApplicationVetoException
- if the subsequent execution is to be aborted. postSetCustomProperties
- void postSetCustomProperties(Task task,
- java.util.List customProperties,
- TaskException taskException)
This method is called after a "SET CUSTOM PROPERTIES" request was executed.
Parameters:
task
- The task whose custom properties were requested to be set. customProperties
- The list of custom properties
. taskException
- The TaskException that occurred or null if no exception occurred. preSetTaskRead
- void preSetTaskRead(Task task,
- boolean taskRead)
- throws ApplicationVetoException
This method is called before a "SET TASK READ" request is executed.
Parameters:
task
- The task whose read property is to be set. taskRead
- The new value of the read flag. Throws:
ApplicationVetoException
- if the subsequent execution is to be aborted. postSetTaskRead
- void postSetTaskRead(Task task,
- boolean taskRead,
- TaskException taskException)
This method is called after a "SET TASK READ" request was executed.
Parameters:
task
- The task whose read property was to be set. taskRead
- The new value of the read flag. taskException
- The TaskException that occurred or null if no exception occurred. preTransferToWorkBasket
- void preTransferToWorkBasket(Task task,
- java.lang.String workBasketName,
- boolean preserveTransferState)
- throws ApplicationVetoException
This method is called before a "TRANSFER TO WORK BASKET" request is executed.
Parameters:
task
- The task that is to be transferred to another work basket. workBasketName
- The target work basket where this task is to be transferred to. preserveTransferState
- The flag indicating if the transferredToWorkBasket
property of the task should be changed as part of this transfer operation. Throws:
ApplicationVetoException
- if the subsequent execution is to be aborted. postTransferToWorkBasket
- 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.
Parameters:
task
- The task that was transferred to another work basket. workBasketName
- The target work basket where this task was transferred to. preserveTransferState
- The flag indicating if the transferredToWorkBasket
property of the task should be changed as part of this transfer operation. taskException
- The TaskException that occurred or null if no exception occurred. preTriggerEscalation
- void preTriggerEscalation(Escalation escalation)
- throws ApplicationVetoException
This method is called before a "TRIGGER ESCALATION" request is executed.
Parameters:
escalation
- The escalation that will be triggered. Throws:
ApplicationVetoException
- if the subsequent execution is to be aborted postTriggerEscalation
- void postTriggerEscalation(Escalation escalation,
- TaskException taskException)
This method is called after a "TRIGGER ESCALATION" request was executed.
Parameters:
escalation
- The escalation that was triggered. taskException
- The TaskException that occurred or null if no exception occurred.