Search Results get_location_bo

Overview

The APPS.HZ_LOCATION_BO_PUB package is a public business object (BO) API within the Oracle E-Business Suite Trading Community Architecture (TCA) foundation. It provides a programmatic interface for creating, updating, saving, and retrieving location business objects. A "location" in TCA represents a physical or logical address that can be associated with parties, party sites, accounts, and other entities. The _BO_PUB naming convention identifies this as a public business object wrapper that layers business-object semantics—such as bulk operations, business object composition, and structured save processing—on top of the base location API, HZ_LOCATION_V2PUB.

This package is classified as a PUB (public) API in Oracle's ETRM classification, meaning it is intended for external invocation by Oracle application code and, under Oracle's published API guidelines, by customer extensions where documented. Its status is VALID in the referenced schemas, and it is certified for Oracle EBS 12.1.1 and 12.2.2.

Key Procedures and Functions

Nine documented procedures and functions are exposed by this package. Five are named in the metadata; their purposes are described below.

• CREATE_LOCATION_BO — Constructs and initializes a new location business object in memory, preparing it for population and subsequent persistence.
• UPDATE_LOCATION_BO — Applies modifications to an existing location business object, typically after it has been retrieved and altered by the calling process.
• SAVE_LOCATION_BO — Persists the in-memory location business object to the database, writing new or changed attributes to the underlying location tables and returning any processing messages.
• GET_LOCATION_BO — Retrieves an existing location business object into memory using an identifying key, so that its attributes may be inspected or modified.
• ASSIGN_LOCATION_REC — Associates a location record with the broader business object structure, handling the linkage between a location and its owning entity within the TCA model.

The remaining documented procedures follow the same BO lifecycle pattern and are invoked through the same public interface. Parameter lists are deliberately not reproduced here; consumers should consult the package specification for exact signatures.

Tables Accessed

The package references two underlying objects through APPS synonyms:

• HZ_LOCATIONS — The core TCA table storing location records, including address lines, geography identifiers, and location validity flags. This is the principal table read and written by SAVE_LOCATION_BO and GET_LOCATION_BO.
• PLITBLM — A PL/SQL index table used for bulk message handling, consistent with the package's dependency on HZ_MESSAGE_OBJ_TBL and FND_API. It supports collection of error and information messages returned to the caller.

Usage Notes

HZ_LOCATION_BO_PUB is typically invoked from TCA-aware application code, including Oracle Forms, concurrent programs, and Java or PL/SQL integration layers, when locations must be manipulated as business objects rather than through base table DML. It is also referenced by HZ_PARTY_SITE_BO_PUB, indicating its role as a subordinate object API within party-site business object processing. The package depends on FND_API, HZ_LOCATION_OBJ, and HZ_LOCATION_V2PUB, so callers should follow the standard TCA API conventions: initialize the API context, invoke the BO procedures, and inspect the returned message table for errors before committing. Custom integrations should always call these public APIs rather than inserting directly into HZ_LOCATIONS.