IBM WebSphere Application ServerTM
Release 8

com.ibm.task.spi
Interface APIEventHandlerPlugin6

All Superinterfaces:
APIEventHandlerPlugin, APIEventHandlerPlugin2, APIEventHandlerPlugin3, APIEventHandlerPlugin4, APIEventHandlerPlugin5
All Known Implementing Classes:
APIEventHandler

public interface APIEventHandlerPlugin6
extends APIEventHandlerPlugin5

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 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 APIEventHandlerPlugin5).

Since:
7.5.1
Version:
7.5.1

Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 void postSetInlineCustomProperties(Task task, java.util.List inlineCustomProperties, TaskException taskException)
          This method is called after a "SET INLINE CUSTOM PROPERTIES" request was executed.
 void postSetInlineCustomProperty(Task task, InlineCustomProperty inlineCustomProperty, TaskException taskException)
          This method is called after a "SET INLINE CUSTOM PROPERTY" request was executed.
 void preSetInlineCustomProperties(Task task, java.util.List inlineCustomProperties)
          This method is called before a "SET INLINE CUSTOM PROPERTIES" request is executed.
 void preSetInlineCustomProperty(Task task, InlineCustomProperty inlineCustomProperty)
          This method is called before a "SET INLINE CUSTOM PROPERTY" request is executed.
 
Methods inherited from interface com.ibm.task.spi.APIEventHandlerPlugin5
postGetTaskAndMarkRead, postSetCustomProperties, postSetTaskRead, postTransferToWorkBasket, postTriggerEscalation, preGetTaskAndMarkRead, preSetCustomProperties, preSetTaskRead, preTransferToWorkBasket, preTriggerEscalation
 
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
 
Methods inherited from interface com.ibm.task.spi.APIEventHandlerPlugin2
postClaim, postCreateWorkItem, postDeleteWorkItem, postSetBinaryCustomProperty, postSetBinaryCustomProperty, postSuspendTaskUntil, postSuspendTaskWithCancelClaim, postTransferWorkItem, preCreateWorkItem, preDeleteWorkItem, preSetBinaryCustomProperty, preSetBinaryCustomProperty, preSuspendTaskUntil, preSuspendTaskWithCancelClaim, preTransferWorkItem
 
Methods inherited from interface com.ibm.task.spi.APIEventHandlerPlugin
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
 

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT
See Also:
Constant Field Values
Method Detail

preSetInlineCustomProperty

void preSetInlineCustomProperty(Task task,
                                InlineCustomProperty inlineCustomProperty)
                                throws ApplicationVetoException
This method is called before a "SET INLINE CUSTOM PROPERTY" request is executed.

Parameters:
task - The task whose inline custom property is to be set.
inlineCustomProperty - The inline custom property to be set.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted.

postSetInlineCustomProperty

void postSetInlineCustomProperty(Task task,
                                 InlineCustomProperty inlineCustomProperty,
                                 TaskException taskException)
This method is called after a "SET INLINE CUSTOM PROPERTY" request was executed.

Parameters:
task - The task whose inline custom property was to be set.
inlineCustomProperty - The inline custom property that was to be set.
taskException - The TaskException that occurred or null if no exception occurred.

preSetInlineCustomProperties

void preSetInlineCustomProperties(Task task,
                                  java.util.List inlineCustomProperties)
                                  throws ApplicationVetoException
This method is called before a "SET INLINE CUSTOM PROPERTIES" request is executed.

Parameters:
task - The task whose inline custom properties is to be set.
inlineCustomProperties - The list of inline custom properties to be set.
Throws:
ApplicationVetoException - if the subsequent execution is to be aborted.

postSetInlineCustomProperties

void postSetInlineCustomProperties(Task task,
                                   java.util.List inlineCustomProperties,
                                   TaskException taskException)
This method is called after a "SET INLINE CUSTOM PROPERTIES" request was executed.

Parameters:
task - The task whose inline custom properties was to be set.
inlineCustomProperties - The list of inline custom properties that was to be set.
taskException - The TaskException that occurred or null if no exception occurred.

IBM WebSphere Application ServerTM
Release 8