Search Results is_updateable

Overview

AK_QUERYOBJ_PVT is a private (PVT) PL/SQL package body owned by APPS that supports the Oracle E-Business Suite query object framework. Its role is to manage the definition, extraction, and loading of query objects—the metadata constructs that describe tables, columns, join conditions, attributes, and key definitions used by the Oracle EBS query and extensibility components. The package provides the core implementation logic behind the public query object APIs, handling the serialization of query object metadata into a loader file format and the reconstitution of query objects from that file format back into the database.

As a private package, AK_QUERYOBJ_PVT is not intended for direct invocation by external application code. It is called by the public wrapper packages that expose query object functionality to the application layer. The package body carries a version header dated 2005 and is delivered in both Oracle EBS 12.1.1 and 12.2.2, operating unchanged across the two releases.

The extraction path is handled internally by a local procedure, WRITE_LINES_TO_BUFFER, which reads query object definitions and their child records and writes them to an output buffer in loader-file format. This local procedure is not designed to be called from outside the package and underpins the public DOWNLOAD_QUERY_OBJECT and UPLOAD_QUERY_OBJECT procedures.

Key Procedures and Functions

The package exposes four documented procedures and functions:

• DOWNLOAD_QUERY_OBJECT — Extracts a query object definition, together with its associated attributes, foreign keys, and unique key definitions, and writes the result to a loader file. It delegates the low-level file writing to the local WRITE_LINES_TO_BUFFER procedure.
• CREATE_QUERY_OBJECT — Creates a new query object header record. It establishes the top-level query object definition that subsequent line-level records attach to.
• CREATE_QUERY_OBJECT_LINE — Creates an individual query object line record, representing a component of the query object such as a table, column, join, or attribute entry associated with the parent query object.
• UPLOAD_QUERY_OBJECT — Reads a loader file and reconstitutes the query object definition into the database, reversing the download operation.

Each procedure follows the standard Oracle EBS API convention of returning a status indicator via an OUT parameter (Success, Error, or Unexpected error).

Tables Accessed

• AK_QUERY_OBJECTS — The header table storing the top-level query object definition. Read and written by the create, download, and upload operations.
• AK_QUERY_OBJECT_LINES — The detail table storing the individual line records belonging to a query object. The local extraction cursor selects from this table ordered by seq_num to preserve the authored sequence of lines.
• PLITBLM — The standard Oracle EBS PL/SQL index-by table used for managing large text buffers, employed here to assemble and hold the loader file content during download operations.

Usage Notes

AK_QUERYOBJ_PVT is invoked indirectly through the public query object APIs and is referenced by two other packages within the application. It is not intended to be called from custom forms or concurrent programs directly. Typical usage arises when query objects are migrated between environments, downloaded for review, or loaded during setup and configuration. Because it is a private API, its signatures may change without notice, and customizations should target the corresponding public wrapper packages rather than AK_QUERYOBJ_PVT itself.