Search Results okl_maintain_contract_pvt




Overview
Explore in AI Chat

Overview

The APPS.OKL_MAINTAIN_CONTRACT_PVT package is a private API within the Oracle E-Business Suite Lease and Finance Management (formerly Oracle Lease Management / OKL) module. It is owned by the APPS schema and classified as a PVT (private) API, meaning it is intended for internal consumption by the OKL application layer rather than as a supported public interface for customer extensions. The package encapsulates core contract maintenance operations that act upon lease contract headers, lines, and related transactional records. The header comment identifies the package with AUTHID CURRENT_USER and the standard OKL error-handling constants (G_UNEXPECTED_ERROR, G_SQLCODE_TOKEN, G_SQLERRM_TOKEN), reflecting adherence to Oracle's PL/SQL API coding standards involving message stack handling and return-status conventions.

The business function served is the controlled maintenance and status transition of lease contracts — most notably the confirmation or cancellation of a contract — while preserving referential integrity across the underlying OKC contract tables and OKL transaction tables.

Key Procedures and Functions

The ETRM metadata documents a single procedure within this package:

  • CONFIRM_CANCEL_CONTRACT — As described in the source comment, this API "takes the contract id as input and returns the status of operation." It accepts a contract identifier and a new contract number, and returns the outcome of the operation through Oracle's standard API return-status parameters (x_return_status, x_msg_count, and x_msg_data). The procedure signatures follow the standard OKL API convention with p_api_version and p_init_msg_list input parameters. It is this procedure that the search term "confirm_cancel_contract" resolves to.

No other procedures or functions are documented for this package. Developers should not assume the existence of undocumented entry points.

Tables Accessed

The package interacts, via APPS synonyms, with the following documented tables:

These tables indicate that confirmation or cancellation of a contract affects not only the header and line records but also associated invoices and party roles, ensuring downstream financial consistency.

Usage Notes

Because this is a private (PVT) package, it is not exposed as a supported public API. It is typically invoked by other OKL packages — the metadata notes it is referenced by two other packages — which collectively form the internal contract lifecycle logic. It may also be called from OKL forms (such as the Lease Management contract forms) during user-initiated confirm or cancel actions, and potentially from concurrent programs that process contract batches. Custom code should invoke the supported public OKL API layer rather than calling OKL_MAINTAIN_CONTRACT_PVT.CONFIRM_CANCEL_CONTRACT directly, since private APIs are subject to change between releases and provide no backward-compatibility guarantee. Callers must supply a valid contract ID and new contract number, and must correctly interpret the returned x_return_status value (typically OKL_API.G_RET_STS_SUCCESS or G_RET_STS_ERROR) along with the associated message stack.