1 PACKAGE HZ_PERSON_BO_PUB AS
2 /*$Header: ARHBPPBS.pls 120.7 2006/09/21 22:01:27 awu noship $ */
3 /*#
4 * Person Business Object API
5 * Public API that allows users to manage Person 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 Business Object API
13 * @rep:doccd 120hztig.pdf Person Business Object API, Oracle Trading Community Architecture Technical Implementation Guide
14 */
15
16 -- PROCEDURE create_person_bo
17 --
18 -- DESCRIPTION
19 -- Create a person business object.
20 --
21 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
22 --
23 -- ARGUMENTS
24 -- IN:
25 -- p_init_msg_list Initialize message stack if it is set to
26 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
27 -- p_validate_bo_flag If it is set to FND_API.G_TRUE, validate
28 -- the completeness of business object.
29 -- p_person_obj Person business object.
30 -- p_created_by_module Created by module.
31 -- OUT:
32 -- x_return_status Return status after the call. The status can
33 -- be fnd_api.g_ret_sts_success (success),
34 -- fnd_api.g_ret_sts_error (error),
35 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
36 -- x_msg_count Number of messages in message stack.
37 -- x_msg_data Message text if x_msg_count is 1.
38 -- x_person_id Person ID.
39 -- x_person_os Person orig system.
40 -- x_person_osr Person orig system reference.
41 --
42 -- NOTES
43 --
44 -- MODIFICATION HISTORY
45 --
46 -- 14-DEC-2004 Arnold Ng Created.
47 --
48
49 PROCEDURE create_person_bo(
50 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
51 p_validate_bo_flag IN VARCHAR2 := fnd_api.g_true,
52 p_person_obj IN HZ_PERSON_BO,
53 p_created_by_module IN VARCHAR2,
54 x_return_status OUT NOCOPY VARCHAR2,
55 x_msg_count OUT NOCOPY NUMBER,
56 x_msg_data OUT NOCOPY VARCHAR2,
57 x_person_id OUT NOCOPY NUMBER,
58 x_person_os OUT NOCOPY VARCHAR2,
59 x_person_osr OUT NOCOPY VARCHAR2
60 );
61 /*#
62 * Create Person Business Object (create_person_bo)
63 * Creates a Person business object. You pass object data to the procedure, packaged within an object type defined
64 * specifically for the API. The object type is HZ_PERSON_BO for the Person business object. In addition to
65 * the object's business object attributes, the object type also includes lower-level embedded child entities or objects
66 * that can be simultaneously created.
67 *
68 * @param p_validate_bo_flag Indicates if the passed business object is to be validated for completeness. Default value: true
69 * @param p_person_obj The Person business object to be created in its entirety
70 * @param p_created_by_module The module creating this business object. Must be a valid created_by_module value
71 * @param p_obj_source The source of this business object
72 * @param p_return_obj_flag Indicates if the created object is to be returned to the caller as an output parameter. Default value: false
73 * @param x_return_status Return status after the call
74 * @param x_messages Messages returned from the creation of the business object
75 * @param x_return_obj The Person business object that was created, returned as an output parameter
76 * @param x_person_id TCA identifier for the Person business object
77 * @param x_person_os Person original system name
78 * @param x_person_osr Person original system reference
79 * @rep:scope public
80 * @rep:lifecycle active
81 * @rep:displayname Create Person Business Object
82 * @rep:doccd 120hztig.pdf Create Person Business Object, Oracle Trading Community Architecture Technical Implementation Guide
83 */
84
85 PROCEDURE create_person_bo(
86 p_validate_bo_flag IN VARCHAR2 := fnd_api.g_true,
87 p_person_obj IN HZ_PERSON_BO,
88 p_created_by_module IN VARCHAR2,
89 p_obj_source IN VARCHAR2 := NULL,
90 p_return_obj_flag IN VARCHAR2 := fnd_api.g_true,
91 x_return_status OUT NOCOPY VARCHAR2,
92 x_messages OUT NOCOPY HZ_MESSAGE_OBJ_TBL,
93 x_return_obj OUT NOCOPY HZ_PERSON_BO,
94 x_person_id OUT NOCOPY NUMBER,
95 x_person_os OUT NOCOPY VARCHAR2,
96 x_person_osr OUT NOCOPY VARCHAR2
97 );
98
99 -- PROCEDURE update_person_bo
100 --
101 -- DESCRIPTION
102 -- Update a person business object.
103 --
104 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
105 --
106 -- ARGUMENTS
107 -- IN:
108 -- p_init_msg_list Initialize message stack if it is set to
109 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
110 -- p_person_obj Person business object.
111 -- p_created_by_module Created by module.
112 -- OUT:
113 -- x_return_status Return status after the call. The status can
114 -- be fnd_api.g_ret_sts_success (success),
115 -- fnd_api.g_ret_sts_error (error),
116 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
117 -- x_msg_count Number of messages in message stack.
118 -- x_msg_data Message text if x_msg_count is 1.
119 -- x_person_id Person ID.
120 -- x_person_os Person orig system.
121 -- x_person_osr Person orig system reference.
122 --
123 -- NOTES
124 --
125 -- MODIFICATION HISTORY
126 --
127 -- 14-DEC-2004 Arnold Ng Created.
128 --
129
130
131 PROCEDURE update_person_bo(
132 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
133 p_person_obj IN HZ_PERSON_BO,
134 p_created_by_module IN VARCHAR2,
135 x_return_status OUT NOCOPY VARCHAR2,
136 x_msg_count OUT NOCOPY NUMBER,
137 x_msg_data OUT NOCOPY VARCHAR2,
138 x_person_id OUT NOCOPY NUMBER,
139 x_person_os OUT NOCOPY VARCHAR2,
140 x_person_osr OUT NOCOPY VARCHAR2
141 );
142
143 /*#
144 * Update Person Business Object (update_person_bo)
145 * Updates a Person business object. You pass any modified object data to the procedure, packaged within an object
146 * type defined specifically for the API. The object type is HZ_PERSON_BO for the Person business object.
147 * In addition to the object's business object attributes, the object type also includes embedded child business entities
148 * or objects that can be simultaneously created or updated.
149 *
150 * @param p_person_obj The Person business object to be updated
151 * @param p_created_by_module The module updating this business object
152 * @param p_obj_source The source of this business object
153 * @param p_return_obj_flag Indicates if the updated object is to be returned to the caller as an output parameter. Default value: false
154 * @param x_return_status Return status after the call
155 * @param x_messages Messages returned from the update of the business object
156 * @param x_return_obj The Person business object that was updated, returned as an output parameter
157 * @param x_person_id TCA identifier for the Person business object
158 * @param x_person_os Person original system name
159 * @param x_person_osr Person original system reference
160 * @rep:scope public
161 * @rep:lifecycle active
162 * @rep:displayname Update Person Business Object
163 * @rep:doccd 120hztig.pdf Update Person Business Object, Oracle Trading Community Architecture Technical Implementation Guide
164 */
165
166 PROCEDURE update_person_bo(
167 p_person_obj IN HZ_PERSON_BO,
168 p_created_by_module IN VARCHAR2,
169 p_obj_source IN VARCHAR2 := NULL,
170 p_return_obj_flag IN VARCHAR2 := fnd_api.g_true,
171 x_return_status OUT NOCOPY VARCHAR2,
172 x_messages OUT NOCOPY HZ_MESSAGE_OBJ_TBL,
173 x_return_obj OUT NOCOPY HZ_PERSON_BO,
174 x_person_id OUT NOCOPY NUMBER,
175 x_person_os OUT NOCOPY VARCHAR2,
176 x_person_osr OUT NOCOPY VARCHAR2
177 );
178
179 -- PROCEDURE save_person_bo
180 --
181 -- DESCRIPTION
182 -- Create or update a person business object.
183 --
184 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
185 --
186 -- ARGUMENTS
187 -- IN:
188 -- p_init_msg_list Initialize message stack if it is set to
189 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
190 -- p_validate_bo_flag If it is set to FND_API.G_TRUE, validate
191 -- the completeness of business object.
192 -- p_person_obj Person business object.
193 -- p_created_by_module Created by module.
194 -- OUT:
195 -- x_return_status Return status after the call. The status can
196 -- be fnd_api.g_ret_sts_success (success),
197 -- fnd_api.g_ret_sts_error (error),
198 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
199 -- x_msg_count Number of messages in message stack.
200 -- x_msg_data Message text if x_msg_count is 1.
201 -- x_person_id Person ID.
202 -- x_person_os Person orig system.
203 -- x_person_osr Person orig system reference.
204 --
205 -- NOTES
206 --
207 -- MODIFICATION HISTORY
208 --
209 -- 14-DEC-2004 Arnold Ng Created.
210 --
211
212 PROCEDURE save_person_bo(
213 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
214 p_validate_bo_flag IN VARCHAR2 := fnd_api.g_true,
215 p_person_obj IN HZ_PERSON_BO,
216 p_created_by_module IN VARCHAR2,
217 x_return_status OUT NOCOPY VARCHAR2,
218 x_msg_count OUT NOCOPY NUMBER,
219 x_msg_data OUT NOCOPY VARCHAR2,
220 x_person_id OUT NOCOPY NUMBER,
221 x_person_os OUT NOCOPY VARCHAR2,
222 x_person_osr OUT NOCOPY VARCHAR2
223 );
224
225 /*#
226 * Save Person Business Object (save_person_bo)
227 * Saves a Person business object. You pass new or modified object data to the procedure, packaged within an object
228 * type defined specifically for the API. The API then determines if the object exists in TCA, based upon the provided
229 * identification information, and creates or updates the object. The object type is HZ_PERSON_BO for the Person
230 * business object. For either case, the object type that you provide will be processed as if the respective API procedure
231 * is being called (create_person_bo or update_person_bo). Please see those procedures for more details.
232 * In addition to the object's business object attributes, the object type also includes embedded child business entities
233 * or objects that can be simultaneously created or updated.
234 *
235 * @param p_return_obj_flag Indicates if the saved object is to be returned to the caller as an output parameter. Default value: false
236 * @param p_validate_bo_flag Indicates if the passed business object is to be validated for completeness if it is being created
237 * @param p_person_obj The Person business object to be saved
238 * @param p_created_by_module The module saving this business object
239 * @param p_obj_source The source of this business object
240 * @param x_return_status Return status after the call
241 * @param x_return_obj The Person business object that was saved, returned as an output parameter
242 * @param x_messages Messages returned from the save of the business object
243 * @param x_person_id TCA identifier for the Person business object
244 * @param x_person_os Person original system name
245 * @param x_person_osr Person original system reference
246 * @rep:scope public
247 * @rep:lifecycle active
248 * @rep:displayname Save Person Business Object
249 * @rep:doccd 120hztig.pdf Save Person Business Object, Oracle Trading Community Architecture Technical Implementation Guide
250 */
251
252
253 PROCEDURE save_person_bo(
254 p_validate_bo_flag IN VARCHAR2 := fnd_api.g_true,
255 p_person_obj IN HZ_PERSON_BO,
256 p_created_by_module IN VARCHAR2,
257 p_obj_source IN VARCHAR2 := NULL,
258 p_return_obj_flag IN VARCHAR2 := fnd_api.g_true,
259 x_return_status OUT NOCOPY VARCHAR2,
260 x_messages OUT NOCOPY HZ_MESSAGE_OBJ_TBL,
261 x_return_obj OUT NOCOPY HZ_PERSON_BO,
262 x_person_id OUT NOCOPY NUMBER,
263 x_person_os OUT NOCOPY VARCHAR2,
264 x_person_osr OUT NOCOPY VARCHAR2
265 );
266
267 --------------------------------------
268 --
269 -- PROCEDURE get_person_bo
270 --
271 -- DESCRIPTION
272 -- Get a logical person.
273 --
274 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
275 --
276 -- ARGUMENTS
277 -- IN:
278 -- p_init_msg_list Initialize message stack if it is set to FND_API.G_TRUE. Default is FND_API.G_FALSE.
279 -- p_person_id Person ID.
280 -- p_person_os Person orig system.
281 -- p_person_osr Person orig system reference.
282 -- OUT:
283 -- x_person_obj Logical person record.
284 -- x_return_status Return status after the call. The status can
285 -- be fnd_api.g_ret_sts_success (success),
286 -- fnd_api.g_ret_sts_error (error),
287 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
288 -- x_msg_count Number of messages in message stack.
289 -- x_msg_data Message text if x_msg_count is 1.
290 --
291 -- NOTES
292 --
293 -- MODIFICATION HISTORY
294 --
295 --
296 -- 10-JUN-2005 AWU Created.
297 --
298
299 /*
300 The Get Person API Procedure is a retrieval service that returns a full Person business object.
301 The user identifies a particular Person business object using the TCA identifier and/or
302 the object Source System information. Upon proper validation of the object,
303 the full Person business object is returned. The object consists of all data included within
304 the Person business object, at all embedded levels. This includes the set of all data stored
305 in the TCA tables for each embedded entity.
306
307 To retrieve the appropriate embedded business objects within the Person business object,
308 the Get procedure calls the equivalent procedure for the following embedded objects:
309
310 Embedded BO Mandatory Multiple Logical API Procedure Comments
311 Party Site N Y get_party_site_bo
312 Phone N Y get_phone_bo
313 Email N Y get_email_bo
314 Web N Y get_web_bo
315 SMS N Y get_sms_bo
316 Employment History N Y Business Structure. Included entities:HZ_EMPLOYMENT_HISTORY, HZ_WORK_CLASS
317
318
319 To retrieve the appropriate embedded entities within the Person business object,
320 the Get procedure returns all records for the particular person from these TCA entity tables:
321
322 Embedded TCA Entity Mandatory Multiple TCA Table Entities
323
324 Party,Person Profile Y N HZ_PARTIES, HZ_PERSON_PROFILES
325 Person Preference N Y HZ_PARTY_PREFERENCES
326 Relationship N Y HZ_RELATIONSHIPS
327 Classification N Y HZ_CODE_ASSIGNMENTS
328 Language N Y HZ_PERSON_LANGUAGE
329 Education N Y HZ_EDUCATION
330 Citizenship N Y HZ_CITIZENSHIP
331 Interest N Y HZ_PERSON_INTEREST
332 Certification N Y HZ_CERTIFICATIONS
333 Financial Profile N Y HZ_FINANCIAL_PROFILE
334 */
335
336 PROCEDURE get_person_bo (
337 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
338 p_person_id IN NUMBER,
339 p_person_os IN VARCHAR2,
340 p_person_osr IN VARCHAR2,
341 x_person_obj OUT NOCOPY HZ_PERSON_BO,
342 x_return_status OUT NOCOPY VARCHAR2,
343 x_msg_count OUT NOCOPY NUMBER,
344 x_msg_data OUT NOCOPY VARCHAR2
345 );
346
350 * procedure, and the procedure returns the identified business object as it exists in TCA.
347 /*#
348 * Get Person Business Object (get_person_bo)
349 * Extracts a particular Person business object from TCA. You pass the object's identification information to the
351 *
352 * @param p_person_id TCA identifier for the Person business object
353 * @param p_person_os Person original system name
354 * @param p_person_osr Person original system reference
355 * @param x_person_obj The retrieved Person business object
356 * @param x_return_status Return status after the call
357 * @param x_messages Messages returned from the retrieval of the business object
358 * @rep:scope public
359 * @rep:lifecycle active
360 * @rep:displayname Get Person Business Object
361 * @rep:doccd 120hztig.pdf Get Person Business Object, Oracle Trading Community Architecture Technical Implementation Guide
362 */
363
364
365 PROCEDURE get_person_bo (
366 p_person_id IN NUMBER,
367 p_person_os IN VARCHAR2,
368 p_person_osr IN VARCHAR2,
369 x_person_obj OUT NOCOPY HZ_PERSON_BO,
370 x_return_status OUT NOCOPY VARCHAR2,
371 x_messages OUT NOCOPY HZ_MESSAGE_OBJ_TBL
372 );
373
374 --------------------------------------
375 --
376 -- PROCEDURE get_persons_created
377 --
378 -- DESCRIPTION
379 --The caller provides an identifier for the Persons created business event and
380 --the procedure returns database objects of the type HZ_PERSON_BO for all of
381 --the Person business objects from the business event.
382
383 --
384 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
385 --
386 -- ARGUMENTS
387 -- IN:
388 -- p_init_msg_list Initialize message stack if it is set to
389 -- p_event_id BES Event identifier.
390 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
391 -- OUT:
392 -- x_person_obj One or more created logical person.
393 -- x_return_status Return status after the call. The status can
394 -- be fnd_api.g_ret_sts_success (success),
395 -- fnd_api.g_ret_sts_error (error),
396 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
397 -- x_msg_count Number of messages in message stack.
398 -- x_msg_data Message text if x_msg_count is 1.
399 --
400 -- NOTES
401 --
402 -- MODIFICATION HISTORY
403 --
404 -- 10-JUN-2005 AWU Created.
405 --
406
407
408
409 /*
410 The Get Persons Created procedure is a service to retrieve all of the Person business objects
411 whose creations have been captured by a logical business event. Each Persons Created
412 business event signifies that one or more Person business objects have been created.
413 The caller provides an identifier for the Persons Created business event and the procedure
414 returns all of the Person business objects from the business event. For each business object
415 creation captured in the business event, the procedure calls the generic Get operation:
416 HZ_PERSON_BO_PVT.get_person_bo
417
418 Gathering all of the returned business objects from those API calls, the procedure packages
419 them in a table structure and returns them to the caller.
420 */
421
422
423 PROCEDURE get_persons_created(
424 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
425 p_event_id IN NUMBER,
426 x_person_objs OUT NOCOPY HZ_PERSON_BO_TBL,
427 x_return_status OUT NOCOPY VARCHAR2,
428 x_msg_count OUT NOCOPY NUMBER,
429 x_msg_data OUT NOCOPY VARCHAR2
430 );
431
432
433 /*#
434 * Get Created Person Business Objects (get_persons_created)
435 * Extracts the Person business objects from TCA based upon an event identifier (event_id) for a Person(s)
436 * Created Business Object Event. You provide the event_id value to the procedure, and the procedure returns the set of
437 * Person business objects that were updated as part of the event. The event identifer value must be valid for a
438 * Person(s) Created Business Object Event.
439 *
440 * @param p_event_id TCA Business Object Event identifier for the 'Person(s) Created' event
441 * @param x_person_objs Person business objects created as part of the 'Person(s) Created' Business Object event
442 * @param x_return_status Return status after the call
446 * @rep:displayname Get Created Person Business Objects
443 * @param x_messages Messages returned from the retrieval of the business objects
444 * @rep:scope public
445 * @rep:lifecycle active
447 * @rep:doccd 120hztig.pdf Get Business Object API Procedures, Oracle Trading Community Architecture Technical Implementation Guide
448 */
449
450 PROCEDURE get_persons_created(
451 p_event_id IN NUMBER,
452 x_person_objs OUT NOCOPY HZ_PERSON_BO_TBL,
453 x_return_status OUT NOCOPY VARCHAR2,
454 x_messages OUT NOCOPY HZ_MESSAGE_OBJ_TBL
455 );
456
457 --------------------------------------
458 --
459 -- PROCEDURE get_persons_updated
460 --
461 -- DESCRIPTION
462 --The caller provides an identifier for the Persons update business event and
463 --the procedure returns database objects of the type HZ_PERSON_BO for all of
464 --the Person business objects from the business event.
465
466 --
467 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
468 --
469 -- ARGUMENTS
470 -- IN:
471 -- p_init_msg_list Initialize message stack if it is set to
472 -- p_event_id BES Event identifier.
473 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
474 -- OUT:
475 -- x_person_objs One or more created logical person.
476 -- x_return_status Return status after the call. The status can
477 -- be fnd_api.g_ret_sts_success (success),
478 -- fnd_api.g_ret_sts_error (error),
479 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
480 -- x_msg_count Number of messages in message stack.
481 -- x_msg_data Message text if x_msg_count is 1.
482 --
483 -- NOTES
484 --
485 -- MODIFICATION HISTORY
486 --
487 -- 10-JUN-2005 AWU Created.
488 --
489
490
491
492 /*
493 The Get Persons Updated procedure is a service to retrieve all of the Person business objects whose updates have been captured
494 by the logical business event. Each Persons Updated business event signifies that one or more Person business objects have been
495 updated.
496 The caller provides an identifier for the Persons Update business event and the procedure returns database objects of the type
497 HZ_PERSON_BO for all of the Person business objects from the business event.
498 Gathering all of the returned database objects from those API calls, the procedure packages them in a table structure and returns
499 them to the caller.
500 */
501
502 PROCEDURE get_persons_updated(
503 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
504 p_event_id IN NUMBER,
505 x_person_objs OUT NOCOPY HZ_PERSON_BO_TBL,
506 x_return_status OUT NOCOPY VARCHAR2,
507 x_msg_count OUT NOCOPY NUMBER,
508 x_msg_data OUT NOCOPY VARCHAR2
509 );
510
511 /*#
512 * Get Updated Person Business Objects (get_persons_updated)
513 * Extracts the Person business objects from TCA based upon an event identifier (event_id) for a Person(s)
514 * Updated Business Object Event. You provide the event_id value to the procedure, and the procedure returns the set of
515 * Person business objects that were updated as part of the event. The event identifer value must be valid for a
516 * Person(s) Updated Business Object Event.
517 *
518 * Provided within the returned business objects are Action Flags that designate how the data, at a particular level of
519 * an object, has changed as a result of the update to the Person business object. Each business object, structure,
520 * and entity has the attribute action_type that provides this type of update. Possible values for the Action Type are
521 * 'CREATED', 'UPDATED', 'CHILD_UPDATED', or 'UNCHANGED':
522 *
523 * Action Type Value: Created
524 * An action type value of 'CREATED' indicates, for a business object or structure, that the root attributes of the object
525 * were created and any number of embedded objects, structures, or entities were also created as part of this update.
526 * For a business entity, the value 'CREATED' indicates that its root attributes were created as part of this update.
527 *
528 * Action Type: Updated
529 * An action type value of 'UPDATED' indicates, for a business object or structure, that the root attributes of the object
530 * were updated and any number of embedded objects, structure, or entities were created or updated as part of this update.
531 * For a business entity, the value 'UPDATED' indicates that its root attributes were updated as part of this update.
532 *
533 * Action Type: Child Updated
534 * An action type value of 'CHILD_UPDATED' indicates, for a business object or structure, that the root attributes of the
535 * object were untouched, but at least one child embedded object, structure, or entity was created or updated as part of
536 * this update. For a business entity, this value is not valid as it has no children.
537 *
538 * Action Type: Unchanged
539 * An action type value of 'UNCHANGED' indicates, for a business object, structure, or entity, that there has been no
540 * change to its root attributes or any of its child objects, structures, or entities.
541 *
542 * @param p_event_id TCA Business Object Event identifier for the 'Person(s) Updated' event
543 * @param x_person_objs Person business objects updated as part of the 'Person(s) Updated' Business Object event
544 * @param x_return_status Return status after the call
545 * @param x_messages Messages returned from the retrieval of the business objects
546 * @rep:scope public
547 * @rep:lifecycle active
551
548 * @rep:displayname Get Updated Person Business Objects
549 * @rep:doccd 120hztig.pdf Get Updated Business Object Procedures, Oracle Trading Community Architecture Technical Implementation Guide
550 */
555 x_return_status OUT NOCOPY VARCHAR2,
552 PROCEDURE get_persons_updated(
553 p_event_id IN NUMBER,
554 x_person_objs OUT NOCOPY HZ_PERSON_BO_TBL,
556 x_messages OUT NOCOPY HZ_MESSAGE_OBJ_TBL
557 );
558
559 --------------------------------------
560 --
561 -- PROCEDURE get_person_updated
562 --
563 -- DESCRIPTION
564 --The caller provides an identifier for the Persons update business event and person_id
565 --the procedure returns one database object of the type HZ_PERSON_BO
566
567 --
568 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
569 --
570 -- ARGUMENTS
571 -- IN:
572 -- p_init_msg_list Initialize message stack if it is set to
573 -- p_event_id BES Event identifier.
574 -- p_person_id Person identifier.
575 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
576 -- OUT:
577 -- x_person_objs One or more created logical person.
578 -- x_return_status Return status after the call. The status can
579 -- be fnd_api.g_ret_sts_success (success),
580 -- fnd_api.g_ret_sts_error (error),
581 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
582 -- x_msg_count Number of messages in message stack.
583 -- x_msg_data Message text if x_msg_count is 1.
584 --
585 -- NOTES
586 --
587 -- MODIFICATION HISTORY
588 --
589 -- 10-JUN-2005 AWU Created.
590 --
591
592
593
594 -- Get only one person object based on p_person_id and event_id
595
596 PROCEDURE get_person_updated(
597 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
598 p_event_id IN NUMBER,
599 p_person_id IN NUMBER,
600 x_person_obj OUT NOCOPY HZ_PERSON_BO,
601 x_return_status OUT NOCOPY VARCHAR2,
602 x_msg_count OUT NOCOPY NUMBER,
603 x_msg_data OUT NOCOPY VARCHAR2
604 );
605
606 /*#
607 * Get Updated Person Business Object (get_person_updated)
608 * Extracts an updated Person business object from TCA based upon the object identifier (person_id) and event
609 * identifier (event_id). You provide values for the two identifiers to the procedure, and the procedure returns the
610 * identified business object. The event identifier value must be valid for a Person(s) Updated Business Object Event.
611 *
612 * Provided within the returned business object are Action Flags that designate how the data, at a particular level of the
613 * object, has changed as a result of the update to the Person business object. Each business object, structure, and
614 * entity has the attribute action_type that provides this type of update. Possible values for the Action Type are
615 * 'CREATED', 'UPDATED', 'CHILD_UPDATED', or 'UNCHANGED' as described
616 *
617 * Action Type Value: Created
618 * An action type value of 'CREATED' indicates, for a business object or structure, that the root attributes of the object
619 * were created and any number of embedded objects, structures, or entities were also created as part of this update. For
620 * a business entity, the value 'CREATED' indicates that its root attributes were created as part of this update.
621 *
622 * Action Type: Updated
623 * An action type value of 'UPDATED' indicates, for a business object or structure, that the root attributes of the object
624 * were updated and any number of embedded objects, structure, or entities were created or updated as part of this update.
625 * For a business entity, the value 'UPDATED' indicates that its root attributes were updated as part of this update.
626 *
627 * Action Type: Child Updated
628 * An action type value of 'CHILD_UPDATED' indicates, for a business object or structure, that the root attributes of the
629 * object were untouched, but at least one child embedded object, structure, or entity was created or updated as part of
630 * this update. For a business entity, this value is not valid as it has no children.
631 *
632 * Action Type: Unchanged
633 * An action type value of 'UNCHANGED' indicates, for a business object, structure, or entity, that there has been no change
634 * to its root attributes or any of its child objects, structures, or entities.
635 *
636 * @param p_event_id TCA Business Object Event identifier for the 'Person(s) Updated' event
637 * @param p_person_id TCA identifier for the updated Person business object
638 * @param x_person_obj Person business object updated as part of the 'Person(s) Updated' Business Object event
639 * @param x_return_status Return status after the call
640 * @param x_messages Messages returned from the retrieval of the business object
641 * @rep:scope public
642 * @rep:lifecycle active
643 * @rep:displayname Get Updated Person Business Objects
644 * @rep:doccd 120hztig.pdf Get Updated Business Object Procedures, Oracle Trading Community Architecture Technical Implementation Guide
645 */
646
647 PROCEDURE get_person_updated(
648 p_event_id IN NUMBER,
649 p_person_id IN NUMBER,
650 x_person_obj OUT NOCOPY HZ_PERSON_BO,
651 x_return_status OUT NOCOPY VARCHAR2,
652 x_messages OUT NOCOPY HZ_MESSAGE_OBJ_TBL
653 );
654
655 /*#
656 * Get Identifiers for Created Person Business Objects (get_ids_persons_created)
657 * Retrieves identification values for the Person business objects created in the Person(s) Created Business
658 * Object Event. You pass an event identifier to the procedure (event_id), and the procedure returns an array of object
659 * identifier (person_id) values that designate all of the Person business objects that were created as part
660 * of this event.
661 *
662 * @param p_init_msg_list Initiailize FND message stack.
663 * @param p_event_id TCA Business Object Event identifier for the 'Person(s) Created' event
664 * @param x_person_ids TCA identifiers for the created Person business objects
665 * @param x_return_status Return status after the call
666 * @param x_msg_count Number of messages in message stack.
667 * @param x_msg_data Messages returned from the operation
668 * @rep:scope public
669 * @rep:lifecycle active
670 * @rep:displayname Get Identifiers for Created Person Business Objects
671 * @rep:doccd 120hztig.pdf Get Business Object API Procedures, Oracle Trading Community Architecture Technical Implementation Guide
672 */
673
674 -- get TCA identifiers for create event
675 PROCEDURE get_ids_persons_created (
676 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
677 p_event_id IN NUMBER,
678 x_person_ids OUT NOCOPY HZ_EXTRACT_BO_UTIL_PVT.BO_ID_TBL,
679 x_return_status OUT NOCOPY VARCHAR2,
680 x_msg_count OUT NOCOPY NUMBER,
681 x_msg_data OUT NOCOPY VARCHAR2
685 /*#
682
683 );
684
686 * Get Identifiers for Updated Person Business Objects (get_ids_persons_updated)
687 * Retrieves identification values for the Person business objects updated in the "Person(s) Updated" Business
688 * Object Event. You pass an event identifier to the procedure (event_id), and the procedure returns an array of object
689 * identifier (person_id) values that designate all of the Person business objects that were updated as part
690 * of this event.
691 *
692 * @param p_init_msg_list Initiailize FND message stack.
693 * @param p_event_id TCA Business Object Event identifier for the 'Person(s) Updated' event.
694 * @param x_person_ids TCA identifiers for the updated Person business objects
695 * @param x_return_status Return status after the call
696 * @param x_msg_count Number of messages in message stack.
697 * @param x_msg_data Messages returned from the operation
698 * @rep:scope public
699 * @rep:lifecycle active
700 * @rep:displayname Get Identifiers for Updated Person Business Objects
701 * @rep:doccd 120hztig.pdf Get Updated Business Object Procedures, Oracle Trading Community Architecture Technical Implementation Guide
702 */
703
704 -- get TCA identifiers for update event
705 PROCEDURE get_ids_persons_updated (
706 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
707 p_event_id IN NUMBER,
708 x_person_ids OUT NOCOPY HZ_EXTRACT_BO_UTIL_PVT.BO_ID_TBL,
709 x_return_status OUT NOCOPY VARCHAR2,
710 x_msg_count OUT NOCOPY NUMBER,
711 x_msg_data OUT NOCOPY VARCHAR2
712 );
713
714 PROCEDURE do_create_person_bo(
715 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
716 p_validate_bo_flag IN VARCHAR2 := fnd_api.g_true,
717 p_person_obj IN OUT NOCOPY HZ_PERSON_BO,
718 p_created_by_module IN VARCHAR2,
719 p_obj_source IN VARCHAR2 := null,
720 x_return_status OUT NOCOPY VARCHAR2,
721 x_msg_count OUT NOCOPY NUMBER,
722 x_msg_data OUT NOCOPY VARCHAR2,
723 x_person_id OUT NOCOPY NUMBER,
724 x_person_os OUT NOCOPY VARCHAR2,
725 x_person_osr OUT NOCOPY VARCHAR2
726 );
727
728 PROCEDURE do_update_person_bo(
729 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
730 p_person_obj IN OUT NOCOPY HZ_PERSON_BO,
731 p_created_by_module IN VARCHAR2,
732 p_obj_source IN VARCHAR2 := NULL,
733 x_return_status OUT NOCOPY VARCHAR2,
734 x_msg_count OUT NOCOPY NUMBER,
735 x_msg_data OUT NOCOPY VARCHAR2,
736 x_person_id OUT NOCOPY NUMBER,
737 x_person_os OUT NOCOPY VARCHAR2,
738 x_person_osr OUT NOCOPY VARCHAR2
739 );
740
741 PROCEDURE do_save_person_bo(
742 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
743 p_validate_bo_flag IN VARCHAR2 := fnd_api.g_true,
744 p_person_obj IN OUT NOCOPY HZ_PERSON_BO,
745 p_created_by_module IN VARCHAR2,
746 p_obj_source IN VARCHAR2 := null,
747 x_return_status OUT NOCOPY VARCHAR2,
748 x_msg_count OUT NOCOPY NUMBER,
749 x_msg_data OUT NOCOPY VARCHAR2,
750 x_person_id OUT NOCOPY NUMBER,
751 x_person_os OUT NOCOPY VARCHAR2,
752 x_person_osr OUT NOCOPY VARCHAR2
753 );
754
755 END HZ_PERSON_BO_PUB;
[Home] [Help]