Search Results okl_cs_create_quote_pub




Overview
Explore in AI Chat

Overview

OKL_CS_CREATE_QUOTE_PUB is a public PL/SQL API package in the Oracle E-Business Suite Lease Management (Oracle Lease and Finance Management, module prefix OKL) schema, owned by APPS. It provides the supported, external entry point for creating and terminating lease quotes within the contract and service authoring flow. The package is classified as a PUB (public) API, meaning its specification is exposed for invocation by forms, concurrent programs, and external integrations rather than being restricted to internal private use. Its declaration uses AUTHID CURRENT_USER, so execution privileges and unqualified name resolution follow the calling schema's context.

The package header carries the standard ETRM API conventions: global constants identify the application (G_APP_NAME := 'OKL'), the package (G_PKG_NAME), the logical API name (G_API_NAME := 'OKL_CS_CREATE_QUOTE'), an API version (G_API_VERSION := 1), commit and initialization flags, and a full validation level (FND_API.G_VALID_LEVEL_FULL). These constants indicate the package adheres to the Oracle Application Object Library API framework, including the standard message list handling, return status, and validation semantics used across Oracle EBS public APIs.

Key Procedures and Functions

The documented specification exposes a single procedure:

  • create_terminate_quote — The primary public procedure of the package. As the name indicates, it handles the creation and termination of quote records in a single API surface. It accepts the standard API version and initialization message list parameters, returns the standard x_return_status, x_msg_count, and x_msg_data outputs, and operates over several strongly typed PL/SQL table parameters.

Two subtype declarations define the collection structures used by the procedure: quot_tbl_type, a subtype of okl_qte_pvt.qtev_tbl_type (the quote entity table type), and qpyv_tbl_type, a subtype of OKL_QUOTE_PARTIES_PUB.qpyv_tbl_type (the quote parties table type). A global empty instance of the quote parties table, G_EMPTY_QPYV_TBL, provides the default value for the p_qpyv_tbl input.

The procedure receives quote data through p_quot_tbl, assignment data through p_assn_tbl (typed from OKL_AM_CREATE_QUOTE_PUB.assn_tbl_type), and optional quote party data through p_qpyv_tbl. It returns the processed quote rows in x_quot_tbl, termination values in x_tqlv_tbl, and assignment rows in x_assn_tbl. No parameter lists beyond those shown in the specification are documented, and consumers should rely solely on the declared signature.

Tables Accessed

The documented metadata lists a single referenced table, PLITBLM, accessed through APPS synonyms. This is a standard Oracle Applications multi-organization/temporary table used in API processing contexts. Although the excerpt identifies only this table explicitly, the underlying quote, termination, and assignment logic implied by the parameter types draws on the quote entity and quote party structures represented by okl_qte_pvt, OKL_QUOTE_PARTIES_PUB, and OKL_AM_CREATE_QUOTE_PUB. Direct table access is therefore largely mediated through those dependent package types rather than declared directly on this package.

Usage Notes

The package is intended to be called from lease and contract authoring forms, from concurrent programs that generate or retire quotes, and from custom code that needs to create or terminate quotes through a supported public API. Callers should invoke create_terminate_quote with a valid p_api_version (expected to be 1), supply the quote, assignment, and optionally quote party tables, and inspect x_return_status for OKL_API.G_RET_STS_SUCCESS before committing. Because the header declares G_COMMIT and G_INIT_MSG_LIST as OKL_API.G_TRUE, callers should confirm transactional and message-list behavior in their calling context rather than assuming implicit commit semantics. No other packages are documented as referencing this API, so it should be treated as a top-level integration point rather than a shared internal utility.