[Home] [Help]
1: PACKAGE HZ_ORG_CUST_BO_PUB 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.
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,
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
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,
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
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,
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
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,
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
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,
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.
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,
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: --------------------------------------
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: );
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:
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: );
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:
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
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(
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: );
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: );
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:
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;