Results for “g_ret_sts_warning”

AI-generated from documented ETRM metadata — verify critical details on the linked pages.

Overview

APPS.TAPI_DEV_KIT is a PL/SQL development kit package belonging to the Oracle Service (CS) product family, specifically associated with the Telecommunications Service Provider application and the contract/telephony API layer. The package is declared with AUTHID CURRENT_USER, meaning its SQL statements execute with the privileges of the invoking schema rather than the defining schema. Its $Header comment (cscttdks.pls 115.3) confirms it belongs to the CS Contracts module and is a developer-facing utility rather than an end-user business API.

The package's primary purpose is to provide a reusable set of constants, message tokens, and helper utilities used by other APIs in the Service/Contracts codebase. It centralizes definitions that would otherwise be duplicated across packages, notably the standard message names published by the Oracle Forms framework when a record cannot be reserved, locked, or found. The constant G_FORM_UNABLE_TO_RESERVE_REC is defined here, and its value clarifies the exact message name relied upon at runtime: FORM_COULD_NOT_RESERVE_RECORD, with the earlier legacy name FORM_UNABLE_TO_RESERVE_RECORD present only as a commented-out line. This distinction is central for developers searching on "g_form_unable_to_reserve_rec", since the constant name and the underlying message string are not identical.

Additional constants in this package drive error handling and token substitution: G_FORM_RECORD_DELETED, G_FORM_RECORD_CHANGED, G_RECORD_LOGICALLY_DELETED, G_REQUIRED_VALUE, and G_INVALID_VALUE. Substitution tokens G_COL_NAME_TOKEN, G_PARENT_TABLE_TOKEN, and G_CHILD_TABLE_TOKEN indicate that the package is used to format messages whose text is parameterized by column and table names.

Key Procedures and Functions

Thirteen documented units are associated with TAPI_DEV_KIT, of which nine are identified below:

• START_ACTIVITY — initializes an API activity, typically invoked at the beginning of a procedural call to establish context and savepoint state.
• END_ACTIVITY — closes the activity initiated by START_ACTIVITY, performing cleanup and standard return-status handling.
• HANDLE_EXCEPTIONS — processes exceptions raised within an API call, translating them into the standard FND message stack and return status.
• GET_WHO_INFO — retrieves the standard "WHO" audit columns (created/updated by, date, login) for populating base-table audit fields.
• SET_MESSAGE — places a message, identified by the constants above, onto the message stack for retrieval by the calling form or program.
• GET_PRIMARY_KEY — returns the surrogate primary key value for a record, used when constructing child or related rows.
• G_MISS_NUM_F, G_MISS_DATE_F, G_MISS_CHAR_F — helper functions that return the FND_API missing-value markers for numeric, date, and character datatypes respectively.

Parameter lists are not documented in the available metadata and are not inferred here.

Tables Accessed

The package references DBMS_SQL and DBMS_TRANSACTION through APPS synonyms. These are Oracle-supplied PL/SQL packages rather than application tables: DBMS_SQL supports dynamic SQL generation (consistent with the GET_PRIMARY_KEY helper), and DBMS_TRANSACTION supports savepoint and rollback control used in the START_ACTIVITY/END_ACTIVITY pattern. No application base tables are documented as being accessed directly.

Usage Notes

TAPI_DEV_KIT is invoked from within other PL/SQL APIs and Oracle Forms as a shared library of constants and helpers, not called directly by end users. It is referenced by twenty-nine other packages, indicating wide reuse across the Service/Contracts API suite. Developers who encounter the "G_FORM_UNABLE_TO_RESERVE_REC" search term in forms or logs should note that at runtime the message is emitted under the name FORM_COULD_NOT_RESERVE_RECORD; this package supplies that constant for consistent message registration and retrieval.