Search Results delete_criteria




Overview

OKL_CRITERIA_PUB is the public application programming interface for managing criteria records within the Oracle E-Business Suite Enterprise Trading and Resource Management (ETRM) module, specifically the Oracle Lease and Finance Management (OKL) product family. The package is owned by the APPS schema and is classified as a PUB (public) API, meaning it is intended for direct invocation by external callers such as Oracle Forms, concurrent programs, and customer-written extensions. Internally, the package acts as a thin public wrapper over the private implementation housed in OKL_CRN_PVT, delegating the substantive business logic, validation, and persistence operations to that private layer while exposing a stable, versioned interface to callers.

The package declares a global application name constant tied to OKC_API.G_APP_NAME, a standard unexpected-error token, and a custom exception G_EXCEPTION_HALT_VALIDATION. It also defines two subtypes, crnv_rec_type and crnv_tbl_type, which mirror the private record and table structures and are used to pass criteria data between the public API and the underlying private package. This design supports both single-record and bulk (table-based) processing, a common pattern in ETRM APIs.

Key Procedures and Functions

The documented procedures exposed by OKL_CRITERIA_PUB are:

  • INSERT_CRITERIA — Creates new criteria records. Two overloaded signatures are provided: one accepting a single record (crnv_rec_type) and one accepting a table (crnv_tbl_type), allowing callers to insert one or many criteria rows in a single call. The procedures return return-status, message count, and message data, and they pass back the populated record or table to the caller.
  • LOCK_CRITERIA — Obtains a locking handle on one or more criteria records, supporting the standard optimistic concurrency model used throughout ETRM. As with INSERT_CRITERIA, both record-level and table-level overloads are exposed.
  • UPDATE_CRITERIA — Modifies existing criteria records. This is the procedure most closely associated with the "update_criteria" search term, and it is the primary entry point for changing criteria definitions maintained in the OKL criteria repository.
  • DELETE_CRITERIA — Removes criteria records from the repository, applying the same standard API error handling and messaging conventions as the other procedures.
  • VALIDATE_CRITERIA — Performs business-rule and data-integrity validation on criteria records prior to insertion or update, allowing callers to pre-validate data or to enforce validation independently of a write operation.

All procedures follow the standard Oracle EBS API signature conventions, including p_api_version, p_init_msg_list, and the x_return_status, x_msg_count, and x_msg_data output parameters.

Tables Accessed

The ETRM metadata identifies PLITBLM as the principal table referenced through APPS synonyms. PLITBLM (PL/SQL Interface Table) is the standard EBS interface structure used to exchange record and table collections between client-side components and server-side PL/SQL APIs. In the context of this package, it serves as the transport mechanism for the record and table parameters passed into insert, lock, update, delete, and validate operations. The actual criteria data is ultimately persisted by the private implementation in OKL_CRN_PVT and its associated base tables, which are not exposed directly through this public package.

Usage Notes

OKL_CRITERIA_PUB is typically invoked from Oracle Forms used to maintain lease and finance criteria, from concurrent programs that load or migrate criteria data, and from custom PL/SQL code that needs to manage criteria records programmatically. Because it is a PUB-classified API, it is the supported integration point for external callers, and direct manipulation of the underlying criteria tables should be avoided in favor of these procedures. Callers should always check x_return_status and inspect the returned messages before committing, and should observe the overload selection (record versus table) to match data volume. The package references no other packages as dependents, meaning it is not invoked automatically by other APIs, so its use is always explicit and caller-driven.