Search Results hz_preference_pub




Overview
Explore in AI Chat

Overview

APPS.HZ_PREFERENCE_PUB is a public API package body within the Oracle E-Business Suite Trading Community Architecture (TCA) schema. Its purpose is to provide a supported, programmatic interface for creating, maintaining, and querying party preferences stored against records in the HZ_PARTIES model. In Oracle EBS 12.1.1 and 12.2.2, preferences allow an application to capture configurable, contact-related attributes for a party — such as a preferred language, contact method, or communication channel — without modifying the core party record. HZ_PREFERENCE_PUB abstracts the underlying preference storage and validation logic, exposing a controlled public API (API classification PUB) so that forms, concurrent programs, and custom extensions can manipulate preferences without directly touching the base tables. The package is documented as VALID and references the standard TCA and FND utility layers, and it is not referenced by any database object, confirming its role as a top-level entry point rather than an internal helper.

Key Procedures and Functions

The ETRM metadata documents eleven procedures and functions. The query-side routines are the CONTAINS_PREFERENCE, CONTAINS_VALUE, and RETRIEVE functions, which determine whether a given preference exists for a party and return preference data respectively. The VALUE_VARCHAR2, VALUE_NUMBER, and VALUE_DATE functions return a stored preference value coerced into the appropriate datatype, reflecting that HZ_PARTY_PREFERENCES stores values in a typed, multi-column form. The maintenance routines are ADD, PUT, and REMOVE, providing the standard insert, update, and delete operations against a party's preferences. The package therefore follows the conventional TCA pattern of paired existence checks, typed value accessors, and transactional DML procedures. Parameter lists are not enumerated in the metadata and are not reproduced here; callers should consult the package specification or the ETRM package documentation for exact signatures.

Tables Accessed

The documented table references are FND_LOOKUP_VALUES, HZ_PARTIES, HZ_PARTY_PREFERENCES, HZ_PARTY_PREFERENCES_S, and DUAL. HZ_PARTY_PREFERENCES is the primary transactional table into which ADD, PUT, and REMOVE write and from which RETRIEVE and the VALUE_* functions read; HZ_PARTY_PREFERENCES_S is the corresponding sequence used to generate preference identifiers. HZ_PARTIES is accessed to validate that the target party exists and is a valid parent for the preference. FND_LOOKUP_VALUES supplies the valid preference codes and, where applicable, the lookup-driven validation of preference names and values. DUAL supports lightweight existence checks without touching the base tables. The package additionally depends on HZ_PARTY_PREFERENCES_PKG, HZ_COMMON_PUB, HZ_UTILITY_PUB, HZ_UTILITY_V2PUB, HZ_POPULATE_BOT_PKG, and the FND_API/FND_MSG_PUB stack for message handling, consistent with TCA API conventions.

Usage Notes

HZ_PREFERENCE_PUB is normally invoked from TCA-based forms, from concurrent programs that bulk-load or maintain party data, and from custom PL/SQL that must attach preferences to a party. It is referenced by seven other packages, indicating it is consumed by higher-level TCA APIs. Custom code should call the public procedures rather than inserting directly into HZ_PARTY_PREFERENCES, because the package enforces lookup validation, message-based error reporting through FND_MSG_PUB, and consistent sequencing. It is worth noting that the documented function set omits an explicit UPDATE function, so maintenance is likely handled through ADD/PUT semantics; callers should verify the exact behavior against their release's package specification before relying on idempotent behavior across 12.1.1 and 12.2.2.