1 PACKAGE pos_pub_history_bo_pkg AUTHID CURRENT_USER AS
2 /* $Header: POSPUBHIS.pls 120.1 2010/11/25 12:27:55 puppulur noship $ */
3 /*#
4 * This package provides APIs to retrieve supplier business objects
5 * from the supplier data hub publication repository and for spoke
6 * systems to send responses to the supplier data hub.
7 *
8 * @rep:scope public
9 * @rep:product POS
10 * @rep:lifecycle active
11 * @rep:displayname Supplier Data Publication APIs
12 * @rep:category BUSINESS_ENTITY AP_SUPPLIER
13 */
14
15
16 /*#
17 * This API returns the supplier business objects given a supplier
18 * publication event.
19 * @param p_api_version Standard API version. Use 1.0.
20 * @param p_init_msg_list Standard API initialize message list flag. Default is fnd_api.g_true
21 * @param p_event_id Supplier publication event ID
22 * @param p_party_id Party ID of a particular supplier to be retrieved if known.
23 * @param p_orig_system If party ID is not known, supply the original system name.
24 * @param p_orig_system_reference If party ID is not known, supply the original system reference. Party ID and original system references can be NULL in which case, all suppliers published in the given event will be returned.
25 * @param x_suppliers Return value. A table of objects, each containing a supplier business object in XML format.
26 * @param x_return_status Standard API return status
27 * @param x_msg_count Standard API message count
28 * @param x_msg_data Standard API message data
29 * @rep:displayname Get Supplier Publication History
30 */
31 PROCEDURE get_published_suppliers
32 (
33 p_api_version IN NUMBER DEFAULT NULL,
34 p_init_msg_list IN VARCHAR2 DEFAULT NULL,
35 p_event_id IN NUMBER,
36 p_party_id IN NUMBER,
37 p_orig_system IN VARCHAR2,
38 p_orig_system_reference IN VARCHAR2,
39 x_suppliers OUT NOCOPY pos_pub_history_bo_tbl,
40 x_return_status OUT NOCOPY VARCHAR2,
41 x_msg_count OUT NOCOPY NUMBER,
42 x_msg_data OUT NOCOPY VARCHAR2
43 );
44
45
46 /*
47 Private version of the above.
48 */
49 PROCEDURE get_pos_pub_history_bo_tbl
50 (
51 p_api_version IN NUMBER DEFAULT NULL,
52 p_init_msg_list IN VARCHAR2 DEFAULT NULL,
53 p_event_id IN NUMBER,
54 p_party_id IN NUMBER,
55 p_orig_system IN VARCHAR2,
56 p_orig_system_reference IN VARCHAR2,
57 x_pos_pub_history_bo_tbl OUT NOCOPY pos_pub_history_bo_tbl,
58 x_return_status OUT NOCOPY VARCHAR2,
59 x_msg_count OUT NOCOPY NUMBER,
60 x_msg_data OUT NOCOPY VARCHAR2
61 );
62
63
64 /*#
65 * This API is intended to be used by a spoke system to respond to a
66 * Supplier Publication Event. A message will be written to the
67 * Supplier Hub's event response table.
68 * @param p_api_version Standard API version. Use 1.0.
69 * @param p_init_msg_list Standard API initialize message list flag. Default is fnd_api.g_true
70 * @param p_commit Commit flag. Perform commit if value is fnd_api.g_true. Default is fnd_api.g_false.
71 * @param p_target_system The spoke system's identity. Required.
72 * @param p_response_process_id Response process ID. Response ID required to uniquely identify a response for a target system. Required.
73 * @param p_response_process_status Response process status code. Stored in response table with open interpretation.
74 * @param p_request_process_id Request process ID. Stored in response table with open interpretation.
75 * @param p_request_process_status Request process status code. Stored in response table with open interpretation.
76 * @param p_event_id Supplier publication event ID this response refers to. Required.
77 * @param p_party_id Party ID of a particular supplier of the event this response refers to. Required.
78 * @param p_message Response message. Stored in response table with open interpretation.
79 * @param x_return_status Standard API return status
80 * @param x_msg_count Standard API message count
81 * @param x_msg_data Standard API message data
82 * @rep:displayname Create Supplier Publication Response
83 */
84 PROCEDURE create_publication_response
85 (
86 p_api_version IN NUMBER DEFAULT NULL,
87 p_init_msg_list IN VARCHAR2 DEFAULT NULL,
88 p_commit IN VARCHAR2 DEFAULT NULL,
89 p_target_system IN VARCHAR2,
90 p_response_process_id IN NUMBER,
91 p_response_process_status IN VARCHAR2,
92 p_request_process_id IN NUMBER,
93 p_request_process_status IN VARCHAR2,
94 p_event_id IN NUMBER,
95 p_party_id IN NUMBER,
96 p_message IN VARCHAR2,
97 x_return_status OUT NOCOPY VARCHAR2,
98 x_msg_count OUT NOCOPY NUMBER,
99 x_msg_data OUT NOCOPY VARCHAR2
100 );
101
102
103 END pos_pub_history_bo_pkg;
[Home] [Help]