Search Results g_exception_halt_validation

Overview

OKL_INDICES_PVT is a private PL/SQL API package in the Oracle E-Business Suite Lease Management (OKL) module, part of the Enterprise Contracts/ETRM product family. It encapsulates the business logic required to create, maintain, validate, lock, and delete lease indices and their associated index values. Index records in OKL represent interest rate or price benchmarks (for example, floating-rate reference indices) that drive variable-rate lease payment calculations. The package is classified as a PVT (private) API, meaning it is intended for internal invocation by other ETRM packages and by public wrapper APIs rather than by customer extensions directly. Its header identifies the source as OKLCIDXB.pls and confirms it is a standard, seeded APPS-owned object present in both 12.1.1 and 12.2.2.

Key Procedures and Functions

The package exposes twenty-three documented procedures and functions organized around two entity groups: the header-level index entity and the detail-level index values. The principal documented procedures include:

• CREATE_INDICES — Creates a header index record and, through an internal recursive call, populates the master index row before populating foreign key values on the detail collection and delegating detail creation to CREATE_INDEX_VALUES. The excerpt confirms this procedure accepts an API version, an initialization message-list flag, standard return status/msg count/msg data OUT parameters, an index header record (idxv_rec_type), and an index values table (ivev_tbl_type).
• UPDATE_INDICES — Modifies an existing index header record.
• VALIDATE_INDICES — Performs business-rule validation on an index header prior to persistence.
• LOCK_INDICES — Acquires a lock on an index header record to serialize concurrent modification.
• DELETE_INDICES — Removes an index header record.
• CREATE_INDEX_VALUES — Creates the detail index value rows belonging to a parent index.
• LOCK_INDEX_VALUES / UPDATE_INDEX_VALUES / DELETE_INDEX_VALUES / VALIDATE_INDEX_VALUES — Provide the corresponding lock, update, delete, and validation operations for the detail rows.

All transactional procedures follow the standard ETRM API convention of returning x_return_status, x_msg_count, and x_msg_data, and they raise the package-level exception G_EXCEPTION_HALT_VALIDATION when an unexpected error is detected, aborting further processing in the calling stack.

Tables Accessed

The package operates primarily against OKL_INDEX_VALUES, accessed through APPS synonyms. This table stores the detail rows holding individual index value entries tied to a parent index header. Writes and reads flow through INSERT, UPDATE, and DELETE statements issued by the CREATE_INDEX_VALUES, UPDATE_INDEX_VALUES, and DELETE_INDEX_VALUES procedures. The package also references PLITBLM, an Oracle Application Object Library table used for message retrieval, which supports the x_msg_count and x_msg_data out-parameters of the standard ETRM API error-handling pattern.

Usage Notes

OKL_INDICES_PVT is referenced by two other ETRM packages, which act as its primary callers; it is typically invoked indirectly rather than called by name from custom code. During the lease indexing flow, a wrapper package calls CREATE_INDICES to persist a new index header along with its detail values in a single logical transaction, and calls UPDATE_INDICES or DELETE_INDICES for subsequent maintenance. Because the API is classified PVT, Oracle does not guarantee signature stability across patches, and custom integrations should prefer the corresponding public API where available. The G_EXCEPTION_HALT_VALIDATION exception identified in the user search is a standard ETRM controlled-stop mechanism: when a delegated call such as create_indices returns OKC_API.G_RET_STS_UNEXP_ERROR, the exception is raised to prevent partial persistence. In 12.1.1 and 12.2.2 the package behaviour and parameter signatures are equivalent, so migration between these releases does not require code changes for existing callers.