DBA Data[Home] [Help]

PACKAGE: APPS.CAC_VIEW_WF_PVT

Source


1 PACKAGE CAC_VIEW_WF_PVT AUTHID CURRENT_USER AS
2 /* $Header: cacvcwss.pls 120.1 2006/02/17 05:32:26 sankgupt noship $ */
3 
4 PROCEDURE StartSubscription
5 /*******************************************************************************
6 ** Start of comments
7 **  Procedure   : StartSubscription
8 **  Description : Given the group and requestor information this API
9 **                will start subscription workflows for all admins
10 **                of the group
11 **  Parameters  :
12 **      name                 direction  type     required?
13 **      ----                 ---------  ----     ---------
14 **      p_api_version        IN         NUMBER   required
15 **      p_init_msg_list      IN         VARCHAR2 optional
16 **      p_commit             IN         VARCHAR2 optional
17 **      x_return_status         OUT  NOCOPY   VARCHAR2 optional
18 **      x_msg_count             OUT  NOCOPY   NUMBER   required
19 **      x_msg_data              OUT  NOCOPY   VARCHAR2 required
20 **      p_CALENDAR_REQUESTOR IN         NUMBER   required
21 **      p_GROUP_ID           IN         NUMBER   required
22 **      p_GROUP_NAME         IN         VARCHAR2 required
23 **      p_GROUP_DESCRIPTION  IN         VARCHAR2 required
24 **  Notes :
25 **
26 ** End of comments
27 *******************************************************************************/
28 ( p_api_version        IN     NUMBER
29 , p_init_msg_list      IN     VARCHAR2 DEFAULT fnd_api.g_false
30 , p_commit             IN     VARCHAR2
31 , x_return_status         OUT NOCOPY VARCHAR2
32 , x_msg_count             OUT NOCOPY NUMBER
33 , x_msg_data              OUT NOCOPY VARCHAR2
34 , p_CALENDAR_REQUESTOR IN     NUMBER   -- Resource ID of the Subscriber
35 , p_GROUP_ID           IN     NUMBER   -- Resource ID of Group Calendar
36 , p_GROUP_NAME         IN     VARCHAR2 -- Name of the Group Calendar
37 , p_GROUP_DESCRIPTION  IN     VARCHAR2 -- Description of the Group Calendar
38 );
39 
40 PROCEDURE StartRequest
41 /*******************************************************************************
42 ** Start of comments
43 **  Procedure   : StartRequest
44 **  Description : Given the group and requestor information this API will start
45 **                a workflow that will send the request to the
46 **                JTF_CALENDAR_ADMIN
47 **  Parameters  :
48 **      name                direction  type     required?
49 **      ----                ---------  ----     ---------
50 **      p_api_version       IN         NUMBER   required
51 **      p_init_msg_list     IN         VARCHAR2 optional
52 **      p_commit            IN         VARCHAR2 optional
53 **      x_return_status        OUT     NOCOPY VARCHAR2 optional
54 **      x_msg_count            OUT     NOCOPY NUMBER   required
55 **      x_msg_data             OUT     NOCOPY VARCHAR2 required
56 **      p_REQUESTOR         IN         NUMBER   required
57 **      p_GROUP_ID          IN         NUMBER   optional
58 **      p_GROUP_NAME        IN         VARCHAR2 required
59 **      p_GROUP_DESCRIPTION IN         VARCHAR2 required
60 **      p_PUBLIC_FLAG       IN         VARCHAR2 required
61 **  Notes :
62 **    1)
63 **
64 ** End of comments
65 *******************************************************************************/
66 ( p_api_version        IN     NUMBER
67 , p_init_msg_list      IN     VARCHAR2 DEFAULT fnd_api.g_false
68 , p_commit             IN     VARCHAR2
69 , x_return_status         OUT NOCOPY VARCHAR2
70 , x_msg_count             OUT NOCOPY NUMBER
71 , x_msg_data              OUT NOCOPY VARCHAR2
72 , p_CALENDAR_REQUESTOR IN     NUMBER   -- Resource ID of the Requestor
73 , p_GROUP_ID           IN     NUMBER   -- Resource ID of Group if known
74 , p_GROUP_NAME         IN     VARCHAR2 -- (Suggested) Name of the Group Calendar
75 , p_GROUP_DESCRIPTION  IN     VARCHAR2 -- (Suggested) Description of the Group Calendar
76 , p_PUBLIC             IN     VARCHAR2 -- Public Calendar flag
77 );
78 
79 PROCEDURE StartInvite
80 /*******************************************************************************
81 ** Start of comments
82 **  Procedure   : StartInviteWF
83 **  Description : Given the task ID of the appointment (p_TaskID) and the
84 **                Resource ID of the invitor (p_INVITOR) this procedure will
85 **                send notifications to all the attendees of the appointment.
86 **  Parameters  :
87 **      name               direction  type     required?
88 **      ----               ---------  ----     ---------
89 **      p_api_version      IN         NUMBER   required
90 **      p_init_msg_list    IN         VARCHAR2 optional
91 **      p_commit           IN         VARCHAR2 optional
92 **      x_return_status       OUT     NOCOPY VARCHAR2 optional
93 **      x_msg_count           OUT     NOCOPY NUMBER   required
94 **      x_msg_data            OUT     NOCOPY VARCHAR2 required
95 **      p_INVITOR          IN         NUMBER   required
96 **      p_TaskID           IN         NUMBER   required
97 **  Notes :
98 **    1) If an invitee does not exist in the WF directory a notification will
99 **       be send to the invitor saying that the invitation was not send.
100 **    2) Currently invitations are only send to employees
101 **    3) The WFs won't be started until a commmit is done.
102 **
103 ** End of comments
104 *******************************************************************************/
105 ( p_api_version   IN     NUMBER
106 , p_init_msg_list IN     VARCHAR2 DEFAULT fnd_api.g_false
107 , p_commit        IN     VARCHAR2
108 , x_return_status    OUT NOCOPY VARCHAR2
109 , x_msg_count        OUT NOCOPY NUMBER
110 , x_msg_data         OUT NOCOPY VARCHAR2
111 , p_INVITOR       IN     NUMBER   -- Resource ID of Invitor
112 , p_TaskID        IN     NUMBER   -- Task ID of the appointment
113 );
114 
115 PROCEDURE StartInviteResource
116 /*******************************************************************************
117 ** Start of comments
118 **  Procedure   : StartInvite
119 **  Description : Given the task ID of the appointment (p_TaskID) and the
120 **                Resource ID of the invitee (p_INVITEE) this procedure will
121 **                send notification to the paticular attendee of the appointment.
122 **  Parameters  :
123 **      name               direction  type     required?
124 **      ----               ---------  ----     ---------
125 **      p_api_version      IN         NUMBER   required
126 **      p_init_msg_list    IN         VARCHAR2 optional
127 **      p_commit           IN         VARCHAR2 optional
128 **      x_return_status       OUT     VARCHAR2 optional
129 **      x_msg_count           OUT     NUMBER   required
130 **      x_msg_data            OUT     VARCHAR2 required
131 **      p_INVITEE          IN         NUMBER   required
132 **      p_INVITEE_TYPE     IN         VARCHAR2 required
133 **      p_INVITOR          IN         NUMBER   required
134 **      p_TaskID           IN         NUMBER   required
135 **  Notes :
136 **    1) If an invitee does not exist in the WF directory a notification will
137 **       be send to the invitor saying that the invitation was not send.
138 **    2) Currently invitations are only send to employees
139 **    3) The WFs won't be started until a commmit is done.
140 **
141 ** End of comments
142 *******************************************************************************/
143 ( p_api_version   IN     NUMBER
144 , p_init_msg_list IN     VARCHAR2  DEFAULT fnd_api.g_false
145 , p_commit        IN     VARCHAR2
146 , x_return_status OUT    NOCOPY	VARCHAR2
147 , x_msg_count     OUT    NOCOPY	NUMBER
148 , x_msg_data      OUT    NOCOPY	VARCHAR2
149 , p_INVITEE       IN     NUMBER   -- Resource ID of Invitee
150 , p_INVITEE_TYPE  IN     VARCHAR2 --Resource Type of the INVITEE
151 , p_INVITOR       IN     NUMBER   -- Resource ID of Invitor
152 , p_TaskID        IN     NUMBER   -- Task ID of the appointment
153 );
154 
155 PROCEDURE UpdateInvitation
156 /*******************************************************************************
157 ** Start of comments
158 **  Procedure   : UpdateInvitation
159 **  Description : Given the task ID of the appointment (p_TaskID) and the
160 **                Resource ID of the invitor (p_INVITOR) this procedure will
161 **                respond to the notifications from the attendees of the appointment.
162 **  Parameters  :
163 **      name               direction  type     required?
164 **      ----               ---------  ----     ---------
165 **      itemtype           IN         VARCHAR2 required
166 **      itemkey            IN         VARCHAR2 required
167 **      actid              IN         NUMBER   required
168 **      funcmode           IN         VARCHAR2 required
169 **      resultout          OUT        VARCHAR2 required
170 **
171 ** End of comments
172 *******************************************************************************/
173 ( itemtype   IN     VARCHAR2
174 , itemkey    IN     VARCHAR2
175 , actid      IN     NUMBER
176 , funcmode   IN     VARCHAR2
177 , resultout     OUT NOCOPY VARCHAR2
178 );
179 
180 
181 PROCEDURE DetermineWFRole
182 /*******************************************************************************
183 ** Start of comments
184 **  Procedure   : DetermineWFRole
185 **  Description : Work out the WF role for the given resource.
186 **                Used to implement the 'Determine WF Role' function in the
187 **                'CACVWSWF.Send Invitation' workflow.
188 **  Parameters  :
189 **      name               direction  type     required?
190 **      ----               ---------  ----     ---------
191 **      itemtype           IN         VARCHAR2 required
192 **      itemkey            IN         VARCHAR2 required
193 **      actid              IN         NUMBER   required
194 **      funcmode           IN         VARCHAR2 required
195 **      resultout             OUT    NOCOPY  VARCHAR2 required
196 **
197 **  Notes :
198 **    1) Expects WF item attributes 'RESOURCE_ID' and 'RESOURCE_TYPE' to be
199 **       available to this procedure.
200 **    2) This procedure should only be used within Workflow
201 **
202 ** End of comments
203 ******************************************************************************/
204 ( itemtype   IN     VARCHAR2
205 , itemkey    IN     VARCHAR2
206 , actid      IN     NUMBER
207 , funcmode   IN     VARCHAR2
208 , resultout     OUT NOCOPY VARCHAR2
209 );
210 
211 PROCEDURE ProcessSubscription
212 /*******************************************************************************
213 ** Start of comments
214 **  Procedure   : ProcessSubscribtion
215 **  Description : Creates a grant for a group calendar
216 **  Parameters  :
217 **      name               direction  type     required?
218 **      ----               ---------  ----     ---------
219 **      itemtype           IN         VARCHAR2 required
220 **      itemkey            IN         VARCHAR2 required
221 **      actid              IN         NUMBER   required
222 **      funcmode           IN         VARCHAR2 required
223 **      resultout             OUT  NOCOPY   VARCHAR2 required
224 **
225 **  Notes :
226 **    1) This procedure should only be used within Workflow
227 **
228 ** End of comments
229 ******************************************************************************/
230 ( itemtype   IN     VARCHAR2
231 , itemkey    IN     VARCHAR2
232 , actid      IN     NUMBER
233 , funcmode   IN     VARCHAR2
234 , resultout     OUT NOCOPY VARCHAR2
235 );
236 
237 PROCEDURE ProcessRequest
238 /*******************************************************************************
239 ** Start of comments
240 **  Procedure   : ProcessRequest
241 **  Description : If required this function creates resource group, resource
242 **                usage and or grants in order to create a group or public
243 **                calendar
244 **  Parameters  :
245 **      name               direction  type     required?
246 **      ----               ---------  ----     ---------
247 **      itemtype           IN         VARCHAR2 required
248 **      itemkey            IN         VARCHAR2 required
249 **      actid              IN         NUMBER   required
250 **      funcmode           IN         VARCHAR2 required
251 **      resultout             OUT  NOCOPY   VARCHAR2 required
252 **
253 **  Notes :
254 **    1) This procedure should only be used within Workflow
258 , itemkey    IN     VARCHAR2
255 ** End of comments
256 ******************************************************************************/
257 ( itemtype   IN     VARCHAR2
259 , actid      IN     NUMBER
260 , funcmode   IN     VARCHAR2
261 , resultout     OUT NOCOPY VARCHAR2
262 );
263 PROCEDURE ProcessInvitation
264 /*******************************************************************************
265 ** Start of comments
266 **  Procedure   : ProcessInvitation
267 **  Description : Given the
268 **  Parameters  :
269 **      name                direction  type     required?
270 **      ----                ---------  ----     ---------
271 **      p_api_version       IN         NUMBER   required
272 **      p_init_msg_list     IN         VARCHAR2 optional
273 **      p_commit            IN         VARCHAR2 optional
274 **      x_return_status        OUT  NOCOPY   VARCHAR2 optional
275 **      x_msg_count            OUT  NOCOPY   NUMBER   required
276 **      x_msg_data             OUT  NOCOPY   VARCHAR2 required
277 **      p_task_assignment_id   IN      NUMBER   required
278 **      p_resource_type        IN      VARCHAR2 required
279 **      p_resource_id          IN      NUMBER   required
280 **      p_assignment_status_id IN      NUMBER   required
281 **  Notes :
282 **    1) Created for ER 2219647
283 **
284 ** End of comments
285 *******************************************************************************/
286 ( p_api_version        IN     NUMBER
287 , p_init_msg_list      IN     VARCHAR2
288 , p_commit             IN     VARCHAR2
289 , x_return_status      OUT    NOCOPY	VARCHAR2
290 , x_msg_count          OUT    NOCOPY	NUMBER
291 , x_msg_data           OUT    NOCOPY	VARCHAR2
292 , p_task_assignment_id IN     NUMBER
293 , p_resource_type      IN     VARCHAR2
294 , p_resource_id        IN     NUMBER
295 , p_assignment_status_id IN NUMBER
296 );
297 
298 PROCEDURE GetInvitationStatus
299 /*******************************************************************************
300 ** Start of comments
301 **  Procedure   : GetInvitationStatus
302 **  Description : Set the attributes for the invitation status and determine which
303 **                notification to send
304 **  Parameters  :
305 **      name               direction  type     required?
306 **      ----               ---------  ----     ---------
307 **      itemtype           IN         VARCHAR2 required
308 **      itemkey            IN         VARCHAR2 required
309 **      actid              IN         NUMBER   required
310 **      funcmode           IN         VARCHAR2 required
311 **      resultout             OUT     NOCOPY VARCHAR2 required
312 **
313 **  Notes :
314 **    1) Expects WF item attributes 'ASSIGNMENT_STATUS_ID' to be available to this procedure.
315 **    2) This procedure should only be used within Workflow
316 **    3) Created for 2219647
317 **
318 ** End of comments
319 ******************************************************************************/
320 ( itemtype   IN     VARCHAR2
321 , itemkey    IN     VARCHAR2
322 , actid      IN     NUMBER
323 , funcmode   IN     VARCHAR2
324 , resultout  OUT    NOCOPY	VARCHAR2
325 );
326 
327 
328 
329 PROCEDURE StartReminders
330 /*******************************************************************************
331 ** Start of comments
332 **  Procedure   : StartReminder
333 **  Description : Given the task ID of the appointment (p_TaskID) and the
334 **                Resource ID of the invitor (p_INVITOR) this procedure will
335 **                start WF reminders for all the attendees of the appointment.
336 **  Parameters  :
337 **      name               direction  type     required?
338 **      ----               ---------  ----     ---------
339 **      p_api_version      IN         NUMBER   required
340 **      p_init_msg_list    IN         VARCHAR2 optional
341 **      p_commit           IN         VARCHAR2 optional
342 **      x_return_status       OUT  NOCOPY   VARCHAR2 optional
343 **      x_msg_count           OUT  NOCOPY   NUMBER   required
347 **  Notes :
344 **      x_msg_data            OUT  NOCOPY   VARCHAR2 required
345 **      p_INVITOR          IN         NUMBER   required
346 **      p_TaskID           IN         NUMBER   required
348 **    1) If an invitee does not exist in the WF directory a notification will
349 **       be send to the invitor saying that the invitation was not send.
350 **    2) Currently invitations are only send to employees
351 **    3) The WFs won't be started until a commmit is done.
352 **
353 ** End of comments
354 *******************************************************************************/
355 ( p_api_version   IN     NUMBER
356 , p_init_msg_list IN     VARCHAR2 DEFAULT fnd_api.g_false
357 , p_commit        IN     VARCHAR2
358 , x_return_status    OUT NOCOPY VARCHAR2
359 , x_msg_count        OUT NOCOPY NUMBER
360 , x_msg_data         OUT NOCOPY VARCHAR2
361 , p_INVITOR       IN     NUMBER   -- Resource ID of Invitor
362 , p_TaskID        IN     NUMBER   -- Task ID of the appointment
363 , p_RemindDate    IN     DATE     -- Date/Time the reminder needs to be send
364 );
365 
366 PROCEDURE SendReminders
367 /*******************************************************************************
368 ** Start of comments
369 **  Procedure   : SendReminders
370 **  Description :
371 **  Parameters  :
372 **      name               direction  type     required?
373 **      ----               ---------  ----     ---------
374 **      itemtype           IN         VARCHAR2 required
375 **      itemkey            IN         VARCHAR2 required
376 **      actid              IN         NUMBER   required
377 **      funcmode           IN         VARCHAR2 required
378 **      resultout             OUT     NOCOPY VARCHAR2 required
379 **
380 **  Notes :
381 **
382 ** End of comments
383 ******************************************************************************/
384 ( itemtype   IN     VARCHAR2
385 , itemkey    IN     VARCHAR2
386 , actid      IN     NUMBER
387 , funcmode   IN     VARCHAR2
388 , resultout     OUT NOCOPY VARCHAR2
389 );
390 
391 PROCEDURE UpdateReminders
392 /*******************************************************************************
393 ** Start of comments
394 **  Procedure   : UpdateReminders
395 **  Description : Given the task ID and a new reminder date this procedure will
396 **                update all the reminders for the appointment, should only be
397 **                called if the reminder me or start date has changed
398 **  Parameters  :
399 **      name               direction  type     required?
400 **      ----               ---------  ----     ---------
401 **      p_api_version      IN         NUMBER   required
402 **      p_init_msg_list    IN         VARCHAR2 optional
403 **      p_commit           IN         VARCHAR2 optional
404 **      x_return_status       OUT  NOCOPY    VARCHAR2 optional
405 **      x_msg_count           OUT  NOCOPY    NUMBER   required
406 **      x_msg_data            OUT  NOCOPY    VARCHAR2 required
407 **      p_TaskID           IN         NUMBER   required
408 **      p_RemindDate       IN         DATE     required
409 **  Notes :
410 **    1) If an invitee does not exist in the WF directory a notification will
411 **       be send to the invitor saying that the invitation was not send.
412 **    2) Currently invitations are only send to employees
413 **    3) The WFs won't be started until a commmit is done.
414 **
415 ** End of comments
416 *******************************************************************************/
417 ( p_api_version   IN     NUMBER
418 , p_init_msg_list IN     VARCHAR2 DEFAULT fnd_api.g_false
419 , p_commit        IN     VARCHAR2
420 , x_return_status    OUT NOCOPY VARCHAR2
421 , x_msg_count        OUT NOCOPY NUMBER
422 , x_msg_data         OUT NOCOPY VARCHAR2
423 , p_TaskID        IN     NUMBER   -- Task ID of the appointment
424 , p_RemindDate    IN     DATE     -- NEW Date/Time the reminder needs to be send
425 );
426 
427 PROCEDURE GetRepeatingRule
428 /*******************************************************************************
429 ** Start of comments
430 **  Procedure   : GetRepeatingRule
431 **  Description : Set the attributes for the repeating rule and determine which
432 **                notification to send
433 **  Parameters  :
434 **      name               direction  type     required?
435 **      ----               ---------  ----     ---------
436 **      itemtype           IN         VARCHAR2 required
437 **      itemkey            IN         VARCHAR2 required
438 **      actid              IN         NUMBER   required
439 **      funcmode           IN         VARCHAR2 required
440 **      resultout             OUT NOCOPY    VARCHAR2 required
441 **
442 **  Notes :
443 **    1) Expects WF item attributes 'TASK_ID' to be available to this procedure.
444 **    2) This procedure should only be used within Workflow
445 **
446 ** End of comments
447 ******************************************************************************/
448 ( itemtype   IN     VARCHAR2
449 , itemkey    IN     VARCHAR2
450 , actid      IN     NUMBER
451 , funcmode   IN     VARCHAR2
452 , resultout     OUT NOCOPY VARCHAR2
453 );
454 
455 PROCEDURE UpdateAttendee
456 /*******************************************************************************
457 ** Start of comments
458 **  Procedure   : UpdateReminders
459 **  Description : Given the task ID and a new reminder date this procedure will
460 **                update all the reminders for the appointment, should only be
461 **                called if the reminder me or start date has changed
462 **  Parameters  :
463 **      name               direction  type     required?
464 **      ----               ---------  ----     ---------
465 **      p_api_version      IN         NUMBER   required
466 **      p_init_msg_list    IN         VARCHAR2 optional
470 **      x_msg_data            OUT     VARCHAR2 required
467 **      p_commit           IN         VARCHAR2 optional
468 **      x_return_status       OUT     VARCHAR2 optional
469 **      x_msg_count           OUT     NUMBER   required
471 **      p_TaskID           IN         NUMBER   required
472 **      p_RemindDate       IN         DATE     required
473 **  Notes :
474 **    1) If an invitee does not exist in the WF directory a notification will
475 **       be send to the invitor saying that the invitation was not send.
476 **    2) Currently invitations are only send to employees
477 **    3) The WFs won't be started until a commmit is done.
478 **
479 ** End of comments
480 *******************************************************************************/
481 ( p_api_version   IN     NUMBER
482 , p_init_msg_list IN     VARCHAR2
483 , p_commit        IN     VARCHAR2
484 , x_return_status OUT    NOCOPY	VARCHAR2
485 , x_msg_count     OUT    NOCOPY	NUMBER
486 , x_msg_data      OUT    NOCOPY	VARCHAR2
487 , p_INVITEE       IN     NUMBER   -- Resource ID of Invitee
488 , p_INVITEE_TYPE  IN     VARCHAR2 --Resource Type of the INVITEE
489 , p_TaskID        IN     NUMBER   -- Task ID of the appointment
490 );
491 
492 PROCEDURE DeleteAttendee
493 /*******************************************************************************
494 ** Start of comments
495 **  Procedure   : DeleteAttendee
496 **  Description : Given the task ID and the Invitee id this procedure will
497 **                send reminders to attendees if the appointment is deleted
498 **
499 **  Parameters  :
500 **      name               direction  type     required?
501 **      ----               ---------  ----     ---------
502 **      p_api_version      IN         NUMBER   required
503 **      p_init_msg_list    IN         VARCHAR2 optional
504 **      p_commit           IN         VARCHAR2 optional
505 **      x_return_status       OUT     VARCHAR2 optional
506 **      x_msg_count           OUT     NUMBER   required
507 **      x_msg_data            OUT     VARCHAR2 required
508 **      p_TaskID           IN         NUMBER   required
509 **      p_RemindDate       IN         DATE     required
510 **      p_INVITEE          IN         NUMBER   required
511 **      p_INVITEE_TYPE     IN         VARCHAR2 required
512 **  Notes :
513 **    1) If an invitee does not exist in the WF directory a notification will
514 **       be send to the invitor saying that the invitation was not send.
515 **    2) Currently invitations are only send to employees
516 **    3) The WFs won't be started until a commmit is done.
517 **
518 ** End of comments
519 *******************************************************************************/
520 ( p_api_version   IN     NUMBER
521 , p_init_msg_list IN     VARCHAR2
522 , p_commit        IN     VARCHAR2
523 , x_return_status OUT    NOCOPY	VARCHAR2
524 , x_msg_count     OUT    NOCOPY	NUMBER
525 , x_msg_data      OUT    NOCOPY	VARCHAR2
526 , p_INVITEE       IN     NUMBER   -- Resource ID of Invitee
527 , p_INVITEE_TYPE  IN     VARCHAR2 --Resource Type of the INVITEE
528 , p_TaskID        IN     NUMBER   -- Task ID of the appointment
529 );
530 
531 END CAC_VIEW_WF_PVT;