1 PACKAGE HZ_PERSON_CUST_BO_PUB AS
2 /*$Header: ARHBPABS.pls 120.8 2008/02/06 11:23:42 vsegu ship $ */
3 /*#
4 * Person Customer Business Object API
5 * Public API that allows users to manage Person Customer business objects in the Trading Community Architecture.
6 * Several operations are supported, including the creation and update of the business object.
7 *
8 * @rep:scope public
9 * @rep:product HZ
10 * @rep:lifecycle active
11 * @rep:category BUSINESS_ENTITY HZ_PERSON
12 * @rep:displayname Person Customer Business Object API
13 * @rep:doccd 120hztig.pdf Person Customer Business Object API, Oracle Trading Community Architecture Technical Implementation Guide
14 */
15
16
17 -- PROCEDURE create_person_cust_bo
18 --
19 -- DESCRIPTION
20 -- Create person customer account.
21 --
22 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
23 --
24 -- ARGUMENTS
25 -- IN:
26 -- p_init_msg_list Initialize message stack if it is set to
27 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
28 -- p_validate_bo_flag If it is set to FND_API.G_TRUE, validate
29 -- the completeness of business object.
30 -- p_person_cust_obj Logical person customer account object.
31 -- p_created_by_module Created by module.
32 -- OUT:
33 -- x_return_status Return status after the call. The status can
34 -- be fnd_api.g_ret_sts_success (success),
35 -- fnd_api.g_ret_sts_error (error),
36 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
37 -- x_msg_count Number of messages in message stack.
38 -- x_msg_data Message text if x_msg_count is 1.
39 -- x_person_id Person ID.
40 --
41 -- NOTES
42 --
43 -- MODIFICATION HISTORY
44 --
45 -- 14-DEC-2004 Arnold Ng Created.
46
47
48 PROCEDURE create_person_cust_bo(
49 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
50 p_validate_bo_flag IN VARCHAR2 := fnd_api.g_true,
51 p_person_cust_obj IN HZ_PERSON_CUST_BO,
52 p_created_by_module IN VARCHAR2,
53 x_return_status OUT NOCOPY VARCHAR2,
54 x_msg_count OUT NOCOPY NUMBER,
55 x_msg_data OUT NOCOPY VARCHAR2,
56 x_person_id OUT NOCOPY NUMBER
57 );
58
59 /*#
60 * Create Person Customer Business Object (create_person_cust_bo)
61 * Creates a Person Customer business object. You pass object data to the procedure, packaged within an object type defined
62 * specifically for the API. The object type is HZ_PERSON_CUST_BO for the Person Customer business object. In addition to
63 * the object's business object attributes, the object type also includes lower-level embedded child entities or objects
64 * that can be simultaneously created.
65 *
66 * @param p_validate_bo_flag Indicates if the passed business object is to be validated for completeness. Default value: true
67 * @param p_person_cust_obj The Person Customer business object to be created in its entirety
68 * @param p_created_by_module The module creating this business object. Must be a valid created_by_module value
69 * @param p_obj_source The source of this business object
70 * @param p_return_obj_flag Indicates if the created object is to be returned to the caller as an output parameter. Default value: false
71 * @param x_return_status Return status after the call
72 * @param x_messages Messages returned from the creation of the business object
73 * @param x_return_obj The Person Customer business object that was created, returned as an output parameter
74 * @param x_person_id TCA identifier for the Person Customer business object
75 * @rep:scope public
76 * @rep:lifecycle active
77 * @rep:displayname Create Person Customer Business Object
78 * @rep:doccd 120hztig.pdf Create Person Customer Business Object, Oracle Trading Community Architecture Technical Implementation Guide
79 */
80
81 PROCEDURE create_person_cust_bo(
82 p_validate_bo_flag IN VARCHAR2 := fnd_api.g_true,
83 p_person_cust_obj IN HZ_PERSON_CUST_BO,
84 p_created_by_module IN VARCHAR2,
85 p_obj_source IN VARCHAR2 := null,
86 p_return_obj_flag IN VARCHAR2 := fnd_api.g_true,
87 x_return_status OUT NOCOPY VARCHAR2,
88 x_messages OUT NOCOPY HZ_MESSAGE_OBJ_TBL,
89 x_return_obj OUT NOCOPY HZ_PERSON_CUST_BO,
90 x_person_id OUT NOCOPY NUMBER
91 );
92
93 -- PROCEDURE update_person_cust_bo
94 --
95 -- DESCRIPTION
96 -- Update person customer account.
97 --
98 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
99 --
100 -- ARGUMENTS
101 -- IN:
102 -- p_init_msg_list Initialize message stack if it is set to
103 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
104 -- p_person_cust_obj Logical person customer account object.
105 -- p_created_by_module Created by module.
106 -- OUT:
107 -- x_return_status Return status after the call. The status can
108 -- be fnd_api.g_ret_sts_success (success),
109 -- fnd_api.g_ret_sts_error (error),
110 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
111 -- x_msg_count Number of messages in message stack.
112 -- x_msg_data Message text if x_msg_count is 1.
113 -- x_person_id Person ID.
114 --
115 -- NOTES
116 --
117 -- MODIFICATION HISTORY
118 --
119 -- 14-DEC-2004 Arnold Ng Created.
120
121
122 PROCEDURE update_person_cust_bo(
123 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
124 p_person_cust_obj IN HZ_PERSON_CUST_BO,
125 p_created_by_module IN VARCHAR2,
126 x_return_status OUT NOCOPY VARCHAR2,
127 x_msg_count OUT NOCOPY NUMBER,
128 x_msg_data OUT NOCOPY VARCHAR2,
129 x_person_id OUT NOCOPY NUMBER
130 );
131
132 /*#
133 * Update Person Customer Business Object (update_person_cust_bo)
134 * Updates a Person Customer business object. You pass any modified object data to the procedure, packaged within an object
135 * type defined specifically for the API. The object type is HZ_PERSON_CUST_BO for the Person Customer business object.
136 * In addition to the object's business object attributes, the object type also includes embedded child business entities
137 * or objects that can be simultaneously created or updated.
138 *
139 * @param p_person_cust_obj The Person Customer business object to be updated
140 * @param p_created_by_module The module updating this business object
141 * @param p_obj_source The source of this business object
142 * @param p_return_obj_flag Indicates if the updated object is to be returned to the caller as an output parameter. Default value: false
143 * @param x_return_status Return status after the call
144 * @param x_messages Messages returned from the update of the business object
145 * @param x_return_obj The Person Customer business object that was updated, returned as an output parameter
146 * @param x_person_id TCA identifier for the Person Customer business object
147 * @rep:scope public
148 * @rep:lifecycle active
149 * @rep:displayname Update Person Customer Business Object
150 * @rep:doccd 120hztig.pdf Update Person Customer Business Object, Oracle Trading Community Architecture Technical Implementation Guide
151 */
152
153
154 PROCEDURE update_person_cust_bo(
155 p_person_cust_obj IN HZ_PERSON_CUST_BO,
156 p_created_by_module IN VARCHAR2,
157 p_obj_source IN VARCHAR2 := null,
158 p_return_obj_flag IN VARCHAR2 := fnd_api.g_true,
159 x_return_status OUT NOCOPY VARCHAR2,
160 x_messages OUT NOCOPY HZ_MESSAGE_OBJ_TBL,
161 x_return_obj OUT NOCOPY HZ_PERSON_CUST_BO,
162 x_person_id OUT NOCOPY NUMBER
163 );
164
165 -- PROCEDURE save_person_cust_bo
166 --
167 -- DESCRIPTION
168 -- Create or update person customer account.
169 --
170 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
171 --
172 -- ARGUMENTS
173 -- IN:
174 -- p_init_msg_list Initialize message stack if it is set to
175 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
176 -- p_validate_bo_flag If it is set to FND_API.G_TRUE, validate
177 -- the completeness of business object.
178 -- p_person_cust_obj Logical person customer account object.
179 -- p_created_by_module Created by module.
180 -- OUT:
181 -- x_return_status Return status after the call. The status can
182 -- be fnd_api.g_ret_sts_success (success),
183 -- fnd_api.g_ret_sts_error (error),
184 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
185 -- x_msg_count Number of messages in message stack.
186 -- x_msg_data Message text if x_msg_count is 1.
187 -- x_person_id Person ID.
188 --
189 -- NOTES
190 --
191 -- MODIFICATION HISTORY
192 --
193 -- 14-DEC-2004 Arnold Ng Created.
194
195
196 PROCEDURE save_person_cust_bo(
197 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
198 p_validate_bo_flag IN VARCHAR2 := fnd_api.g_true,
199 p_person_cust_obj IN HZ_PERSON_CUST_BO,
200 p_created_by_module IN VARCHAR2,
201 x_return_status OUT NOCOPY VARCHAR2,
202 x_msg_count OUT NOCOPY NUMBER,
203 x_msg_data OUT NOCOPY VARCHAR2,
204 x_person_id OUT NOCOPY NUMBER
205 );
206
207 /*#
208 * Save Person Customer Business Object (save_person_cust_bo)
209 * Saves a Person Customer business object. You pass new or modified object data to the procedure, packaged within an object
210 * type defined specifically for the API. The API then determines if the object exists in TCA, based upon the provided
211 * identification information, and creates or updates the object. The object type is HZ_PERSON_CUST_BO for the Person Customer
212 * business object. For either case, the object type that you provide will be processed as if the respective API procedure
213 * is being called (create_person_cust_bo or update_person_cust_bo). Please see those procedures for more details.
214 * In addition to the object's business object attributes, the object type also includes embedded child business entities
215 * or objects that can be simultaneously created or updated.
216 *
217 * @param p_return_obj_flag Indicates if the saved object is to be returned to the caller as an output parameter. Default value: false
218 * @param p_validate_bo_flag Indicates if the passed business object is to be validated for completeness if it is being created
219 * @param p_person_cust_obj The Person Customer business object to be saved
220 * @param p_created_by_module The module saving this business object
221 * @param p_obj_source The source of this business object
222 * @param x_return_status Return status after the call
223 * @param x_return_obj The Person Customer business object that was saved, returned as an output parameter
224 * @param x_messages Messages returned from the save of the business object
225 * @param x_person_id TCA identifier for the Person Customer business object
226 * @rep:scope public
227 * @rep:lifecycle active
228 * @rep:displayname Save Person Customer Business Object
229 * @rep:doccd 120hztig.pdf Save Person Customer Business Object, Oracle Trading Community Architecture Technical Implementation Guide
230 */
231
232
233 PROCEDURE save_person_cust_bo(
234 p_validate_bo_flag IN VARCHAR2 := fnd_api.g_true,
235 p_person_cust_obj IN HZ_PERSON_CUST_BO,
236 p_created_by_module IN VARCHAR2,
237 p_obj_source IN VARCHAR2 := null,
238 p_return_obj_flag IN VARCHAR2 := fnd_api.g_true,
239 x_return_status OUT NOCOPY VARCHAR2,
240 x_messages OUT NOCOPY HZ_MESSAGE_OBJ_TBL,
241 x_return_obj OUT NOCOPY HZ_PERSON_CUST_BO,
242 x_person_id OUT NOCOPY NUMBER
243 );
244
245 --------------------------------------
246 --
247 -- PROCEDURE get_person_cust_bo
248 --
249 -- DESCRIPTION
250 -- Get a logical person customer.
251 --
252 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
253 --
254 -- ARGUMENTS
255 -- IN:
256 -- p_init_msg_list Initialize message stack if it is set to FND_API.G_TRUE. Default is FND_API.G_FALSE.
257 -- p_person_id Person ID.
258 -- p_person_os Person orig system.
259 -- p_person_osr Person orig system reference.
260
261 -- OUT:
262 -- x_person_cust_obj Logical person customer record.
263 -- x_return_status Return status after the call. The status can
264 -- be fnd_api.g_ret_sts_success (success),
265 -- fnd_api.g_ret_sts_error (error),
266 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
267 -- x_msg_count Number of messages in message stack.
268 -- x_msg_data Message text if x_msg_count is 1.
269 --
270 -- NOTES
271 --
272 -- MODIFICATION HISTORY
273 --
274 --
275 -- 10-JUN-2005 AWU Created.
276 --
277
278 /*
279 The Get Person Customer API Procedure is a retrieval service that returns a full Person Customer business object.
280 The user identifies a particular Person Customer business object using the TCA identifier and/or
281 the object Source System information. Upon proper validation of the object,
282 the full Person Customer business object is returned. The object consists of all data included within
283 the Person Customer business object, at all embedded levels. This includes the set of all data stored
284 in the TCA tables for each embedded entity.
285
286 To retrieve the appropriate embedded business objects within the Person Customer business object,
287 the Get procedure calls the equivalent procedure for the following embedded objects:
288
289 Embedded BO Mandatory Multiple Logical API Procedure Comments
290
291 Person Y N get_person_bo
292 Customer Account Y Y get_cust_acct_bo Called for each Customer Account object for the Person Customer
293
294 */
295
296
297 PROCEDURE get_person_cust_bo(
298 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
299 p_person_id IN NUMBER,
300 p_person_os IN VARCHAR2,
301 p_person_osr IN VARCHAR2,
302 x_person_cust_obj OUT NOCOPY HZ_PERSON_CUST_BO,
303 x_return_status OUT NOCOPY VARCHAR2,
304 x_msg_count OUT NOCOPY NUMBER,
305 x_msg_data OUT NOCOPY VARCHAR2
306 );
307
308 /*#
309 * Get Person Customer Business Object (get_person_cust_bo)
310 * Extracts a particular Person Customer business object from TCA. You pass the object's identification information to the
311 * procedure, and the procedure returns the identified business object as it exists in TCA.
312 *
313 * @param p_person_id TCA identifier for the Person Customer business object
314 * @param p_person_os Person Customer original system name
315 * @param p_person_osr Person Customer original system reference
316 * @param x_person_cust_obj The retrieved Person Customer business object
317 * @param x_return_status Return status after the call
318 * @param x_messages Messages returned from the retrieval of the business object
319 * @rep:scope public
320 * @rep:lifecycle active
321 * @rep:displayname Get Person Customer Business Object
322 * @rep:doccd 120hztig.pdf Get Person Customer Business Object, Oracle Trading Community Architecture Technical Implementation Guide
323 */
324
325
326 PROCEDURE get_person_cust_bo(
327 p_person_id IN NUMBER,
328 p_person_os IN VARCHAR2,
329 p_person_osr IN VARCHAR2,
330 x_person_cust_obj OUT NOCOPY HZ_PERSON_CUST_BO,
334
331 x_return_status OUT NOCOPY VARCHAR2,
332 x_messages OUT NOCOPY HZ_MESSAGE_OBJ_TBL
333 );
335 --------------------------------------
336 --
337 -- PROCEDURE get_person_custs_created
338 --
339 -- DESCRIPTION
340 --The caller provides an identifier for the Person Customers created business event and
341 --the procedure returns database objects of the type HZ_PERSON CUSTOMER_BO for all of
342 --the Person Customer business objects from the business event.
343
344 --
345 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
346 --
347 -- ARGUMENTS
348 -- IN:
349 -- p_init_msg_list Initialize message stack if it is set to
350 -- p_event_id BES Event identifier.
351 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
352 -- OUT:
353 -- x_person_cust_objs One or more created logical person customer.
354 -- x_return_status Return status after the call. The status can
355 -- be fnd_api.g_ret_sts_success (success),
356 -- fnd_api.g_ret_sts_error (error),
357 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
358 -- x_msg_count Number of messages in message stack.
359 -- x_msg_data Message text if x_msg_count is 1.
360 --
361 -- NOTES
362 --
363 -- MODIFICATION HISTORY
364 --
365 -- 10-JUN-2005 AWU Created.
366 --
367
368
369
370 /*
371 The Get Person customers Created procedure is a service to retrieve all of the Person Customer business objects
372 whose creations have been captured by a logical business event. Each Person Customers Created
373 business event signifies that one or more Person Customer business objects have been created.
374 The caller provides an identifier for the Person Customers Created business event and the procedure
375 returns all of the Person Customer business objects from the business event. For each business object
376 creation captured in the business event, the procedure calls the generic Get operation:
377 HZ_PERSON_BO_PVT.get_person_bo
378
379 Gathering all of the returned business objects from those API calls, the procedure packages
380 them in a table structure and returns them to the caller.
381 */
382
383 PROCEDURE get_person_custs_created(
384 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
385 p_event_id IN NUMBER,
386 x_person_cust_objs OUT NOCOPY HZ_PERSON_CUST_BO_TBL,
387 x_return_status OUT NOCOPY VARCHAR2,
388 x_msg_count OUT NOCOPY NUMBER,
389 x_msg_data OUT NOCOPY VARCHAR2
390 );
391
392 /*#
393 * Get Created Person Customer Business Objects (get_person_custs_created)
394 * Extracts the Person Customer business objects from TCA based upon an event identifier (event_id) for a
395 * Person Customer(s) Created Business Object Event. You provide the event_id value to the procedure, and the
396 * procedure returns the set of Person Customer business objects that were updated as part of the event. The
397 * event identifer value must be valid for a Person Customer(s) Created Business Object Event.
398 *
399 * @param p_event_id TCA Business Object Event identifier for the 'Person Customer(s) Created' event
400 * @param x_person_cust_objs Person Customer business objects created as part of the 'Person Customer(s) Created' Business Object event
401 * @param x_return_status Return status after the call
402 * @param x_messages Messages returned from the retrieval of the business objects
403 * @rep:scope public
404 * @rep:lifecycle active
405 * @rep:displayname Get Created Person Customer Business Objects
406 * @rep:doccd 120hztig.pdf Get Business Object API Procedures, Oracle Trading Community Architecture Technical Implementation Guide
407 */
408
409 PROCEDURE get_person_custs_created(
410 p_event_id IN NUMBER,
411 x_person_cust_objs OUT NOCOPY HZ_PERSON_CUST_BO_TBL,
412 x_return_status OUT NOCOPY VARCHAR2,
413 x_messages OUT NOCOPY HZ_MESSAGE_OBJ_TBL
414 );
415
416
417 --------------------------------------
418 --
419 -- PROCEDURE get_person_custs_updated
420 --
421 -- DESCRIPTION
422 --The caller provides an identifier for the Person Customers update business event and
423 --the procedure returns database objects of the type HZ_PERSON_CUST_BO for all of
424 --the Person Customer business objects from the business event.
425
426 --
427 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
428 --
429 -- ARGUMENTS
430 -- IN:
431 -- p_init_msg_list Initialize message stack if it is set to
432 -- p_event_id BES Event identifier.
433 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
434 -- OUT:
435 -- x_person_cust_objs One or more created logical person.
436 -- x_return_status Return status after the call. The status can
437 -- be fnd_api.g_ret_sts_success (success),
438 -- fnd_api.g_ret_sts_error (error),
439 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
440 -- x_msg_count Number of messages in message stack.
441 -- x_msg_data Message text if x_msg_count is 1.
442 --
443 -- NOTES
444 --
445 -- MODIFICATION HISTORY
446 --
447 -- 10-JUN-2005 AWU Created.
448 --
452 /*
449
450
451
453 The Get Person Customers Updated procedure is a service to retrieve all of the Person Customer business objects whose updates
454 have been captured by the logical business event. Each Person Customers Updated business event signifies that one or more Person
455 Customer business objects have been updated.
456 The caller provides an identifier for the Person Customers Update business event and the procedure returns database objects of
457 the type HZ_PERSON_CUST_BO for all of the Person Customer business objects from the business event.
458 Gathering all of the returned database objects from those API calls, the procedure packages them in a table structure and returns
459 them to the caller.
460 */
461
462 PROCEDURE get_person_custs_updated(
463 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
464 p_event_id IN NUMBER,
465 x_person_cust_objs OUT NOCOPY HZ_PERSON_CUST_BO_TBL,
466 x_return_status OUT NOCOPY VARCHAR2,
467 x_msg_count OUT NOCOPY NUMBER,
468 x_msg_data OUT NOCOPY VARCHAR2
469 );
470
471 /*#
472 * Get Updated Person Customer Business Objects (get_person_custs_updated)
473 * Extracts the Person Customer business objects from TCA based upon an event identifier (event_id) for a Person Customer(s)
474 * Updated Business Object Event. You provide the event_id value to the procedure, and the procedure returns the set of
475 * Person Customer business objects that were updated as part of the event. The event identifer value must be valid for a
476 * Person Customer(s) Updated Business Object Event.
477 *
478 * Provided within the returned business objects are Action Flags that designate how the data, at a particular level of
479 * an object, has changed as a result of the update to the Person Customer business object. Each business object, structure,
480 * and entity has the attribute action_type that provides this type of update. Possible values for the Action Type are
481 * 'CREATED', 'UPDATED', 'CHILD_UPDATED', or 'UNCHANGED':
482 *
483 * Action Type Value: Created
484 * An action type value of 'CREATED' indicates, for a business object or structure, that the root attributes of the object
485 * were created and any number of embedded objects, structures, or entities were also created as part of this update.
486 * For a business entity, the value 'CREATED' indicates that its root attributes were created as part of this update.
487 *
488 * Action Type: Updated
489 * An action type value of 'UPDATED' indicates, for a business object or structure, that the root attributes of the object
490 * were updated and any number of embedded objects, structure, or entities were created or updated as part of this update.
491 * For a business entity, the value 'UPDATED' indicates that its root attributes were updated as part of this update.
492 *
493 * Action Type: Child Updated
494 * An action type value of 'CHILD_UPDATED' indicates, for a business object or structure, that the root attributes of the
495 * object were untouched, but at least one child embedded object, structure, or entity was created or updated as part of
496 * this update. For a business entity, this value is not valid as it has no children.
497 *
498 * Action Type: Unchanged
499 * An action type value of 'UNCHANGED' indicates, for a business object, structure, or entity, that there has been no
500 * change to its root attributes or any of its child objects, structures, or entities.
501 *
502 * @param p_event_id TCA Business Object Event identifier for the 'Person Customer(s) Updated' event
503 * @param x_person_cust_objs Person Customer business objects updated as part of the 'Person Customer(s) Updated' Business Object event
504 * @param x_return_status Return status after the call
505 * @param x_messages Messages returned from the retrieval of the business objects
506 * @rep:scope public
507 * @rep:lifecycle active
508 * @rep:displayname Get Updated Person Customer Business Objects
509 * @rep:doccd 120hztig.pdf Get Updated Business Object Procedures, Oracle Trading Community Architecture Technical Implementation Guide
510 */
511
512 PROCEDURE get_person_custs_updated(
513 p_event_id IN NUMBER,
514 x_person_cust_objs OUT NOCOPY HZ_PERSON_CUST_BO_TBL,
515 x_return_status OUT NOCOPY VARCHAR2,
516 x_messages OUT NOCOPY HZ_MESSAGE_OBJ_TBL
517 );
518
519 --------------------------------------
520 --
521 -- PROCEDURE get_person_cust_updated
522 --
523 -- DESCRIPTION
524 --The caller provides an identifier for the Person customer update business event and person id
525 --the procedure returns one database object of the type HZ_PERSON_CUST_BO
526 --
527 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
528 --
529 -- ARGUMENTS
530 -- IN:
531 -- p_init_msg_list Initialize message stack if it is set to
532 -- p_event_id BES Event identifier.
533 -- p_person_cust_id Person customer identifier.
534 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
535 -- OUT:
536 -- x_person_cust_obj One updated logical person.
537 -- x_return_status Return status after the call. The status can
538 -- be fnd_api.g_ret_sts_success (success),
539 -- fnd_api.g_ret_sts_error (error),
540 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
541 -- x_msg_count Number of messages in message stack.
542 -- x_msg_data Message text if x_msg_count is 1.
543 --
544 -- NOTES
545 --
546 -- MODIFICATION HISTORY
547 --
551 PROCEDURE get_person_cust_updated(
548 -- 06-JUN-2005 AWU Created.
549 --
550
552 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
553 p_event_id IN NUMBER,
554 p_person_cust_id IN NUMBER,
555 x_person_cust_obj OUT NOCOPY HZ_PERSON_CUST_BO,
556 x_return_status OUT NOCOPY VARCHAR2,
557 x_msg_count OUT NOCOPY NUMBER,
558 x_msg_data OUT NOCOPY VARCHAR2
559 );
560
561 /*#
562 * Get Updated Person Customer Business Object (get_person_cust_updated)
563 * Extracts an updated Person Customer business object from TCA based upon the object identifier (person_cust_id) and event
564 * identifier (event_id). You provide values for the two identifiers to the procedure, and the procedure returns the
565 * identified business object. The event identifier value must be valid for a Person Customer(s) Updated Business Object Event.
566 *
567 * Provided within the returned business object are Action Flags that designate how the data, at a particular level of the
568 * object, has changed as a result of the update to the Person Customer business object. Each business object, structure, and
569 * entity has the attribute action_type that provides this type of update. Possible values for the Action Type are
570 * 'CREATED', 'UPDATED', 'CHILD_UPDATED', or 'UNCHANGED' as described
571 *
572 * Action Type Value: Created
573 * An action type value of 'CREATED' indicates, for a business object or structure, that the root attributes of the object
574 * were created and any number of embedded objects, structures, or entities were also created as part of this update. For
575 * a business entity, the value 'CREATED' indicates that its root attributes were created as part of this update.
576 *
577 * Action Type: Updated
578 * An action type value of 'UPDATED' indicates, for a business object or structure, that the root attributes of the object
579 * were updated and any number of embedded objects, structure, or entities were created or updated as part of this update.
580 * For a business entity, the value 'UPDATED' indicates that its root attributes were updated as part of this update.
581 *
582 * Action Type: Child Updated
583 * An action type value of 'CHILD_UPDATED' indicates, for a business object or structure, that the root attributes of the
584 * object were untouched, but at least one child embedded object, structure, or entity was created or updated as part of
585 * this update. For a business entity, this value is not valid as it has no children.
586 *
587 * Action Type: Unchanged
588 * An action type value of 'UNCHANGED' indicates, for a business object, structure, or entity, that there has been no change
589 * to its root attributes or any of its child objects, structures, or entities.
590 *
591 * @param p_event_id TCA Business Object Event identifier for the 'Person Customer(s) Updated' event
592 * @param p_person_cust_id TCA identifier for the updated Person Customer business object
593 * @param x_person_cust_obj Person Customer business object updated as part of the 'Person Customer(s) Updated' Business Object event
594 * @param x_return_status Return status after the call
595 * @param x_messages Messages returned from the retrieval of the business object
596 * @rep:scope public
597 * @rep:lifecycle active
598 * @rep:displayname Get Updated Person Customer Business Objects
599 * @rep:doccd 120hztig.pdf Get Updated Business Object Procedures, Oracle Trading Community Architecture Technical Implementation Guide
600 */
601
602 PROCEDURE get_person_cust_updated(
603 p_event_id IN NUMBER,
604 p_person_cust_id IN NUMBER,
605 x_person_cust_obj OUT NOCOPY HZ_PERSON_CUST_BO,
606 x_return_status OUT NOCOPY VARCHAR2,
607 x_messages OUT NOCOPY HZ_MESSAGE_OBJ_TBL
608 );
609
610 /*#
611 * Get Identifiers for Created Person Customer Business Objects (get_ids_person_custs_created)
612 * Retrieves identification values for the Person Customer business objects created in the Person Customer(s) Created Business
613 * Object Event. You pass an event identifier to the procedure (event_id), and the procedure returns an array of object
614 * identifier (person_cust_id) values that designate all of the Person Customer business objects that were created as part
615 * of this event.
616 *
617 * @param p_init_msg_list Initiailize FND message stack.
618 * @param p_event_id TCA Business Object Event identifier for the 'Person Customer(s) Created' event
619 * @param x_person_cust_ids TCA identifiers for the created Person Customer business objects
620 * @param x_return_status Return status after the call
621 * @param x_msg_count Number of messages in message stack.
622 * @param x_msg_data Messages returned from the operation
623 * @rep:scope public
624 * @rep:lifecycle active
625 * @rep:displayname Get Identifiers for Created Person Customer Business Objects
626 * @rep:doccd 120hztig.pdf Get Business Object API Procedures, Oracle Trading Community Architecture Technical Implementation Guide
627 */
628
629 -- get TCA identifiers for create event
630 PROCEDURE get_ids_person_custs_created (
631 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
632 p_event_id IN NUMBER,
633 x_person_cust_ids OUT NOCOPY HZ_EXTRACT_BO_UTIL_PVT.BO_ID_TBL,
634 x_return_status OUT NOCOPY VARCHAR2,
635 x_msg_count OUT NOCOPY NUMBER,
636 x_msg_data OUT NOCOPY VARCHAR2
637
638 );
639
640 /*#
641 * Get Identifiers for Updated Person Customer Business Objects (get_ids_person_custs_updated)
642 * Retrieves identification values for the Person Customer business objects updated in the "Person Customer(s) Updated" Business
643 * Object Event. You pass an event identifier to the procedure (event_id), and the procedure returns an array of object
644 * identifier (person_cust_id) values that designate all of the Person Customer business objects that were updated as part
645 * of this event.
646 *
647 * @param p_init_msg_list Initiailize FND message stack.
648 * @param p_event_id TCA Business Object Event identifier for the 'Person Customer(s) Updated' event.
649 * @param x_person_cust_ids TCA identifiers for the updated Person Customer business objects
650 * @param x_return_status Return status after the call
651 * @param x_msg_count Number of messages in message stack.
652 * @param x_msg_data Messages returned from the operation
653 * @rep:scope public
654 * @rep:lifecycle active
655 * @rep:displayname Get Identifiers for Updated Person Customer Business Objects
656 * @rep:doccd 120hztig.pdf Get Updated Business Object Procedures, Oracle Trading Community Architecture Technical Implementation Guide
657 */
658 -- get TCA identifiers for update event
659 PROCEDURE get_ids_person_custs_updated (
660 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
661 p_event_id IN NUMBER,
662 x_person_cust_ids OUT NOCOPY HZ_EXTRACT_BO_UTIL_PVT.BO_ID_TBL,
663 x_return_status OUT NOCOPY VARCHAR2,
664 x_msg_count OUT NOCOPY NUMBER,
665 x_msg_data OUT NOCOPY VARCHAR2
666 );
667
668
669 /*#
670 * Create Person Customer Business Object (create_person_cust_v2_bo)
671 * Creates a Person Customer business object. You pass object data to the procedure, packaged within an object type defined
672 * specifically for the API. The object type is HZ_PERSON_CUST_V2_BO for the Person Customer business object. In addition to
673 * the object's business object attributes, the object type also includes lower-level embedded child entities or objects
674 * that can be simultaneously created.
675 *
676 * @param p_validate_bo_flag Indicates if the passed business object is to be validated for completeness. Default value: true
677 * @param p_person_cust_v2_obj The Person Customer business object to be created in its entirety
678 * @param p_created_by_module The module creating this business object. Must be a valid created_by_module value
679 * @param p_obj_source The source of this business object
680 * @param p_return_obj_flag Indicates if the created object is to be returned to the caller as an output parameter. Default value: false
681 * @param x_return_status Return status after the call
682 * @param x_messages Messages returned from the creation of the business object
683 * @param x_return_obj The Person Customer business object that was created, returned as an output parameter
684 * @param x_person_id TCA identifier for the Person Customer business object
685 * @rep:scope public
686 * @rep:lifecycle active
687 * @rep:displayname Create Person Customer Business Object
688 * @rep:doccd 120hztig.pdf Create Person Customer Business Object, Oracle Trading Community Architecture Technical Implementation Guide
689 */
690
691 PROCEDURE create_person_cust_v2_bo(
692 p_validate_bo_flag IN VARCHAR2 := fnd_api.g_true,
693 p_person_cust_v2_obj IN HZ_PERSON_CUST_V2_BO,
694 p_created_by_module IN VARCHAR2,
695 p_obj_source IN VARCHAR2 := null,
696 p_return_obj_flag IN VARCHAR2 := fnd_api.g_true,
697 x_return_status OUT NOCOPY VARCHAR2,
698 x_messages OUT NOCOPY HZ_MESSAGE_OBJ_TBL,
699 x_return_obj OUT NOCOPY HZ_PERSON_CUST_V2_BO,
700 x_person_id OUT NOCOPY NUMBER
701 );
702
703 /*#
704 * Update Person Customer Business Object (update_person_cust_v2_bo)
705 * Updates a Person Customer business object. You pass any modified object data to the procedure, packaged within an object
706 * type defined specifically for the API. The object type is HZ_PERSON_CUST_V2_BO for the Person Customer business object.
707 * In addition to the object's business object attributes, the object type also includes embedded child business entities
708 * or objects that can be simultaneously created or updated.
709 *
710 * @param p_person_cust_v2_obj The Person Customer business object to be updated
711 * @param p_created_by_module The module updating this business object
712 * @param p_obj_source The source of this business object
713 * @param p_return_obj_flag Indicates if the updated object is to be returned to the caller as an output parameter. Default value: false
714 * @param x_return_status Return status after the call
715 * @param x_messages Messages returned from the update of the business object
716 * @param x_return_obj The Person Customer business object that was updated, returned as an output parameter
717 * @param x_person_id TCA identifier for the Person Customer business object
718 * @rep:scope public
719 * @rep:lifecycle active
720 * @rep:displayname Update Person Customer Business Object
721 * @rep:doccd 120hztig.pdf Update Person Customer Business Object, Oracle Trading Community Architecture Technical Implementation Guide
722 */
723
724
725 PROCEDURE update_person_cust_v2_bo(
726 p_person_cust_v2_obj IN HZ_PERSON_CUST_V2_BO,
727 p_created_by_module IN VARCHAR2,
728 p_obj_source IN VARCHAR2 := null,
729 p_return_obj_flag IN VARCHAR2 := fnd_api.g_true,
730 x_return_status OUT NOCOPY VARCHAR2,
731 x_messages OUT NOCOPY HZ_MESSAGE_OBJ_TBL,
732 x_return_obj OUT NOCOPY HZ_PERSON_CUST_V2_BO,
733 x_person_id OUT NOCOPY NUMBER
734 );
735
736 /*#
737 * Save Person Customer Business Object (save_person_cust_v2_bo)
738 * Saves a Person Customer business object. You pass new or modified object data to the procedure, packaged within an object
739 * type defined specifically for the API. The API then determines if the object exists in TCA, based upon the provided
740 * identification information, and creates or updates the object. The object type is HZ_PERSON_CUST_V2_BO for the Person Customer
741 * business object. For either case, the object type that you provide will be processed as if the respective API procedure
742 * is being called (create_person_cust_v2_bo or update_person_cust_v2_bo). Please see those procedures for more details.
743 * In addition to the object's business object attributes, the object type also includes embedded child business entities
744 * or objects that can be simultaneously created or updated.
745 *
746 * @param p_return_obj_flag Indicates if the saved object is to be returned to the caller as an output parameter. Default value: false
747 * @param p_validate_bo_flag Indicates if the passed business object is to be validated for completeness if it is being created
748 * @param p_person_cust_v2_obj The Person Customer business object to be saved
749 * @param p_created_by_module The module saving this business object
750 * @param p_obj_source The source of this business object
751 * @param x_return_status Return status after the call
752 * @param x_return_obj The Person Customer business object that was saved, returned as an output parameter
753 * @param x_messages Messages returned from the save of the business object
754 * @param x_person_id TCA identifier for the Person Customer business object
755 * @rep:scope public
756 * @rep:lifecycle active
757 * @rep:displayname Save Person Customer Business Object
758 * @rep:doccd 120hztig.pdf Save Person Customer Business Object, Oracle Trading Community Architecture Technical Implementation Guide
759 */
760
761
762 PROCEDURE save_person_cust_v2_bo(
763 p_validate_bo_flag IN VARCHAR2 := fnd_api.g_true,
764 p_person_cust_v2_obj IN HZ_PERSON_CUST_V2_BO,
765 p_created_by_module IN VARCHAR2,
766 p_obj_source IN VARCHAR2 := null,
767 p_return_obj_flag IN VARCHAR2 := fnd_api.g_true,
768 x_return_status OUT NOCOPY VARCHAR2,
769 x_messages OUT NOCOPY HZ_MESSAGE_OBJ_TBL,
770 x_return_obj OUT NOCOPY HZ_PERSON_CUST_V2_BO,
771 x_person_id OUT NOCOPY NUMBER
772 );
773
774 --------------------------------------
775 --
776 -- PROCEDURE get_person_cust_v2_bo
777 --
778 -- DESCRIPTION
779 -- Get a logical person customer.
780 --
781 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
782 --
783 -- ARGUMENTS
784 -- IN:
785 -- p_init_msg_list Initialize message stack if it is set to FND_API.G_TRUE. Default is FND_API.G_FALSE.
786 -- p_person_id Person ID.
787 -- p_person_os Person orig system.
788 -- p_person_osr Person orig system reference.
789
790 -- OUT:
791 -- x_person_cust_v2_obj Logical person customer record.
792 -- x_return_status Return status after the call. The status can
793 -- be fnd_api.g_ret_sts_success (success),
794 -- fnd_api.g_ret_sts_error (error),
795 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
796 -- x_msg_count Number of messages in message stack.
797 -- x_msg_data Message text if x_msg_count is 1.
798 --
799 -- NOTES
800 --
801 -- MODIFICATION HISTORY
802 --
803 --
804 -- 1-FEB-2008 VSEGU Created.
805 --
806
807 /*
808 The Get Person Customer API Procedure is a retrieval service that returns a full Person Customer business object.
809 The user identifies a particular Person Customer business object using the TCA identifier and/or
810 the object Source System information. Upon proper validation of the object,
811 the full Person Customer business object is returned. The object consists of all data included within
812 the Person Customer business object, at all embedded levels. This includes the set of all data stored
813 in the TCA tables for each embedded entity.
814
815 To retrieve the appropriate embedded business objects within the Person Customer business object,
816 the Get procedure calls the equivalent procedure for the following embedded objects:
817
818 Embedded BO Mandatory Multiple Logical API Procedure Comments
819
820 Person Y N get_person_bo
821 Customer Account Y Y get_cust_acct_v2_bo Called for each Customer Account object for the Person Customer
822
823 */
824
825
826 PROCEDURE get_person_cust_v2_bo(
827 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
828 p_person_id IN NUMBER,
829 p_person_os IN VARCHAR2,
830 p_person_osr IN VARCHAR2,
831 x_person_cust_v2_obj OUT NOCOPY HZ_PERSON_CUST_V2_BO,
832 x_return_status OUT NOCOPY VARCHAR2,
833 x_msg_count OUT NOCOPY NUMBER,
834 x_msg_data OUT NOCOPY VARCHAR2
835 );
836
837 /*#
838 * Get Person Customer Business Object (get_person_cust_v2_bo)
839 * Extracts a particular Person Customer business object from TCA. You pass the object's identification information to the
840 * procedure, and the procedure returns the identified business object as it exists in TCA.
841 *
842 * @param p_person_id TCA identifier for the Person Customer business object
843 * @param p_person_os Person Customer original system name
844 * @param p_person_osr Person Customer original system reference
845 * @param x_person_cust_v2_obj The retrieved Person Customer business object
846 * @param x_return_status Return status after the call
847 * @param x_messages Messages returned from the retrieval of the business object
848 * @rep:scope public
849 * @rep:lifecycle active
850 * @rep:displayname Get Person Customer Business Object
851 * @rep:doccd 120hztig.pdf Get Person Customer Business Object, Oracle Trading Community Architecture Technical Implementation Guide
852 */
853
854
855 PROCEDURE get_person_cust_v2_bo(
856 p_person_id IN NUMBER,
857 p_person_os IN VARCHAR2,
858 p_person_osr IN VARCHAR2,
859 x_person_cust_v2_obj OUT NOCOPY HZ_PERSON_CUST_V2_BO,
860 x_return_status OUT NOCOPY VARCHAR2,
861 x_messages OUT NOCOPY HZ_MESSAGE_OBJ_TBL
862 );
863
864
865
866 --------------------------------------
867 --
868 -- PROCEDURE get_v2_person_custs_created
869 --
870 -- DESCRIPTION
871 --The caller provides an identifier for the Person Customers created business event and
872 --the procedure returns database objects of the type HZ_PERSON CUSTOMER_BO for all of
873 --the Person Customer business objects from the business event.
874
875 --
876 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
877 --
878 -- ARGUMENTS
879 -- IN:
880 -- p_init_msg_list Initialize message stack if it is set to
881 -- p_event_id BES Event identifier.
882 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
883 -- OUT:
884 -- x_person_cust_v2_objs One or more created logical person customer.
885 -- x_return_status Return status after the call. The status can
886 -- be fnd_api.g_ret_sts_success (success),
887 -- fnd_api.g_ret_sts_error (error),
888 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
889 -- x_msg_count Number of messages in message stack.
890 -- x_msg_data Message text if x_msg_count is 1.
891 --
892 -- NOTES
893 --
894 -- MODIFICATION HISTORY
895 --
896 -- 04-FEB-2008 VSEGU Created.
897 --
898
899
900
901 /*
902 The Get Person customers Created procedure is a service to retrieve all of the Person Customer business objects
903 whose creations have been captured by a logical business event. Each Person Customers Created
904 business event signifies that one or more Person Customer business objects have been created.
905 The caller provides an identifier for the Person Customers Created business event and the procedure
906 returns all of the Person Customer business objects from the business event. For each business object
907 creation captured in the business event, the procedure calls the generic Get operation:
908 HZ_PERSON_BO_PVT.get_person_bo
909
910 Gathering all of the returned business objects from those API calls, the procedure packages
911 them in a table structure and returns them to the caller.
912 */
913
914 PROCEDURE get_v2_person_custs_created(
915 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
916 p_event_id IN NUMBER,
917 x_person_cust_v2_objs OUT NOCOPY HZ_PERSON_CUST_V2_BO_TBL,
918 x_return_status OUT NOCOPY VARCHAR2,
919 x_msg_count OUT NOCOPY NUMBER,
920 x_msg_data OUT NOCOPY VARCHAR2
921 );
922
923 /*#
924 * Get Created Person Customer Business Objects (get_v2_person_custs_created)
925 * Extracts the Person Customer business objects from TCA based upon an event identifier (event_id) for a
926 * Person Customer(s) Created Business Object Event. You provide the event_id value to the procedure, and the
927 * procedure returns the set of Person Customer business objects that were updated as part of the event. The
928 * event identifer value must be valid for a Person Customer(s) Created Business Object Event.
929 *
930 * @param p_event_id TCA Business Object Event identifier for the 'Person Customer(s) Created' event
931 * @param x_person_cust_v2_objs Person Customer business objects created as part of the 'Person Customer(s) Created' Business Object event
932 * @param x_return_status Return status after the call
933 * @param x_messages Messages returned from the retrieval of the business objects
934 * @rep:scope public
935 * @rep:lifecycle active
936 * @rep:displayname Get Created Person Customer Business Objects
937 * @rep:doccd 120hztig.pdf Get Business Object API Procedures, Oracle Trading Community Architecture Technical Implementation Guide
938 */
939
940 PROCEDURE get_v2_person_custs_created(
941 p_event_id IN NUMBER,
942 x_person_cust_v2_objs OUT NOCOPY HZ_PERSON_CUST_V2_BO_TBL,
943 x_return_status OUT NOCOPY VARCHAR2,
944 x_messages OUT NOCOPY HZ_MESSAGE_OBJ_TBL
945 );
946
947
948 --------------------------------------
949 --
950 -- PROCEDURE get_v2_person_custs_updated
951 --
952 -- DESCRIPTION
953 --The caller provides an identifier for the Person Customers update business event and
954 --the procedure returns database objects of the type HZ_PERSON_CUST_V2_BO for all of
955 --the Person Customer business objects from the business event.
956
957 --
958 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
959 --
960 -- ARGUMENTS
961 -- IN:
962 -- p_init_msg_list Initialize message stack if it is set to
963 -- p_event_id BES Event identifier.
964 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
965 -- OUT:
966 -- x_person_cust_v2_objs One or more created logical person.
967 -- x_return_status Return status after the call. The status can
968 -- be fnd_api.g_ret_sts_success (success),
969 -- fnd_api.g_ret_sts_error (error),
970 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
971 -- x_msg_count Number of messages in message stack.
972
973 -- x_msg_data Message text if x_msg_count is 1.
974 -- NOTES
975 --
976 -- MODIFICATION HISTORY
977 --
978 -- 04-FEB-2008 VSEGU Created.
979 --
980
981
982
983 /*
984 The Get Person Customers Updated procedure is a service to retrieve all of the Person Customer business objects whose updates
985 have been captured by the logical business event. Each Person Customers Updated business event signifies that one or more Person
986 Customer business objects have been updated.
990 them to the caller.
987 The caller provides an identifier for the Person Customers Update business event and the procedure returns database objects of
988 the type HZ_PERSON_CUST_V2_BO for all of the Person Customer business objects from the business event.
989 Gathering all of the returned database objects from those API calls, the procedure packages them in a table structure and returns
991 */
992
993 PROCEDURE get_v2_person_custs_updated(
994 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
995 p_event_id IN NUMBER,
996 x_person_cust_v2_objs OUT NOCOPY HZ_PERSON_CUST_V2_BO_TBL,
997 x_return_status OUT NOCOPY VARCHAR2,
998 x_msg_count OUT NOCOPY NUMBER,
999 x_msg_data OUT NOCOPY VARCHAR2
1000 );
1001
1002
1003 /*#
1004 * Get Updated Person Customer Business Objects (get_v2_person_custs_updated)
1005 * Extracts the Person Customer business objects from TCA based upon an event identifier (event_id) for a Person Customer(s)
1006 * Updated Business Object Event. You provide the event_id value to the procedure, and the procedure returns the set of
1007 * Person Customer business objects that were updated as part of the event. The event identifer value must be valid for a
1008 * Person Customer(s) Updated Business Object Event.
1009 *
1010 * Provided within the returned business objects are Action Flags that designate how the data, at a particular level of
1011 * an object, has changed as a result of the update to the Person Customer business object. Each business object, structure,
1012 * and entity has the attribute action_type that provides this type of update. Possible values for the Action Type are
1013 * 'CREATED', 'UPDATED', 'CHILD_UPDATED', or 'UNCHANGED':
1014 *
1015 * Action Type Value: Created
1016 * An action type value of 'CREATED' indicates, for a business object or structure, that the root attributes of the object
1017 * were created and any number of embedded objects, structures, or entities were also created as part of this update.
1018 * For a business entity, the value 'CREATED' indicates that its root attributes were created as part of this update.
1019 *
1020 * Action Type: Updated
1021 * An action type value of 'UPDATED' indicates, for a business object or structure, that the root attributes of the object
1022 * were updated and any number of embedded objects, structure, or entities were created or updated as part of this update.
1023 * For a business entity, the value 'UPDATED' indicates that its root attributes were updated as part of this update.
1024 *
1025 * Action Type: Child Updated
1026 * An action type value of 'CHILD_UPDATED' indicates, for a business object or structure, that the root attributes of the
1027 * object were untouched, but at least one child embedded object, structure, or entity was created or updated as part of
1028 * this update. For a business entity, this value is not valid as it has no children.
1029 *
1030 * Action Type: Unchanged
1031 * An action type value of 'UNCHANGED' indicates, for a business object, structure, or entity, that there has been no
1032 * change to its root attributes or any of its child objects, structures, or entities.
1033 *
1034 * @param p_event_id TCA Business Object Event identifier for the 'Person Customer(s) Updated' event
1035 * @param x_person_cust_v2_objs Person Customer business objects updated as part of the 'Person Customer(s) Updated' Business Object event
1036 * @param x_return_status Return status after the call
1037 * @param x_messages Messages returned from the retrieval of the business objects
1038 * @rep:scope public
1039 * @rep:lifecycle active
1040 * @rep:displayname Get Updated Person Customer Business Objects
1041 * @rep:doccd 120hztig.pdf Get Updated Business Object Procedures, Oracle Trading Community Architecture Technical Implementation Guide
1042 */
1043
1044 PROCEDURE get_v2_person_custs_updated(
1045 p_event_id IN NUMBER,
1046 x_person_cust_v2_objs OUT NOCOPY HZ_PERSON_CUST_V2_BO_TBL,
1047 x_return_status OUT NOCOPY VARCHAR2,
1048 x_messages OUT NOCOPY HZ_MESSAGE_OBJ_TBL
1049 );
1050
1051 --------------------------------------
1052 --
1053 -- PROCEDURE get_v2_person_cust_updated
1054 --
1055 -- DESCRIPTION
1056 --The caller provides an identifier for the Person customer update business event and person id
1057 --the procedure returns one database object of the type HZ_PERSON_CUST_V2_BO
1058 --
1059 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
1060 --
1061 -- ARGUMENTS
1062 -- IN:
1063 -- p_init_msg_list Initialize message stack if it is set to
1064 -- p_event_id BES Event identifier.
1065 -- p_person_cust_id Person customer identifier.
1066 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
1067 -- OUT:
1068 -- x_person_cust_v2_obj One updated logical person.
1069 -- x_return_status Return status after the call. The status can
1070 -- be fnd_api.g_ret_sts_success (success),
1071 -- fnd_api.g_ret_sts_error (error),
1072 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
1073 -- x_msg_count Number of messages in message stack.
1074 -- x_msg_data Message text if x_msg_count is 1.
1075 --
1076 -- NOTES
1077 --
1078 -- MODIFICATION HISTORY
1079 --
1080 -- 04-FEB-2008 VSEGU Created.
1081 --
1082
1083 PROCEDURE get_v2_person_cust_updated(
1084 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
1085 p_event_id IN NUMBER,
1086 p_person_cust_id IN NUMBER,
1087 x_person_cust_v2_obj OUT NOCOPY HZ_PERSON_CUST_V2_BO,
1088 x_return_status OUT NOCOPY VARCHAR2,
1089 x_msg_count OUT NOCOPY NUMBER,
1090 x_msg_data OUT NOCOPY VARCHAR2
1091 );
1092
1093 /*#
1094 * Get Updated Person Customer Business Object (get_v2_person_cust_updated)
1095 * Extracts an updated Person Customer business object from TCA based upon the object identifier (person_cust_id) and event
1096 * identifier (event_id). You provide values for the two identifiers to the procedure, and the procedure returns the
1097 * identified business object. The event identifier value must be valid for a Person Customer(s) Updated Business Object Event.
1098 *
1099 * Provided within the returned business object are Action Flags that designate how the data, at a particular level of the
1100 * object, has changed as a result of the update to the Person Customer business object. Each business object, structure, and
1101 * entity has the attribute action_type that provides this type of update. Possible values for the Action Type are
1102 * 'CREATED', 'UPDATED', 'CHILD_UPDATED', or 'UNCHANGED' as described
1103 *
1104 * Action Type Value: Created
1105 * An action type value of 'CREATED' indicates, for a business object or structure, that the root attributes of the object
1106 * were created and any number of embedded objects, structures, or entities were also created as part of this update. For
1107 * a business entity, the value 'CREATED' indicates that its root attributes were created as part of this update.
1108 *
1109 * Action Type: Updated
1110 * An action type value of 'UPDATED' indicates, for a business object or structure, that the root attributes of the object
1111 * were updated and any number of embedded objects, structure, or entities were created or updated as part of this update.
1112 * For a business entity, the value 'UPDATED' indicates that its root attributes were updated as part of this update.
1113 *
1114 * Action Type: Child Updated
1115 * An action type value of 'CHILD_UPDATED' indicates, for a business object or structure, that the root attributes of the
1116 * object were untouched, but at least one child embedded object, structure, or entity was created or updated as part of
1117 * this update. For a business entity, this value is not valid as it has no children.
1118 *
1119 * Action Type: Unchanged
1120 * An action type value of 'UNCHANGED' indicates, for a business object, structure, or entity, that there has been no change
1121 * to its root attributes or any of its child objects, structures, or entities.
1122 *
1123 * @param p_event_id TCA Business Object Event identifier for the 'Person Customer(s) Updated' event
1124 * @param p_person_cust_id TCA identifier for the updated Person Customer business object
1125 * @param x_person_cust_v2_obj Person Customer business object updated as part of the 'Person Customer(s) Updated' Business Object event
1126 * @param x_return_status Return status after the call
1127 * @param x_messages Messages returned from the retrieval of the business object
1128 * @rep:scope public
1129 * @rep:lifecycle active
1130 * @rep:displayname Get Updated Person Customer Business Objects
1131 * @rep:doccd 120hztig.pdf Get Updated Business Object Procedures, Oracle Trading Community Architecture Technical Implementation Guide
1132 */
1133
1134 PROCEDURE get_v2_person_cust_updated(
1135 p_event_id IN NUMBER,
1136 p_person_cust_id IN NUMBER,
1137 x_person_cust_v2_obj OUT NOCOPY HZ_PERSON_CUST_V2_BO,
1138 x_return_status OUT NOCOPY VARCHAR2,
1139 x_messages OUT NOCOPY HZ_MESSAGE_OBJ_TBL
1140 );
1141
1142
1143
1144 END HZ_PERSON_CUST_BO_PUB;
[Home] [Help]