public interface APIEventHandlerPlugin4 extends APIEventHandlerPlugin3
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 APIEventHandlerPlugin4 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 APIEventHandlerPlugin3
).
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT |
Modifier and Type | Method and Description |
---|---|
void |
postSetInputMessage(Task task,
java.io.Serializable inputMessage,
TaskException taskException)
This method is called after a "SET INPUT MESSAGE" request was executed.
|
void |
postUpdateEscalation(Escalation escalation,
TaskException taskException)
This method is called after an "UPDATE ESCALATION" request was executed.
|
void |
preSetInputMessage(Task task,
java.io.Serializable inputMessage)
This method is called before a "SET INPUT MESSAGE" request is executed.
|
void |
preUpdateEscalation(Escalation escalation)
This method is called before an "UPDATE ESCALATION" request is executed.
|
postSuspendTaskUntil, postSuspendTaskUntil, postSuspendTaskWithCancelClaim, postSuspendTaskWithCancelClaim, preSuspendTaskUntil, preSuspendTaskUntil, preSuspendTaskWithCancelClaim, preSuspendTaskWithCancelClaim
postClaim, postCreateWorkItem, postDeleteWorkItem, postSetBinaryCustomProperty, postSetBinaryCustomProperty, postSuspendTaskUntil, postSuspendTaskWithCancelClaim, postTransferWorkItem, preCreateWorkItem, preDeleteWorkItem, preSetBinaryCustomProperty, preSetBinaryCustomProperty, preSuspendTaskUntil, preSuspendTaskWithCancelClaim, preTransferWorkItem
postCallTask, postCancelClaim, postClaim, postComplete, postCompleteWithFollowOnTask, postCompleteWithNewFollowOnTask, postCreateAndCallTask, postCreateAndStartTask, postCreateAndStartTaskAsSubTask, postCreateTask, postCreateWorkItem, postDeleteTask, postDeleteWorkItem, postReplaceWorkItem, postRestartTask, postResumeTask, postSetBinaryCustomProperty, postSetCustomProperty, postSetFaultMessage, postSetOutputMessage, postStartTask, postStartTaskAsSubTask, postSuspendTask, postTerminateTask, postTransferWorkItem, postUpdateInactiveTask, postUpdateTask, preCallTask, preCancelClaim, preClaim, preComplete, preCompleteWithFollowOnTask, preCompleteWithNewFollowOnTask, preCreateAndCallTask, preCreateAndStartTask, preCreateAndStartTaskAsSubTask, preCreateTask, preCreateWorkItem, preDeleteTask, preDeleteWorkItem, preReplaceWorkItem, preRestartTask, preResumeTask, preSetBinaryCustomProperty, preSetCustomProperty, preSetFaultMessage, preSetOutputMessage, preStartTask, preStartTaskAsSubTask, preSuspendTask, preTerminateTask, preTransferWorkItem, preUpdateInactiveTask, preUpdateTask
static final java.lang.String COPYRIGHT
void preSetInputMessage(Task task, java.io.Serializable inputMessage) throws ApplicationVetoException
task
- The task whose input message is to be set.inputMessage
- The input message.ApplicationVetoException
- if the subsequent execution is to be abortedvoid postSetInputMessage(Task task, java.io.Serializable inputMessage, TaskException taskException)
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.void preUpdateEscalation(Escalation escalation) throws ApplicationVetoException
escalation
- The escalation that will be updated.ApplicationVetoException
- if the subsequent execution is to be abortedvoid postUpdateEscalation(Escalation escalation, TaskException taskException)
escalation
- The escalation that was requested to be updated.taskException
- The TaskException that occurred or null if no exception occurred.