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