1 PACKAGE HZ_CUST_ACCT_SITE_BO_PUB AUTHID CURRENT_USER AS
2 /*$Header: ARHBCSBS.pls 120.10 2008/02/06 11:20:32 vsegu ship $ */
3 /*#
4 * Customer Account Site Business Object API
5 * Public API that allows users to manage Customer Account Site 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_ADDRESS
12 * @rep:displayname Customer Account Site Business Object API
13 * @rep:doccd 120hztig.pdf Customer Account Site Business Object API, Oracle Trading Community Architecture Technical Implementation Guide
14 */
15
16 -- PROCEDURE create_cust_acct_site_bo
17 --
18 -- DESCRIPTION
19 -- Create customer account site 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_cust_acct_site_obj Customer account site object.
30 -- p_created_by_module Created by module.
31 -- IN OUT:
32 -- px_parent_acct_id Parent customer account id
33 -- px_parent_acct_os Parent customer account os
34 -- px_parent_acct_osr Parent customer account osr
35 -- OUT:
36 -- x_return_status Return status after the call. The status can
37 -- be fnd_api.g_ret_sts_success (success),
38 -- fnd_api.g_ret_sts_error (error),
39 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
40 -- x_msg_count Number of messages in message stack.
41 -- x_msg_data Message text if x_msg_count is 1.
42 -- x_cust_acct_site_id Customer Account Site ID.
43 -- x_cust_acct_site_os Customer Account Site orig system.
44 -- x_cust_acct_site_osr Customer Account Site orig system reference.
45 --
46 -- NOTES
47 --
48 -- MODIFICATION HISTORY
49 --
50 -- 14-DEC-2004 Arnold Ng Created.
51 --
52
53 PROCEDURE create_cust_acct_site_bo(
54 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
55 p_validate_bo_flag IN VARCHAR2 := fnd_api.g_true,
56 p_cust_acct_site_obj IN HZ_CUST_ACCT_SITE_BO,
57 p_created_by_module IN VARCHAR2,
58 x_return_status OUT NOCOPY VARCHAR2,
59 x_msg_count OUT NOCOPY NUMBER,
60 x_msg_data OUT NOCOPY VARCHAR2,
61 x_cust_acct_site_id OUT NOCOPY NUMBER,
62 x_cust_acct_site_os OUT NOCOPY VARCHAR2,
63 x_cust_acct_site_osr OUT NOCOPY VARCHAR2,
64 px_parent_acct_id IN OUT NOCOPY NUMBER,
65 px_parent_acct_os IN OUT NOCOPY VARCHAR2,
66 px_parent_acct_osr IN OUT NOCOPY VARCHAR2
67 );
68
69 /*#
70 * Create Customer Account Site Business Object (create_cust_acct_site_bo)
71 * Creates a Customer Account Site business object. You pass object data to the procedure, packaged within an object type
72 * defined specifically for the API. The object type is HZ_CUST_ACCT_SITE_BO for the Customer Account Site business object.
73 * In addition to the object's business object attributes, the object type also includes lower-level embedded child entities
74 * or objects that can be simultaneously created.
75 *
76 * @param p_return_obj_flag Indicates if the created object is to be returned to the caller as an output parameter. Default value: false
77 * @param p_validate_bo_flag Indicates if the passed business object is to be validated for completeness. Default value: true
78 * @param p_cust_acct_site_obj The Customer Account Site business object to be created in its entirety
79 * @param p_created_by_module The module creating this business object. Must be a valid created_by_module value
80 * @param p_obj_source The source of this business object
81 * @param x_return_status Return status after the call
82 * @param x_return_obj The Customer Account Site business object that was created, returned as an output parameter
83 * @param x_messages Messages returned from the creation of the business object
84 * @param x_cust_acct_site_id TCA identifier for the Customer Account Site business object
85 * @param x_cust_acct_site_os Customer Account Site original system name
86 * @param x_cust_acct_site_osr Customer Account Site original system reference
87 * @param px_parent_acct_id TCA identifier for parent object. Either this parameter or both the px_parent_os and px_parent_osr parameters must be given
88 * @param px_parent_acct_os Parent object original system name
89 * @param px_parent_acct_osr Parent object original system reference
90 * @rep:scope public
91 * @rep:lifecycle active
92 * @rep:displayname Create Customer Account Site Business Object
93 * @rep:doccd 120hztig.pdf Create Customer Account Site Business Object, Oracle Trading Community Architecture Technical Implementation Guide
94 */
95 PROCEDURE create_cust_acct_site_bo(
96 p_validate_bo_flag IN VARCHAR2 := fnd_api.g_true,
97 p_cust_acct_site_obj IN HZ_CUST_ACCT_SITE_BO,
98 p_created_by_module IN VARCHAR2,
99 p_obj_source IN VARCHAR2 := null,
100 p_return_obj_flag IN VARCHAR2 := fnd_api.g_true,
101 x_return_status OUT NOCOPY VARCHAR2,
102 x_messages OUT NOCOPY HZ_MESSAGE_OBJ_TBL,
103 x_return_obj OUT NOCOPY HZ_CUST_ACCT_SITE_BO,
104 x_cust_acct_site_id OUT NOCOPY NUMBER,
105 x_cust_acct_site_os OUT NOCOPY VARCHAR2,
106 x_cust_acct_site_osr OUT NOCOPY VARCHAR2,
107 px_parent_acct_id IN OUT NOCOPY NUMBER,
108 px_parent_acct_os IN OUT NOCOPY VARCHAR2,
109 px_parent_acct_osr IN OUT NOCOPY VARCHAR2
110 );
111
112 -- PROCEDURE update_cust_acct_site_bo
113 --
114 -- DESCRIPTION
115 -- Update customer account site business object.
116 --
117 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
118 --
119 -- ARGUMENTS
120 -- IN:
121 -- p_init_msg_list Initialize message stack if it is set to
122 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
123 -- p_cust_acct_site_obj Customer account site object.
124 -- p_created_by_module Created by module.
125 -- OUT:
126 -- x_return_status Return status after the call. The status can
127 -- be fnd_api.g_ret_sts_success (success),
128 -- fnd_api.g_ret_sts_error (error),
129 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
130 -- x_msg_count Number of messages in message stack.
131 -- x_msg_data Message text if x_msg_count is 1.
132 -- x_cust_acct_site_id Customer Account Site ID.
133 -- x_cust_acct_site_os Customer Account Site orig system.
134 -- x_cust_acct_site_osr Customer Account Site orig system reference.
135 --
136 -- NOTES
137 --
138 -- MODIFICATION HISTORY
139 --
140 -- 14-DEC-2004 Arnold Ng Created.
141 --
142
143 PROCEDURE update_cust_acct_site_bo(
144 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
145 p_cust_acct_site_obj IN HZ_CUST_ACCT_SITE_BO,
146 p_created_by_module IN VARCHAR2,
147 x_return_status OUT NOCOPY VARCHAR2,
148 x_msg_count OUT NOCOPY NUMBER,
149 x_msg_data OUT NOCOPY VARCHAR2,
150 x_cust_acct_site_id OUT NOCOPY NUMBER,
151 x_cust_acct_site_os OUT NOCOPY VARCHAR2,
152 x_cust_acct_site_osr OUT NOCOPY VARCHAR2
153 );
154
155 /*#
156 * Update Customer Account Site Business Object (update_cust_acct_site_bo)
157 * Updates a Customer Account Site business object. You pass any modified object data to the procedure, packaged within an
158 * object type defined specifically for the API. The object type is HZ_CUST_ACCT_SITE_BO for the Customer Account Site
159 * business object. In addition to the object's business object attributes, the object type also includes embedded child
160 * business entities or objects that can be simultaneously created or updated.
161 *
162 * @param p_return_obj_flag Indicates if the updated object is to be returned to the caller as an output parameter. Default value: false
163 * @param p_cust_acct_site_obj The Customer Account Site business object to be updated
164 * @param p_created_by_module The module updating this business object
165 * @param p_obj_source The source of this business object
166 * @param x_return_status Return status after the call
167 * @param x_return_obj The Customer Account Site business object that was updated, returned as an output parameter
168 * @param x_messages Messages returned from the update of the business object
169 * @param x_cust_acct_site_id TCA identifier for the Customer Account Site business object
170 * @param x_cust_acct_site_os Customer Account Site original system name
171 * @param x_cust_acct_site_osr Customer Account Site original system reference
172 * @rep:scope public
173 * @rep:lifecycle active
174 * @rep:displayname Update Customer Account Site Business Object
175 * @rep:doccd 120hztig.pdf Update Customer Account Site Business Object, Oracle Trading Community Architecture Technical Implementation Guide
176 */
177 PROCEDURE update_cust_acct_site_bo(
178 p_cust_acct_site_obj IN HZ_CUST_ACCT_SITE_BO,
179 p_created_by_module IN VARCHAR2,
180 p_obj_source IN VARCHAR2 := null,
181 p_return_obj_flag IN VARCHAR2 := fnd_api.g_true,
182 x_return_status OUT NOCOPY VARCHAR2,
183 x_messages OUT NOCOPY HZ_MESSAGE_OBJ_TBL,
184 x_return_obj OUT NOCOPY HZ_CUST_ACCT_SITE_BO,
185 x_cust_acct_site_id OUT NOCOPY NUMBER,
186 x_cust_acct_site_os OUT NOCOPY VARCHAR2,
187 x_cust_acct_site_osr OUT NOCOPY VARCHAR2
188 );
189
190 -- PROCEDURE save_cust_acct_site_bo
191 --
192 -- DESCRIPTION
193 -- Create or update customer account site business object.
194 --
195 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
196 --
197 -- ARGUMENTS
198 -- IN:
199 -- p_init_msg_list Initialize message stack if it is set to
200 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
201 -- p_validate_bo_flag If it is set to FND_API.G_TRUE, validate
202 -- the completeness of business object.
203 -- p_cust_acct_site_obj Customer account site object.
204 -- p_created_by_module Created by module.
205 -- IN OUT:
206 -- px_parent_acct_id Parent customer account id
207 -- px_parent_acct_os Parent customer account os
208 -- px_parent_acct_osr Parent customer account osr
209 -- OUT:
210 -- x_return_status Return status after the call. The status can
211 -- be fnd_api.g_ret_sts_success (success),
212 -- fnd_api.g_ret_sts_error (error),
213 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
214 -- x_msg_count Number of messages in message stack.
215 -- x_msg_data Message text if x_msg_count is 1.
216 -- x_cust_acct_site_id Customer Account Site ID.
217 -- x_cust_acct_site_os Customer Account Site orig system.
218 -- x_cust_acct_site_osr Customer Account Site orig system reference.
219 --
220 -- NOTES
221 --
222 -- MODIFICATION HISTORY
223 --
224 -- 14-DEC-2004 Arnold Ng Created.
225 --
226
227 PROCEDURE save_cust_acct_site_bo(
228 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
229 p_validate_bo_flag IN VARCHAR2 := fnd_api.g_true,
230 p_cust_acct_site_obj IN HZ_CUST_ACCT_SITE_BO,
231 p_created_by_module IN VARCHAR2,
232 x_return_status OUT NOCOPY VARCHAR2,
233 x_msg_count OUT NOCOPY NUMBER,
234 x_msg_data OUT NOCOPY VARCHAR2,
235 x_cust_acct_site_id OUT NOCOPY NUMBER,
236 x_cust_acct_site_os OUT NOCOPY VARCHAR2,
237 x_cust_acct_site_osr OUT NOCOPY VARCHAR2,
238 px_parent_acct_id IN OUT NOCOPY NUMBER,
239 px_parent_acct_os IN OUT NOCOPY VARCHAR2,
240 px_parent_acct_osr IN OUT NOCOPY VARCHAR2
241 );
242
243 /*#
244 * Save Customer Account Site Business Object (save_cust_acct_site_bo)
245 * Saves a Customer Account Site business object. You pass new or modified object data to the procedure, packaged within
246 * an object type defined specifically for the API. The API then determines if the object exists in TCA, based upon the
247 * provided identification information, and creates or updates the object. The object type is HZ_CUST_ACCT_SITE_BO for
248 * the Customer Account Site business object. For either case, the object type that you provide will be processed as if
249 * the respective API procedure is being called (create_cust_acct_site_bo or update_cust_acct_site_bo). Please see those
250 * procedures for more details. In addition to the object's business object attributes, the object type also includes
251 * embedded child business entities or objects that can be simultaneously created or updated.
252 *
253 * @param p_return_obj_flag Indicates if the saved object is to be returned to the caller as an output parameter. Default value: false
254 * @param p_validate_bo_flag Indicates if the passed business object is to be validated for completeness if it is being created
255 * @param p_cust_acct_site_obj The Customer Account Site business object to be saved
256 * @param p_created_by_module The module saving this business object
257 * @param p_obj_source The source of this business object
258 * @param x_return_status Return status after the call
259 * @param x_return_obj The Customer Account Site business object that was saved, returned as an output parameter
260 * @param x_messages Messages returned from the save of the business object
261 * @param x_cust_acct_site_id TCA identifier for the Customer Account Site business object
262 * @param x_cust_acct_site_os Customer Account Site original system name
263 * @param x_cust_acct_site_osr Customer Account Site original system reference
264 * @param px_parent_acct_id TCA identifier for parent object. Either this parameter or both the px_parent_os and px_parent_osr parameters must be given
265 * @param px_parent_acct_os Parent object original system name
266 * @param px_parent_acct_osr Parent object original system reference
267 * @rep:scope public
268 * @rep:lifecycle active
269 * @rep:displayname Save Customer Account Site Business Object
273 p_validate_bo_flag IN VARCHAR2 := fnd_api.g_true,
270 * @rep:doccd 120hztig.pdf Save Customer Account Site Business Object, Oracle Trading Community Architecture Technical Implementation Guide
271 */
272 PROCEDURE save_cust_acct_site_bo(
274 p_cust_acct_site_obj IN HZ_CUST_ACCT_SITE_BO,
275 p_created_by_module IN VARCHAR2,
276 p_obj_source IN VARCHAR2 := null,
277 p_return_obj_flag IN VARCHAR2 := fnd_api.g_true,
278 x_return_status OUT NOCOPY VARCHAR2,
279 x_messages OUT NOCOPY HZ_MESSAGE_OBJ_TBL,
280 x_return_obj OUT NOCOPY HZ_CUST_ACCT_SITE_BO,
281 x_cust_acct_site_id OUT NOCOPY NUMBER,
282 x_cust_acct_site_os OUT NOCOPY VARCHAR2,
283 x_cust_acct_site_osr OUT NOCOPY VARCHAR2,
284 px_parent_acct_id IN OUT NOCOPY NUMBER,
285 px_parent_acct_os IN OUT NOCOPY VARCHAR2,
286 px_parent_acct_osr IN OUT NOCOPY VARCHAR2
287 );
288
289 --------------------------------------
290 --
291 -- PROCEDURE get_cust_acct_site_bo
292 --
293 -- DESCRIPTION
294 -- Get logical customer account site.
295 --
296 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
297 --
298 -- ARGUMENTS
299 -- IN:
300 -- p_init_msg_list Initialize message stack if it is set to
301 -- p_parent_id parent id.
302 -- p_cust_acct_site_id customer account site ID.
303 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
304 -- OUT:
305 -- x_cust_acct_site_obj Logical customer account site record.
306 -- x_return_status Return status after the call. The status can
307 -- be fnd_api.g_ret_sts_success (success),
308 -- fnd_api.g_ret_sts_error (error),
309 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
310 -- x_msg_count Number of messages in message stack.
311 -- x_msg_data Message text if x_msg_count is 1.
312 --
313 -- NOTES
314 --
315 -- MODIFICATION HISTORY
316 --
317 --
318 -- 8-JUN-2005 AWU Created.
319 --
320
321 /*
322
323 The Get customer account site API Procedure is a retrieval service that returns a full customer account site business object.
324 The user identifies a particular Organization Contact business object using the TCA identifier and/or the object's Source System
325 information. Upon proper validation of the object, the full Organization Contact business object is returned.
326 The object consists of all data included within the Organization Contact business object, at all embedded levels. This includes the
327 set of all data stored in the TCA tables for each embedded entity.
328
329
330 Embedded BO Mandatory Multiple Logical API Procedure Comments
331
332 Party Site Y N get_party_site_bo
333 Customer Account Site Contact N Y get_cust_acct_contact_bo
334 Customer Account Site Use N Y Business Structure. Included entities and
335 structures:HZ_CUST_SITE_USES_ALL,Customer
336 Profile (Business Structure)
337
338
342 Embedded TCA Entity Mandatory Multiple TCA Table Entities
339 To retrieve the appropriate embedded entities within the 'Organization Contact' business object, the Get procedure returns all
340 records for the particular contact from these TCA entity tables.
341
343
344 Customer account site Y N HZ_CUST_ACCOUNTS
345 Bank account site Use N Y Owned by Payments team
346 Payment Method N N Owned by AR team
347
348 */
349
350 PROCEDURE get_cust_acct_site_bo (
351 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
352 p_cust_acct_site_id IN NUMBER,
353 p_cust_acct_site_os IN VARCHAR2,
354 p_cust_acct_site_osr IN VARCHAR2,
355 x_cust_acct_site_obj OUT NOCOPY HZ_CUST_ACCT_SITE_BO,
356 x_return_status OUT NOCOPY VARCHAR2,
357 x_msg_count OUT NOCOPY NUMBER,
358 x_msg_data OUT NOCOPY VARCHAR2
359 );
360
361 /*#
362 * Get Customer Account Site Business Object (get_cust_acct_site_bo)
363 * Extracts a particular Customer Account Site business object from TCA. You pass the object's identification information
364 * to the procedure, and the procedure returns the identified business object as it exists in TCA.
365 *
366 * @param p_cust_acct_site_id TCA identifier for the Customer Account Site business object
367 * @param p_cust_acct_site_os Customer Account Site original system name
368 * @param p_cust_acct_site_osr Customer Account Site original system reference
369 * @param x_cust_acct_site_obj The retrieved Customer Account Site business object
370 * @param x_return_status Return status after the call
371 * @param x_messages Messages returned from the retrieval of the business object
372 * @rep:scope public
373 * @rep:lifecycle active
374 * @rep:displayname Get Customer Account Site Business Object
375 * @rep:doccd 120hztig.pdf Get Customer Account Site Business Object, Oracle Trading Community Architecture Technical Implementation Guide
376 */
377 PROCEDURE get_cust_acct_site_bo (
378 p_cust_acct_site_id IN NUMBER,
379 p_cust_acct_site_os IN VARCHAR2,
380 p_cust_acct_site_osr IN VARCHAR2,
381 x_cust_acct_site_obj OUT NOCOPY HZ_CUST_ACCT_SITE_BO,
382 x_return_status OUT NOCOPY VARCHAR2,
383 x_messages OUT NOCOPY HZ_MESSAGE_OBJ_TBL
384 );
385
386 PROCEDURE do_create_cust_acct_site_bo(
387 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
388 p_validate_bo_flag IN VARCHAR2 := fnd_api.g_true,
389 p_cust_acct_site_obj IN OUT NOCOPY HZ_CUST_ACCT_SITE_BO,
390 p_created_by_module IN VARCHAR2,
391 p_obj_source IN VARCHAR2 := null,
392 x_return_status OUT NOCOPY VARCHAR2,
393 x_msg_count OUT NOCOPY NUMBER,
394 x_msg_data OUT NOCOPY VARCHAR2,
395 x_cust_acct_site_id OUT NOCOPY NUMBER,
396 x_cust_acct_site_os OUT NOCOPY VARCHAR2,
397 x_cust_acct_site_osr OUT NOCOPY VARCHAR2,
398 px_parent_acct_id IN OUT NOCOPY NUMBER,
399 px_parent_acct_os IN OUT NOCOPY VARCHAR2,
400 px_parent_acct_osr IN OUT NOCOPY VARCHAR2
401 );
402
403 PROCEDURE do_update_cust_acct_site_bo(
404 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
405 p_validate_bo_flag IN VARCHAR2 := fnd_api.g_true,
406 p_cust_acct_site_obj IN OUT NOCOPY HZ_CUST_ACCT_SITE_BO,
407 p_created_by_module IN VARCHAR2,
408 p_obj_source IN VARCHAR2 := null,
409 x_return_status OUT NOCOPY VARCHAR2,
410 x_msg_count OUT NOCOPY NUMBER,
411 x_msg_data OUT NOCOPY VARCHAR2,
412 x_cust_acct_site_id OUT NOCOPY NUMBER,
413 x_cust_acct_site_os OUT NOCOPY VARCHAR2,
414 x_cust_acct_site_osr OUT NOCOPY VARCHAR2,
415 p_parent_os IN VARCHAR2
416 );
417
418 PROCEDURE do_save_cust_acct_site_bo(
419 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
420 p_validate_bo_flag IN VARCHAR2 := fnd_api.g_true,
421 p_cust_acct_site_obj IN OUT NOCOPY HZ_CUST_ACCT_SITE_BO,
422 p_created_by_module IN VARCHAR2,
423 p_obj_source IN VARCHAR2 := null,
424 x_return_status OUT NOCOPY VARCHAR2,
425 x_msg_count OUT NOCOPY NUMBER,
426 x_msg_data OUT NOCOPY VARCHAR2,
427 x_cust_acct_site_id OUT NOCOPY NUMBER,
428 x_cust_acct_site_os OUT NOCOPY VARCHAR2,
429 x_cust_acct_site_osr OUT NOCOPY VARCHAR2,
430 px_parent_acct_id IN OUT NOCOPY NUMBER,
431 px_parent_acct_os IN OUT NOCOPY VARCHAR2,
432 px_parent_acct_osr IN OUT NOCOPY VARCHAR2
433 );
434
435 -- PROCEDURE create_cust_acct_site_v2_bo
436 --
437 -- DESCRIPTION
438 -- Create customer account site business object.
439 --
440 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
441 --
442 -- ARGUMENTS
443 -- IN:
444 -- p_init_msg_list Initialize message stack if it is set to
445 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
446 -- p_validate_bo_flag If it is set to FND_API.G_TRUE, validate
447 -- the completeness of business object.
448 -- p_cust_acct_site_v2_obj Customer account site object.
449 -- p_created_by_module Created by module.
453 -- px_parent_acct_osr Parent customer account osr
450 -- IN OUT:
451 -- px_parent_acct_id Parent customer account id
452 -- px_parent_acct_os Parent customer account os
454 -- OUT:
455 -- x_return_status Return status after the call. The status can
456 -- be fnd_api.g_ret_sts_success (success),
457 -- fnd_api.g_ret_sts_error (error),
458 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
459 -- x_msg_count Number of messages in message stack.
460 -- x_messages Messages in message stack
461 -- x_cust_acct_site_id Customer Account Site ID.
462 -- x_cust_acct_site_os Customer Account Site orig system.
463 -- x_cust_acct_site_osr Customer Account Site orig system reference.
464 --
465 -- NOTES
466 --
467 -- MODIFICATION HISTORY
468 --
469 -- 31-JAN-2008 vsegu Created.
470 --
471
472 /*#
473 * Create Customer Account Site Business Object (create_cust_acct_site_v2_bo)
474 * Creates a Customer Account Site business object. You pass object data to the procedure, packaged within an object type
475 * defined specifically for the API. The object type is HZ_CUST_ACCT_SITE_V2_BO for the Customer Account Site business object.
476 * In addition to the object's business object attributes, the object type also includes lower-level embedded child entities
477 * or objects that can be simultaneously created.
478 *
479 * @param p_return_obj_flag Indicates if the created object is to be returned to the caller as an output parameter. Default value: false
480 * @param p_validate_bo_flag Indicates if the passed business object is to be validated for completeness. Default value: true
481 * @param p_cust_acct_site_v2_obj The Customer Account Site business object to be created in its entirety
482 * @param p_created_by_module The module creating this business object. Must be a valid created_by_module value
483 * @param p_obj_source The source of this business object
484 * @param x_return_status Return status after the call
485 * @param x_return_obj The Customer Account Site business object that was created, returned as an output parameter
486 * @param x_messages Messages returned from the creation of the business object
487 * @param x_cust_acct_site_id TCA identifier for the Customer Account Site business object
488 * @param x_cust_acct_site_os Customer Account Site original system name
489 * @param x_cust_acct_site_osr Customer Account Site original system reference
490 * @param px_parent_acct_id TCA identifier for parent object. Either this parameter or both the px_parent_os and px_parent_osr parameters must be given
491 * @param px_parent_acct_os Parent object original system name
492 * @param px_parent_acct_osr Parent object original system reference
493 * @rep:scope public
494 * @rep:lifecycle active
495 * @rep:displayname Create Customer Account Site Business Object
496 * @rep:doccd 120hztig.pdf Create Customer Account Site Business Object, Oracle Trading Community Architecture Technical Implementation Guide
497 */
498 PROCEDURE create_cust_acct_site_v2_bo(
499 p_validate_bo_flag IN VARCHAR2 := fnd_api.g_true,
500 p_cust_acct_site_v2_obj IN HZ_CUST_ACCT_SITE_V2_BO,
501 p_created_by_module IN VARCHAR2,
502 p_obj_source IN VARCHAR2 := null,
503 p_return_obj_flag IN VARCHAR2 := fnd_api.g_true,
504 x_return_status OUT NOCOPY VARCHAR2,
505 x_messages OUT NOCOPY HZ_MESSAGE_OBJ_TBL,
506 x_return_obj OUT NOCOPY HZ_CUST_ACCT_SITE_V2_BO,
507 x_cust_acct_site_id OUT NOCOPY NUMBER,
508 x_cust_acct_site_os OUT NOCOPY VARCHAR2,
509 x_cust_acct_site_osr OUT NOCOPY VARCHAR2,
510 px_parent_acct_id IN OUT NOCOPY NUMBER,
511 px_parent_acct_os IN OUT NOCOPY VARCHAR2,
512 px_parent_acct_osr IN OUT NOCOPY VARCHAR2
513 );
514
515 -- PROCEDURE update_cust_acct_site_v2_bo
516 --
517 -- DESCRIPTION
518 -- Update customer account site business object.
519 --
520 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
521 --
522 -- ARGUMENTS
523 -- IN:
524 -- p_init_msg_list Initialize message stack if it is set to
525 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
526 -- p_cust_acct_site_v2_obj Customer account site object.
527 -- p_created_by_module Created by module.
528 -- OUT:
529 -- x_return_status Return status after the call. The status can
530 -- be fnd_api.g_ret_sts_success (success),
531 -- fnd_api.g_ret_sts_error (error),
532 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
533 -- x_msg_count Number of messages in message stack.
534 -- x_messages Messages in message stack
535 -- x_cust_acct_site_id Customer Account Site ID.
536 -- x_cust_acct_site_os Customer Account Site orig system.
537 -- x_cust_acct_site_osr Customer Account Site orig system reference.
538 --
539 -- NOTES
540 --
541 -- MODIFICATION HISTORY
542 --
543 -- 31-JAN-2008 vsegu Created.
544 --
545
546 /*#
547 * Update Customer Account Site Business Object (update_cust_acct_site_v2_bo)
548 * Updates a Customer Account Site business object. You pass any modified object data to the procedure, packaged within an
549 * object type defined specifically for the API. The object type is HZ_CUST_ACCT_SITE_V2_BO for the Customer Account Site
553 * @param p_return_obj_flag Indicates if the updated object is to be returned to the caller as an output parameter. Default value: false
550 * business object. In addition to the object's business object attributes, the object type also includes embedded child
551 * business entities or objects that can be simultaneously created or updated.
552 *
554 * @param p_cust_acct_site_v2_obj The Customer Account Site business object to be updated
555 * @param p_created_by_module The module updating this business object
556 * @param p_obj_source The source of this business object
557 * @param x_return_status Return status after the call
558 * @param x_return_obj The Customer Account Site business object that was updated, returned as an output parameter
559 * @param x_messages Messages returned from the update of the business object
560 * @param x_cust_acct_site_id TCA identifier for the Customer Account Site business object
561 * @param x_cust_acct_site_os Customer Account Site original system name
562 * @param x_cust_acct_site_osr Customer Account Site original system reference
563 * @rep:scope public
564 * @rep:lifecycle active
565 * @rep:displayname Update Customer Account Site Business Object
566 * @rep:doccd 120hztig.pdf Update Customer Account Site Business Object, Oracle Trading Community Architecture Technical Implementation Guide
567 */
568 PROCEDURE update_cust_acct_site_v2_bo(
569 p_cust_acct_site_v2_obj IN HZ_CUST_ACCT_SITE_V2_BO,
570 p_created_by_module IN VARCHAR2,
571 p_obj_source IN VARCHAR2 := null,
572 p_return_obj_flag IN VARCHAR2 := fnd_api.g_true,
573 x_return_status OUT NOCOPY VARCHAR2,
574 x_messages OUT NOCOPY HZ_MESSAGE_OBJ_TBL,
575 x_return_obj OUT NOCOPY HZ_CUST_ACCT_SITE_V2_BO,
576 x_cust_acct_site_id OUT NOCOPY NUMBER,
577 x_cust_acct_site_os OUT NOCOPY VARCHAR2,
578 x_cust_acct_site_osr OUT NOCOPY VARCHAR2
579 );
580
581 -- PROCEDURE save_cust_acct_site_v2_bo
582 --
583 -- DESCRIPTION
584 -- Create or update customer account site business object.
585 --
586 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
587 --
588 -- ARGUMENTS
589 -- IN:
590 -- p_init_msg_list Initialize message stack if it is set to
591 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
592 -- p_validate_bo_flag If it is set to FND_API.G_TRUE, validate
593 -- the completeness of business object.
594 -- p_cust_acct_site_v2_obj Customer account site object.
595 -- p_created_by_module Created by module.
596 -- IN OUT:
597 -- px_parent_acct_id Parent customer account id
598 -- px_parent_acct_os Parent customer account os
599 -- px_parent_acct_osr Parent customer account osr
600 -- OUT:
601 -- x_return_status Return status after the call. The status can
602 -- be fnd_api.g_ret_sts_success (success),
603 -- fnd_api.g_ret_sts_error (error),
604 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
605 -- x_msg_count Number of messages in message stack.
606 -- x_messages Messages in message stack
607 -- x_cust_acct_site_id Customer Account Site ID.
608 -- x_cust_acct_site_os Customer Account Site orig system.
609 -- x_cust_acct_site_osr Customer Account Site orig system reference.
610 --
611 -- NOTES
612 --
613 -- MODIFICATION HISTORY
614 --
615 -- 31-JAN-2008 vsegu Created.
616 --
617
618 /*#
619 * Save Customer Account Site Business Object (save_cust_acct_site_v2_bo)
620 * Saves a Customer Account Site business object. You pass new or modified object data to the procedure, packaged within
621 * an object type defined specifically for the API. The API then determines if the object exists in TCA, based upon the
622 * provided identification information, and creates or updates the object. The object type is HZ_CUST_ACCT_SITE_V2_BO for
623 * the Customer Account Site business object. For either case, the object type that you provide will be processed as if
624 * the respective API procedure is being called (create_cust_acct_site_v2_bo or update_cust_acct_site_v2_bo). Please see those
625 * procedures for more details. In addition to the object's business object attributes, the object type also includes
626 * embedded child business entities or objects that can be simultaneously created or updated.
627 *
628 * @param p_return_obj_flag Indicates if the saved object is to be returned to the caller as an output parameter. Default value: false
629 * @param p_validate_bo_flag Indicates if the passed business object is to be validated for completeness if it is being created
630 * @param p_cust_acct_site_v2_obj The Customer Account Site business object to be saved
631 * @param p_created_by_module The module saving this business object
632 * @param p_obj_source The source of this business object
633 * @param x_return_status Return status after the call
634 * @param x_return_obj The Customer Account Site business object that was saved, returned as an output parameter
635 * @param x_messages Messages returned from the save of the business object
636 * @param x_cust_acct_site_id TCA identifier for the Customer Account Site business object
637 * @param x_cust_acct_site_os Customer Account Site original system name
638 * @param x_cust_acct_site_osr Customer Account Site original system reference
639 * @param px_parent_acct_id TCA identifier for parent object. Either this parameter or both the px_parent_os and px_parent_osr parameters must be given
643 * @rep:lifecycle active
640 * @param px_parent_acct_os Parent object original system name
641 * @param px_parent_acct_osr Parent object original system reference
642 * @rep:scope public
644 * @rep:displayname Save Customer Account Site Business Object
645 * @rep:doccd 120hztig.pdf Save Customer Account Site Business Object, Oracle Trading Community Architecture Technical Implementation Guide
646 */
647 PROCEDURE save_cust_acct_site_v2_bo(
648 p_validate_bo_flag IN VARCHAR2 := fnd_api.g_true,
649 p_cust_acct_site_v2_obj IN HZ_CUST_ACCT_SITE_V2_BO,
650 p_created_by_module IN VARCHAR2,
651 p_obj_source IN VARCHAR2 := null,
652 p_return_obj_flag IN VARCHAR2 := fnd_api.g_true,
653 x_return_status OUT NOCOPY VARCHAR2,
654 x_messages OUT NOCOPY HZ_MESSAGE_OBJ_TBL,
655 x_return_obj OUT NOCOPY HZ_CUST_ACCT_SITE_V2_BO,
656 x_cust_acct_site_id OUT NOCOPY NUMBER,
657 x_cust_acct_site_os OUT NOCOPY VARCHAR2,
658 x_cust_acct_site_osr OUT NOCOPY VARCHAR2,
659 px_parent_acct_id IN OUT NOCOPY NUMBER,
660 px_parent_acct_os IN OUT NOCOPY VARCHAR2,
661 px_parent_acct_osr IN OUT NOCOPY VARCHAR2
662 );
663
664 --------------------------------------
665 --
666 -- PROCEDURE get_cust_acct_site_v2_bo
667 --
668 -- DESCRIPTION
669 -- Get logical customer account site.
670 --
671 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
672 --
673 -- ARGUMENTS
674 -- IN:
675 -- p_init_msg_list Initialize message stack if it is set to
676 -- p_parent_id parent id.
677 -- p_cust_acct_site_id customer account site ID.
678 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
679 -- OUT:
680 -- x_cust_acct_site_v2_obj Logical customer account site record.
681 -- x_return_status Return status after the call. The status can
682 -- be fnd_api.g_ret_sts_success (success),
683 -- fnd_api.g_ret_sts_error (error),
684 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
685 -- x_msg_count Number of messages in message stack.
686 -- x_msg_data Message text if x_msg_count is 1.
687 --
688 -- NOTES
689 --
690 -- MODIFICATION HISTORY
691 --
692 --
693 -- 31-JAN-2008 VSEGU Created.
694 --
695
696 /*
697
698 The Get customer account site API Procedure is a retrieval service that returns a full customer account site business object.
699 The user identifies a particular Organization Contact business object using the TCA identifier and/or the object's Source System
700 information. Upon proper validation of the object, the full Organization Contact business object is returned.
701 The object consists of all data included within the Organization Contact business object, at all embedded levels. This includes the
702 set of all data stored in the TCA tables for each embedded entity.
703
704
705 Embedded BO Mandatory Multiple Logical API Procedure Comments
706
707 Party Site Y N get_party_site_bo
708 Customer Account Site Contact N Y get_cust_acct_contact_bo
709 Customer Account Site Use N Y Business Structure. Included entities and
710 structures:HZ_CUST_SITE_USES_ALL,Customer
711 Profile (Business Structure)
712
713
714 To retrieve the appropriate embedded entities within the 'Organization Contact' business object, the Get procedure returns all
715 records for the particular contact from these TCA entity tables.
716
717 Embedded TCA Entity Mandatory Multiple TCA Table Entities
718
719 Customer account site Y N HZ_CUST_ACCOUNTS
720 Bank account site Use N Y Owned by Payments team
721 Payment Method N N Owned by AR team
722
723 */
724
725 PROCEDURE get_cust_acct_site_v2_bo (
726 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
727 p_cust_acct_site_id IN NUMBER,
728 p_cust_acct_site_os IN VARCHAR2,
729 p_cust_acct_site_osr IN VARCHAR2,
730 x_cust_acct_site_v2_obj OUT NOCOPY HZ_CUST_ACCT_SITE_V2_BO,
731 x_return_status OUT NOCOPY VARCHAR2,
732 x_msg_count OUT NOCOPY NUMBER,
733 x_msg_data OUT NOCOPY VARCHAR2
734 );
735
736 /*#
737 * Get Customer Account Site Business Object (get_cust_acct_site_v2_bo)
738 * Extracts a particular Customer Account Site business object from TCA. You pass the object's identification information
739 * to the procedure, and the procedure returns the identified business object as it exists in TCA.
740 *
741 * @param p_cust_acct_site_id TCA identifier for the Customer Account Site business object
742 * @param p_cust_acct_site_os Customer Account Site original system name
743 * @param p_cust_acct_site_osr Customer Account Site original system reference
744 * @param x_cust_acct_site_v2_obj The retrieved Customer Account Site business object
745 * @param x_return_status Return status after the call
746 * @param x_messages Messages returned from the retrieval of the business object
747 * @rep:scope public
748 * @rep:lifecycle active
749 * @rep:displayname Get Customer Account Site Business Object
750 * @rep:doccd 120hztig.pdf Get Customer Account Site Business Object, Oracle Trading Community Architecture Technical Implementation Guide
751 */
752 PROCEDURE get_cust_acct_site_v2_bo (
753 p_cust_acct_site_id IN NUMBER,
754 p_cust_acct_site_os IN VARCHAR2,
755 p_cust_acct_site_osr IN VARCHAR2,
756 x_cust_acct_site_v2_obj OUT NOCOPY HZ_CUST_ACCT_SITE_V2_BO,
757 x_return_status OUT NOCOPY VARCHAR2,
758 x_messages OUT NOCOPY HZ_MESSAGE_OBJ_TBL
759 );
760
761 PROCEDURE do_create_cust_acct_site_v2_bo(
762 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
763 p_validate_bo_flag IN VARCHAR2 := fnd_api.g_true,
764 p_cust_acct_site_v2_obj IN OUT NOCOPY HZ_CUST_ACCT_SITE_V2_BO,
765 p_created_by_module IN VARCHAR2,
766 p_obj_source IN VARCHAR2 := null,
767 x_return_status OUT NOCOPY VARCHAR2,
768 x_msg_count OUT NOCOPY NUMBER,
769 x_msg_data OUT NOCOPY VARCHAR2,
770 x_cust_acct_site_id OUT NOCOPY NUMBER,
771 x_cust_acct_site_os OUT NOCOPY VARCHAR2,
772 x_cust_acct_site_osr OUT NOCOPY VARCHAR2,
773 px_parent_acct_id IN OUT NOCOPY NUMBER,
774 px_parent_acct_os IN OUT NOCOPY VARCHAR2,
775 px_parent_acct_osr IN OUT NOCOPY VARCHAR2
776 );
777
778 PROCEDURE do_update_cust_acct_site_v2_bo(
779 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
780 p_validate_bo_flag IN VARCHAR2 := fnd_api.g_true,
781 p_cust_acct_site_v2_obj IN OUT NOCOPY HZ_CUST_ACCT_SITE_V2_BO,
782 p_created_by_module IN VARCHAR2,
783 p_obj_source IN VARCHAR2 := null,
784 x_return_status OUT NOCOPY VARCHAR2,
785 x_msg_count OUT NOCOPY NUMBER,
786 x_msg_data OUT NOCOPY VARCHAR2,
787 x_cust_acct_site_id OUT NOCOPY NUMBER,
788 x_cust_acct_site_os OUT NOCOPY VARCHAR2,
789 x_cust_acct_site_osr OUT NOCOPY VARCHAR2,
790 p_parent_os IN VARCHAR2
791 );
792
793 PROCEDURE do_save_cust_acct_site_v2_bo(
794 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
795 p_validate_bo_flag IN VARCHAR2 := fnd_api.g_true,
796 p_cust_acct_site_v2_obj IN OUT NOCOPY HZ_CUST_ACCT_SITE_V2_BO,
797 p_created_by_module IN VARCHAR2,
798 p_obj_source IN VARCHAR2 := null,
799 x_return_status OUT NOCOPY VARCHAR2,
800 x_msg_count OUT NOCOPY NUMBER,
801 x_msg_data OUT NOCOPY VARCHAR2,
802 x_cust_acct_site_id OUT NOCOPY NUMBER,
803 x_cust_acct_site_os OUT NOCOPY VARCHAR2,
804 x_cust_acct_site_osr OUT NOCOPY VARCHAR2,
805 px_parent_acct_id IN OUT NOCOPY NUMBER,
806 px_parent_acct_os IN OUT NOCOPY VARCHAR2,
807 px_parent_acct_osr IN OUT NOCOPY VARCHAR2
808 );
809
810 END HZ_CUST_ACCT_SITE_BO_PUB;
[Home] [Help]