Search Results okl_options_pvt




Overview
Explore in AI Chat

Overview

The APPS.OKL_OPTIONS_PVT package body is a private (PVT-classified) PL/SQL API within the Oracle E-Business Suite ETRM (Enterprise Transaction and Reference Management) module, specifically the Oracle Lease and Finance Management (OKL) schema. It provides the internal business logic that governs lease and finance options — the configurable contractual features attached to lease agreements, such as purchase options, renewal terms, termination clauses, and associated option values. As a private package, OKL_OPTIONS_PVT is not intended for direct invocation by external consumers; it is normally called by its public counterpart, OKL_OPTIONS_PUB, and other internal APIs. The package encapsulates create, update, delete, lock, and validation operations for both the option header and its dependent option-value records, enforcing ETRM business rules, referential integrity, and multi-row concurrency handling. Its VALID status in both 12.1.1 and 12.2.2 confirms the object is compiled and operational across these releases.

Key Procedures and Functions

The package exposes 23 documented procedures and functions. The core option-lifecycle operations include:

  • CREATE_OPTIONS — Creates a new option header record for a lease or finance instrument.
  • UPDATE_OPTIONS — Modifies an existing option header.
  • VALIDATE_OPTIONS — Performs business-rule validation on option header data prior to persistence.
  • LOCK_OPTIONS — Acquires a concurrency lock on an option record.
  • DELETE_OPTIONS — Removes an option header.

The option-value subset mirrors this lifecycle for the child records that hold an option’s individual value entries:

Additional helper members (within the 23 total) support internal logic such as defaulting, lookups, and dependency coordination. Parameter lists are not documented here and should not be assumed.

Tables Accessed

Per the documented dependency metadata, the package references the PLITBLM table via APPS synonyms; PLITBLM is the standard ETRM/PL-SQL index-by table that stores multi-row DML collections for bulk processing, enabling the package to insert, update, or delete sets of option and option-value records efficiently. The package also directly depends on the view OKL_OPT_VALUES_V, which surfaces option-value data, and on the related PL/SQL units OKL_OPT_PVT, OKL_OVE_PVT, OKC_API, and FND_API. The OKC_API and FND_API dependencies indicate the package relies on the ETRM contract API layer and the Oracle Application Object Library API for standardized error handling (for example, FND_MSG_PUB) and API conventions, while OKL_OPT_PVT and OKL_OVE_PVT supply lower-level option and option-value handling. Underlying base option tables are accessed indirectly through these dependencies rather than named explicitly in the metadata.

Usage Notes

OKL_OPTIONS_PVT is a private API and is not referenced by any other database object per the documented metadata, although the ETRM 12.2.2 metadata records it as referenced by 2 other packages (typically OKL_OPTIONS_PUB and a related processing unit). It is invoked internally when ETRM option data must be persisted, validated, or locked:

  • Oracle Forms — Lease and option setup or maintenance forms in the OKL module call the public wrapper, which delegates to this private body.
  • Concurrent programs — Batch processes that generate, copy, or default lease options invoke it as part of their transaction logic.
  • Custom extensions — Developers should not call private APIs such as this directly; the supported integration point is the corresponding public (PUB) package. Any custom code should be restricted to documented public interfaces to preserve upgrade safety across 12.1.1 and 12.2.2.

Because the object is VALID and relies on standard FND/OKC error-handling, error messages should be retrieved through the standard API message stack rather than interpreted directly.