DBA Data[Home] [Help]

PACKAGE: APPS.JTF_CAL_WF_PVT

Source


1 PACKAGE JTF_CAL_WF_PVT AUTHID CURRENT_USER AS
2 /* $Header: jtfvcws.pls 120.1 2005/06/24 01:50:53 sanandan ship $ */
3 /*#
4  * Private APIs for the HTML Calendar module.
5  * This API will handle Calendar workflows functionality
6  * @rep:scope private
7  * @rep:product CAC
8  * @rep:displayname JTF Calendar Workflow Private API
9  * @rep:lifecycle active
10  * @rep:compatibility S
11  * @rep:category BUSINESS_ENTITY CAC_APPOINTMENT
12  */
13 
14 PROCEDURE StartSubscription
15 /*******************************************************************************
16 ** Start of comments
17 **  Procedure   : StartSubscription
18 **  Description : Given the group and requestor information this API
19 **                will start subscription workflows for all admins
20 **                of the group
21 **  Parameters  :
22 **      name                 direction  type     required?
23 **      ----                 ---------  ----     ---------
24 **      p_api_version        IN         NUMBER   required
25 **      p_init_msg_list      IN         VARCHAR2 optional
26 **      p_commit             IN         VARCHAR2 optional
27 **      x_return_status         OUT  NOCOPY   VARCHAR2 optional
28 **      x_msg_count             OUT  NOCOPY   NUMBER   required
29 **      x_msg_data              OUT  NOCOPY   VARCHAR2 required
30 **      p_CALENDAR_REQUESTOR IN         NUMBER   required
31 **      p_GROUP_ID           IN         NUMBER   required
32 **      p_GROUP_NAME         IN         VARCHAR2 required
33 **      p_GROUP_DESCRIPTION  IN         VARCHAR2 required
34 **  Notes :
35 **
36 ** End of comments
37 *******************************************************************************/
38 /*#
39  * Given the group and requestor information this API will start subscription
40  * workflows for all admins of the group
41  * @param p_api_version API Version Required
42  * @param p_init_msg_list Initialize message list flag, Optional Default = FND_API.G_FALSE
43  * @param p_commit Required
44  * @param x_return_status Required Length  = 1
45  * @param x_msg_count API Error message count, Required
46  * @param x_msg_data API Error message data, Required Length  = 2000
47  * @param p_CALENDAR_REQUESTOR Resource ID of the Subscriber
48  * @param p_GROUP_ID Resource ID of Group Calendar
49  * @param p_GROUP_NAME Name of the Group Calendar
50  * @param p_GROUP_DESCRIPTION Description of the Group Calendar
51  * @rep:scope private
52  * @rep:lifecycle active
53  * @rep:displayname StartSubscription
54  */
55 ( p_api_version        IN     NUMBER
56 , p_init_msg_list      IN     VARCHAR2 DEFAULT fnd_api.g_false
57 , p_commit             IN     VARCHAR2
58 , x_return_status         OUT NOCOPY VARCHAR2
59 , x_msg_count             OUT NOCOPY NUMBER
60 , x_msg_data              OUT NOCOPY VARCHAR2
61 , p_CALENDAR_REQUESTOR IN     NUMBER   -- Resource ID of the Subscriber
62 , p_GROUP_ID           IN     NUMBER   -- Resource ID of Group Calendar
63 , p_GROUP_NAME         IN     VARCHAR2 -- Name of the Group Calendar
64 , p_GROUP_DESCRIPTION  IN     VARCHAR2 -- Description of the Group Calendar
65 );
66 
67 PROCEDURE StartRequest
68 /*******************************************************************************
69 ** Start of comments
70 **  Procedure   : StartRequest
71 **  Description : Given the group and requestor information this API will start
72 **                a workflow that will send the request to the
73 **                JTF_CALENDAR_ADMIN
74 **  Parameters  :
75 **      name                direction  type     required?
76 **      ----                ---------  ----     ---------
77 **      p_api_version       IN         NUMBER   required
78 **      p_init_msg_list     IN         VARCHAR2 optional
79 **      p_commit            IN         VARCHAR2 optional
80 **      x_return_status        OUT     NOCOPY VARCHAR2 optional
81 **      x_msg_count            OUT     NOCOPY NUMBER   required
82 **      x_msg_data             OUT     NOCOPY VARCHAR2 required
83 **      p_REQUESTOR         IN         NUMBER   required
84 **      p_GROUP_ID          IN         NUMBER   optional
85 **      p_GROUP_NAME        IN         VARCHAR2 required
86 **      p_GROUP_DESCRIPTION IN         VARCHAR2 required
87 **      p_PUBLIC_FLAG       IN         VARCHAR2 required
88 **  Notes :
89 **    1)
90 **
91 ** End of comments
92 *******************************************************************************/
93 /*#
94  * Given the group and requestor information this API will start
95  * a workflow that will send the request to the JTF_CALENDAR_ADMIN
96  * @param p_api_version API Version Required
97  * @param p_init_msg_list Initialize message list flag, Optional Default = FND_API.G_FALSE
98  * @param p_commit Required
99  * @param x_return_status Required Length  = 1
100  * @param x_msg_count API Error message count, Required
101  * @param x_msg_data API Error message data, Required Length  = 2000
102  * @param p_CALENDAR_REQUESTOR Resource ID of the Subscriber
103  * @param p_GROUP_ID Resource ID of Group Calendar
104  * @param p_GROUP_NAME (Suggested) Name of the Group Calendar
105  * @param p_GROUP_DESCRIPTION (Suggested) Description of the Group Calendar
106  * @param p_PUBLIC Public Calendar flag
107  * @rep:scope private
108  * @rep:lifecycle active
109  * @rep:displayname StartRequest
110  */
111 ( p_api_version        IN     NUMBER
112 , p_init_msg_list      IN     VARCHAR2 DEFAULT fnd_api.g_false
113 , p_commit             IN     VARCHAR2
114 , x_return_status         OUT NOCOPY VARCHAR2
115 , x_msg_count             OUT NOCOPY NUMBER
116 , x_msg_data              OUT NOCOPY VARCHAR2
117 , p_CALENDAR_REQUESTOR IN     NUMBER   -- Resource ID of the Requestor
118 , p_GROUP_ID           IN     NUMBER   -- Resource ID of Group if known
119 , p_GROUP_NAME         IN     VARCHAR2 -- (Suggested) Name of the Group Calendar
120 , p_GROUP_DESCRIPTION  IN     VARCHAR2 -- (Suggested) Description of the Group Calendar
121 , p_PUBLIC             IN     VARCHAR2 -- Public Calendar flag
122 );
123 
124 PROCEDURE StartInvite
125 /*******************************************************************************
126 ** Start of comments
127 **  Procedure   : StartInviteWF
128 **  Description : Given the task ID of the appointment (p_TaskID) and the
129 **                Resource ID of the invitor (p_INVITOR) this procedure will
130 **                send notifications to all the attendees of the appointment.
131 **  Parameters  :
132 **      name               direction  type     required?
133 **      ----               ---------  ----     ---------
134 **      p_api_version      IN         NUMBER   required
135 **      p_init_msg_list    IN         VARCHAR2 optional
136 **      p_commit           IN         VARCHAR2 optional
137 **      x_return_status       OUT     NOCOPY VARCHAR2 optional
138 **      x_msg_count           OUT     NOCOPY NUMBER   required
139 **      x_msg_data            OUT     NOCOPY VARCHAR2 required
140 **      p_INVITOR          IN         NUMBER   required
141 **      p_TaskID           IN         NUMBER   required
142 **  Notes :
143 **    1) If an invitee does not exist in the WF directory a notification will
144 **       be send to the invitor saying that the invitation was not send.
145 **    2) Currently invitations are only send to employees
146 **    3) The WFs won't be started until a commmit is done.
147 **
148 ** End of comments
149 *******************************************************************************/
150 /*#
151  * Given the task ID of the appointment (p_TaskID) and the
152  * Resource ID of the invitor (p_INVITOR) this procedure will
153  * send notifications to all the attendees of the appointment.
154  * @param p_api_version API Version Required
155  * @param p_init_msg_list Initialize message list flag, Optional Default = FND_API.G_FALSE
156  * @param p_commit Required
157  * @param x_return_status Required Length  = 1
158  * @param x_msg_count API Error message count, Required
159  * @param x_msg_data API Error message data, Required Length  = 2000
160  * @param p_INVITOR Resource ID of Invitor
161  * @param p_TaskID  Task ID of the appointment
162  * @rep:scope private
163  * @rep:lifecycle active
164  * @rep:displayname StartInvite
165  */
166 ( p_api_version   IN     NUMBER
167 , p_init_msg_list IN     VARCHAR2 DEFAULT fnd_api.g_false
168 , p_commit        IN     VARCHAR2
169 , x_return_status    OUT NOCOPY VARCHAR2
170 , x_msg_count        OUT NOCOPY NUMBER
171 , x_msg_data         OUT NOCOPY VARCHAR2
172 , p_INVITOR       IN     NUMBER   -- Resource ID of Invitor
173 , p_TaskID        IN     NUMBER   -- Task ID of the appointment
174 );
175 
176 PROCEDURE StartInviteResource
177 /*******************************************************************************
178 ** Start of comments
179 **  Procedure   : StartInvite
180 **  Description : Given the task ID of the appointment (p_TaskID) and the
181 **                Resource ID of the invitee (p_INVITEE) this procedure will
182 **                send notification to the paticular attendee of the appointment.
183 **  Parameters  :
184 **      name               direction  type     required?
185 **      ----               ---------  ----     ---------
186 **      p_api_version      IN         NUMBER   required
187 **      p_init_msg_list    IN         VARCHAR2 optional
188 **      p_commit           IN         VARCHAR2 optional
189 **      x_return_status       OUT     VARCHAR2 optional
190 **      x_msg_count           OUT     NUMBER   required
191 **      x_msg_data            OUT     VARCHAR2 required
192 **      p_INVITEE          IN         NUMBER   required
193 **      p_INVITEE_TYPE     IN         VARCHAR2 required
194 **      p_INVITOR          IN         NUMBER   required
195 **      p_TaskID           IN         NUMBER   required
196 **  Notes :
197 **    1) If an invitee does not exist in the WF directory a notification will
198 **       be send to the invitor saying that the invitation was not send.
199 **    2) Currently invitations are only send to employees
200 **    3) The WFs won't be started until a commmit is done.
201 **
202 ** End of comments
203 *******************************************************************************/
204 /*#
205  * Given the task ID of the appointment (p_TaskID) and the
206  * Resource ID of the invitor (p_INVITOR) this procedure will
207  * send notifications to the paticular attendee of the appointment.
208  * @param p_api_version API Version Required
209  * @param p_init_msg_list Initialize message list flag, Optional Default = FND_API.G_FALSE
210  * @param p_commit Required
211  * @param x_return_status Required Length  = 1
212  * @param x_msg_count API Error message count, Required
213  * @param x_msg_data API Error message data, Required Length  = 2000
214  * @param p_INVITEE Resource ID of Invitee
215  * @param p_INVITEE_TYPE Resource Type of the INVITEE
216  * @param p_INVITOR Resource ID of Invitor
217  * @param p_TaskID  Task ID of the appointment
218  * @rep:scope private
219  * @rep:lifecycle active
220  * @rep:displayname StartInviteResource
221  */
222 ( p_api_version   IN     NUMBER
223 , p_init_msg_list IN     VARCHAR2  DEFAULT fnd_api.g_false
224 , p_commit        IN     VARCHAR2
225 , x_return_status OUT    NOCOPY VARCHAR2
226 , x_msg_count     OUT    NOCOPY NUMBER
227 , x_msg_data      OUT    NOCOPY VARCHAR2
228 , p_INVITEE       IN     NUMBER   -- Resource ID of Invitee
229 , p_INVITEE_TYPE  IN     VARCHAR2 --Resource Type of the INVITEE
230 , p_INVITOR       IN     NUMBER   -- Resource ID of Invitor
231 , p_TaskID        IN     NUMBER   -- Task ID of the appointment
232 );
233 
234 PROCEDURE UpdateInvitation
235 /*******************************************************************************
236 ** Start of comments
237 **  Procedure   : UpdateInvitation
238 **  Description : Given the task ID of the appointment (p_TaskID) and the
239 **                Resource ID of the invitor (p_INVITOR) this procedure will
240 **                respond to the notifications from the attendees of the appointment.
241 **  Parameters  :
242 **      name               direction  type     required?
243 **      ----               ---------  ----     ---------
244 **      itemtype           IN         VARCHAR2 required
245 **      itemkey            IN         VARCHAR2 required
246 **      actid              IN         NUMBER   required
247 **      funcmode           IN         VARCHAR2 required
248 **      resultout          OUT        VARCHAR2 required
249 **
250 ** End of comments
251 *******************************************************************************/
252 /*#
253  * Given the task ID of the appointment (p_TaskID) and the
254  * Resource ID of the invitor (p_INVITOR) this procedure will
255  * respond to the notifications from the attendees of the appointment.
256  * @param itemtype - Type of the current item
257  * @param itemkey - Key of the current item
258  * @param actid - Process activity instance id
259  * @param funcmode - Function execution mode like ('RUN', 'CANCEL', 'TIMEOUT')
260  * @param resultout - Name of Workflow process to run
261  * @rep:scope private
262  * @rep:lifecycle active
263  * @rep:displayname UpdateInvitation
264  */
265 ( itemtype   IN     VARCHAR2
266 , itemkey    IN     VARCHAR2
267 , actid      IN     NUMBER
268 , funcmode   IN     VARCHAR2
269 , resultout     OUT NOCOPY VARCHAR2
270 );
271 
272 
273 PROCEDURE DetermineWFRole
274 /*******************************************************************************
275 ** Start of comments
276 **  Procedure   : DetermineWFRole
277 **  Description : Work out the WF role for the given resource.
278 **                Used to implement the 'Determine WF Role' function in the
279 **                'JTFCALWF.Send Invitation' workflow.
280 **  Parameters  :
281 **      name               direction  type     required?
282 **      ----               ---------  ----     ---------
283 **      itemtype           IN         VARCHAR2 required
284 **      itemkey            IN         VARCHAR2 required
285 **      actid              IN         NUMBER   required
286 **      funcmode           IN         VARCHAR2 required
287 **      resultout             OUT    NOCOPY  VARCHAR2 required
288 **
289 **  Notes :
290 **    1) Expects WF item attributes 'RESOURCE_ID' and 'RESOURCE_TYPE' to be
291 **       available to this procedure.
295 ******************************************************************************/
292 **    2) This procedure should only be used within Workflow
293 **
294 ** End of comments
296 /*#
297  * Work out the WF role for the given resource.
298  * Used to implement the 'Determine WF Role' function in the
299  * 'JTFCALWF.Send Invitation' workflow.
300  * @param itemtype - Type of the current item
301  * @param itemkey - Key of the current item
302  * @param actid - Process activity instance id
303  * @param funcmode - Function execution mode like ('RUN', 'CANCEL', 'TIMEOUT')
304  * @param resultout - Name of Workflow process to run
305  * @rep:scope private
306  * @rep:lifecycle active
307  * @rep:displayname DetermineWFRole
308  */
309 ( itemtype   IN     VARCHAR2
310 , itemkey    IN     VARCHAR2
311 , actid      IN     NUMBER
312 , funcmode   IN     VARCHAR2
313 , resultout     OUT NOCOPY VARCHAR2
314 );
315 
316 PROCEDURE ProcessSubscription
317 /*******************************************************************************
318 ** Start of comments
319 **  Procedure   : ProcessSubscribtion
320 **  Description : Creates a grant for a group calendar
321 **  Parameters  :
322 **      name               direction  type     required?
323 **      ----               ---------  ----     ---------
324 **      itemtype           IN         VARCHAR2 required
325 **      itemkey            IN         VARCHAR2 required
326 **      actid              IN         NUMBER   required
327 **      funcmode           IN         VARCHAR2 required
328 **      resultout             OUT  NOCOPY   VARCHAR2 required
329 **
330 **  Notes :
331 **    1) This procedure should only be used within Workflow
332 **
333 ** End of comments
334 ******************************************************************************/
335 /*#
336  * Creates a grant for a group calendar
337  * @param itemtype - Type of the current item
338  * @param itemkey - Key of the current item
339  * @param actid - Process activity instance id
340  * @param funcmode - Function execution mode like ('RUN', 'CANCEL', 'TIMEOUT')
341  * @param resultout - Name of Workflow process to run
342  * @rep:scope private
343  * @rep:lifecycle active
344  * @rep:displayname ProcessSubscription
345  */
346 ( itemtype   IN     VARCHAR2
347 , itemkey    IN     VARCHAR2
348 , actid      IN     NUMBER
349 , funcmode   IN     VARCHAR2
350 , resultout     OUT NOCOPY VARCHAR2
351 );
352 
353 PROCEDURE ProcessRequest
354 /*******************************************************************************
355 ** Start of comments
356 **  Procedure   : ProcessRequest
357 **  Description : If required this function creates resource group, resource
358 **                usage and or grants in order to create a group or public
359 **                calendar
360 **  Parameters  :
361 **      name               direction  type     required?
362 **      ----               ---------  ----     ---------
363 **      itemtype           IN         VARCHAR2 required
364 **      itemkey            IN         VARCHAR2 required
365 **      actid              IN         NUMBER   required
366 **      funcmode           IN         VARCHAR2 required
367 **      resultout             OUT  NOCOPY   VARCHAR2 required
368 **
369 **  Notes :
370 **    1) This procedure should only be used within Workflow
371 ** End of comments
372 ******************************************************************************/
373 /*#
374  * If required this function creates resource group, resource
375  * usage and or grants in order to create a group or public calendar
376  * @param itemtype - Type of the current item
377  * @param itemkey - Key of the current item
378  * @param actid - Process activity instance id
379  * @param funcmode - Function execution mode like ('RUN', 'CANCEL', 'TIMEOUT')
380  * @param resultout - Name of Workflow process to run
381  * @rep:scope private
382  * @rep:lifecycle active
383  * @rep:displayname ProcessRequest
384  */
385 ( itemtype   IN     VARCHAR2
386 , itemkey    IN     VARCHAR2
387 , actid      IN     NUMBER
388 , funcmode   IN     VARCHAR2
389 , resultout     OUT NOCOPY VARCHAR2
390 );
391 PROCEDURE ProcessInvitation
392 /*******************************************************************************
393 ** Start of comments
394 **  Procedure   : ProcessInvitation
395 **  Description : Given the
396 **  Parameters  :
397 **      name                direction  type     required?
398 **      ----                ---------  ----     ---------
399 **      p_api_version       IN         NUMBER   required
400 **      p_init_msg_list     IN         VARCHAR2 optional
401 **      p_commit            IN         VARCHAR2 optional
402 **      x_return_status        OUT  NOCOPY   VARCHAR2 optional
403 **      x_msg_count            OUT  NOCOPY   NUMBER   required
404 **      x_msg_data             OUT  NOCOPY   VARCHAR2 required
405 **      p_task_assignment_id   IN      NUMBER   required
406 **      p_resource_type        IN      VARCHAR2 required
407 **      p_resource_id          IN      NUMBER   required
408 **      p_assignment_status_id IN      NUMBER   required
409 **  Notes :
410 **    1) Created for ER 2219647
411 **
412 ** End of comments
413 *******************************************************************************/
414 /*#
415  * For given resource this API will process invitation
416  * @param p_api_version API Version Required
420  * @param x_msg_count API Error message count, Required
417  * @param p_init_msg_list Initialize message list flag, Optional Default = FND_API.G_FALSE
418  * @param p_commit Required
419  * @param x_return_status Required Length  = 1
421  * @param x_msg_data API Error message data, Required Length  = 2000
422  * @param p_task_assignment_id Input task assignment id
423  * @param p_resource_type Input resource type
424  * @param p_resource_id Input resource id
425  * @param p_assignment_status_id Input assignment status Id
426  * @rep:scope private
427  * @rep:lifecycle active
428  * @rep:displayname ProcessInvitation
429  */
430 ( p_api_version        IN     NUMBER
431 , p_init_msg_list      IN     VARCHAR2
432 , p_commit             IN     VARCHAR2
433 , x_return_status      OUT    NOCOPY    VARCHAR2
434 , x_msg_count          OUT    NOCOPY    NUMBER
435 , x_msg_data           OUT    NOCOPY    VARCHAR2
436 , p_task_assignment_id IN     NUMBER
437 , p_resource_type      IN     VARCHAR2
438 , p_resource_id        IN     NUMBER
439 , p_assignment_status_id IN NUMBER
440 );
441 
442 PROCEDURE GetInvitationStatus
443 /*******************************************************************************
444 ** Start of comments
445 **  Procedure   : GetInvitationStatus
446 **  Description : Set the attributes for the invitation status and determine which
447 **                notification to send
448 **  Parameters  :
449 **      name               direction  type     required?
450 **      ----               ---------  ----     ---------
451 **      itemtype           IN         VARCHAR2 required
452 **      itemkey            IN         VARCHAR2 required
453 **      actid              IN         NUMBER   required
454 **      funcmode           IN         VARCHAR2 required
455 **      resultout             OUT     NOCOPY VARCHAR2 required
456 **
457 **  Notes :
458 **    1) Expects WF item attributes 'ASSIGNMENT_STATUS_ID' to be available to this procedure.
459 **    2) This procedure should only be used within Workflow
460 **    3) Created for 2219647
461 **
462 ** End of comments
463 ******************************************************************************/
464 /*#
465  * Set the attributes for the invitation status and determine which notification to send
466  * @param itemtype - Type of the current item
467  * @param itemkey - Key of the current item
468  * @param actid - Process activity instance id
469  * @param funcmode - Function execution mode like ('RUN', 'CANCEL', 'TIMEOUT')
470  * @param resultout - Name of Workflow process to run
471  * @rep:scope private
472  * @rep:lifecycle active
473  * @rep:displayname GetInvitationStatus
474  */
475 ( itemtype   IN     VARCHAR2
476 , itemkey    IN     VARCHAR2
477 , actid      IN     NUMBER
478 , funcmode   IN     VARCHAR2
479 , resultout  OUT    NOCOPY      VARCHAR2
480 );
481 
482 
483 
484 PROCEDURE StartReminders
485 /*******************************************************************************
486 ** Start of comments
487 **  Procedure   : StartReminder
488 **  Description : Given the task ID of the appointment (p_TaskID) and the
489 **                Resource ID of the invitor (p_INVITOR) this procedure will
490 **                start WF reminders for all the attendees of the appointment.
491 **  Parameters  :
492 **      name               direction  type     required?
493 **      ----               ---------  ----     ---------
494 **      p_api_version      IN         NUMBER   required
495 **      p_init_msg_list    IN         VARCHAR2 optional
496 **      p_commit           IN         VARCHAR2 optional
497 **      x_return_status       OUT  NOCOPY   VARCHAR2 optional
498 **      x_msg_count           OUT  NOCOPY   NUMBER   required
499 **      x_msg_data            OUT  NOCOPY   VARCHAR2 required
500 **      p_INVITOR          IN         NUMBER   required
501 **      p_TaskID           IN         NUMBER   required
502 **  Notes :
503 **    1) If an invitee does not exist in the WF directory a notification will
504 **       be send to the invitor saying that the invitation was not send.
505 **    2) Currently invitations are only send to employees
506 **    3) The WFs won't be started until a commmit is done.
507 **
508 ** End of comments
509 *******************************************************************************/
510 /*#
511  * Given the task ID of the appointment (p_TaskID) and the
512  * Resource ID of the invitor (p_INVITOR) this procedure will
513  * start WF reminders for all the attendees of the appointment.
514  * @param p_api_version API Version Required
515  * @param p_init_msg_list Initialize message list flag, Optional Default = FND_API.G_FALSE
516  * @param p_commit Required
517  * @param x_return_status Required Length  = 1
518  * @param x_msg_count API Error message count, Required
519  * @param x_msg_data API Error message data, Required Length  = 2000
520  * @param p_INVITOR Resource ID of Invitor
521  * @param p_TaskID  Task ID of the appointment
522  * @param p_RemindDate Date/Time the reminder needs to be send
523  * @rep:scope private
524  * @rep:lifecycle active
525  * @rep:displayname StartReminders
526  */
527 ( p_api_version   IN     NUMBER
528 , p_init_msg_list IN     VARCHAR2 DEFAULT fnd_api.g_false
529 , p_commit        IN     VARCHAR2
530 , x_return_status    OUT NOCOPY VARCHAR2
531 , x_msg_count        OUT NOCOPY NUMBER
532 , x_msg_data         OUT NOCOPY VARCHAR2
533 , p_INVITOR       IN     NUMBER   -- Resource ID of Invitor
537 
534 , p_TaskID        IN     NUMBER   -- Task ID of the appointment
535 , p_RemindDate    IN     DATE     -- Date/Time the reminder needs to be send
536 );
538 PROCEDURE SendReminders
539 /*******************************************************************************
540 ** Start of comments
541 **  Procedure   : SendReminders
542 **  Description :
543 **  Parameters  :
544 **      name               direction  type     required?
545 **      ----               ---------  ----     ---------
546 **      itemtype           IN         VARCHAR2 required
547 **      itemkey            IN         VARCHAR2 required
548 **      actid              IN         NUMBER   required
549 **      funcmode           IN         VARCHAR2 required
550 **      resultout             OUT     NOCOPY VARCHAR2 required
551 **
552 **  Notes :
553 **
554 ** End of comments
555 ******************************************************************************/
556 /*#
557  * Send Reminders
558  * @param itemtype - Type of the current item
559  * @param itemkey - Key of the current item
560  * @param actid - Process activity instance id
561  * @param funcmode - Function execution mode like ('RUN', 'CANCEL', 'TIMEOUT')
562  * @param resultout - Name of Workflow process to run
563  * @rep:scope private
564  * @rep:lifecycle active
565  * @rep:displayname SendReminders
566  */
567 ( itemtype   IN     VARCHAR2
568 , itemkey    IN     VARCHAR2
569 , actid      IN     NUMBER
570 , funcmode   IN     VARCHAR2
571 , resultout     OUT NOCOPY VARCHAR2
572 );
573 
574 PROCEDURE UpdateReminders
575 /*******************************************************************************
576 ** Start of comments
577 **  Procedure   : UpdateReminders
578 **  Description : Given the task ID and a new reminder date this procedure will
579 **                update all the reminders for the appointment, should only be
580 **                called if the reminder me or start date has changed
581 **  Parameters  :
582 **      name               direction  type     required?
583 **      ----               ---------  ----     ---------
584 **      p_api_version      IN         NUMBER   required
585 **      p_init_msg_list    IN         VARCHAR2 optional
586 **      p_commit           IN         VARCHAR2 optional
587 **      x_return_status       OUT  NOCOPY    VARCHAR2 optional
588 **      x_msg_count           OUT  NOCOPY    NUMBER   required
589 **      x_msg_data            OUT  NOCOPY    VARCHAR2 required
590 **      p_TaskID           IN         NUMBER   required
591 **      p_RemindDate       IN         DATE     required
592 **  Notes :
593 **    1) If an invitee does not exist in the WF directory a notification will
594 **       be send to the invitor saying that the invitation was not send.
595 **    2) Currently invitations are only send to employees
596 **    3) The WFs won't be started until a commmit is done.
597 **
598 ** End of comments
599 *******************************************************************************/
600 /*#
601  * Given the task ID and a new reminder date this procedure will
602  * update all the reminders for the appointment, should only be
603  * called if the reminder me or start date has changed
604  * @param p_api_version API Version Required
605  * @param p_init_msg_list Initialize message list flag, Optional Default = FND_API.G_FALSE
606  * @param p_commit Required
607  * @param x_return_status Required Length  = 1
608  * @param x_msg_count API Error message count, Required
609  * @param x_msg_data API Error message data, Required Length  = 2000
610  * @param p_TaskID  Task ID of the appointment
611  * @param p_RemindDate Date/Time the reminder needs to be send
612  * @rep:scope private
613  * @rep:lifecycle active
614  * @rep:displayname UpdateReminders
615  */
616 ( p_api_version   IN     NUMBER
617 , p_init_msg_list IN     VARCHAR2 DEFAULT fnd_api.g_false
618 , p_commit        IN     VARCHAR2
619 , x_return_status    OUT NOCOPY VARCHAR2
620 , x_msg_count        OUT NOCOPY NUMBER
621 , x_msg_data         OUT NOCOPY VARCHAR2
622 , p_TaskID        IN     NUMBER   -- Task ID of the appointment
623 , p_RemindDate    IN     DATE     -- NEW Date/Time the reminder needs to be send
624 );
625 
626 PROCEDURE GetRepeatingRule
627 /*******************************************************************************
628 ** Start of comments
629 **  Procedure   : GetRepeatingRule
630 **  Description : Set the attributes for the repeating rule and determine which
631 **                notification to send
632 **  Parameters  :
633 **      name               direction  type     required?
634 **      ----               ---------  ----     ---------
635 **      itemtype           IN         VARCHAR2 required
636 **      itemkey            IN         VARCHAR2 required
637 **      actid              IN         NUMBER   required
638 **      funcmode           IN         VARCHAR2 required
639 **      resultout             OUT NOCOPY    VARCHAR2 required
640 **
641 **  Notes :
642 **    1) Expects WF item attributes 'TASK_ID' to be available to this procedure.
643 **    2) This procedure should only be used within Workflow
644 **
645 ** End of comments
646 ******************************************************************************/
647 /*#
648  * Set the attributes for the repeating rule and determine which
649  * notification to send
650  * @param itemtype - Type of the current item
651  * @param itemkey - Key of the current item
652  * @param actid - Process activity instance id
653  * @param funcmode - Function execution mode like ('RUN', 'CANCEL', 'TIMEOUT')
657  * @rep:displayname GetRepeatingRule
654  * @param resultout - Name of Workflow process to run
655  * @rep:scope private
656  * @rep:lifecycle active
658  */
659 ( itemtype   IN     VARCHAR2
660 , itemkey    IN     VARCHAR2
661 , actid      IN     NUMBER
662 , funcmode   IN     VARCHAR2
663 , resultout     OUT NOCOPY VARCHAR2
664 );
665 
666 END JTF_CAL_WF_PVT;