Search Results delete_options

Overview

OKL_OPTIONS_PUB is the public application programming interface for Oracle Lease and Finance Management (OKL), the ETRM module that manages lease and loan contracts in Oracle E-Business Suite. The package body exposes the Options complex entity, a supporting structure used to capture contract-level and line-level option details (such as purchase options, renewal options, and end-of-term options) along with their associated option values. In EBS 12.1.1 and 12.2.2, this package functions as the outermost, customer-callable layer of the OKL options API stack: it performs customer and vertical-industry pre-processing hook points, delegates the substantive transaction work to the private package OKL_OPTIONS_PVT, and performs post-processing before returning results to the caller.

The package follows the standard Oracle Application Object Library (AOL) API conventions: a version parameter, an initialization-message-list flag, a savepoint mechanism for transactional consistency, and the standard OUT parameters for return status, message count, and message data. Errors are propagated through the FND_API exceptions and retrieved for the caller using FND_MSG_PUB.

Key Procedures and Functions

ETRM documentation lists 23 procedures and functions in this package. The published entry points include:

• CREATE_OPTIONS — Creates the Options root entity together with its associated option value records in a single API call. It accepts an options header record and an option values table, invokes OKL_OPTIONS_PVT.CREATE_OPTIONS, and returns the persisted header and value structures along with the standard API status indicators.
• UPDATE_OPTIONS — Modifies an existing Options entity and its related option values.
• VALIDATE_OPTIONS — Performs validation-only checking of the Options entity without committing data; used for pre-submission verification in forms and custom processes.
• LOCK_OPTIONS — Obtains a logical lock on the Options entity to prevent concurrent modification.
• DELETE_OPTIONS — Removes the Options root entity.
• CREATE_OPTION_VALUES — Creates child option value records independently of the parent header operation.
• LOCK_OPTION_VALUES — Applies a logical lock to specific option value rows.
• UPDATE_OPTION_VALUES — Modifies existing option value records.
• DELETE_OPTION_VALUES — Deletes option value records.
• VALIDATE_OPTION_VALUES — Validates option value data without persisting changes.

Each procedure observes the same return status and message-buffer protocol on the CREATE_OPTIONS pattern shown in the source excerpt.

Tables Accessed

The documented APPS-synonym reference for this package is PLITBLM, a generic PL/SQL index-by table storage structure rather than a business data table. The substantive Options tables are accessed indirectly: OKL_OPTIONS_PUB delegates to OKL_OPTIONS_PVT, which performs the DML against the underlying OKL option header and value tables. Direct DML should never be issued against those base tables; all maintenance is expected to flow through this API layer to preserve validation and locking behaviour. Callers must therefore treat OKL_OPTIONS_PUB as the boundary for read/write access to option data.

Usage Notes

OKL_OPTIONS_PUB is the recommended integration point for any external or custom code that must create, modify, validate, or delete lease options. Typical invocations include OKL contract-entry forms and related UI flows, concurrent programs that import or migrate option data, and custom PL/SQL integrations that build option structures. The package is referenced by seven other packages, confirming that it is embedded in the wider OKL API call graph. Callers must pass a valid API version, honour the initialization flag, inspect x_return_status against the FND_API constants (G_RET_STS_SUCCESS, G_RET_STS_ERROR, G_RET_STS_UNEXP_ERROR), and read messages via FND_MSG_PUB when the status indicates failure.