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