Search Results get_terms_conditions




Overview

OKL_TERMS_AND_CONDS_PVT is a private (PVT) API package in the Oracle E-Business Suite ETRM (Enterprise Transaction and Contract Management / Oracle Lease Management) module, owned by the APPS schema. Its business function is to return the terms and conditions metadata associated with an Oracle Lease Management contract or related document, expressed as a structured PL/SQL collection. This package underpins the presentation of lease contractual terms and conditions, allowing callers to retrieve the set of term groups, titles, sequence rules, and rendering attributes that describe how terms and conditions should be displayed to the end user.

The package is classified as a private API, meaning it is intended for internal consumption by other ETRM components rather than as a formally published public interface. It is coded with AUTHID CURRENT_USER, so it executes with the privileges of the invoking user. The header ID indicates an early build (115.3, dated 2003), reflecting the long-standing stability of this logic across ETRM releases including 12.1.1 and 12.2.2.

Key Procedures and Functions

The package exposes a single documented program unit:

  • GET_TERMS_CONDITIONS — Retrieves terms and conditions data into an output PL/SQL table. It accepts an API version, an initialization flag for message-list handling, and a p_type selector that governs which category of terms and conditions is returned. It returns the standard EBS API messaging trio (x_return_status, x_msg_count, x_msg_data) plus an output table (x_trm_tbl) populated with rows of record type trm_rec_type.

The output record type trm_rec_type carries the descriptive attributes of each terms-and-conditions entry: id, group_title, description, rule_group, rule_sequence, title_style, pagetitle, region, currency, disabled, and jsp. The companion type trm_tbl_type is an associative array of trm_rec_type indexed by BINARY_INTEGER, forming the output collection. The inclusion of title_style, region, and jsp indicates the procedure supplies UI-oriented metadata used to render terms and conditions regions or pages in a servlet-based (JSP) presentation layer.

Tables Accessed

The provided ETRM 12.2.2 metadata records no explicit table references for this package via APPS synonyms. This is consistent with a private package that may derive its result set through its own SELECT statements executed under definer-invoker semantics, or that relies on package state rather than a persistent base table mapping surfaced by the ETRM metadata. In practice, the returned term groups and descriptions correspond to ETRM terms-and-conditions setup data, but no specific base tables are documented here, so no table-level assertions can be made beyond the documented metadata.

Usage Notes

Because OKL_TERMS_AND_CONDS_PVT is a PVT API, it is normally invoked from within ETRM application code rather than directly from client programs. The ETRM documentation notes that it is referenced by one other package, confirming its role as a supporting utility consumed by higher-level logic. Typical invocation patterns include:

  • Internal ETRM API callers — The referencing package calls GET_TERMS_CONDITIONS to obtain display metadata before rendering terms and conditions for a lease or contract.
  • JSP / servlet presentation layer — The jsp, region, and pagetitle attributes support web-based rendering of terms and conditions.
  • Custom extensions — Developers integrating custom terms-and-conditions screens may call the procedure after initializing the message list, checking x_return_status and consuming messages from x_msg_count/x_msg_data.

Callers should pass a valid p_api_version, honor the standard EBS message-list convention, and treat the package as private, as its signatures may change across releases without public notice.