1 PACKAGE HZ_EXTRACT_CONT_POINT_BO_PVT AUTHID CURRENT_USER AS
2 /*$Header: ARHECPVS.pls 120.1 2005/07/13 21:25:09 awu noship $ */
3 /*
4 * This package contains the private APIs for logical phone.
5 * @rep:scope private
6 * @rep:product HZ
7 * @rep:displayname phone
8 * @rep:category BUSINESS_ENTITY HZ_PARTIES
9 * @rep:lifecycle active
10 * @rep:doccd 115hztig.pdf phone Get APIs
11 */
12
13 /*
14 The Get Contact Point API Procedures are retrieval services that return a full Contact Point business object of the type specified.
15 The user identifies a particular Contact Point business object using the TCA identifier and/or the objects Source System information.
16 Upon proper validation of the object, the full Contact Point business object is returned. The object consists of all data included
17 within the Contact Point business object, at all embedded levels. This includes the set of all data stored in the TCA tables for each
18 embedded entity.
19
20 To retrieve the appropriate embedded entities within the Contact Point business objects, the Get procedure returns all records for
21 the particular object from these TCA entity tables.
22
23 Embedded BO Mandatory Multiple Logical API Procedure Comments
24
25 Contact Point Y N HZ_CONTACT_POINTS
26 Contact Preference N Y HZ_CONTACT_PREFERENCES
27
28 */
29
30
31 --------------------------------------
32 --
33 -- PROCEDURE get_phone_bos
34 --
35 -- DESCRIPTION
36 -- Get a or more logical phone.
37 --
38 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
39 --
40 -- ARGUMENTS
41 -- IN:
42 -- p_init_msg_list Initialize message stack if it is set to
43 -- p_phone_id phone ID.If this id passed in, return only one phone obj.
44 -- p_parent_id parent_id
45 -- p_parent_table_name parent_table name
46 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
47 -- OUT:
48 -- x_phone_objs Logical phone records.
49 -- x_return_status Return status after the call. The status can
50 -- be fnd_api.g_ret_sts_success (success),
51 -- fnd_api.g_ret_sts_error (error),
52 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
53 -- x_msg_count Number of messages in message stack.
54 -- x_msg_data Message text if x_msg_count is 1.
55 --
56 -- NOTES
57 --
58 -- MODIFICATION HISTORY
59 --
60 --
61 -- 30-May-2005 AWU Created.
62 --
63
64
65
66 PROCEDURE get_phone_bos(
67 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
68 p_phone_id IN NUMBER,
69 p_parent_id IN NUMBER,
70 p_parent_table_name IN VARCHAR2,
71 p_action_type IN VARCHAR2 := NULL,
72 x_phone_objs OUT NOCOPY HZ_PHONE_CP_BO_TBL,
73 x_return_status OUT NOCOPY VARCHAR2,
74 x_msg_count OUT NOCOPY NUMBER,
75 x_msg_data OUT NOCOPY VARCHAR2
76 );
77
78
79
80 --------------------------------------
81 --
82 -- PROCEDURE get_telex_bos
83 --
84 -- DESCRIPTION
85 -- Get a or more logical telex.
86 --
87 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
88 --
89 -- ARGUMENTS
90 -- IN:
91 -- p_init_msg_list Initialize message stack if it is set to
92 -- p_telex_id telex ID. If this id passed in, return only one obj.
93 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
94 -- p_parent_id parent_id
95 -- p_parent_table_name parent_table name
96 -- OUT:
97 -- x_telex_objs Logical telex records.
98 -- x_return_status Return status after the call. The status can
99 -- be fnd_api.g_ret_sts_success (success),
100 -- fnd_api.g_ret_sts_error (error),
101 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
102 -- x_msg_count Number of messages in message stack.
103 -- x_msg_data Message text if x_msg_count is 1.
104 --
105 -- NOTES
106 --
107 -- MODIFICATION HISTORY
108 --
109 --
110 -- 30-May-2005 AWU Created.
111 --
112
113
114
115 PROCEDURE get_telex_bos(
116 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
117 p_telex_id IN NUMBER,
118 p_parent_id IN NUMBER,
119 p_parent_table_name IN VARCHAR2,
120 p_action_type IN VARCHAR2 := NULL,
121 x_telex_objs OUT NOCOPY HZ_TELEX_CP_BO_TBL,
122 x_return_status OUT NOCOPY VARCHAR2,
123 x_msg_count OUT NOCOPY NUMBER,
124 x_msg_data OUT NOCOPY VARCHAR2
125 );
126
127
128 --------------------------------------
129 --
130 -- PROCEDURE get_email_bos
131 --
132 -- DESCRIPTION
133 -- Get a or more logical email.
134 --
135 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
136 --
137 -- ARGUMENTS
138 -- IN:
139 -- p_init_msg_list Initialize message stack if it is set to
140 -- p_email_id email ID. If this id passed in, return only one obj.
141 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
142 -- p_parent_id parent_id
143 -- p_parent_table_name parent_table name
144 -- OUT:
145 -- x_email_objs Logical email records.
146 -- x_return_status Return status after the call. The status can
147 -- be fnd_api.g_ret_sts_success (success),
148 -- fnd_api.g_ret_sts_error (error),
149 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
150 -- x_msg_count Number of messages in message stack.
151 -- x_msg_data Message text if x_msg_count is 1.
152 --
153 -- NOTES
154 --
155 -- MODIFICATION HISTORY
156 --
157 --
158 -- 30-May-2005 AWU Created.
159 --
160
161
162
163 PROCEDURE get_email_bos(
164 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
165 p_email_id IN NUMBER,
166 p_parent_id IN NUMBER,
167 p_parent_table_name IN VARCHAR2,
168 p_action_type IN VARCHAR2 := NULL,
169 x_email_objs OUT NOCOPY HZ_EMAIL_CP_BO_TBL,
170 x_return_status OUT NOCOPY VARCHAR2,
171 x_msg_count OUT NOCOPY NUMBER,
172 x_msg_data OUT NOCOPY VARCHAR2
173 );
174
175
176
177 --------------------------------------
178 --
179 -- PROCEDURE get_web_bos
180 --
181 -- DESCRIPTION
182 -- Get a or more logical web business object.
183 --
184 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
185 --
186 -- ARGUMENTS
187 -- IN:
188 -- p_init_msg_list Initialize message stack if it is set to
189 -- p_web_id web ID. If this id passed in, return only one obj.
190 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
191 -- p_parent_id parent_id
192 -- p_parent_table_name parent_table name
193 -- OUT:
194 -- x_web_objs Logical web records.
195 -- x_return_status Return status after the call. The status can
196 -- be fnd_api.g_ret_sts_success (success),
197 -- fnd_api.g_ret_sts_error (error),
198 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
199 -- x_msg_count Number of messages in message stack.
200 -- x_msg_data Message text if x_msg_count is 1.
201 --
202 -- NOTES
203 --
204 -- MODIFICATION HISTORY
205 --
206 --
207 -- 30-May-2005 AWU Created.
208 --
209
210
211
212 PROCEDURE get_web_bos(
213 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
214 p_web_id IN NUMBER,
215 p_parent_id IN NUMBER,
216 p_parent_table_name IN VARCHAR2,
217 p_action_type IN VARCHAR2 := NULL,
218 x_web_objs OUT NOCOPY HZ_WEB_CP_BO_TBL,
219 x_return_status OUT NOCOPY VARCHAR2,
220 x_msg_count OUT NOCOPY NUMBER,
221 x_msg_data OUT NOCOPY VARCHAR2
222 );
223
224
225 --------------------------------------
226 --
227 -- PROCEDURE get_edi_bos
228 --
229 -- DESCRIPTION
230 -- Get a or more logical edi business object.
231 --
232 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
233 --
234 -- ARGUMENTS
235 -- IN:
236 -- p_init_msg_list Initialize message stack if it is set to
237 -- p_edi_id edi ID. If this id passed in, return only one obj.
238 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
239 -- p_parent_id parent_id
240 -- p_parent_table_name parent_table name
241 -- OUT:
242 -- x_edi_objs Logical edi records.
243 -- x_return_status Return status after the call. The status can
244 -- be fnd_api.g_ret_sts_success (success),
245 -- fnd_api.g_ret_sts_error (error),
246 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
247 -- x_msg_count Number of messages in message stack.
248 -- x_msg_data Message text if x_msg_count is 1.
249 --
250 -- NOTES
251 --
252 -- MODIFICATION HISTORY
253 --
254 --
255 -- 30-May-2005 AWU Created.
256 --
257
258
259
260 PROCEDURE get_edi_bos(
261 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
262 p_edi_id IN NUMBER,
263 p_parent_id IN NUMBER,
264 p_parent_table_name IN VARCHAR2,
265 p_action_type IN VARCHAR2 := NULL,
266 x_edi_objs OUT NOCOPY HZ_EDI_CP_BO_TBL,
267 x_return_status OUT NOCOPY VARCHAR2,
268 x_msg_count OUT NOCOPY NUMBER,
269 x_msg_data OUT NOCOPY VARCHAR2
270 );
271
272 --------------------------------------
273 --
274 -- PROCEDURE get_eft_bos
275 --
276 -- DESCRIPTION
277 -- Get a or more logical eft.
278 --
279 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
280 --
281 -- ARGUMENTS
282 -- IN:
283 -- p_init_msg_list Initialize message stack if it is set to
284 -- p_eft_id eft ID. If this id passed in, return only one obj.
285 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
286 -- p_parent_id parent_id
287 -- p_parent_table_name parent_table name
288 -- OUT:
289 -- x_eft_objs Logical eft records.
290 -- x_return_status Return status after the call. The status can
291 -- be fnd_api.g_ret_sts_success (success),
292 -- fnd_api.g_ret_sts_error (error),
293 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
294 -- x_msg_count Number of messages in message stack.
295 -- x_msg_data Message text if x_msg_count is 1.
296 --
297 -- NOTES
298 --
299 -- MODIFICATION HISTORY
300 --
301 --
302 -- 30-May-2005 AWU Created.
303 --
304
305
306
307 PROCEDURE get_eft_bos(
308 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
309 p_eft_id IN NUMBER,
310 p_parent_id IN NUMBER,
311 p_parent_table_name IN VARCHAR2,
312 p_action_type IN VARCHAR2 := NULL,
313 x_eft_objs OUT NOCOPY HZ_EFT_CP_BO_TBL,
314 x_return_status OUT NOCOPY VARCHAR2,
315 x_msg_count OUT NOCOPY NUMBER,
316 x_msg_data OUT NOCOPY VARCHAR2
317 );
318
319 --------------------------------------
320 --
321 -- PROCEDURE get_sms_bos
322 --
323 -- DESCRIPTION
324 -- Get a or more logical sms.
325 --
326 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
327 --
328 -- ARGUMENTS
329 -- IN:
330 -- p_init_msg_list Initialize message stack if it is set to
331 -- p_sms_id sms ID. If this id passed in, return only one obj.
332 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
333 -- p_parent_id parent_id
334 -- p_parent_table_name parent_table name
335 -- OUT:
336 -- x_sms_objs Logical sms records.
337 -- x_return_status Return status after the call. The status can
338 -- be fnd_api.g_ret_sts_success (success),
339 -- fnd_api.g_ret_sts_error (error),
340 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
341 -- x_msg_count Number of messages in message stack.
342 -- x_msg_data Message text if x_msg_count is 1.
343 --
344 -- NOTES
345 --
346 -- MODIFICATION HISTORY
347 --
348 --
349 -- 30-May-2005 AWU Created.
350 --
351
352
353
354 PROCEDURE get_sms_bos(
355 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
356 p_sms_id IN NUMBER,
357 p_parent_id IN NUMBER,
358 p_parent_table_name IN VARCHAR2,
359 p_action_type IN VARCHAR2 := NULL,
360 x_sms_objs OUT NOCOPY HZ_SMS_CP_BO_TBL,
361 x_return_status OUT NOCOPY VARCHAR2,
362 x_msg_count OUT NOCOPY NUMBER,
363 x_msg_data OUT NOCOPY VARCHAR2
364 );
365
366 PROCEDURE get_cont_pref_objs(
367 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
368 p_cont_level_table_id IN NUMBER,
369 p_cont_level_table IN VARCHAR2,
370 p_contact_type IN VARCHAR2,
371 p_action_type IN VARCHAR2 := NULL,
372 x_cont_pref_objs OUT NOCOPY HZ_CONTACT_PREF_OBJ_TBL,
373 x_return_status OUT NOCOPY VARCHAR2,
374 x_msg_count OUT NOCOPY NUMBER,
375 x_msg_data OUT NOCOPY VARCHAR2
376 );
377
378
379 END HZ_EXTRACT_CONT_POINT_BO_PVT;
[Home] [Help]