1 PACKAGE HZ_EXTRACT_ORG_CUST_BO_PVT AS
2 /*$Header: ARHEOAVS.pls 120.2 2008/02/06 10:33:54 vsegu ship $ */
3 /*
4 * This package contains the private APIs for logical person_cust.
5 * @rep:scope private
6 * @rep:product HZ
7 * @rep:displayname Organization Customer
8 * @rep:category BUSINESS_ENTITY HZ_PARTIES
9 * @rep:lifecycle active
10 * @rep:doccd 115hztig.pdf Organization Customer Get APIs
11 */
12
13 --------------------------------------
14 --
15 -- PROCEDURE get_org_cust_bo
16 --
17 -- DESCRIPTION
18 -- Get a logical organization customer.
19 --
20 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
21 --
22 -- ARGUMENTS
23 -- IN:
24 -- p_init_msg_list Initialize message stack if it is set to
25 -- p_organization_id Organization ID.
26 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
27 -- OUT:
28 -- x_org_cust_obj Logical organization customer record.
29 -- x_return_status Return status after the call. The status can
30 -- be fnd_api.g_ret_sts_success (success),
31 -- fnd_api.g_ret_sts_error (error),
32 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
33 -- x_msg_count Number of messages in message stack.
34 -- x_msg_data Message text if x_msg_count is 1.
35 --
36 -- NOTES
37 --
38 -- MODIFICATION HISTORY
39 --
40 --
41 -- 10-JUN-2005 AWU Created.
42 --
43
44 /*
45 The Get Organization Customer API Procedure is a retrieval service that returns a full Organization Customer business object.
46 The user identifies a particular Organization Customer business object using the TCA identifier and/or
47 the object Source System information. Upon proper validation of the object,
48 the full Organization Customer business object is returned. The object consists of all data included within
49 the Organization Customer business object, at all embedded levels. This includes the set of all data stored
50 in the TCA tables for each embedded entity.
51
52 To retrieve the appropriate embedded business objects within the Organization Customer business object,
53 the Get procedure calls the equivalent procedure for the following embedded objects:
54
55 Embedded BO Mandatory Multiple Logical API Procedure Comments
56
57 Person Y N get_person_bo
58 Customer Account Y Y get_cust_acct_bo Called for each Customer Account object for the Organization Customer
59
60 */
61
62
63
64 PROCEDURE get_org_cust_bo(
65 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
66 p_organization_id IN NUMBER,
67 p_action_type IN VARCHAR2 := NULL,
68 x_org_cust_obj OUT NOCOPY HZ_ORG_CUST_BO,
69 x_return_status OUT NOCOPY VARCHAR2,
70 x_msg_count OUT NOCOPY NUMBER,
71 x_msg_data OUT NOCOPY VARCHAR2
72 );
73
74 --------------------------------------
75 --
76 -- PROCEDURE get_org_custs_created
77 --
78 -- DESCRIPTION
79 --The caller provides an identifier for the Organization Customers created business event and
80 --the procedure returns database objects of the type HZ_ORG CUSTOMER_BO for all of
81 --the Organization Customer business objects from the business event.
82
83 --
84 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
85 --
86 -- ARGUMENTS
87 -- IN:
88 -- p_init_msg_list Initialize message stack if it is set to
89 -- p_event_id BES Event identifier.
90 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
91 -- OUT:
92 -- x_org_cust_objs One or more created logical organization customer.
93 -- x_return_status Return status after the call. The status can
94 -- be fnd_api.g_ret_sts_success (success),
95 -- fnd_api.g_ret_sts_error (error),
96 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
97 -- x_msg_count Number of messages in message stack.
98 -- x_msg_data Message text if x_msg_count is 1.
99 --
100 -- NOTES
101 --
102 -- MODIFICATION HISTORY
103 --
104 -- 10-JUN-2005 AWU Created.
105 --
106
107
108
109 /*
110 The Get organization customers Created procedure is a service to retrieve all of the Organization Customer business objects
111 whose creations have been captured by a logical business event. Each Organization Customers Created
112 business event signifies that one or more Organization Customer business objects have been created.
113 The caller provides an identifier for the Organization Customers Created business event and the procedure
114 returns all of the Organization Customer business objects from the business event. For each business object
115 creation captured in the business event, the procedure calls the generic Get operation:
116 HZ_ORG_BO_PVT.get_org_bo
117
118 Gathering all of the returned business objects from those API calls, the procedure packages
119 them in a table structure and returns them to the caller.
120 */
121
122
123 PROCEDURE get_org_custs_created(
124 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
125 p_event_id IN NUMBER,
126 x_org_cust_objs OUT NOCOPY HZ_ORG_CUST_BO_TBL,
127 x_return_status OUT NOCOPY VARCHAR2,
128 x_msg_count OUT NOCOPY NUMBER,
129 x_msg_data OUT NOCOPY VARCHAR2
130 );
131
132
133
134 --------------------------------------
135 --
136 -- PROCEDURE get_org_custs_updated
137 --
138 -- DESCRIPTION
139 --The caller provides an identifier for the Organization Customers update business event and
140 --the procedure returns database objects of the type HZ_ORG_CUST_BO for all of
141 --the Organization Customer business objects from the business event.
142
143 --
144 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
145 --
146 -- ARGUMENTS
147 -- IN:
148 -- p_init_msg_list Initialize message stack if it is set to
149 -- p_event_id BES Event identifier.
150 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
151 -- OUT:
152 -- x_org_cust_objs One or more created logical person.
153 -- x_return_status Return status after the call. The status can
154 -- be fnd_api.g_ret_sts_success (success),
155 -- fnd_api.g_ret_sts_error (error),
156 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
157 -- x_msg_count Number of messages in message stack.
158 -- x_msg_data Message text if x_msg_count is 1.
159 --
160 -- NOTES
161 --
162 -- MODIFICATION HISTORY
163 --
164 -- 10-JUN-2005 AWU Created.
165 --
166
167
168
169 /*
170 The Get Organization Customers Updated procedure is a service to retrieve all of the Organization Customer business
171 objects whose updates have been captured by the logical business event. Each Organization Customers Updated business
172 event signifies that one or more Organization Customer business objects have been updated.
173 The caller provides an identifier for the Organization Customers Update business event and the procedure returns
174 database objects of the type HZ_ORG_CUST_BO for all of the Organization Customer business objects from the business event.
175 Gathering all of the returned database objects from those API calls, the procedure packages them in a table structure
176 and returns them to the caller.
177 */
178
179 PROCEDURE get_org_custs_updated(
180 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
181 p_event_id IN NUMBER,
182 x_org_cust_objs OUT NOCOPY HZ_ORG_CUST_BO_TBL,
183 x_return_status OUT NOCOPY VARCHAR2,
184 x_msg_count OUT NOCOPY NUMBER,
185 x_msg_data OUT NOCOPY VARCHAR2
186 );
187
188 PROCEDURE get_org_cust_updated(
189 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
190 p_event_id IN NUMBER,
191 p_org_cust_id IN NUMBER,
192 x_org_cust_obj OUT NOCOPY HZ_ORG_CUST_BO,
193 x_return_status OUT NOCOPY VARCHAR2,
194 x_msg_count OUT NOCOPY NUMBER,
195 x_msg_data OUT NOCOPY VARCHAR2
196 );
197
198
199 --------------------------------------
200 --
201 -- PROCEDURE get_org_cust_v2_bo
202 --
203 -- DESCRIPTION
204 -- Get a logical organization customer.
205 --
206 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
207 --
208 -- ARGUMENTS
209 -- IN:
210 -- p_init_msg_list Initialize message stack if it is set to
211 -- p_organization_id Organization ID.
212 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
213 -- OUT:
214 -- x_org_cust_v2_obj Logical organization customer record.
215 -- x_return_status Return status after the call. The status can
216 -- be fnd_api.g_ret_sts_success (success),
217 -- fnd_api.g_ret_sts_error (error),
218 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
219 -- x_msg_count Number of messages in message stack.
220 -- x_msg_data Message text if x_msg_count is 1.
221 --
222 -- NOTES
223 --
224 -- MODIFICATION HISTORY
225 --
226 --
227 -- 04-FEB-2008 VSEGU Created.
228 --
229
230 /*
231 The Get Organization Customer API Procedure is a retrieval service that returns a full Organization Customer business object.
232 The user identifies a particular Organization Customer business object using the TCA identifier and/or
233 the object Source System information. Upon proper validation of the object,
234 the full Organization Customer business object is returned. The object consists of all data included within
235 the Organization Customer business object, at all embedded levels. This includes the set of all data stored
236 in the TCA tables for each embedded entity.
237
238 To retrieve the appropriate embedded business objects within the Organization Customer business object,
239 the Get procedure calls the equivalent procedure for the following embedded objects:
240
241 Embedded BO Mandatory Multiple Logical API Procedure Comments
242
243 Person Y N get_person_bo
244 Customer Account Y Y get_cust_acct_v2_bo Called for each Customer Account object for the Organization Customer
245
246 */
247
248
249
250 PROCEDURE get_org_cust_v2_bo(
251 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
252 p_organization_id IN NUMBER,
253 p_action_type IN VARCHAR2 := NULL,
254 x_org_cust_v2_obj OUT NOCOPY HZ_ORG_CUST_V2_BO,
255 x_return_status OUT NOCOPY VARCHAR2,
256 x_msg_count OUT NOCOPY NUMBER,
257 x_msg_data OUT NOCOPY VARCHAR2
258 );
259
260 --------------------------------------
261 --
262 -- PROCEDURE get_v2_org_custs_created
263 --
264 -- DESCRIPTION
265 --The caller provides an identifier for the Organization Customers created business event and
266 --the procedure returns database objects of the type HZ_ORG CUSTOMER_BO for all of
267 --the Organization Customer business objects from the business event.
268
269 --
270 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
271 --
272 -- ARGUMENTS
273 -- IN:
274 -- p_init_msg_list Initialize message stack if it is set to
275 -- p_event_id BES Event identifier.
276 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
277 -- OUT:
278 -- x_org_cust_v2_objs One or more created logical organization customer.
279 -- x_return_status Return status after the call. The status can
280 -- be fnd_api.g_ret_sts_success (success),
281 -- fnd_api.g_ret_sts_error (error),
282 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
283 -- x_msg_count Number of messages in message stack.
284 -- x_msg_data Message text if x_msg_count is 1.
285 --
286 -- NOTES
287 --
288 -- MODIFICATION HISTORY
289 --
290 -- 04-FEB-2008 VSEGU Created.
291 --
292
293
294
295 /*
296 The Get organization customers Created procedure is a service to retrieve all of the Organization Customer business objects
297 whose creations have been captured by a logical business event. Each Organization Customers Created
298 business event signifies that one or more Organization Customer business objects have been created.
299 The caller provides an identifier for the Organization Customers Created business event and the procedure
300 returns all of the Organization Customer business objects from the business event. For each business object
301 creation captured in the business event, the procedure calls the generic Get operation:
302 HZ_ORG_BO_PVT.get_org_bo
303
304 Gathering all of the returned business objects from those API calls, the procedure packages
305 them in a table structure and returns them to the caller.
306 */
307
308
309 PROCEDURE get_v2_org_custs_created(
310 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
311 p_event_id IN NUMBER,
312 x_org_cust_v2_objs OUT NOCOPY HZ_ORG_CUST_V2_BO_TBL,
313 x_return_status OUT NOCOPY VARCHAR2,
314 x_msg_count OUT NOCOPY NUMBER,
315 x_msg_data OUT NOCOPY VARCHAR2
316 );
317
318
319
320 --------------------------------------
321 --
322 -- PROCEDURE get_v2_org_custs_updated
323 --
327 --the Organization Customer business objects from the business event.
324 -- DESCRIPTION
325 --The caller provides an identifier for the Organization Customers update business event and
326 --the procedure returns database objects of the type HZ_ORG_CUST_V2_BO for all of
328
329 --
330 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
331 --
332 -- ARGUMENTS
333 -- IN:
334 -- p_init_msg_list Initialize message stack if it is set to
335 -- p_event_id BES Event identifier.
336 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
337 -- OUT:
338 -- x_org_cust_v2_objs One or more created logical person.
339 -- x_return_status Return status after the call. The status can
340 -- be fnd_api.g_ret_sts_success (success),
341 -- fnd_api.g_ret_sts_error (error),
342 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
343 -- x_msg_count Number of messages in message stack.
344 -- x_msg_data Message text if x_msg_count is 1.
345 --
346 -- NOTES
347 --
348 -- MODIFICATION HISTORY
349 --
350 -- 04-FEB-2008 VSEGU Created.
351 --
352
353
354
355 /*
356 The Get Organization Customers Updated procedure is a service to retrieve all of the Organization Customer business
357 objects whose updates have been captured by the logical business event. Each Organization Customers Updated business
358 event signifies that one or more Organization Customer business objects have been updated.
359 The caller provides an identifier for the Organization Customers Update business event and the procedure returns
360 database objects of the type HZ_ORG_CUST_V2_BO for all of the Organization Customer business objects from the business event.
361 Gathering all of the returned database objects from those API calls, the procedure packages them in a table structure
362 and returns them to the caller.
363 */
364
365 PROCEDURE get_v2_org_custs_updated(
366 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
367 p_event_id IN NUMBER,
368 x_org_cust_v2_objs OUT NOCOPY HZ_ORG_CUST_V2_BO_TBL,
369 x_return_status OUT NOCOPY VARCHAR2,
370 x_msg_count OUT NOCOPY NUMBER,
371 x_msg_data OUT NOCOPY VARCHAR2
372 );
373
374 PROCEDURE get_v2_org_cust_updated(
375 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
376 p_event_id IN NUMBER,
377 p_org_cust_id IN NUMBER,
378 x_org_cust_v2_obj OUT NOCOPY HZ_ORG_CUST_V2_BO,
379 x_return_status OUT NOCOPY VARCHAR2,
380 x_msg_count OUT NOCOPY NUMBER,
381 x_msg_data OUT NOCOPY VARCHAR2
382 );
383 END HZ_EXTRACT_ORG_CUST_BO_PVT;
[Home] [Help]