1 PACKAGE HZ_ORG_CONTACT_BO_PUB AUTHID CURRENT_USER AS
2 /*$Header: ARHBOCBS.pls 120.10 2006/09/22 00:40:57 acng noship $ */
3 /*#
4 * Organization Contact Business Object API
5 * Public API that allows users to manage Organization Contact 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_CONTACT
12 * @rep:displayname Organization Contact Business Object API
13 * @rep:doccd 120hztig.pdf Organization Contact Business Object API, Oracle Trading Community Architecture Technical Implementation Guide
14 */
15
16 -- PROCEDURE create_org_contact_bo
17 --
18 -- DESCRIPTION
19 -- Creates org contact 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_org_contact_obj Logical org contact object.
30 -- p_created_by_module Created by module.
31 -- IN OUT:
32 -- px_parent_org_id Parent organization id
33 -- px_parent_org_os Parent organization os
34 -- px_parent_org_osr Parent organization 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_org_contact_id Org Contact ID.
43 -- x_org_contact_os Org Contact orig system.
44 -- x_org_contact_osr Org Contact orig system reference.
45 --
46 -- NOTES
47 --
48 -- MODIFICATION HISTORY
49 --
50 -- 14-DEC-2004 Arnold Ng Created.
51
52 PROCEDURE create_org_contact_bo(
53 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
54 p_validate_bo_flag IN VARCHAR2 := fnd_api.g_true,
55 p_org_contact_obj IN HZ_ORG_CONTACT_BO,
56 p_created_by_module IN VARCHAR2,
57 x_return_status OUT NOCOPY VARCHAR2,
58 x_msg_count OUT NOCOPY NUMBER,
59 x_msg_data OUT NOCOPY VARCHAR2,
60 x_org_contact_id OUT NOCOPY NUMBER,
61 x_org_contact_os OUT NOCOPY VARCHAR2,
62 x_org_contact_osr OUT NOCOPY VARCHAR2,
63 px_parent_org_id IN OUT NOCOPY NUMBER,
64 px_parent_org_os IN OUT NOCOPY VARCHAR2,
65 px_parent_org_osr IN OUT NOCOPY VARCHAR2
66 );
67
68 /*#
69 * Create Organization Contact Business Object (create_org_contact_bo)
70 * Creates a Organization Contact business object. You pass object data to the procedure, packaged within an
71 * object type defined specifically for the API. The object type is HZ_ORG_CONTACT_BO for the Organization Contact
72 * business object. In addition to the object's business object attributes, the object type also includes lower-level
73 * embedded child entities or objects that can be simultaneously created.
74 *
75 * @param p_return_obj_flag Indicates if the created object is to be returned to the caller as an output parameter. Default value: false
76 * @param p_validate_bo_flag Indicates if the passed business object is to be validated for completeness. Default value: true
77 * @param p_org_contact_obj The Organization Contact business object to be created in its entirety
78 * @param p_created_by_module The module creating this business object. Must be a valid created_by_module value
79 * @param p_obj_source The source of this business object
80 * @param x_return_status Return status after the call
81 * @param x_return_obj The Organization Contact business object that was created, returned as an output parameter
82 * @param x_messages Messages returned from the creation of the business object
83 * @param x_org_contact_id TCA identifier for the Organization Contact business object
84 * @param x_org_contact_os Organization Contact original system name
85 * @param x_org_contact_osr Organization Contact original system reference
86 * @param px_parent_org_id TCA identifier for parent object. Either this parameter or both the px_parent_os and px_parent_osr parameters must be given
87 * @param px_parent_org_os Parent object original system name
88 * @param px_parent_org_osr Parent object original system reference
89 * @rep:scope public
90 * @rep:lifecycle active
91 * @rep:displayname Create Organization Contact Business Object
92 * @rep:doccd 120hztig.pdf Create Organization Contact Business Object, Oracle Trading Community Architecture Technical Implementation Guide
93 */
94 PROCEDURE create_org_contact_bo(
95 p_validate_bo_flag IN VARCHAR2 := fnd_api.g_true,
96 p_org_contact_obj IN HZ_ORG_CONTACT_BO,
97 p_created_by_module IN VARCHAR2,
98 p_obj_source IN VARCHAR2 := null,
99 p_return_obj_flag IN VARCHAR2 := fnd_api.g_true,
100 x_return_status OUT NOCOPY VARCHAR2,
101 x_messages OUT NOCOPY HZ_MESSAGE_OBJ_TBL,
102 x_return_obj OUT NOCOPY HZ_ORG_CONTACT_BO,
103 x_org_contact_id OUT NOCOPY NUMBER,
104 x_org_contact_os OUT NOCOPY VARCHAR2,
105 x_org_contact_osr OUT NOCOPY VARCHAR2,
106 px_parent_org_id IN OUT NOCOPY NUMBER,
107 px_parent_org_os IN OUT NOCOPY VARCHAR2,
108 px_parent_org_osr IN OUT NOCOPY VARCHAR2
109 );
110
111 -- PROCEDURE update_org_contact_bo
112 --
113 -- DESCRIPTION
114 -- Update org contact business object.
115 --
116 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
117 --
118 -- ARGUMENTS
119 -- IN:
120 -- p_init_msg_list Initialize message stack if it is set to
121 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
122 -- p_org_contact_obj Logical org contact object.
123 -- p_created_by_module Created by module.
124 -- OUT:
125 -- x_return_status Return status after the call. The status can
126 -- be fnd_api.g_ret_sts_success (success),
127 -- fnd_api.g_ret_sts_error (error),
128 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
129 -- x_msg_count Number of messages in message stack.
130 -- x_msg_data Message text if x_msg_count is 1.
131 -- x_org_contact_id Org Contact ID.
132 -- x_org_contact_os Org Contact orig system.
133 -- x_org_contact_osr Org Contact orig system reference.
134 --
135 -- NOTES
136 --
137 -- MODIFICATION HISTORY
138 --
139 -- 14-DEC-2004 Arnold Ng Created.
140
141 PROCEDURE update_org_contact_bo(
142 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
143 p_org_contact_obj IN HZ_ORG_CONTACT_BO,
144 p_created_by_module IN VARCHAR2,
145 x_return_status OUT NOCOPY VARCHAR2,
146 x_msg_count OUT NOCOPY NUMBER,
147 x_msg_data OUT NOCOPY VARCHAR2,
148 x_org_contact_id OUT NOCOPY NUMBER,
149 x_org_contact_os OUT NOCOPY VARCHAR2,
150 x_org_contact_osr OUT NOCOPY VARCHAR2
151 );
152
153 /*#
154 * Update Organization Contact Business Object (update_org_contact_bo)
155 * Updates a Organization Contact business object. You pass any modified object data to the procedure, packaged
156 * within an object type defined specifically for the API. The object type is HZ_ORG_CONTACT_BO for the
157 * Organization Contact business object. In addition to the object's business object attributes, the object type
158 * also includes embedded child business entities or objects that can be simultaneously created or updated.
159 *
160 * @param p_return_obj_flag Indicates if the updated object is to be returned to the caller as an output parameter. Default value: false
161 * @param p_org_contact_obj The Organization Contact business object to be updated
162 * @param p_created_by_module The module updating this business object
163 * @param p_obj_source The source of this business object
164 * @param x_return_status Return status after the call
165 * @param x_return_obj The Organization Contact business object that was updated, returned as an output parameter
166 * @param x_messages Messages returned from the update of the business object
167 * @param x_org_contact_id TCA identifier for the Organization Contact business object
168 * @param x_org_contact_os Organization Contact original system name
169 * @param x_org_contact_osr Organization Contact original system reference
170 * @rep:scope public
171 * @rep:lifecycle active
172 * @rep:displayname Update Organization Contact Business Object
173 * @rep:doccd 120hztig.pdf Update Organization Contact Business Object, Oracle Trading Community Architecture Technical Implementation Guide
174 */
175 PROCEDURE update_org_contact_bo(
176 p_org_contact_obj IN HZ_ORG_CONTACT_BO,
177 p_created_by_module IN VARCHAR2,
178 p_obj_source IN VARCHAR2 := null,
179 p_return_obj_flag IN VARCHAR2 := fnd_api.g_true,
180 x_return_status OUT NOCOPY VARCHAR2,
181 x_messages OUT NOCOPY HZ_MESSAGE_OBJ_TBL,
182 x_return_obj OUT NOCOPY HZ_ORG_CONTACT_BO,
183 x_org_contact_id OUT NOCOPY NUMBER,
184 x_org_contact_os OUT NOCOPY VARCHAR2,
185 x_org_contact_osr OUT NOCOPY VARCHAR2
186 );
187
188 -- PROCEDURE save_org_contact_bo
189 --
190 -- DESCRIPTION
191 -- Creates or update org contact business object.
192 --
193 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
194 --
195 -- ARGUMENTS
196 -- IN:
197 -- p_init_msg_list Initialize message stack if it is set to
198 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
199 -- p_validate_bo_flag If it is set to FND_API.G_TRUE, validate
200 -- the completeness of business object.
201 -- p_org_contact_obj Logical org contact object.
202 -- p_created_by_module Created by module.
203 -- IN OUT:
204 -- px_parent_org_id Parent organization id
205 -- px_parent_org_os Parent organization os
206 -- px_parent_org_osr Parent organization osr
207 -- OUT:
208 -- x_return_status Return status after the call. The status can
209 -- be fnd_api.g_ret_sts_success (success),
210 -- fnd_api.g_ret_sts_error (error),
211 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
212 -- x_msg_count Number of messages in message stack.
213 -- x_msg_data Message text if x_msg_count is 1.
214 -- x_org_contact_id Org Contact ID.
215 -- x_org_contact_os Org Contact orig system.
216 -- x_org_contact_osr Org Contact orig system reference.
217 --
218 -- NOTES
219 --
220 -- MODIFICATION HISTORY
221 --
222 -- 14-DEC-2004 Arnold Ng Created.
223
224 PROCEDURE save_org_contact_bo(
225 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
226 p_validate_bo_flag IN VARCHAR2 := fnd_api.g_true,
227 p_org_contact_obj IN HZ_ORG_CONTACT_BO,
228 p_created_by_module IN VARCHAR2,
229 x_return_status OUT NOCOPY VARCHAR2,
230 x_msg_count OUT NOCOPY NUMBER,
231 x_msg_data OUT NOCOPY VARCHAR2,
232 x_org_contact_id OUT NOCOPY NUMBER,
233 x_org_contact_os OUT NOCOPY VARCHAR2,
234 x_org_contact_osr OUT NOCOPY VARCHAR2,
235 px_parent_org_id IN OUT NOCOPY NUMBER,
236 px_parent_org_os IN OUT NOCOPY VARCHAR2,
237 px_parent_org_osr IN OUT NOCOPY VARCHAR2
238 );
239
240 /*#
241 * Save Organization Contact Business Object (save_org_contact_bo)
242 * Saves a Organization Contact business object. You pass new or modified object data to the procedure, packaged
243 * within an object type defined specifically for the API. The API then determines if the object exists in TCA,
244 * based upon the provided identification information, and creates or updates the object. The object type is
245 * HZ_ORG_CONTACT_BO for the Organization Contact business object. For either case, the object type that you provide
246 * will be processed as if the respective API procedure is being called (create_org_contact_bo or update_org_contact_bo).
247 * Please see those procedures for more details. In addition to the object's business object attributes, the object
248 * type also includes embedded child business entities or objects that can be simultaneously created or updated.
249 *
250 * @param p_return_obj_flag Indicates if the saved object is to be returned to the caller as an output parameter. Default value: false
251 * @param p_validate_bo_flag Indicates if the passed business object is to be validated for completeness if it is being created
252 * @param p_org_contact_obj The Organization Contact business object to be saved
253 * @param p_created_by_module The module saving this business object
254 * @param p_obj_source The source of this business object
255 * @param x_return_status Return status after the call
256 * @param x_return_obj The Organization Contact business object that was saved, returned as an output parameter
257 * @param x_messages Messages returned from the save of the business object
258 * @param x_org_contact_id TCA identifier for the Organization Contact business object
259 * @param x_org_contact_os Organization Contact original system name
260 * @param x_org_contact_osr Organization Contact original system reference
261 * @param px_parent_org_id TCA identifier for parent object. Either this parameter, or both the px_parent_os and px_parent_osr parameters, must be given
262 * @param px_parent_org_os Parent object original system name
263 * @param px_parent_org_osr Parent object original system reference
264 * @rep:scope public
265 * @rep:lifecycle active
266 * @rep:displayname Save Organization Contact Business Object
267 * @rep:doccd 120hztig.pdf Save Organization Contact Business Object, Oracle Trading Community Architecture Technical Implementation Guide
268 */
269 PROCEDURE save_org_contact_bo(
270 p_validate_bo_flag IN VARCHAR2 := fnd_api.g_true,
271 p_org_contact_obj IN HZ_ORG_CONTACT_BO,
272 p_created_by_module IN VARCHAR2,
273 p_obj_source IN VARCHAR2 := null,
274 p_return_obj_flag IN VARCHAR2 := fnd_api.g_true,
275 x_return_status OUT NOCOPY VARCHAR2,
276 x_messages OUT NOCOPY HZ_MESSAGE_OBJ_TBL,
277 x_return_obj OUT NOCOPY HZ_ORG_CONTACT_BO,
278 x_org_contact_id OUT NOCOPY NUMBER,
279 x_org_contact_os OUT NOCOPY VARCHAR2,
280 x_org_contact_osr OUT NOCOPY VARCHAR2,
281 px_parent_org_id IN OUT NOCOPY NUMBER,
282 px_parent_org_os IN OUT NOCOPY VARCHAR2,
283 px_parent_org_osr IN OUT NOCOPY VARCHAR2
284 );
285
286 --------------------------------------
287 --
288 -- PROCEDURE get_org_contact_bo
289 --
290 -- DESCRIPTION
291 -- Get org contact information.
292 --
293 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
294 --
295 -- ARGUMENTS
296 -- IN:
297 -- p_init_msg_list Initialize message stack if it is set to FND_API.G_TRUE. Default is FND_API.G_FALSE.
298 -- p_org_contact_id Org Contact id.
299 -- p_org_contact_os Org contact orig system.
300 -- p_org_contact_osr Org contact orig system reference.
301 --
302 -- OUT:
306 -- fnd_api.g_ret_sts_error (error),
303 -- x_org contact_objs Table of org contact objects.
304 -- x_return_status Return status after the call. The status can
305 -- be fnd_api.g_ret_sts_success (success),
307 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
308 -- x_msg_count Number of messages in message stack.
309 -- x_msg_data Message text if x_msg_count is 1.
310 --
311 -- NOTES
312 --
316 -- 15-June-2005 AWU Created.
313 -- MODIFICATION HISTORY
314 --
315 --
317 --
318
319
320 PROCEDURE get_org_contact_bo(
321 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
322 p_org_contact_id IN NUMBER,
323 p_org_contact_os IN VARCHAR2,
324 p_org_contact_osr IN VARCHAR2,
325 x_org_contact_obj OUT NOCOPY HZ_ORG_CONTACT_BO,
326 x_return_status OUT NOCOPY VARCHAR2,
330
327 x_msg_count OUT NOCOPY NUMBER,
328 x_msg_data OUT NOCOPY VARCHAR2
329 );
331 /*#
332 * Get Organization Contact Business Object (get_org_contact_bo)
333 * Extracts a particular Organization Contact business object from TCA. You pass the object's identification
334 * information to the procedure, and the procedure returns the identified business object as it exists in TCA.
335 *
336 * @param p_org_contact_id TCA identifier for the Organization Contact business object
337 * @param p_org_contact_os Organization Contact original system name
338 * @param p_org_contact_osr Organization Contact original system reference
339 * @param x_org_contact_obj The retrieved Organization Contact business object
340 * @param x_return_status Return status after the call
341 * @param x_messages Messages returned from the retrieval of the business object
342 * @rep:scope public
343 * @rep:lifecycle active
344 * @rep:displayname Get Organization Contact Business Object
345 * @rep:doccd 120hztig.pdf Get Organization Contact Business Object, Oracle Trading Community Architecture Technical Implementation Guide
346 */
347 PROCEDURE get_org_contact_bo(
348 p_org_contact_id IN NUMBER,
349 p_org_contact_os IN VARCHAR2,
350 p_org_contact_osr IN VARCHAR2,
351 x_org_contact_obj OUT NOCOPY HZ_ORG_CONTACT_BO,
352 x_return_status OUT NOCOPY VARCHAR2,
353 x_messages OUT NOCOPY HZ_MESSAGE_OBJ_TBL
354 );
355
356 PROCEDURE do_create_org_contact_bo(
357 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
358 p_validate_bo_flag IN VARCHAR2 := fnd_api.g_true,
359 p_org_contact_obj IN OUT NOCOPY HZ_ORG_CONTACT_BO,
363 x_msg_count OUT NOCOPY NUMBER,
360 p_created_by_module IN VARCHAR2,
361 p_obj_source IN VARCHAR2 := null,
362 x_return_status OUT NOCOPY VARCHAR2,
364 x_msg_data OUT NOCOPY VARCHAR2,
365 x_org_contact_id OUT NOCOPY NUMBER,
366 x_org_contact_os OUT NOCOPY VARCHAR2,
367 x_org_contact_osr OUT NOCOPY VARCHAR2,
368 px_parent_org_id IN OUT NOCOPY NUMBER,
369 px_parent_org_os IN OUT NOCOPY VARCHAR2,
370 px_parent_org_osr IN OUT NOCOPY VARCHAR2
371 );
372
373 PROCEDURE do_update_org_contact_bo(
374 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
375 p_org_contact_obj IN OUT NOCOPY HZ_ORG_CONTACT_BO,
376 p_created_by_module IN VARCHAR2,
377 p_obj_source IN VARCHAR2 := null,
378 x_return_status OUT NOCOPY VARCHAR2,
379 x_msg_count OUT NOCOPY NUMBER,
380 x_msg_data OUT NOCOPY VARCHAR2,
381 x_org_contact_id OUT NOCOPY NUMBER,
382 x_org_contact_os OUT NOCOPY VARCHAR2,
383 x_org_contact_osr OUT NOCOPY VARCHAR2,
384 p_parent_os IN VARCHAR2
385 );
386
387 PROCEDURE do_save_org_contact_bo(
388 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
389 p_validate_bo_flag IN VARCHAR2 := fnd_api.g_true,
390 p_org_contact_obj IN OUT NOCOPY HZ_ORG_CONTACT_BO,
391 p_created_by_module IN VARCHAR2,
392 p_obj_source IN VARCHAR2 := null,
393 x_return_status OUT NOCOPY VARCHAR2,
394 x_msg_count OUT NOCOPY NUMBER,
395 x_msg_data OUT NOCOPY VARCHAR2,
396 x_org_contact_id OUT NOCOPY NUMBER,
397 x_org_contact_os OUT NOCOPY VARCHAR2,
398 x_org_contact_osr OUT NOCOPY VARCHAR2,
399 px_parent_org_id IN OUT NOCOPY NUMBER,
400 px_parent_org_os IN OUT NOCOPY VARCHAR2,
401 px_parent_org_osr IN OUT NOCOPY VARCHAR2
402 );
403
404 END HZ_ORG_CONTACT_BO_PUB;
[Home] [Help]