Search Results okl_orl_pvt




Overview
Explore in AI Chat

Overview

OKL_ORL_PVT is a private (PVT) PL/SQL package in the Oracle E-Business Suite Lease Management (OKL) module, part of the Enterprise Trading and Risk Management (ETRM) product family. It operates on the OKL_OPT_RULES entity, which stores the overall instructions and rules associated with lease option lines. The package name derives from "ORL," the internal shorthand for the option rules record, and it provides the low-level data manipulation and validation layer that public APIs and forms call into rather than accessing OKL_OPT_RULES directly.

The package is declared AUTHID CURRENT_USER, meaning it executes with the privileges of the calling session rather than the package owner. All global record structures carry default values of OKC_API.G_MISS_NUM, G_MISS_CHAR, or G_MISS_DATE. This convention allows the API layer to distinguish between a column that the caller explicitly set and one that was never populated, which is essential for partial updates and copy operations.

Key Procedures and Functions

The documented interface exposes thirteen procedures and functions organized around a standard table-handler pattern:

  • INSERT_ROW — Creates a new OKL_OPT_RULES record from the orl_rec_type structure and returns the generated identifier.
  • UPDATE_ROW — Modifies an existing option rules row, applying only those attributes the caller has populated.
  • DELETE_ROW — Removes an option rules record.
  • LOCK_ROW — Acquires a row-level lock to serialize concurrent modification before update or delete.
  • VALIDATE_ROW — Checks required attributes, foreign key relationships, and business rules prior to persistence.
  • CHANGE_VERSION — Increments the OBJECT_VERSION_NUMBER column to support optimistic locking.
  • API_COPY — Duplicates an existing option rules record, remapping identifiers as required by the target context.
  • QC — Performs a query-check routine, typically used to confirm row existence or state consistency.

The package also defines the orl_rec_type and orlv_rec_type record types and the orl_tbl_type PL/SQL table, which serve as the public data contract for callers. The orlv_rec_type reads from OKL_OPT_RULES_V, the validation view.

Tables Accessed

The package interacts with two documented objects through APPS synonyms:

  • OKL_OPT_RULES — The base table holding option rules. All insert, update, delete, and lock operations target this table. The columns referenced include ID, OPT_ID, RGR_RGD_CODE, RGR_RDF_CODE, SRD_ID_FOR, LRG_LSE_ID, LRG_SRD_ID, OVERALL_INSTRUCTIONS, and the standard WHO audit columns.
  • PLITBLM — The PL/SQL implementation table (index-by table) used to shuttle record sets between the private package and its callers without a database round trip for each row.

The validation view OKL_OPT_RULES_V is referenced for the orlv_rec_type structure, though it is not listed among the base table synonyms.

Usage Notes

OKL_ORL_PVT is referenced by nine other packages, indicating it sits near the bottom of the OKL call stack. It is not intended for direct invocation from end-user code; instead, public APIs and the Lease Management forms call it. Customizations should target the documented public API that wraps these operations rather than OKL_ORL_PVT directly, because private packages may change signature between patch levels. If direct calls are unavoidable, callers should always invoke VALIDATE_ROW and LOCK_ROW before UPDATE_ROW or DELETE_ROW, and should use CHANGE_VERSION when implementing optimistic concurrency. Because the header carries a 115.5 version stamp dated 2002, the package has been stable across 11i and the 12.1.1/12.2.2 releases.