1 PACKAGE HZ_EXTRACT_PERSON_CUST_BO_PVT AS
2 /*$Header: ARHEPAVS.pls 120.2 2008/02/06 10:16:55 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 Person Customer
8 * @rep:category BUSINESS_ENTITY HZ_PARTIES
9 * @rep:lifecycle active
10 * @rep:doccd 115hztig.pdf Person Customer Get APIs
11 */
12
13 --------------------------------------
14 --
15 -- PROCEDURE get_person_cust_bo
16 --
17 -- DESCRIPTION
18 -- Get a logical person 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_person_id Person ID.
26 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
27 -- OUT:
28 -- x_person_cust_obj Logical person 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 Person Customer API Procedure is a retrieval service that returns a full Person Customer business object.
46 The user identifies a particular Person Customer business object using the TCA identifier and/or
47 the object Source System information. Upon proper validation of the object,
48 the full Person Customer business object is returned. The object consists of all data included within
49 the Person 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 Person 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 Person Customer
59
60 */
61
62
63
64 PROCEDURE get_person_cust_bo(
65 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
66 p_person_id IN NUMBER,
67 p_action_type IN VARCHAR2 := NULL,
68 x_person_cust_obj OUT NOCOPY HZ_PERSON_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 PROCEDURE get_person_cust_v2_bo(
75 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
76 p_person_id IN NUMBER,
77 p_action_type IN VARCHAR2 := NULL,
78 x_person_cust_v2_obj OUT NOCOPY HZ_PERSON_CUST_V2_BO,
79 x_return_status OUT NOCOPY VARCHAR2,
80 x_msg_count OUT NOCOPY NUMBER,
81 x_msg_data OUT NOCOPY VARCHAR2
82 );
83
84 --------------------------------------
85 --
86 -- PROCEDURE get_person_custs_created
87 --
88 -- DESCRIPTION
89 --The caller provides an identifier for the Person Customers created business event and
90 --the procedure returns database objects of the type HZ_PERSON CUSTOMER_BO for all of
91 --the Person Customer business objects from the business event.
92
93 --
94 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
95 --
96 -- ARGUMENTS
97 -- IN:
98 -- p_init_msg_list Initialize message stack if it is set to
99 -- p_event_id BES Event identifier.
100 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
101 -- OUT:
102 -- x_person_cust_objs One or more created logical person customer.
103 -- x_return_status Return status after the call. The status can
104 -- be fnd_api.g_ret_sts_success (success),
105 -- fnd_api.g_ret_sts_error (error),
106 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
107 -- x_msg_count Number of messages in message stack.
108 -- x_msg_data Message text if x_msg_count is 1.
109 --
110 -- NOTES
111 --
112 -- MODIFICATION HISTORY
113 --
114 -- 10-JUN-2005 AWU Created.
115 --
116
117
118
119 /*
120 The Get Person customers Created procedure is a service to retrieve all of the Person Customer business objects
121 whose creations have been captured by a logical business event. Each Person Customers Created
122 business event signifies that one or more Person Customer business objects have been created.
123 The caller provides an identifier for the Person Customers Created business event and the procedure
124 returns all of the Person Customer business objects from the business event. For each business object
125 creation captured in the business event, the procedure calls the generic Get operation:
126 HZ_PERSON_BO_PVT.get_person_bo
127
128 Gathering all of the returned business objects from those API calls, the procedure packages
129 them in a table structure and returns them to the caller.
130 */
131
132
133 PROCEDURE get_person_custs_created(
134 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
135 p_event_id IN NUMBER,
136 x_person_cust_objs OUT NOCOPY HZ_PERSON_CUST_BO_TBL,
137 x_return_status OUT NOCOPY VARCHAR2,
138 x_msg_count OUT NOCOPY NUMBER,
139 x_msg_data OUT NOCOPY VARCHAR2
140 );
141
142
143
144 --------------------------------------
145 --
146 -- PROCEDURE get_person_custs_updated
147 --
148 -- DESCRIPTION
149 --The caller provides an identifier for the Person Customers update business event and
150 --the procedure returns database objects of the type HZ_PERSON_CUST_BO for all of
151 --the Person Customer business objects from the business event.
152
153 --
154 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
155 --
156 -- ARGUMENTS
157 -- IN:
158 -- p_init_msg_list Initialize message stack if it is set to
159 -- p_event_id BES Event identifier.
160 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
161 -- OUT:
162 -- x_person_cust_objs One or more created logical person.
163 -- x_return_status Return status after the call. The status can
164 -- be fnd_api.g_ret_sts_success (success),
165 -- fnd_api.g_ret_sts_error (error),
166 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
167 -- x_msg_count Number of messages in message stack.
168 -- x_msg_data Message text if x_msg_count is 1.
169 --
170 -- NOTES
171 --
172 -- MODIFICATION HISTORY
173 --
174 -- 10-JUN-2005 AWU Created.
175 --
176
177
178
179 /*
180 The Get Person Customers Updated procedure is a service to retrieve all of the Person Customer business objects whose
181 updates have been captured by the logical business event. Each Person Customers Updated business event signifies that
182 one or more Person Customer business objects have been updated.
183 The caller provides an identifier for the Person Customers Update business event and the procedure returns database
184 objects of the type HZ_PERSON_CUST_BO for all of the Person Customer business objects from the business event.
185 Gathering all of the returned database objects from those API calls, the procedure packages them in a table structure
186 and returns them to the caller.
187 */
188
189 PROCEDURE get_person_custs_updated(
190 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
191 p_event_id IN NUMBER,
192 x_person_cust_objs OUT NOCOPY HZ_PERSON_CUST_BO_TBL,
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 -- PROCEDURE get_person_cust_updated
201 --
202 -- DESCRIPTION
203 --The caller provides an identifier for the Person customer update business event and person id
204 --the procedure returns one database object of the type HZ_PERSON_CUST_BO
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_event_id BES Event identifier.
212 -- p_person_cust_id Person customer identifier.
213 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
214 -- OUT:
215 -- x_person_cust_obj One updated logical person.
216 -- x_return_status Return status after the call. The status can
217 -- be fnd_api.g_ret_sts_success (success),
218 -- fnd_api.g_ret_sts_error (error),
219 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
220 -- x_msg_count Number of messages in message stack.
221 -- x_msg_data Message text if x_msg_count is 1.
222 --
223 -- NOTES
224 --
225 -- MODIFICATION HISTORY
226 --
227 -- 06-JUN-2005 AWU Created.
228 --
229
230 PROCEDURE get_person_cust_updated(
231 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
232 p_event_id IN NUMBER,
233 p_person_cust_id IN NUMBER,
234 x_person_cust_obj OUT NOCOPY HZ_PERSON_CUST_BO,
235 x_return_status OUT NOCOPY VARCHAR2,
236 x_msg_count OUT NOCOPY NUMBER,
237 x_msg_data OUT NOCOPY VARCHAR2
238 );
239
240 --------------------------------------
241 --
242 -- PROCEDURE get_v2_person_custs_created
243 --
244 -- DESCRIPTION
245 --The caller provides an identifier for the Person Customers created business event and
246 --the procedure returns database objects of the type HZ_PERSON CUSTOMER_BO for all of
247 --the Person Customer business objects from the business event.
248
249 --
250 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
251 --
252 -- ARGUMENTS
253 -- IN:
254 -- p_init_msg_list Initialize message stack if it is set to
255 -- p_event_id BES Event identifier.
256 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
257 -- OUT:
258 -- x_person_cust_v2_objs One or more created logical person customer.
259 -- x_return_status Return status after the call. The status can
260 -- be fnd_api.g_ret_sts_success (success),
261 -- fnd_api.g_ret_sts_error (error),
262 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
263 -- x_msg_count Number of messages in message stack.
264 -- x_msg_data Message text if x_msg_count is 1.
265 --
266 -- NOTES
267 --
268 -- MODIFICATION HISTORY
269 --
270 -- 10-JUN-2005 VSEGU Created.
271 --
272
273
274
275 /*
276 The Get Person customers Created procedure is a service to retrieve all of the Person Customer business objects
277 whose creations have been captured by a logical business event. Each Person Customers Created
278 business event signifies that one or more Person Customer business objects have been created.
279 The caller provides an identifier for the Person Customers Created business event and the procedure
280 returns all of the Person Customer business objects from the business event. For each business object
281 creation captured in the business event, the procedure calls the generic Get operation:
282 HZ_PERSON_BO_PVT.get_person_bo
283
284 Gathering all of the returned business objects from those API calls, the procedure packages
285 them in a table structure and returns them to the caller.
286 */
287
288
289 PROCEDURE get_v2_person_custs_created(
290 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
291 p_event_id IN NUMBER,
292 x_person_cust_v2_objs OUT NOCOPY HZ_PERSON_CUST_V2_BO_TBL,
293 x_return_status OUT NOCOPY VARCHAR2,
294 x_msg_count OUT NOCOPY NUMBER,
295 x_msg_data OUT NOCOPY VARCHAR2
296 );
297
298
299
300 --------------------------------------
301 --
302 -- PROCEDURE get_v2_person_custs_updated
303 --
304 -- DESCRIPTION
305 --The caller provides an identifier for the Person Customers update business event and
306 --the procedure returns database objects of the type HZ_PERSON_CUST_V2_BO for all of
307 --the Person Customer business objects from the business event.
308
309 --
310 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
311 --
312 -- ARGUMENTS
313 -- IN:
314 -- p_init_msg_list Initialize message stack if it is set to
315 -- p_event_id BES Event identifier.
316 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
317 -- OUT:
318 -- x_person_cust_v2_objs One or more created logical person.
319 -- x_return_status Return status after the call. The status can
320 -- be fnd_api.g_ret_sts_success (success),
321 -- fnd_api.g_ret_sts_error (error),
322 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
323 -- x_msg_count Number of messages in message stack.
324 -- x_msg_data Message text if x_msg_count is 1.
325 --
326 -- NOTES
327 --
328 -- MODIFICATION HISTORY
329 --
330 -- 10-JUN-2005 VSEGU Created.
331 --
332
333
334
335 /*
336 The Get Person Customers Updated procedure is a service to retrieve all of the Person Customer business objects whose
337 updates have been captured by the logical business event. Each Person Customers Updated business event signifies that
338 one or more Person Customer business objects have been updated.
339 The caller provides an identifier for the Person Customers Update business event and the procedure returns database
340 objects of the type HZ_PERSON_CUST_V2_BO for all of the Person Customer business objects from the business event.
341 Gathering all of the returned database objects from those API calls, the procedure packages them in a table structure
342 and returns them to the caller.
343 */
344
345 PROCEDURE get_v2_person_custs_updated(
346 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
347 p_event_id IN NUMBER,
348 x_person_cust_v2_objs OUT NOCOPY HZ_PERSON_CUST_V2_BO_TBL,
349 x_return_status OUT NOCOPY VARCHAR2,
350 x_msg_count OUT NOCOPY NUMBER,
351 x_msg_data OUT NOCOPY VARCHAR2
352 );
353
354 --------------------------------------
355 --
356 -- PROCEDURE get_v2_person_cust_updated
357 --
358 -- DESCRIPTION
359 --The caller provides an identifier for the Person customer update business event and person id
360 --the procedure returns one database object of the type HZ_PERSON_CUST_V2_BO
361 --
362 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
363 --
364 -- ARGUMENTS
365 -- IN:
366 -- p_init_msg_list Initialize message stack if it is set to
367 -- p_event_id BES Event identifier.
368 -- p_person_cust_id Person customer identifier.
369 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
370 -- OUT:
371 -- x_person_cust_v2_obj One updated logical person.
372 -- x_return_status Return status after the call. The status can
373 -- be fnd_api.g_ret_sts_success (success),
374 -- fnd_api.g_ret_sts_error (error),
375 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
376 -- x_msg_count Number of messages in message stack.
377 -- x_msg_data Message text if x_msg_count is 1.
378 --
379 -- NOTES
380 --
381 -- MODIFICATION HISTORY
382 --
383 -- 04-FEB-2008 VSEGU Created.
384 --
385
386 PROCEDURE get_v2_person_cust_updated(
387 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
388 p_event_id IN NUMBER,
389 p_person_cust_id IN NUMBER,
390 x_person_cust_v2_obj OUT NOCOPY HZ_PERSON_CUST_V2_BO,
391 x_return_status OUT NOCOPY VARCHAR2,
392 x_msg_count OUT NOCOPY NUMBER,
393 x_msg_data OUT NOCOPY VARCHAR2
394 );
395
396 END HZ_EXTRACT_PERSON_CUST_BO_PVT;
[Home] [Help]