Search Results download_query_object

Overview

The APPS.AK_QUERYOBJ_GRP package is a group API within the Oracle E-Business Suite Application Object Library (AK) schema. Its business function is to provide a controlled, standardized interface for creating and retrieving query objects and their associated lines. Query objects are structural definitions used by Oracle EBS to store reusable query definitions that drive runtime search, lookup, and data selection behavior across self-service and administrative applications.

In Oracle EBS 12.1.1 and 12.2.2, the _GRP suffix denotes a "group" API layer. This layer sits above private implementation packages and exposes a stable, published interface that conforms to the FND_API standard programming model. Because it is declared AUTHID CURRENT_USER, the package executes with the privileges of the calling schema rather than the owner, which is consistent with the standard Oracle EBS API security model. The header comment records that the file was last shipped at version 120.2 in 2005, indicating the interface has been stable across multiple release boundaries.

Key Procedures and Functions

The ETRM metadata documents three callable procedures in the package.

• CREATE_QUERY_OBJECT — The primary group API for creating a query object. The procedure comment describes its purpose as calling the private API to create a query object "using the given info," and its documented result is the standard p_return_status output parameter, which returns one of three standard statuses: Unexpected error, Error, or Success. Its parameters are documented as "query object columns," including a validation level, API version number, initialization flag, message count/data out parameters, return status, and the query object attributes p_query_code and p_application_id, along with the standard WHO columns (created_by, creation_date, last_updated_by, last_update_date, last_update_login).
• CREATE_QUERY_OBJECT_LINE — The group API for creating an individual query object line. Following the same pattern as CREATE_QUERY_OBJECT, it calls the private API to create a line "using the given info" and returns the standard p_return_status. Because a query object is composed of one or more lines, this procedure is the companion entry point used when building the full query definition.
• DOWNLOAD_QUERY_OBJECT — A retrieval procedure that exports or materializes an existing query object definition. It complements the two creation procedures by providing the read-side counterpart of the group API surface.

Tables Accessed

The package is documented as referencing only two objects through APPS synonyms: DUAL and PLITBLM. DUAL is the standard Oracle single-row utility table, typically used here for lightweight existence checks or to satisfy SELECT-list PL/SQL evaluation within the API's internal logic. PLITBLM is the PL/SQL integer table type used by the Oracle Forms and FND message stack infrastructure; its presence indicates that the package participates in the standard FND_API message-handling path, capturing and surfacing errors through p_msg_count and p_msg_data. Persistent query object data is written and read by the underlying private implementation package, which this group API delegates to rather than manipulating the base tables directly.

Usage Notes

The package is most commonly invoked from PL/SQL rather than directly from a form or concurrent program. Typical callers are other Oracle EBS APIs and custom extensions that need to register a query object at setup or configuration time. Because the procedures return the standard FND_API status codes, calling code is expected to declare a local variable for p_return_status and check it for FND_API.G_RET_STS_SUCCESS, halting and reporting via p_msg_data when the status indicates an error. The ETRM metadata records that the package is referenced by one other package, confirming that its primary consumption pattern is as a dependency of higher-level setup logic rather than direct end-user interaction. As with all documented Oracle EBS APIs, it should be called only once per unit of work, and custom code should treat the interface as frozen; the underlying private package carries the actual business logic and may change between point releases.