Trading Networks 10.3 | Administering and Monitoring B2B Transactions | Trading Networks Built-In Services Reference | TPA Folder | Summary of Elements in this Folder | wm.tn.tpa:getTPALock
 
wm.tn.tpa:getTPALock
Requests a lock for the TPA that matches the given senderID, receiverID, and agreementID.
The service blocks until a lock is available. If the TPA does not exist, the service reports an error. For other service invocation- or database-related errors, it throws an exception. When an application is done with a lock, it must release the lock using wm.tn.tpa:releaseTPALock. You can use only the following services within a locking block:
* wm.tn.tpa:getTPAInLock
* wm.tn.tpa:updateControlNumberInLock
* wm.tn.tpa:updateTPADataInLock
* wm.tn.tpa:setLockError
Input Parameters
senderID
String The internal ID of the trading partner that has the sender role in the transaction the TPA governs.
receiverID
String The internal ID of the trading partner that has the receiver role in the transaction the TPA governs.
agreementID
String The agreement ID of the TPA.
Output Parameters
lock
Object The lock object returned by the service.
error
Document List The error reported by the service. If no error is found, this is null.