Search Results okl_rule_extract_pub_w




Overview
Explore in AI Chat

Overview

The package body APPS.OKL_RULE_EXTRACT_PUB_W is a public PL/SQL API belonging to the Oracle E-Business Suite Enterprise Territory Management / Oracle Lease and Finance Management (OKL) family of modules. Its name indicates that it functions as the public wrapper ("_W") for the rule extraction subcomponent, exposing a stable, externally callable interface to the internal rule-extraction private package (OKL_RULE_EXTRACT_PVT) and its own wrapper counterpart (OKL_RULE_EXTRACT_PVT_W). The package performs rule extraction and metadata retrieval for the OKL rules engine, allowing callers to obtain the rule definitions, rule groups, subclasses, and rule metadata required to evaluate and apply contractual, pricing, or accounting rules within the lease and finance domain.

The _PUB_W suffix is consistent with the Oracle EBS layered API convention, where public packages delegate to private packages that encapsulate business logic. The public wrapper presents a controlled contract, invokes the FND_API error-handling framework, and passes structured table parameters using the standard JTF collection types.

Key Procedures and Functions

The metadata documents four callable procedures and functions in the package. No parameter lists are reproduced here; only their documented purpose is described.

  • GET_SUBCLASS_RGS — Retrieves the rule groups (RGs) associated with a given subclass. This supports callers that need to discover which rule groups apply to a particular subclass of a business object before extracting or evaluating the underlying rules.
  • GET_RG_RULES — Returns the set of rules defined for a specified rule group. This is the primary extraction entry point for retrieving the rules that have been assembled into a rule group for evaluation.
  • GET_RULE_DEF — Fetches the definition of an individual rule. It supplies the structural detail of a rule, such as the conditions and actions that comprise it, so the caller can evaluate or display the rule.
  • GET_RULES_METADATA — Returns metadata describing the rules and their associated attributes. This enables generic and user-interface consumers to render rule information without hard-coding column knowledge.

Together these routines provide a read-oriented extraction surface: callers navigate from subclass to rule group, from rule group to rules, and from rules to full definitions and metadata.

Tables Accessed

The ETRM metadata excerpt does not enumerate the underlying base tables read or written by this package; it lists only the referenced packages and collection types. Consistent with its role as a wrapper, the package does not directly manipulate tables itself but delegates data access to OKL_RULE_EXTRACT_PVT, which in turn queries the OKL rule definition, rule group, and rule-to-group association tables through APPS synonyms. SQL-level table names should be confirmed by inspecting the private package's dependent views.

Usage Notes

OKL_RULE_EXTRACT_PUB_W is typically invoked by forms, concurrent programs, or custom PL/SQL code that must obtain rule definitions and metadata for the OKL rules engine. It is referenced by no other database object, so it is called directly by the application layer rather than by other PL/SQL packages. It depends on OKL_RULE_EXTRACT_PUB, OKL_RULE_EXTRACT_PVT_W, OKC_API, FND_API, and the JTF collection types. Callers should adhere to standard FND_API conventions for return status and error messages.