[Home] [Help]
1: PACKAGE HZ_PERSON_CUST_BO_PUB AS
2: /*$Header: ARHBPABS.pls 120.8 2008/02/06 11:23:42 vsegu ship $ */
3: /*#
4: * Person Customer Business Object API
5: * Public API that allows users to manage Person Customer business objects in the Trading Community Architecture.
47:
48: PROCEDURE create_person_cust_bo(
49: p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
50: p_validate_bo_flag IN VARCHAR2 := fnd_api.g_true,
51: p_person_cust_obj IN HZ_PERSON_CUST_BO,
52: p_created_by_module IN VARCHAR2,
53: x_return_status OUT NOCOPY VARCHAR2,
54: x_msg_count OUT NOCOPY NUMBER,
55: x_msg_data OUT NOCOPY VARCHAR2,
58:
59: /*#
60: * Create Person Customer Business Object (create_person_cust_bo)
61: * Creates a Person Customer business object. You pass object data to the procedure, packaged within an object type defined
62: * specifically for the API. The object type is HZ_PERSON_CUST_BO for the Person Customer business object. In addition to
63: * the object's business object attributes, the object type also includes lower-level embedded child entities or objects
64: * that can be simultaneously created.
65: *
66: * @param p_validate_bo_flag Indicates if the passed business object is to be validated for completeness. Default value: true
79: */
80:
81: PROCEDURE create_person_cust_bo(
82: p_validate_bo_flag IN VARCHAR2 := fnd_api.g_true,
83: p_person_cust_obj IN HZ_PERSON_CUST_BO,
84: p_created_by_module IN VARCHAR2,
85: p_obj_source IN VARCHAR2 := null,
86: p_return_obj_flag IN VARCHAR2 := fnd_api.g_true,
87: x_return_status OUT NOCOPY VARCHAR2,
85: p_obj_source IN VARCHAR2 := null,
86: p_return_obj_flag IN VARCHAR2 := fnd_api.g_true,
87: x_return_status OUT NOCOPY VARCHAR2,
88: x_messages OUT NOCOPY HZ_MESSAGE_OBJ_TBL,
89: x_return_obj OUT NOCOPY HZ_PERSON_CUST_BO,
90: x_person_id OUT NOCOPY NUMBER
91: );
92:
93: -- PROCEDURE update_person_cust_bo
120:
121:
122: PROCEDURE update_person_cust_bo(
123: p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
124: p_person_cust_obj IN HZ_PERSON_CUST_BO,
125: p_created_by_module IN VARCHAR2,
126: x_return_status OUT NOCOPY VARCHAR2,
127: x_msg_count OUT NOCOPY NUMBER,
128: x_msg_data OUT NOCOPY VARCHAR2,
131:
132: /*#
133: * Update Person Customer Business Object (update_person_cust_bo)
134: * Updates a Person Customer business object. You pass any modified object data to the procedure, packaged within an object
135: * type defined specifically for the API. The object type is HZ_PERSON_CUST_BO for the Person Customer business object.
136: * In addition to the object's business object attributes, the object type also includes embedded child business entities
137: * or objects that can be simultaneously created or updated.
138: *
139: * @param p_person_cust_obj The Person Customer business object to be updated
151: */
152:
153:
154: PROCEDURE update_person_cust_bo(
155: p_person_cust_obj IN HZ_PERSON_CUST_BO,
156: p_created_by_module IN VARCHAR2,
157: p_obj_source IN VARCHAR2 := null,
158: p_return_obj_flag IN VARCHAR2 := fnd_api.g_true,
159: x_return_status OUT NOCOPY VARCHAR2,
157: p_obj_source IN VARCHAR2 := null,
158: p_return_obj_flag IN VARCHAR2 := fnd_api.g_true,
159: x_return_status OUT NOCOPY VARCHAR2,
160: x_messages OUT NOCOPY HZ_MESSAGE_OBJ_TBL,
161: x_return_obj OUT NOCOPY HZ_PERSON_CUST_BO,
162: x_person_id OUT NOCOPY NUMBER
163: );
164:
165: -- PROCEDURE save_person_cust_bo
195:
196: PROCEDURE save_person_cust_bo(
197: p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
198: p_validate_bo_flag IN VARCHAR2 := fnd_api.g_true,
199: p_person_cust_obj IN HZ_PERSON_CUST_BO,
200: p_created_by_module IN VARCHAR2,
201: x_return_status OUT NOCOPY VARCHAR2,
202: x_msg_count OUT NOCOPY NUMBER,
203: x_msg_data OUT NOCOPY VARCHAR2,
207: /*#
208: * Save Person Customer Business Object (save_person_cust_bo)
209: * Saves a Person Customer business object. You pass new or modified object data to the procedure, packaged within an object
210: * type defined specifically for the API. The API then determines if the object exists in TCA, based upon the provided
211: * identification information, and creates or updates the object. The object type is HZ_PERSON_CUST_BO for the Person Customer
212: * business object. For either case, the object type that you provide will be processed as if the respective API procedure
213: * is being called (create_person_cust_bo or update_person_cust_bo). Please see those procedures for more details.
214: * In addition to the object's business object attributes, the object type also includes embedded child business entities
215: * or objects that can be simultaneously created or updated.
231:
232:
233: PROCEDURE save_person_cust_bo(
234: p_validate_bo_flag IN VARCHAR2 := fnd_api.g_true,
235: p_person_cust_obj IN HZ_PERSON_CUST_BO,
236: p_created_by_module IN VARCHAR2,
237: p_obj_source IN VARCHAR2 := null,
238: p_return_obj_flag IN VARCHAR2 := fnd_api.g_true,
239: x_return_status OUT NOCOPY VARCHAR2,
237: p_obj_source IN VARCHAR2 := null,
238: p_return_obj_flag IN VARCHAR2 := fnd_api.g_true,
239: x_return_status OUT NOCOPY VARCHAR2,
240: x_messages OUT NOCOPY HZ_MESSAGE_OBJ_TBL,
241: x_return_obj OUT NOCOPY HZ_PERSON_CUST_BO,
242: x_person_id OUT NOCOPY NUMBER
243: );
244:
245: --------------------------------------
298: p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
299: p_person_id IN NUMBER,
300: p_person_os IN VARCHAR2,
301: p_person_osr IN VARCHAR2,
302: x_person_cust_obj OUT NOCOPY HZ_PERSON_CUST_BO,
303: x_return_status OUT NOCOPY VARCHAR2,
304: x_msg_count OUT NOCOPY NUMBER,
305: x_msg_data OUT NOCOPY VARCHAR2
306: );
326: PROCEDURE get_person_cust_bo(
327: p_person_id IN NUMBER,
328: p_person_os IN VARCHAR2,
329: p_person_osr IN VARCHAR2,
330: x_person_cust_obj OUT NOCOPY HZ_PERSON_CUST_BO,
331: x_return_status OUT NOCOPY VARCHAR2,
332: x_messages OUT NOCOPY HZ_MESSAGE_OBJ_TBL
333: );
334:
382:
383: PROCEDURE get_person_custs_created(
384: p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
385: p_event_id IN NUMBER,
386: x_person_cust_objs OUT NOCOPY HZ_PERSON_CUST_BO_TBL,
387: x_return_status OUT NOCOPY VARCHAR2,
388: x_msg_count OUT NOCOPY NUMBER,
389: x_msg_data OUT NOCOPY VARCHAR2
390: );
407: */
408:
409: PROCEDURE get_person_custs_created(
410: p_event_id IN NUMBER,
411: x_person_cust_objs OUT NOCOPY HZ_PERSON_CUST_BO_TBL,
412: x_return_status OUT NOCOPY VARCHAR2,
413: x_messages OUT NOCOPY HZ_MESSAGE_OBJ_TBL
414: );
415:
419: -- PROCEDURE get_person_custs_updated
420: --
421: -- DESCRIPTION
422: --The caller provides an identifier for the Person Customers update business event and
423: --the procedure returns database objects of the type HZ_PERSON_CUST_BO for all of
424: --the Person Customer business objects from the business event.
425:
426: --
427: -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
453: The Get Person Customers Updated procedure is a service to retrieve all of the Person Customer business objects whose updates
454: have been captured by the logical business event. Each Person Customers Updated business event signifies that one or more Person
455: Customer business objects have been updated.
456: The caller provides an identifier for the Person Customers Update business event and the procedure returns database objects of
457: the type HZ_PERSON_CUST_BO for all of the Person Customer business objects from the business event.
458: Gathering all of the returned database objects from those API calls, the procedure packages them in a table structure and returns
459: them to the caller.
460: */
461:
461:
462: PROCEDURE get_person_custs_updated(
463: p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
464: p_event_id IN NUMBER,
465: x_person_cust_objs OUT NOCOPY HZ_PERSON_CUST_BO_TBL,
466: x_return_status OUT NOCOPY VARCHAR2,
467: x_msg_count OUT NOCOPY NUMBER,
468: x_msg_data OUT NOCOPY VARCHAR2
469: );
510: */
511:
512: PROCEDURE get_person_custs_updated(
513: p_event_id IN NUMBER,
514: x_person_cust_objs OUT NOCOPY HZ_PERSON_CUST_BO_TBL,
515: x_return_status OUT NOCOPY VARCHAR2,
516: x_messages OUT NOCOPY HZ_MESSAGE_OBJ_TBL
517: );
518:
521: -- PROCEDURE get_person_cust_updated
522: --
523: -- DESCRIPTION
524: --The caller provides an identifier for the Person customer update business event and person id
525: --the procedure returns one database object of the type HZ_PERSON_CUST_BO
526: --
527: -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
528: --
529: -- ARGUMENTS
551: PROCEDURE get_person_cust_updated(
552: p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
553: p_event_id IN NUMBER,
554: p_person_cust_id IN NUMBER,
555: x_person_cust_obj OUT NOCOPY HZ_PERSON_CUST_BO,
556: x_return_status OUT NOCOPY VARCHAR2,
557: x_msg_count OUT NOCOPY NUMBER,
558: x_msg_data OUT NOCOPY VARCHAR2
559: );
601:
602: PROCEDURE get_person_cust_updated(
603: p_event_id IN NUMBER,
604: p_person_cust_id IN NUMBER,
605: x_person_cust_obj OUT NOCOPY HZ_PERSON_CUST_BO,
606: x_return_status OUT NOCOPY VARCHAR2,
607: x_messages OUT NOCOPY HZ_MESSAGE_OBJ_TBL
608: );
609:
1140: );
1141:
1142:
1143:
1144: END HZ_PERSON_CUST_BO_PUB;