Search Results get_order_parameter_value




Overview
Explore in AI Chat

Overview

XDP_INTERFACES_PUB is a public API package in the Oracle E-Business Suite (EBS) Application Object Library, owned by the APPS schema and classified as a PUB interface. It serves as the primary programmatic entry point for loading and managing order data within the Oracle Enterprise Transportation and Logistics (ETRM) domain, historically associated with the Oracle Order Capture and SDP (Supply Chain Data Provider) order model. The package body carries the CVS header identifier XDPINPBB.pls 120.1, dated 2005/06/15, indicating the object has been stable across EBS releases 12.1.1 and 12.2.2 with minimal change.

The package encapsulates the business logic required to validate, pre-process, and persist order headers, order lines, and their associated descriptive parameters. Internally it relies on the XDP_TYPES PL/SQL package for its strongly typed collection arguments, including ORDER_HEADER, ORDER_PARAMETER_LIST, ORDER_LINE_LIST, and LINE_PARAM_LIST. It also follows Oracle's standard API architecture, invoking FND_API.Compatible_API_Call for version compatibility checking, FND_API.to_Boolean and FND_MSG_PUB.initialize for message list handling, and FND_API.G_EXC_UNEXPECTED_ERROR for standardized exception raising. This conformance allows the API to participate cleanly in concurrent processing, forms, and custom extension code.

Key Procedures and Functions

The package exposes nine documented procedures and functions, covering the order lifecycle from creation through cancellation and retrieval.

  • PROCESS_ORDER — The core routine for creating or updating an order. It accepts an order header, order parameters, order line list, and line parameter list, validates compatibility, optionally initializes the message list, performs pre-processing, and returns the generated SDP order identifier along with standard return status, message count, and message data outputs.
  • CANCEL_ORDER — Reverses or voids a previously processed order, applying the same API framework conventions.
  • GET_ORDER_PARAMETER_LIST — Retrieves the complete set of order-level parameters for a given order.
  • GET_ORDER_PARAMETER_VALUE — Returns a single named order-level parameter value, useful for targeted lookups.
  • GET_LINE_PARAMETER_VALUE — The line-level counterpart, returning the value of a specific parameter associated with an individual order line. This is the routine users most frequently search for when resolving line attribute questions.
  • GET_ORDER_DETAILS — Returns header and line detail information for an existing order.
  • GET_ORDER_STATUS — Returns the current processing or workflow status of an order.

Tables Accessed

The only documented table referenced via APPS synonyms is PLITBLM, an ETRM/Order Capture related table. Through this synonym the package reads parameter and order metadata needed to resolve values returned by the GET_ functions and to validate data during PROCESS_ORDER. The persistence of order headers and lines themselves is handled indirectly through the underlying order schema objects invoked by PROCESS_ORDER; the public package itself abstracts those details.

Usage Notes

XDP_INTERFACES_PUB is referenced by four other packages and is accordingly invoked from forms, concurrent programs, and custom PL/SQL integrations that need to create, cancel, or query orders. Typical call patterns set p_api_version to a value compatible with the internal l_api_version of 11.5, supply p_init_msg_list as FND_API.G_TRUE to capture errors, and read x_RETURN_STATUS plus x_msg_count/x_msg_data to detect failures. Because the API uses NOCOPY OUT parameters and standardized FND messaging, callers should always inspect the return status rather than relying on exceptions alone. When migrating between 12.1.1 and 12.2.2, the package signature has remained stable, so existing customizations invoking GET_LINE_PARAMETER_VALUE and its siblings generally require no modification.