Search Results g_not_allowed

Overview

OKL_SETUPOPTIONS_PVT is a private (PVT) PL/SQL package in the Oracle E-Business Suite Contracts (OKL) module, which forms part of the Enterprise Contracts / Lease Management (ETRM) application. The package encapsulates the persistence and retrieval logic for contract setup options, which are the configuration values that govern how a lease or contract is processed within the application. Because it is classified as a private API, it is not intended for direct invocation by external or customer-developed code; instead it serves as the internal implementation layer behind the public OKL_OPTIONS_PUB interface.

The package declares AUTHID CURRENT_USER, meaning it executes with the privileges of the invoking schema rather than the definer, a standard convention for ETRM private APIs. Its specification includes a set of global constants used for error handling and message token substitution, along with a custom exception, G_EXCEPTION_HALT_PROCESSING, used to abort processing when a fatal condition is encountered.

Key Procedures and Functions

The package exposes three documented procedures. Parameter lists are intentionally summarized rather than reproduced, as the ETRM metadata truncates the full signatures.

• GET_REC — Retrieves a single setup options record based on an input options record (used as a key/selection criteria). It returns a status flag, a no-data-found indicator, and the populated options record. This is the standard query entry point for setup option data.
• INSERT_OPTIONS — Creates a new setup options record. It follows the standard ETRM API convention of accepting an API version and an initialization flag, and returning a return status, message count, and message data, along with the inserted record. It is used when no existing setup options exist for a given context.
• UPDATE_OPTIONS — Modifies an existing setup options record, using the same API version, message-list, and error-handling conventions as INSERT_OPTIONS. This is the routine invoked when configuration values change.

Each routine adheres to the OKL_API messaging model, populating G_SQLERRM_TOKEN, G_SQLCODE_TOKEN, and table/column tokens for error message substitution.

Tables Accessed

The ETRM metadata does not enumerate the underlying tables via APPS synonyms for this package, so the physical objects are not documented explicitly. Based on the package's purpose and its reference to the OKL_OPTIONS_PUB record types (optv_rec_type and optv_tbl_type), the package reads from and writes to the setup options base table that stores contract configuration values. All access is performed through the OKL_API error-handling framework, which validates and commits changes transactionally.

Usage Notes

OKL_SETUPOPTIONS_PVT is referenced by two other packages in the ETRM codebase, confirming it functions as a shared internal service rather than a top-level entry point. Because it is classified PVT, it should not be called directly from custom code; developers should invoke the corresponding public wrapper in OKL_OPTIONS_PUB instead. It is typically triggered from the Contracts setup forms when users create or modify lease setup options, and any concurrent programs that seed or maintain contract configuration. The G_NOT_ALLOWED constant, tagged with the message name OKL_NOT_ALLOWED, indicates that the package enforces business rules restricting certain insert or update operations, raising an error when an operation violates setup policy. Maintainers should treat the error tokens and constants as internal and rely on the public API for supported customization.