UowLockingChangeEventHandler

The UowLockingChangeEventHandler handles the UowLockingChange event.

EXEC specification: com.ibm.paydir.ima.txsvr.event.appbridge.UowLockingChangeEventHandler

This event handler issues a Messaging API message on the JMS send queue when a unit of work is locked or unlocked for editing. The unit of work can be a batch (ICL), an inbound transmission, or an entry.

Event parameters

This event handler uses the general Messaging API event handler parameters and parameters that are specific to the event. Event parameters are specified in the Scheduler.xml file.

Table 1 shows the additional event parameters for the unit of work locking change event handler.
Table 1. UowLockingChangeEventHandler parameters
Parameter name Type Value Description
uowTypes String Any of the following values:
  • PRESENTMENT_ID
  • PRESENTMENT_GROUP_ID
  • ENTRY_ID
 A comma delimited set of type codes for a unit of work, any one of which must match the posting unit of work type being locked. By default, all unit of work types post the locking event if this parameter is not specified or is an empty string.
lockingDir Boolean True or false Specifies whether the locking event is to be posted for a lock (true) or an unlock (false) operation. The default is to post the locking event for both locking directions.
actionType Short 0 or 1 Specifies that the locking event is to be posted only for the indicated action type. The default is to post the locking event for all action types.

Message contents

When the message is delivered to the target application, it contains the information that is shown in Table 2.
Table 2. Message content for UowLockingChangeEventHandler
Message part Value Description
Unit-of-Work UOW The unit of work data object (UOW) being locked. This unit of work data object has a type of PRESENTMENT_ID, PRESENTMENT_GROUP_ID, or ENTRY_ID depending on the artifact being locked.
Payload com.ibm.paydir.ima.txacc.app.bridge.UowLockingChangeEventPayload Additional details for the unit of work being locked. The UowLockingChangeEventPayload class is an example of the type of payload delivered. This payload provides the accessor methods shown in Table 3 to retrieve the details for the unit of work.
The com.ibm.paydir.ima.txacc.app.bridge.UowLockingChangeEventPayload data object has the accessor methods shown in Table 3 for retrieving the locking details.
Table 3. UowLockingChangeEventHandler accessor methods
Method name Return type Description
isLocked ( ) Boolean Retrieves the unit of work locking direction:
  • Lock (true)
  • Unlock (false)
getLockedBy ( ) String Retrieves the user ID that locked the unit of work
getActionType ( ) Short Retrieves the unit of work locking action type code
getBusinessDayId ( ) Long Retrieves the unit of work locking business day identifier

Response processing

The UowLockingChangeEventHandler does not expect a reply.

Example handler XML

The example XML shows a presLocked Messaging API message sent on the UOW_EDIT.QUEUE on localhost. The message is sent when a unit of work of type PRESENTMENT_ID or PRESENTMENT_GROUP_ID is locked for editing. The message is posted only for batches (ICLs) and inbound transmissions that are locked since the lockingDir is set to true. Unlocked transitions are ignored by this XML event handler specification. 
<EVENT>
   <NAME>UOW Presentment Locked</NAME>
   <TYPE>UowLockingChange</TYPE>
   <EXEC>
      com.ibm.paydir.ima.txsvr.event.appbridge.UowLockingChangeEventHandler
   </EXEC>
   <PARAMETER name="msgType">presLocked</PARAMETER>
   <PARAMETER name="uowTypes">PRESENTMENT_ID,PRESENTMENT_GROUP_ID</PARAMETER>
   <PARAMETER name="lockingDir">TRUE</PARAMETER>
   <PARAMETER name="destinationID">UOW Editing Services</PARAMETER>
   <PARAMETER name="jmsQmgrHostname">localhost</PARAMETER>
   <PARAMETER name="jmsQmgrChannel">SYSTEM.DEF.SVRCONN</PARAMETER>
   <PARAMETER name="jmsQmgrPort">1414</PARAMETER>
   <PARAMETER name="jmsClient">true</PARAMETER>
   <PARAMETER name="jmsQmgrName">FTM.QMANAGER</PARAMETER>
   <PARAMETER name="jmsSendQueue">UOW_EDIT.QUEUE</PARAMETER>
</EVENT>