Search Results csf_locus_pub




Overview
Explore in AI Chat

Overview

APPS.CSF_LOCUS_PUB is a public PL/SQL API within the Oracle E-Business Suite location and spatial foundation layer. It provides programmatic access to locus objects — point or linear references along a road network — allowing callers to convert between a locus representation and its underlying Oracle Spatial SDO_GEOMETRY plus associated segment, offset, and direction attributes. The package therefore underpins address validation, geocoding, routing, and service-area determination used by field service, telematics, and location-aware applications.

The package header carries the revision tag CSFPLCSS.pls 120.7.12010000.1, indicating a 2008-era baseline that is shipped in both 12.1.1 and 12.2.2. Return constants (g_ret_locus_success, g_ret_locus_invalid_locus, g_ret_locus_invalid_geometry) define the status vocabulary used across its procedures.

Key Procedures and Functions

The documented interface exposes 24 procedures and functions, all PUBLIC. Core conversion routines include READ_LOCUS, which takes a locus object and returns geometry, segment ID, offset, and side/direction of the road; WRITE_LOCUS, which performs the inverse; and VERIFY_LOCUS, which validates a locus against the road network. Both READ_LOCUS and WRITE_LOCUS declare PRAGMA RESTRICT_REFERENCES (RNDS, WNDS, WNPS) to guarantee no database read or write side effects.

Attribute accessors include GET_LOCUS_SEGMENTID, GET_LOCUS_SPOT, GET_LOCUS_SIDE, GET_LOCUS_LAT, GET_LOCUS_LON, GET_LOCUS_SRID, and GET_LOCUS_STRING, each isolating a single locus property for callers that do not require the full geometry. GET_GEOMETRY, GET_GEOMETRY_TBL, and GET_SERV_AREA_COORDINATES retrieve spatial representations, including set-based forms for multiple geometries and service-area boundaries. GET_SEGMENT_ID resolves a segment identifier independently.

Routing and processing routines include COMPUTE_AND_SAVE_ROUTE and COMPUTE_AND_SAVE_LOCUSES, which derive and persist route or locus data, and SHOULD_CALL_LF, which determines whether the location framework should be invoked. IS_MANUAL_GEOMETRY distinguishes manually entered geometries from system-generated ones.

Tables Accessed

The package references the following objects through APPS synonyms:

Usage Notes

CSF_LOCUS_PUB is typically invoked from Oracle Forms, concurrent programs, and custom PL/SQL that require locus-to-geometry or geometry-to-locus translation. Because READ_LOCUS and WRITE_LOCUS carry PURITY assertions (RNDS, WNDS, WNPS), they are safe to call from SQL contexts and functions embedded in queries. The package is referenced by eight other packages, confirming its role as a shared foundation API. In 12.1.1 and 12.2.2 the signature and behavior are effectively identical; callers should pass the documented API version (1.0) and inspect x_return_status against the published constants. The searched term get_locus_side corresponds directly to the documented GET_LOCUS_SIDE procedure, which returns the road side associated with a locus.