Search Results okl_trx_contracts_pub




Overview
Explore in AI Chat

Overview

OKL_TRX_CONTRACTS_PUB is the public, or PUB-classified, PL/SQL API for the Oracle E-Business Suite Lease Management (formerly Oracle Lease and Finance Management) transaction contract entity. It is the externally callable wrapper that exposes the business operations needed to create, modify, validate, lock, and delete lease and financing transaction contracts and their associated contract lines. The package sits within the OKL (Leasing) schema objects but is owned by APPS and runs with the standard EBS concurrent and forms privileges.

The underlying source file (OKLPTCNB.pls) shows the package was authored in the early 11i era and carried forward into 12.1.1 and 12.2.2 largely unchanged. The public wrappers delegate the substantive work to a private companion package, OKL_TRX_CONTRACTS_PVT, following the standard EBS API layering convention of separating public signatures from private implementation. Each public procedure performs preprocessing and postprocessing, calls the private API, and maps return statuses and message counts back to the caller.

Key Procedures and Functions

The documented API surface contains twenty-three procedures and functions, including these principal entry points:

  • CREATE_TRX_CONTRACTS — creates a new transaction contract header together with its contract lines. It accepts an API version, initialization flag, header record, and line table, and returns the created header and lines along with the standard return status, message count, and message data outputs.
  • UPDATE_TRX_CONTRACTS — modifies an existing transaction contract header and its line collection.
  • VALIDATE_TRX_CONTRACTS — performs business-rule validation against the contract without persisting changes.
  • LOCK_TRX_CONTRACTS — obtains a concurrency lock on the contract header so competing sessions cannot modify it simultaneously.
  • DELETE_TRX_CONTRACTS — removes a contract and its dependent lines.
  • CREATE_TRX_CNTRCT_LINES — creates one or more contract lines for an existing contract.
  • LOCK_TRX_CNTRCT_LINES — the procedure corresponding to the user search term "lock_trx_cntrct_lines"; it acquires a concurrency lock on the contract line rows to protect them during an update or delete operation.
  • UPDATE_TRX_CNTRCT_LINES — modifies existing contract line attributes.
  • DELETE_TRX_CNTRCT_LINES — removes contract lines from a contract.
  • VALIDATE_TRX_CNTRCT_LINES — validates contract line data against lease business rules.

All procedures follow the OKC_API/FND_API conventions: a SAVEPOINT is established at entry, exceptions are trapped as G_EXC_ERROR or G_EXC_UNEXPECTED_ERROR, and on failure the transaction is rolled back to the savepoint before the status and messages are returned. This makes each call atomic and safe to invoke from within larger transactions.

Tables Accessed

The documented metadata lists PLITBLM as the table referenced through APPS synonyms. This is a standard EBS message-handling table used to store and retrieve API messages. The actual contract and contract line rows are manipulated by the delegated private package, OKL_TRX_CONTRACTS_PVT, which operates on the OKL transaction contract tables (such as OKL_TRX_CONTRACTS and OKL_TRX_CONTRACT_LINES). The public package itself is therefore thin: it validates inputs, locks the appropriate rows, and forwards the work to the private layer.

Usage Notes

The package is referenced by approximately forty other database objects, which indicates it is a widely consumed integration point rather than an end-user-facing object. It is typically invoked from Lease Management forms, from concurrent programs that originate contracts from order or quote data, and from custom PL/SQL extensions that need to create or maintain lease contracts programmatically. Because the public routines commit or roll back only to their internal savepoint, callers retain control of the enclosing transaction and can chain multiple API calls.

When locking contract lines — as implied by the search term lock_trx_cntrct_lines — the recommended pattern is to call LOCK_TRX_CNTRCT_LINES before UPDATE_TRX_CNTRCT_LINES or DELETE_TRX_CNTRCT_LINES to prevent concurrent modification and lost updates. Callers should always inspect x_return_status and consume x_msg_count/x_msg_data through FND_MSG_PUB to surface validation errors.