1 PACKAGE CSM_PARTY_DOWNLOAD_PUB AUTHID CURRENT_USER AS
2 /* $Header: csmpptds.pls 120.3 2008/02/26 10:15:51 anaraman noship $ */
3
4 TYPE l_party_id_tbl_type IS TABLE OF csm_parties_acc.party_id%TYPE INDEX BY BINARY_INTEGER;
5 TYPE l_user_id_tbl_type IS TABLE OF csm_parties_acc.user_id%TYPE INDEX BY BINARY_INTEGER;
6
7 /*#
8 * Assign a customer to an user API.
9 *
10 * @param p_api_version_number the standard API version number
11 * @param p_init_msg_list the standard API flag allows API callers to request
12 * that the API does the initialization of the message list on their behalf.
13 * By default, the message list will not be initialized.
14 * @param p_user_id the user id to which the customer is to be assigned
15 * @param p_party_id the customer to be assigned
16 * @param p_operation the operation to be performed
17 * must have one of the following values:
18 * <LI><Code>INSERT</Code>
19 * <LI><Code>DELETE</Code>
20 * @param x_msg_count returns the number of messages in the API message list
21 * @param x_return_status returns the result of all the operations performed
22 * by the API and must have one of the following values:
23 * <LI><Code>FND_API.G_RET_STS_SUCCESS</Code>
24 * <LI><Code>FND_API.G_RET_STS_ERROR</Code>
25 * <LI><Code>FND_API.G_RET_STS_UNEXP_ERROR</Code>
26 * @param x_error_message return the error message
27 */
28
29 PROCEDURE assign_cust_to_user
30 ( p_api_version_number IN NUMBER,
31 p_init_msg_list IN VARCHAR2 :=FND_API.G_FALSE,
32 p_user_id IN NUMBER,
33 p_party_id IN NUMBER,
34 p_operation IN VARCHAR2,
35 x_msg_count OUT NOCOPY NUMBER,
36 x_return_status OUT NOCOPY VARCHAR2,
37 x_error_message OUT NOCOPY VARCHAR2
38 );
39
40 /*#
41 * Assign a multiple customers to multiple users API.
42 *
43 * @param p_api_version_number the standard API version number
44 * @param p_init_msg_list the standard API flag allows API callers to request
45 * that the API does the initialization of the message list on their behalf.
46 * By default, the message list will not be initialized.
47 * @param p_user_id_lst the user id to which the customer is to be assigned
48 * @param p_party_id_lst the customer to be assigned
49 * @param p_operation the operation to be performed
50 * must have one of the following values:
51 * <LI><Code>INSERT</Code>
52 * <LI><Code>DELETE</Code>
53 * @param x_msg_count returns the number of messages in the API message list
54 * @param x_return_status returns the result of all the operations performed
55 * by the API and must have one of the following values:
56 * <LI><Code>FND_API.G_RET_STS_SUCCESS</Code>
57 * <LI><Code>FND_API.G_RET_STS_ERROR</Code>
58 * <LI><Code>FND_API.G_RET_STS_UNEXP_ERROR</Code>
59 * @param x_error_message return the error message
60 */
61
62 PROCEDURE assign_mul_cust_to_users
63 ( p_api_version_number IN NUMBER,
64 p_init_msg_list IN VARCHAR2 :=FND_API.G_FALSE,
65 p_user_id_lst IN l_user_id_tbl_type,
66 p_party_id_lst IN l_party_id_tbl_type,
67 p_operation IN VARCHAR2,
68 x_msg_count OUT NOCOPY NUMBER,
69 x_return_status OUT NOCOPY VARCHAR2,
70 x_error_message OUT NOCOPY VARCHAR2
71 );
72
73 /*#
74 * Assign a customer location to an user API.
75 *
76 * @param p_api_version_number the standard API version number
77 * @param p_init_msg_list the standard API flag allows API callers to request
78 * that the API does the initialization of the message list on their behalf.
79 * By default, the message list will not be initialized.
80 * @param p_user_id the user id to which the customer is to be assigned
81 * @param p_party_id the customer to be assigned
82 * @param p_location_id the customer location to be assigned
83 * @param p_operation the operation to be performed
84 * must have one of the following values:
85 * <LI><Code>INSERT</Code>
86 * <LI><Code>DELETE</Code>
87 * @param x_msg_count returns the number of messages in the API message list
88 * @param x_return_status returns the result of all the operations performed
89 * by the API and must have one of the following values:
90 * <LI><Code>FND_API.G_RET_STS_SUCCESS</Code>
91 * <LI><Code>FND_API.G_RET_STS_ERROR</Code>
92 * <LI><Code>FND_API.G_RET_STS_UNEXP_ERROR</Code>
93 * @param x_error_message return the error message
94 */
95
96 PROCEDURE assign_cust_loc_to_user
97 ( p_api_version_number IN NUMBER,
98 p_init_msg_list IN VARCHAR2 :=FND_API.G_FALSE,
99 p_user_id IN NUMBER,
100 p_party_id IN NUMBER,
101 p_location_id IN NUMBER,
102 p_operation IN VARCHAR2,
103 x_msg_count OUT NOCOPY NUMBER,
104 x_return_status OUT NOCOPY VARCHAR2,
105 x_error_message OUT NOCOPY VARCHAR2
106 );
107
108 /*#
109 * Assign a multiple customer locations to multiple users API.
110 *
111 * @param p_api_version_number the standard API version number
112 * @param p_init_msg_list the standard API flag allows API callers to request
113 * that the API does the initialization of the message list on their behalf.
114 * By default, the message list will not be initialized.
115 * @param p_user_id_lst the user id to which the customer is to be assigned
116 * @param p_party_id the customer to be assigned
117 * @param p_location_id_lst the customer location to be assigned
118 * @param p_operation the operation to be performed
119 * must have one of the following values:
120 * <LI><Code>INSERT</Code>
121 * <LI><Code>DELETE</Code>
122 * @param x_msg_count returns the number of messages in the API message list
123 * @param x_return_status returns the result of all the operations performed
124 * by the API and must have one of the following values:
125 * <LI><Code>FND_API.G_RET_STS_SUCCESS</Code>
126 * <LI><Code>FND_API.G_RET_STS_ERROR</Code>
127 * <LI><Code>FND_API.G_RET_STS_UNEXP_ERROR</Code>
128 * @param x_error_message return the error message
129 */
130
131 PROCEDURE assign_mul_cust_loc_to_users
132 ( p_api_version_number IN NUMBER,
133 p_init_msg_list IN VARCHAR2 :=FND_API.G_FALSE,
134 p_user_id_lst IN l_user_id_tbl_type,
135 p_party_id IN NUMBER,
136 p_location_id_lst IN l_party_id_tbl_type,
137 p_operation IN VARCHAR2,
138 x_msg_count OUT NOCOPY NUMBER,
139 x_return_status OUT NOCOPY VARCHAR2,
140 x_error_message OUT NOCOPY VARCHAR2
141 );
142
143 /*#
144 * To fetch the parties related to an user API.
145 *
146 * @param p_api_version_number the standard API version number
147 * @param p_init_msg_list the standard API flag allows API callers to request
148 * that the API does the initialization of the message list on their behalf.
149 * By default, the message list will not be initialized.
150 * @param p_user_id the user id for which customers has to be fetched
151 * @param p_party_id_lst the customers which are fetched
152 * @param p_operation the operation to be performed can be null also
153 * @param x_msg_count returns the number of messages in the API message list
154 * @param x_return_status returns the result of all the operations performed
155 * by the API and must have one of the following values:
156 * <LI><Code>FND_API.G_RET_STS_SUCCESS</Code>
157 * <LI><Code>FND_API.G_RET_STS_ERROR</Code>
158 * <LI><Code>FND_API.G_RET_STS_UNEXP_ERROR</Code>
159 * @param x_error_message return the error message
160 */
161
162 PROCEDURE get_parties_for_user
163 ( p_api_version_number IN NUMBER,
164 p_init_msg_list IN VARCHAR2 :=FND_API.G_FALSE,
165 p_user_id IN NUMBER,
166 p_party_id_lst OUT NOCOPY l_party_id_tbl_type,
167 p_operation IN VARCHAR2,
168 x_msg_count OUT NOCOPY NUMBER,
169 x_return_status OUT NOCOPY VARCHAR2,
170 x_error_message OUT NOCOPY VARCHAR2
171 );
172
173 /*#
174 * To fetch the locations of a party related to an user API.
175 *
176 * @param p_api_version_number the standard API version number
177 * @param p_init_msg_list the standard API flag allows API callers to request
178 * that the API does the initialization of the message list on their behalf.
179 * By default, the message list will not be initialized.
180 * @param p_user_id the user id for which locations has to be fetched
181 * @param p_party_id the customers for which locations has to be fetched
182 * @param p_operation the operation to be performed can be null also
183 * @param p_location_id the location which are fetched
184 * @param x_msg_count returns the number of messages in the API message list
185 * @param x_return_status returns the result of all the operations performed
186 * by the API and must have one of the following values:
187 * <LI><Code>FND_API.G_RET_STS_SUCCESS</Code>
188 * <LI><Code>FND_API.G_RET_STS_ERROR</Code>
189 * <LI><Code>FND_API.G_RET_STS_UNEXP_ERROR</Code>
190 * @param x_error_message return the error message
191 */
192
193 PROCEDURE get_party_locations_for_user
194 ( p_api_version_number IN NUMBER,
195 p_init_msg_list IN VARCHAR2 :=FND_API.G_FALSE,
196 p_user_id IN NUMBER,
197 p_party_id IN NUMBER,
198 p_location_id OUT NOCOPY l_party_id_tbl_type,
199 p_operation IN VARCHAR2,
200 x_msg_count OUT NOCOPY NUMBER,
201 x_return_status OUT NOCOPY VARCHAR2,
202 x_error_message OUT NOCOPY VARCHAR2
203 );
204
205 END CSM_PARTY_DOWNLOAD_PUB;
[Home] [Help]