1 PACKAGE amv_mychannel_pvt AUTHID CURRENT_USER AS
2 /* $Header: amvvmycs.pls 120.1 2005/06/30 13:01:01 appldev ship $ */
3 --
4 --
5 -- NAME
6 -- AMV_MYCHANNEL_PVT
7 -- PURPOSE
8 --
9 -- HISTORY
10 -- 08/16/1999 SLKRISHN CREATED
11 --
12 --
13 TYPE AMV_NUMBER_VARRAY_TYPE IS TABLE OF NUMBER;
14
15 TYPE amv_return_obj_type IS RECORD(
16 returned_record_count NUMBER,
17 next_record_position NUMBER,
18 total_record_count NUMBER
19 );
20
21 TYPE amv_request_obj_type IS RECORD(
22 records_requested NUMBER,
23 start_record_position NUMBER,
24 return_total_count_flag VARCHAR2(1)
25 );
26
27 TYPE amv_cat_hierarchy_obj_type IS RECORD(
28 hierarchy_level number,
29 id number,
30 name varchar2(240)
31 );
32
33 TYPE amv_cat_hierarchy_varray_type IS TABLE of amv_cat_hierarchy_obj_type;
34
35 TYPE AMV_MY_CHANNEL_OBJ_TYPE IS RECORD(
36 my_channel_id NUMBER,
37 channel_type VARCHAR2(30),
38 access_level_type VARCHAR2(30),
39 user_or_group_id NUMBER,
40 user_or_group_type VARCHAR2(30),
41 subscribing_to_id NUMBER,
42 subscribing_to_type VARCHAR2(30),
43 subscription_reason_type VARCHAR2(30),
44 order_number NUMBER,
45 status VARCHAR2(30),
46 notify_flag VARCHAR2(1),
47 notification_interval_type VARCHAR2(30)
48 );
49
50 TYPE AMV_MY_CHANNEL_VARRAY_TYPE IS TABLE OF AMV_MY_CHANNEL_OBJ_TYPE;
51
52 TYPE AMV_WF_NOTIF_OBJ_TYPE IS RECORD(
53 notification_id NUMBER,
54 subject VARCHAR2(4000),
55 begin_date DATE,
56 end_date DATE,
57 due_date DATE,
58 status VARCHAR2(30),
59 priority NUMBER,
60 type VARCHAR2(30)
61 );
62
63 TYPE AMV_WF_NOTIF_VARRAY_TYPE IS TABLE OF AMV_WF_NOTIF_OBJ_TYPE;
64
65 TYPE amv_itemdisplay_obj_type IS RECORD(
66 id number,
67 name varchar2(240),
68 description varchar2(2000),
69 type varchar2(30)
70 );
71
72 TYPE amv_itemdisplay_varray_type IS TABLE of amv_itemdisplay_obj_type;
73
74 --------------------------------------------------------------------------------
75 -- Start of comments
76 -- API name : Subscribe_Channel
77 -- Type : Private
78 -- Pre-reqs : None
79 -- Function : Launch workflow to subscribe a channel for an user
80 -- Parameters :
81 -- IN p_api_version IN NUMBER Required
82 -- p_init_msg_list IN VARCHAR2 Optional
83 -- Default = FND_API.G_FALSE
84 -- p_commit IN VARCHAR2 Optional
85 -- Default = FND_API.G_FALSE
86 -- p_validation_level IN NUMBER Optional
87 -- Default = FND_API.G_VALID_LEVEL_FULL
88 -- p_check_login_user IN VARCHAR2 Optional
89 -- Default = FND_API.G_TRUE
90 -- p_channel_id IN NUMBER Required
91 -- OUT : x_return_status OUT VARCHAR2
92 -- x_msg_count OUT NUMBER
93 -- x_msg_data OUT VARCHAR2
94 -- Version : Current version 1.0
95 -- Previous version 1.0
96 -- Initial version 1.0
97 -- Notes :
98 --
99 -- End of comments
100 PROCEDURE Subscribe_Channel
101 ( p_api_version IN NUMBER,
102 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
103 p_commit IN VARCHAR2 := FND_API.G_FALSE,
104 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
105 p_check_login_user IN VARCHAR2 := FND_API.G_TRUE,
106 p_channel_id IN NUMBER,
107 x_return_status OUT NOCOPY VARCHAR2,
108 x_msg_count OUT NOCOPY NUMBER,
109 x_msg_data OUT NOCOPY VARCHAR2
110 );
111 --
112 -- Algorithm:
113 -- BEGIN
114 -- ...
115 -- END
116 --
117
118 --
119 -- This package contains the following procedures
120 --
121 --------------------------------------------------------------------------------
122 -- Start of comments
123 -- API name : Add_Subscription
124 -- Type : Private
125 -- Pre-reqs : None
126 -- Function : Subscribe a channel/category for an user
127 -- Parameters :
128 -- IN p_api_version IN NUMBER Required
129 -- p_init_msg_list IN VARCHAR2 Optional
130 -- Default = FND_API.G_FALSE
131 -- p_commit IN VARCHAR2 Optional
132 -- Default = FND_API.G_FALSE
133 -- p_validation_level IN NUMBER Optional
134 -- Default = FND_API.G_VALID_LEVEL_FULL
135 -- p_check_login_user IN VARCHAR2 Optional
136 -- Default = FND_API.G_TRUE
137 -- p_mychannel_obj IN
138 -- AMV_MY_CHANNEL_OBJ_TYPE Required
139 -- MyChannel data to be created.
140 -- OUT : x_return_status OUT VARCHAR2
141 -- x_msg_count OUT NUMBER
142 -- x_msg_data OUT VARCHAR2
143 -- x_mychannel_id OUT NUMBER
144 -- Version : Current version 1.0
145 -- Previous version 1.0
146 -- Initial version 1.0
147 -- Notes :
148 --
149 -- End of comments
150 --
151 --BREAK
152 PROCEDURE Add_Subscription
153 ( p_api_version IN NUMBER,
154 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
155 p_commit IN VARCHAR2 := FND_API.G_FALSE,
156 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
157 x_return_status OUT NOCOPY VARCHAR2,
158 x_msg_count OUT NOCOPY NUMBER,
159 x_msg_data OUT NOCOPY VARCHAR2,
160 p_check_login_user IN VARCHAR2 := FND_API.G_TRUE,
161 p_mychannel_obj IN AMV_MY_CHANNEL_OBJ_TYPE,
162 x_mychannel_id OUT NOCOPY NUMBER
163 );
164 --
165 -- Algorithm:
166 -- BEGIN
167 -- ...
168 -- END
169 --
170 --------------------------------------------------------------------------------
171 -- Start of comments
172 -- API name : Remove_Subscription
173 -- Type : Private
174 -- Pre-reqs : None
175 -- Function : Delete the subscription given p_mychannel_id.
176 -- Parameters :
177 -- IN p_api_version IN NUMBER Required
178 -- p_init_msg_list IN VARCHAR2 Optional
179 -- Default = FND_API.G_FALSE
180 -- p_commit IN VARCHAR2 Optional
181 -- Default = FND_API.G_FALSE
182 -- p_validation_level IN NUMBER Optional
183 -- Default = FND_API.G_VALID_LEVEL_FULL
184 -- p_check_login_user IN VARCHAR2 Optional
185 -- Default = FND_API.G_TRUE
186 -- p_mychannel_id IN NUMBER Optional
187 -- Default = FND_API.G_MISS_NUM
188 -- MyChannel Id
189 -- p_user_or_group_id IN NUMBER Optional
190 -- Default = FND_API.G_MISS_NUM
191 -- p_user_or_group_type IN VARCHAR2 Optional
192 -- Default = FND_API.G_MISS_CHAR
193 -- p_subscribing_to_id IN NUMBER Optional
194 -- Default = FND_API.G_MISS_NUM
195 -- p_subscribing_to_type IN VARCHAR2 Optional
196 -- Default = FND_API.G_MISS_CHAR
197 -- Pass the user and subscription id and types
198 -- instead of mychannel id.
199 -- Must pass the mychannel id or the joint key of
200 -- above four values
201 -- OUT : x_return_status OUT VARCHAR2
202 -- x_msg_count OUT NUMBER
203 -- x_msg_data OUT VARCHAR2
204 -- Version : Current version 1.0
205 -- Previous version 1.0
206 -- Initial version 1.0
207 -- Notes :
208 --
209 -- End of comments
210 --
211 PROCEDURE Remove_Subscription
212 ( p_api_version IN NUMBER,
213 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
214 p_commit IN VARCHAR2 := FND_API.G_FALSE,
215 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
216 x_return_status OUT NOCOPY VARCHAR2,
217 x_msg_count OUT NOCOPY NUMBER,
218 x_msg_data OUT NOCOPY VARCHAR2,
219 p_check_login_user IN VARCHAR2 := FND_API.G_TRUE,
220 p_mychannel_id IN NUMBER := FND_API.G_MISS_NUM,
221 p_user_or_group_id IN NUMBER := FND_API.G_MISS_NUM,
222 p_user_or_group_type IN VARCHAR2 := FND_API.G_MISS_CHAR,
223 p_subscribing_to_id IN NUMBER := FND_API.G_MISS_NUM,
224 p_subscribing_to_type IN VARCHAR2 := FND_API.G_MISS_CHAR
225 );
226 --
227 -- Algorithm:
228 -- BEGIN
229 -- ...
230 -- END
231 --
232 --------------------------------------------------------------------------------
233 -- Start of comments
234 -- API name : Update_MyChannel
235 -- Type : Private
236 -- Pre-reqs : None
237 -- Function : Update the mychannel given p_mychannel_id.
238 -- Parameters :
239 -- IN p_api_version IN NUMBER Required
240 -- p_init_msg_list IN VARCHAR2 Optional
241 -- Default = FND_API.G_FALSE
242 -- p_commit IN VARCHAR2 Optional
243 -- Default = FND_API.G_FALSE
244 -- p_validation_level IN NUMBER Optional
245 -- Default = FND_API.G_VALID_LEVEL_FULL
246 -- p_check_login_user IN VARCHAR2 Optional
247 -- Default = FND_API.G_TRUE
248 -- p_mychannel_obj IN AMV_MY_CHANNEL_OBJ_TYPE Required
249 -- OUT : x_return_status OUT VARCHAR2
250 -- x_msg_count OUT NUMBER
251 -- x_msg_data OUT VARCHAR2
252 -- Version : Current version 1.0
253 -- Previous version 1.0
254 -- Initial version 1.0
255 -- Notes :
256 --
257 -- End of comments
258 --
259 PROCEDURE Update_MyChannel
260 ( p_api_version IN NUMBER,
261 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
262 p_commit IN VARCHAR2 := FND_API.G_FALSE,
263 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
264 x_return_status OUT NOCOPY VARCHAR2,
265 x_msg_count OUT NOCOPY NUMBER,
266 x_msg_data OUT NOCOPY VARCHAR2,
267 p_check_login_user IN VARCHAR2 := FND_API.G_TRUE,
268 p_mychannel_obj IN AMV_MY_CHANNEL_OBJ_TYPE
269 );
270 --
271 -- Algorithm:
272 -- BEGIN
273 -- ...
274 -- END
275 --------------------------------------------------------------------------------
276 -- Start of comments
277 -- API name : Get_MyChannels
278 -- Type : Private
279 -- Pre-reqs : None
280 -- Function : Get all the channels for a given user (p_user_id)
281 -- Parameters :
282 -- IN p_api_version IN NUMBER Required
283 -- p_init_msg_list IN VARCHAR2 Optional
284 -- Default = FND_API.G_FALSE
285 -- p_validation_level IN NUMBER Optional
286 -- Default = FND_API.G_VALID_LEVEL_FULL
287 -- p_check_login_user IN VARCHAR2 Optional
288 -- Default = FND_API.G_TRUE
289 -- p_user_id IN NUMBER Required
290 -- the given user
291 -- OUT : x_return_status OUT VARCHAR2
292 -- x_msg_count OUT NUMBER
293 -- x_msg_data OUT VARCHAR2
294 -- x_mychannel_array OUT AMV_MY_CHANNEL_VARRAY_TYPE
295 -- Version : Current version 1.0
296 -- Previous version 1.0
297 -- Initial version 1.0
298 -- Notes :
299 --
300 -- End of comments
301 --
302 PROCEDURE Get_MyChannels
303 ( p_api_version IN NUMBER,
304 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
305 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
306 x_return_status OUT NOCOPY VARCHAR2,
307 x_msg_count OUT NOCOPY NUMBER,
308 x_msg_data OUT NOCOPY VARCHAR2,
309 p_check_login_user IN VARCHAR2 := FND_API.G_TRUE,
310 p_user_id IN NUMBER,
311 x_mychannel_array OUT NOCOPY AMV_MY_CHANNEL_VARRAY_TYPE
312 );
313 --
314 -- Algorithm:
315 -- BEGIN
316 -- ...
317 -- END
318 --
319 --------------------------------------------------------------------------------
320 -- Start of comments
321 -- API name : Get_MyChannelsPerCategory
322 -- Type : Private
323 -- Pre-reqs : None
324 -- Function : Get all channels in a category which an user has access to
325 -- Parameters :
326 -- IN p_api_version IN NUMBER Required
327 -- p_init_msg_list IN VARCHAR2 Optional
328 -- Default = FND_API.G_FALSE
329 -- p_validation_level IN NUMBER Optional
330 -- Default = FND_API.G_VALID_LEVEL_FULL
331 -- p_check_login_user IN VARCHAR2 Optional
332 -- Default = FND_API.G_TRUE
333 -- p_user_id IN NUMBER Required
334 -- the given user
335 -- p_category_id IN NUMBER Required
336 -- OUT : x_return_status OUT VARCHAR2
337 -- x_msg_count OUT NUMBER
338 -- x_msg_data OUT VARCHAR2
339 -- x_channel_array OUT AMV_NUMBER_VARRAY_TYPE
340 -- Version : Current version 1.0
341 -- Previous version 1.0
342 -- Initial version 1.0
343 -- Notes :
344 --
345 -- End of comments
346 --
347 PROCEDURE Get_MyChannelsPerCategory
348 ( p_api_version IN NUMBER,
349 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
350 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
351 x_return_status OUT NOCOPY VARCHAR2,
352 x_msg_count OUT NOCOPY NUMBER,
353 x_msg_data OUT NOCOPY VARCHAR2,
354 p_check_login_user IN VARCHAR2 := FND_API.G_TRUE,
355 p_user_id IN NUMBER,
356 p_category_id IN NUMBER,
357 x_channel_array OUT NOCOPY AMV_NUMBER_VARRAY_TYPE
358 );
359 --
360 -- Algorithm:
361 -- BEGIN
362 -- ...
363 -- END
364 --
365 --------------------------------------------------------------------------------
366 --------------------------------------------------------------------------------
367 -- Start of comments
368 -- API name : Get_MyNotifications
372 -- Parameters :
369 -- Type : Private
370 -- Pre-reqs : None
371 -- Function : Get all notifications for a user - either approval or fyi
373 -- IN p_api_version IN NUMBER Required
374 -- p_init_msg_list IN VARCHAR2 Optional
375 -- Default = FND_API.G_FALSE
376 -- p_validation_level IN NUMBER Optional
377 -- Default = FND_API.G_VALID_LEVEL_FULL
378 -- p_check_login_user IN VARCHAR2 Optional
379 -- Default = FND_API.G_TRUE
380 -- p_resource_id IN NUMBER Optional
381 -- Default = FND_API.G_MISS_NUM
382 -- resource manager resource id
383 -- p_user_id IN NUMBER Optional
384 -- Default = FND_API.G_MISS_NUM
385 -- fnd user id
386 -- p_user_name IN VARCHAR2 Optional
387 -- Default = FND_API.G_MISS_CHAR
388 -- fnd user name
389 -- p_notification_type IN VARCHAR2 Optional
390 -- Default = FND_API.G_MISS_CHAR
391 -- OUT : x_return_status OUT VARCHAR2
392 -- x_msg_count OUT NUMBER
393 -- x_msg_data OUT VARCHAR2
394 -- x_notifications_array OUT AMV_WF_NOTIF_VARRAY_TYPE
395 -- Version : Current version 1.0
396 -- Previous version 1.0
397 -- Initial version 1.0
398 -- Notes :
399 --
400 -- End of comments
401 --
402 PROCEDURE Get_MyNotifications
403 ( p_api_version IN NUMBER,
404 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
405 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
406 x_return_status OUT NOCOPY VARCHAR2,
407 x_msg_count OUT NOCOPY NUMBER,
408 x_msg_data OUT NOCOPY VARCHAR2,
409 p_check_login_user IN VARCHAR2 := FND_API.G_TRUE,
410 p_resource_id IN NUMBER := FND_API.G_MISS_NUM,
411 p_user_id IN NUMBER := FND_API.G_MISS_NUM,
412 p_user_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
413 p_notification_type IN VARCHAR2 := FND_API.G_MISS_CHAR,
414 x_notification_url OUT NOCOPY VARCHAR2,
415 x_notifications_array OUT NOCOPY AMV_WF_NOTIF_VARRAY_TYPE
416 );
417 --
418 -- Algorithm:
419 -- BEGIN
420 -- ...
421 -- END
422 --
423 --------------------------------------------------------------------------------
424 --------------------------------------------------------------------------------
425 -- Start of comments
426 -- API name : Get_ItemsPerUser
427 -- Type : Private
428 -- Pre-reqs : None
429 -- Function : Return all items a user can access based channel/cat access
430 -- Parameters :
431 -- IN p_api_version IN NUMBER Required
432 -- p_init_msg_list IN VARCHAR2 Optional
433 -- Default = FND_API.G_FALSE
434 -- p_validation_level IN NUMBER Optional
435 -- Default = FND_API.G_VALID_LEVEL_FULL
436 -- p_category_id IN NUMBER Required
437 -- p_include_subcats IN VARCHAR2 Optional
438 -- Default = FND_API.G_FALSE
439 -- OUT : x_return_status OUT VARCHAR2
440 -- x_msg_count OUT NUMBER
441 -- x_msg_data OUT VARCHAR2
442 -- x_items_array OUT AMV_CAT_HIERARCHY_VARRAY_TYPE
443 -- Version : Current version 1.0
444 -- Previous version 1.0
445 -- Initial version 1.0
446 -- Notes :
447 --
448 -- End of comments
449 --
450 PROCEDURE Get_ItemsPerUser
451 ( p_api_version IN NUMBER,
452 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
453 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
454 x_return_status OUT NOCOPY VARCHAR2,
455 x_msg_count OUT NOCOPY NUMBER,
456 x_msg_data OUT NOCOPY VARCHAR2,
457 p_check_login_user IN VARCHAR2 := FND_API.G_TRUE,
458 p_user_id IN NUMBER,
459 p_request_obj IN AMV_REQUEST_OBJ_TYPE,
460 x_return_obj OUT NOCOPY AMV_RETURN_OBJ_TYPE,
461 x_items_array OUT NOCOPY AMV_CAT_HIERARCHY_VARRAY_TYPE
462 );
463 --
464 -- Algorithm:
465 -- BEGIN
466 -- ...
467 -- END
468 --
469 --------------------------------------------------------------------------------
470 --------------------------------------------------------------------------------
471 -- Start of comments
472 -- API name : Get_UserItems
473 -- Type : Private
474 -- Pre-reqs : None
475 -- Function : Return all items published by the user
476 -- Parameters :
477 -- IN p_api_version IN NUMBER Required
478 -- p_init_msg_list IN VARCHAR2 Optional
479 -- Default = FND_API.G_FALSE
480 -- p_validation_level IN NUMBER Optional
481 -- Default = FND_API.G_VALID_LEVEL_FULL
482 -- p_category_id IN NUMBER Required
483 -- p_include_subcats IN VARCHAR2 Optional
484 -- Default = FND_API.G_FALSE
485 -- OUT : x_return_status OUT VARCHAR2
486 -- x_msg_count OUT NUMBER
487 -- x_msg_data OUT VARCHAR2
488 -- x_items_array OUT AMV_CAT_HIERARCHY_VARRAY_TYPE
489 -- Version : Current version 1.0
490 -- Previous version 1.0
491 -- Initial version 1.0
492 -- Notes :
493 --
494 -- End of comments
495 --
496 PROCEDURE Get_UserItems
497 ( p_api_version IN NUMBER,
498 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
499 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
500 x_return_status OUT NOCOPY VARCHAR2,
501 x_msg_count OUT NOCOPY NUMBER,
502 x_msg_data OUT NOCOPY VARCHAR2,
503 p_check_login_user IN VARCHAR2 := FND_API.G_TRUE,
504 p_application_id IN NUMBER,
505 p_user_id IN NUMBER,
506 p_request_obj IN AMV_REQUEST_OBJ_TYPE,
507 x_return_obj OUT NOCOPY AMV_RETURN_OBJ_TYPE,
508 x_items_array OUT NOCOPY AMV_itemdisplay_VARRAY_TYPE
509 );
510 --
511 -- Algorithm:
512 -- BEGIN
513 -- ...
514 -- END
515 --
516 --------------------------------------------------------------------------------
517 --------------------------------------------------------------------------------
518 -- Start of comments
519 -- API name : Can_UserMaintainChannel
520 -- Type : Private
521 -- Pre-reqs : None
522 -- Function : check if user can maintain channel
523 -- Parameters :
524 -- IN p_api_version IN NUMBER Required
525 -- p_init_msg_list IN VARCHAR2 Optional
526 -- Default = FND_API.G_FALSE
527 -- p_validation_level IN NUMBER Optional
528 -- Default = FND_API.G_VALID_LEVEL_FULL
529 -- p_user_id IN NUMBER Required
530 -- p_include_subcats IN VARCHAR2 Optional
531 -- Default = FND_API.G_FALSE
532 -- OUT : x_return_status OUT VARCHAR2
533 -- x_msg_count OUT NUMBER
534 -- x_msg_data OUT VARCHAR2
535 -- x_items_array OUT AMV_CAT_HIERARCHY_VARRAY_TYPE
536 -- Version : Current version 1.0
537 -- Previous version 1.0
538 -- Initial version 1.0
539 -- Notes :
540 --
541 -- End of comments
542 --
543 PROCEDURE Can_UserMaintainChannel
544 ( p_api_version IN NUMBER,
545 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
546 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
547 x_return_status OUT NOCOPY VARCHAR2,
548 x_msg_count OUT NOCOPY NUMBER,
549 x_msg_data OUT NOCOPY VARCHAR2,
550 p_check_login_user IN VARCHAR2 := FND_API.G_TRUE,
551 p_user_id IN NUMBER,
552 p_channel_id IN NUMBER,
553 x_maintain_flag OUT NOCOPY VARCHAR2
554 );
555 --
556 -- Algorithm:
557 -- BEGIN
558 -- ...
559 -- END
560 --
561 --------------------------------------------------------------------------------
562 --------------------------------------------------------------------------------
563 --
564 END amv_mychannel_pvt;
[Home] [Help]