Search Results get_item_text_clob




Overview

The CTXSYS.EGO_ITEM_TEXT_CTX_PKG package body is an Oracle Text (interMedia Text, iMT) supporting package that exposes PL/SQL APIs for retrieving descriptive item text stored for EGO (Engineering and Product Development) entities in Oracle E-Business Suite. The package resides in the CTXSYS schema and acts as a thin wrapper over the EGO user datastore implementation supplied by the Applications schema. Its principal role is to provide the callable entry points that the Oracle Text index engine invokes when it must materialize the text associated with a given row of an EGO base table, whether that text is needed as a character large object (CLOB) or as a varchar2 string.

Functionally, the package isolates Oracle Text from the physical location and representation of item text. The actual retrieval logic is delegated to APPS.EGO_ITEM_TEXT_UTIL.Get_Item_Text, which knows how to locate and return the item description text for a specified row. By exposing both a CLOB and a varchar2 variant, the package allows the Text engine and other callers to request the representation best suited to their indexing or display needs without duplicating the underlying extraction logic.

Key Procedures and Functions

  • Get_Item_Text_CLOB — Accepts a row identifier (ROWID) identifying the target EGO row and returns the associated item text as a CLOB through an IN OUT NOCOPY output parameter. Internally it declares a local varchar2 placeholder and calls APPS.EGO_ITEM_TEXT_UTIL.Get_Item_Text with an output type of 'CLOB', passing the ROWID and the CLOB output parameter.
  • Get_Item_Text_VARCHAR2 — Accepts a ROWID and returns the item text as a varchar2 through an IN OUT NOCOPY output parameter. It declares a local CLOB variable and invokes APPS.EGO_ITEM_TEXT_UTIL.Get_Item_Text with an output type of 'VARCHAR2', passing the ROWID, the local CLOB, and the varchar2 output parameter. The commented-out DBMS_LOB.CreateTemporary and DBMS_LOB.FreeTemporary calls indicate that the local LOB was originally created and freed explicitly, a practice that was subsequently removed.

Both procedures contain no validation or exception-handling logic of their own; error conditions are raised from the delegated utility procedure. The header comment identifying the shipped file is egoimctx.sql 120.0.12010000.3, confirming the package originates from the Applications code line rather than a customer modification.

Tables Accessed

No tables are referenced directly by name within this package. All data access occurs inside APPS.EGO_ITEM_TEXT_UTIL.Get_Item_Text, which queries the EGO item text storage structures and resolves them through APPS synonyms. Because the package itself performs no DML, it is not a source of direct table contention; it inherits whatever read behavior the delegated utility exhibits.

Usage Notes

This package is invoked primarily by the Oracle Text indexing infrastructure through the EGO user datastore preference, which drives Get_Item_Text_CLOB and Get_Item_Text_VARCHAR2 when the Text index requires the source text for a row. It may also be called from custom PL/SQL that needs to display or process item text for a known ROWID. The package is documented in ETRM with an API classification of OTHER and is not referenced by any other documented package, so callers should treat it as an internal Text integration point rather than a general-purpose public API. Because it is owned by CTXSYS, custom code should reference it with appropriate privileges. The convention of passing a ROWID rather than a primary key means callers must already hold a valid row identifier; the returned text can be large in the CLOB variant, so callers retrieving long descriptions should allocate CLOB output appropriately. The varchar2 variant is suitable only for text that fits typical SQL string limits.