Search Results okl_upper_case_required

Overview

OKL_VP_EXTEND_PUB is a public PL/SQL package in the Oracle E-Business Suite (EBS) Oracle Lease and Finance Management (OKL / ETRM) module, owned by the APPS schema. It functions as a thin public API wrapper over the internal private package OKL_VP_EXTEND_PVT, exposing contract extension operations to external callers. In the ETRM domain, "VP" refers to the Versions/Contract Processing area, and the package supports extending a lease or loan contract beyond its original term.

The package is declared with AUTHID CURRENT_USER, so it executes with the privileges of the calling schema rather than the definer, which is significant for the OKL_API error-handling framework it relies on. Its global constants mirror the OKL_API standards: G_PKG_NAME, G_APP_NAME, G_REQUIRED_VALUE, G_INVALID_VALUE, G_SQLERRM_TOKEN, G_SQLCODE_TOKEN, G_UNEXPECTED_ERROR, G_COL_NAME_TOKEN, and G_UPPERCASE_REQUIRED. The constant G_UPPERCASE_REQUIRED (value 'OKL_UPPER_CASE_REQUIRED') is the message token raised when an input argument fails the mandatory uppercase validation enforced by the OKL_API validation utilities. The package header dates from an early release (OKLPEXTS.pls 115.3, 2002) and remains structurally unchanged through 12.1.1 and 12.2.2.

Key Procedures and Functions

The package exposes a single documented procedure:

• extend_contract — the sole public entry point. It accepts an API version, an initialization flag for the message list (p_init_msg_list, defaulting to OKL_API.G_FALSE), and standard OKL_API output parameters for return status, message count, and message data. Its principal input is p_ext_header_rec, typed as extension_header_rec_type, a subtype aliased to okl_vp_extend_pvt.extension_header_rec_type. This record carries the contract extension header attributes required to create or register an extension against a contract. The procedure validates the record, and any value that must be uppercase but is supplied in mixed or lower case triggers the G_UPPERCASE_REQUIRED token via the OKL_API validation layer. On success, x_return_status returns OKL_API.G_RET_STS_SUCCESS; otherwise it returns error or unexpected-error status with message details retrievable through the standard OKL message stack.

No other procedures or functions are documented for this package.

Tables Accessed

The documented metadata lists no direct table references through APPS synonyms for OKL_VP_EXTEND_PUB. This is expected: the package is a public wrapper, and all DML against the underlying contract extension tables is performed by the private package OKL_VP_EXTEND_PVT and the contract header tables it manages. Any table access therefore occurs indirectly through the private layer rather than from the public specification itself.

Usage Notes

OKL_VP_EXTEND_PUB is intended for programmatic invocation, not for direct form-level use. Typical callers include internal ETRM packages (the metadata records that it is referenced by one other package), concurrent-program logic, and custom extensions or integrations written against the public OKL API. Callers must pass a fully populated extension_header_rec_type, honor the OKL_API conventions for p_init_msg_list, and inspect x_return_status and the message stack before proceeding. Payloads should supply mandatory string attributes in uppercase to preempt the G_UPPERCASE_REQUIRED validation error. Because the package runs with AUTHID CURRENT_USER, the invoking schema must hold execute privilege and any required object privileges on the underlying OKL objects.