Search Results get_subclass_rgs

Overview

OKL_RULE_EXTRACT_PUB is the public API layer of the Oracle Lease Management (OKL) rule extraction framework in Oracle E-Business Suite. Its purpose is to expose rule group and rule definition data associated with lease contract structures to external callers — forms, concurrent programs, and custom extensions — in a controlled, standardized manner. The package follows the Oracle EBS PL/SQL API conventions, providing a thin public wrapper over the corresponding private package OKL_RULE_EXTRACT_PVT, which contains the substantive retrieval logic. The public/private split ensures that only supported entry points are exposed, while validation, message handling, and initialisation are consistently applied through the OKL_API utility package.

The package is classified as a PUB API within the APPS schema and carries a relatively mature version history (the source header references version 115.13), indicating stability across the 12.1.1 and 12.2.2 releases. The user search term "get_rg_rules" maps directly to one of the four documented public procedures, GET_RG_RULES, which retrieves rule groups and their associated rules for a given contract or structure identifier.

Key Procedures and Functions

The package exposes four documented procedures:

• GET_SUBCLASS_RGS — Returns all rule groups attached to a specified subclass, keyed by contract header identifier (p_chr_id). The result is returned through a strongly typed collection (sc_rg_tbl_type). This is the only procedure whose full signature appears in the available excerpt.
• GET_RG_RULES — The procedure most commonly associated with the search term "get_rg_rules". It returns the rules belonging to a given rule group, allowing callers to enumerate the individual rule definitions that make up a rule group attached to a lease contract.
• GET_RULE_DEF — Returns the definition of an individual rule, providing the metadata or configuration detail for a specific rule rather than the aggregated group listing.
• GET_RULES_METADATA — Returns metadata describing rules, supporting callers that need to enumerate or interpret rule definitions without retrieving full rule data.

All four follow the standard EBS API pattern: an entry point that calls OKL_API.START_ACTIVITY for initialisation, delegates to the private package OKL_RULE_EXTRACT_PVT, and completes with OKL_API.END_ACTIVITY. Exceptions are trapped and translated into standard return status values (G_RET_STS_SUCCESS, G_RET_STS_ERROR, G_RET_STS_UNEXP_ERROR) via OKL_API.HANDLE_EXCEPTIONS.

Tables Accessed

The documented table references, resolved through APPS synonyms, are:

• OKC_K_HEADERS_B — The contract header base table. It supplies the contract-level identity (CHR_ID) against which rule groups and rules are resolved.
• OKC_K_LINES_B — The contract line base table, used to associate rules with specific lines or structures within a contract.
• OKC_K_PARTY_ROLES_B — The contract party role base table, enabling rule extraction to be scoped by the parties participating in the contract where required.

Usage Notes

OKL_RULE_EXTRACT_PUB is typically invoked from Lease Management forms and from custom code that needs to interrogate the rule configuration of a lease contract without directly querying the underlying OKC and OKL tables. Because it is a PUB API, it should always be preferred over direct table access or calls to the private package, since the public layer guarantees proper initialisation, message stack management, and return status semantics.

The package is referenced by at least one other package within the ETRM schema, confirming its role as a shared service rather than a form-only utility. Callers must supply p_api_version and p_init_msg_list, and should inspect x_return_status and the message stack (x_msg_count, x_msg_data) after each call. In 12.2.2, the OKL and OKC schemas retain the same structure, so code written against 12.1.1 remains compatible.