Search Results x_return_status

Overview

OKS_INTERACTION_HIST_PUB is the public (PUB-classified) PL/SQL package body for the Interaction History entity within the Oracle E-Business Suite Service (OKS) module. Interaction History records the log of customer and service interactions—such as calls, visits, and correspondence—associated with service contracts, service requests, and installed base assets. The package exposes a TCA-style concurrent API strategy that supports row-level insert, update, delete, and validation operations against the interaction history data model, delegating all substantive work to its private counterpart, OKS_INTERACTION_HIST_PVT.

The last two characters of the package name, "_PUB", are significant: the module follows Oracle's standard public/private API pattern, where the _PUB layer provides a stable, externally callable interface and the _PVT layer encapsulates the business logic and persistence. The header comment ($Header: OKSPINHB.pls 120.1 2005/10/03 ...) indicates this is a long-standing component carried forward across EBS 12.1.1 and 12.2.2 without major architectural change.

Key Procedures and Functions

The ETRM metadata documents 18 procedures and functions in the package body. The core documented entry points are:

• QC — A quality-control hook that calls OKS_INTERACTION_HIST_PVT.qc to run package-level consistency checks.
• CHANGE_VERSION — Delegates to the private counterpart to perform version changes required by Oracle's concurrent manager / API versioning conventions.
• API_COPY — Wraps OKS_INTERACTION_HIST_PVT.api_copy, supporting the copying of interaction history records.
• INSERT_ROW — Public entry point for creating a new interaction history row; performs parameter validation and API initialization before delegating to the private layer.
• LOCK_ROW — Obtains a row-level lock on an interaction history record to support concurrent safe updates.
• UPDATE_ROW — Public entry point for modifying an existing interaction history row.
• DELETE_ROW — Public entry point for removing an interaction history record.
• VALIDATE_ROW — Validates an interaction history record (declared as inhv_rec_type) without persisting it, exposing standard API error parameters.

Each procedure follows the standard EBS API signature convention: p_api_version, p_init_msg_list, x_return_status, x_msg_count, and x_msg_data. The x_return_status parameter is initialized to OKC_API.G_RET_STS_SUCCESS and is subsequently managed by OKC_API.START_ACTIVITY, which sets the standard return status values (S for success, E for error, U for unexpected error).

Tables Accessed

The ETRM metadata lists no explicit table references for this package, because OKS_INTERACTION_HIST_PUB is a thin wrapper: all SQL against the underlying OKS_INTERACTION_HIST table (and its related interaction history and interaction detail tables) is executed inside OKS_INTERACTION_HIST_PVT via APPS synonyms. The public layer itself performs no direct DML; the private layer reads and writes the interaction history records that the public procedures operate on.

Usage Notes

OKS_INTERACTION_HIST_PUB is typically invoked from the Service (OKS) module's JSP/Forms user interface, from concurrent programs that batch-load or maintain interaction history, and from custom PL/SQL that needs to create, update, or validate interaction history records using the supported API contract. Callers should always check x_return_status after each call and use OKC_API.GET_MSG_* routines to retrieve any errors. The metadata states the package is referenced by 0 other packages, confirming it is a leaf-level public API consumed by forms, concurrent programs, or external custom code rather than by other PL/SQL APIs.