Search Results is_rank_list_exhausted

Overview

The APPS.FTE_CARRIER_RANK_LIST_PVT package body implements the private business logic supporting Oracle E-Business Suite's Freight and Transportation Execution (FTE) carrier rank list functionality. In the ETRM data model, a carrier rank list defines the ordered sequence of carriers that the rating and tendering engine will consider when selecting a carrier for a shipment or trip. This package provides the internal API layer through which rank lists are created, queried, modified, deleted, evaluated for exhaustion, and printed. It is classified as a Private (PVT) API, meaning its procedures are intended to be invoked by other FTE/WSH packages rather than directly by external consumers, forms, or customizations.

The package belongs to the APPS schema and is documented as VALID in both Oracle EBS 12.1.1 and 12.2.2. It operates against the FTE_CARRIER_RANK_LIST and FTE_CARRIER_RANK_LIST_S tables to persist rank list definitions and their sequence-of-carrier detail, and it integrates closely with the WSH (Warehouse Shipping) trip and tendering modules through dependencies such as WSH_TRIPS, WSH_TRIPS_PVT, FTE_TENDER_PVT, and FTE_TRIP_RATING_GRP.

Key Procedures and Functions

The package exposes nine documented program units:

• CREATE_RANK_LIST_BULK — Creates carrier rank lists in bulk, allowing multiple rank list definitions to be inserted in a single invocation. This supports high-volume setup and data migration scenarios.
• RANK_LIST_ACTION — The core workhorse that performs a requested action against a rank list, such as applying sequencing, updating carrier positions, or manipulating rank list state.
• RANK_LIST_ACTION_UIWRAPPER — A UI-facing wrapper around RANK_LIST_ACTION that adapts the internal logic for invocation from an Oracle Forms interface, handling messages and errors in a form-friendly manner.
• DELETE_RANK_LIST_UIWRAPPER — Removes a carrier rank list and its associated detail records, exposing the delete operation through a form-compatible interface.
• GET_RANK_DETAILS — Retrieves the detailed carrier entries and sequencing that make up a specified rank list.
• GET_RANK_LIST — Retrieves the header-level rank list definition, returning the rank list identifier and associated attributes.
• IS_RANK_LIST_EXHAUSTED — Evaluates whether a rank list has been fully consumed, i.e., whether all carriers in the ordered sequence have already been attempted, which is critical to tendering decision logic.
• REMOVE_SERVICE_APPLY_NEXT — Removes a service entry from consideration and advances the ranking pointer to the next applicable carrier in the list, supporting the iterative tender process.
• PRINT_RANK_LIST — Produces a formatted output of a rank list, typically used for review or documentation purposes.

Tables Accessed

The package reads and writes the following tables (via APPS synonyms):

• FTE_CARRIER_RANK_LIST — The primary header table storing rank list definitions, including the rank list identifier and sequencing control attributes. It is read and modified during create, action, delete, and query operations.
• FTE_CARRIER_RANK_LIST_S — The detail (sequence) table holding the ordered carrier entries that constitute a rank list. This is the table referenced in the user's search term "fte_carrier_rank_list_s" and is central to GET_RANK_DETAILS and the apply-next logic.
• WSH_TRIPS — The shipment/trip table, accessed to associate rank lists with trips and to support tendering decisions.
• DUAL — Used for single-row PL/SQL computations and constant retrieval.
• PLITBLM — The standard PL/SQL Tables (PL/SQL table memory) package, typically used for array manipulation during bulk operations.

Usage Notes

Because FTE_CARRIER_RANK_LIST_PVT is a PVT (private) API, it is not intended for direct invocation by end users or external customizations. It is referenced by seven other packages and is invoked internally by the FTE and WSH modules. The UI wrappers (RANK_LIST_ACTION_UIWRAPPER and DELETE_RANK_LIST_UIWRAPPER) exist specifically to support Oracle Forms-based maintenance of carrier rank lists within the EBS transportation setup and execution windows.

The IS_RANK_LIST_EXHAUSTED and REMOVE_SERVICE_APPLY_NEXT procedures are integral to the carrier tendering workflow: as tendering attempts each carrier in sequence, the rank list is progressively consumed, and the exhausted check determines whether further carriers remain. The dependency on FND_MSG_PUB and FND_MESSAGE indicates standard EBS error and message handling, while WSH_DEBUG_SV provides diagnostic logging. Customizations should call public (non-PVT) FTE/WSH APIs or use the corresponding forms rather than referencing this package directly, as signatures and behavior are owned by Oracle and subject to change across patch levels.