DBA Data[Home] [Help]

PACKAGE: APPS.FUN_RECIPIENT_WF

Source


1 PACKAGE FUN_RECIPIENT_WF AS
2 /* $Header: FUN_RECI_WF_S.pls 120.9.12010000.1 2008/07/29 09:49:02 appldev ship $ */
3 
4     -- Raise when AP transfer has unknown failure.
5     ap_transfer_failure EXCEPTION;
6 
7 
8 
9 /*-----------------------------------------------------
10  * PROCEDURE get_attr
11  * ----------------------------------------------------
12  * Get the attributes for the recipient WF.
13  * ---------------------------------------------------*/
14 
15 PROCEDURE get_attr (
16     itemtype    IN varchar2,
17     itemkey     IN varchar2,
18     actid       IN number,
19     funcmode    IN varchar2,
20     resultout   IN OUT NOCOPY varchar2);
21 
22 
23 /*-----------------------------------------------------
24  * PROCEDURE validate_trx
25  * ----------------------------------------------------
26  * Call the Transaction API to validate the trx.
27  * ---------------------------------------------------*/
28 
29 PROCEDURE validate_trx (
30     itemtype    IN varchar2,
31     itemkey     IN varchar2,
32     actid       IN number,
33     funcmode    IN varchar2,
34     resultout   IN OUT NOCOPY varchar2);
35 
36 
37 /*-----------------------------------------------------
38  * PROCEDURE delete_trx
39  * ----------------------------------------------------
40  * Delete the transaction from the recipient's DB.
41  * ---------------------------------------------------*/
42 
43 PROCEDURE delete_trx (
44     itemtype    IN varchar2,
45     itemkey     IN varchar2,
46     actid       IN number,
47     funcmode    IN varchar2,
48     resultout   IN OUT NOCOPY varchar2);
49 
50 
51 
52 /*-----------------------------------------------------
53  * PROCEDURE is_gl_batch_mode
54  * ----------------------------------------------------
55  * Check whether GL transfer is in batch mode.
56  * ---------------------------------------------------*/
57 
58 PROCEDURE is_gl_batch_mode (
59     itemtype    IN varchar2,
60     itemkey     IN varchar2,
61     actid       IN number,
62     funcmode    IN varchar2,
63     resultout   IN OUT NOCOPY varchar2);
64 
65 
66 /*-----------------------------------------------------
67  * PROCEDURE check_invoice_reqd
68  * ----------------------------------------------------
69  * Check whether this transaction requires invoice.
70  * ---------------------------------------------------*/
71 
72 PROCEDURE check_invoice_reqd (
73     itemtype    IN varchar2,
74     itemkey     IN varchar2,
75     actid       IN number,
76     funcmode    IN varchar2,
77     resultout   IN OUT NOCOPY varchar2);
78 
79 
80 /*-----------------------------------------------------
81  * PROCEDURE check_approval_result
82  * ----------------------------------------------------
83  * Check status: APPROVED or REJECTED.
84  * ---------------------------------------------------*/
85 
86 PROCEDURE check_approval_result (
87     itemtype    IN varchar2,
88     itemkey     IN varchar2,
89     actid       IN number,
90     funcmode    IN varchar2,
91     resultout   IN OUT NOCOPY varchar2);
92 
93 
94 /*-----------------------------------------------------
95  * PROCEDURE is_manual_approval
96  * ----------------------------------------------------
97  * Check whether this transaction requires manual
98  * approval.
99  * ---------------------------------------------------*/
100 
101 PROCEDURE is_manual_approval (
102     itemtype    IN varchar2,
103     itemkey     IN varchar2,
104     actid       IN number,
105     funcmode    IN varchar2,
106     resultout   IN OUT NOCOPY varchar2);
107 
108 
109 /*-----------------------------------------------------
110  * PROCEDURE abort_approval
111  * ----------------------------------------------------
112  * Abort the accounting and approval process.
113  * ---------------------------------------------------*/
114 
115 PROCEDURE abort_approval (
116     itemtype    IN varchar2,
117     itemkey     IN varchar2,
118     actid       IN number,
119     funcmode    IN varchar2,
120     resultout   IN OUT NOCOPY varchar2);
121 
122 
123 /*-----------------------------------------------------
124  * PROCEDURE generate_approval_doc
125  * ----------------------------------------------------
126  * Generate the approval document.
127  * ---------------------------------------------------*/
128 
129 PROCEDURE generate_approval_doc (
130     document_id     IN number,
131     display_type    IN varchar2,
132     document        IN OUT NOCOPY varchar2,
133     document_type   IN OUT NOCOPY varchar2);
134 
135 
136 /*-----------------------------------------------------
137  * PROCEDURE is_same_instance
138  * ----------------------------------------------------
139  * Check whether the initiator and recipient are on the
140  * same instance.
141  * ---------------------------------------------------*/
142 
143 PROCEDURE is_same_instance (
144     itemtype    IN varchar2,
145     itemkey     IN varchar2,
146     actid       IN number,
147     funcmode    IN varchar2,
148     resultout   IN OUT NOCOPY varchar2);
149 
150 
151 /*-----------------------------------------------------
152  * PROCEDURE get_contact
153  * ----------------------------------------------------
154  * Get the contact for this party.
155  * ---------------------------------------------------*/
156 
157 PROCEDURE get_contact (
158     itemtype    IN varchar2,
159     itemkey     IN varchar2,
160     actid       IN number,
161     funcmode    IN varchar2,
162     resultout   IN OUT NOCOPY varchar2);
163 
164 
165 /*-----------------------------------------------------
166  * PROCEDURE check_allow_reject
167  * ----------------------------------------------------
168  * Check whether this transaction requires manual
169  * approval.
170  * ---------------------------------------------------*/
171 
172 PROCEDURE check_allow_reject (
173     itemtype    IN varchar2,
174     itemkey     IN varchar2,
175     actid       IN number,
176     funcmode    IN varchar2,
177     resultout   IN OUT NOCOPY varchar2);
178 
179 
180 /*-----------------------------------------------------
181  * PROCEDURE post_approval_ntf
182  * ----------------------------------------------------
183  * Check whether anyone has already approved or
184  * or rejected the transaction.
185  * ---------------------------------------------------*/
186 
187 PROCEDURE post_approval_ntf (
188     itemtype    IN varchar2,
189     itemkey     IN varchar2,
190     actid       IN number,
191     funcmode    IN varchar2,
192     resultout   IN OUT NOCOPY varchar2);
193 
194 
195 /*-----------------------------------------------------
196  * PROCEDURE check_ap_setup
197  * ----------------------------------------------------
198  * Check that AP is setup correctly with supplier and
199  * open period and all that.
200  * ---------------------------------------------------*/
201 
202 PROCEDURE check_ap_setup (
203     itemtype    IN varchar2,
204     itemkey     IN varchar2,
205     actid       IN number,
206     funcmode    IN varchar2,
207     resultout   IN OUT NOCOPY varchar2);
208 
209 
210 /*-----------------------------------------------------
211  * PROCEDURE transfer_to_ap
212  * ----------------------------------------------------
213  * Transfer to AP. Wrapper for
214  * FUN_AP_TRANSFER.TRANSFER_SINGLE
215  * ---------------------------------------------------*/
216 
217 PROCEDURE transfer_to_ap (
218     itemtype    IN varchar2,
219     itemkey     IN varchar2,
220     actid       IN number,
221     funcmode    IN varchar2,
222     resultout   IN OUT NOCOPY varchar2);
223 
224 
225 /*-----------------------------------------------------
226  * PROCEDURE raise_error
227  * ----------------------------------------------------
228  * Raise the error event.
229  * ---------------------------------------------------*/
230 
231 PROCEDURE raise_error (
232     itemtype    IN varchar2,
233     itemkey     IN varchar2,
234     actid       IN number,
235     funcmode    IN varchar2,
236     resultout   IN OUT NOCOPY varchar2);
237 
238 
239 /*-----------------------------------------------------
240  * PROCEDURE raise_received
241  * ----------------------------------------------------
242  * Raise the received event.
243  * ---------------------------------------------------*/
244 
245 PROCEDURE raise_received (
246     itemtype    IN varchar2,
247     itemkey     IN varchar2,
248     actid       IN number,
249     funcmode    IN varchar2,
250     resultout   IN OUT NOCOPY varchar2);
251 
252 
253 /*-----------------------------------------------------
254  * PROCEDURE raise_reject
255  * ----------------------------------------------------
256  * Raise the reject event.
257  * ---------------------------------------------------*/
258 
259 PROCEDURE raise_reject (
260     itemtype    IN varchar2,
261     itemkey     IN varchar2,
262     actid       IN number,
263     funcmode    IN varchar2,
264     resultout   IN OUT NOCOPY varchar2);
265 
266 
267 /*-----------------------------------------------------
268  * PROCEDURE raise_approve
269  * ----------------------------------------------------
270  * Raise the approve event.
271  * ---------------------------------------------------*/
272 
273 PROCEDURE raise_approve (
274     itemtype    IN varchar2,
275     itemkey     IN varchar2,
276     actid       IN number,
277     funcmode    IN varchar2,
278     resultout   IN OUT NOCOPY varchar2);
279 
280 
281 /*-----------------------------------------------------
282  * PROCEDURE raise_gl_transfer
283  * ----------------------------------------------------
284  * Raise the transfer to gl event.
285  * ---------------------------------------------------*/
286 
287 PROCEDURE raise_gl_transfer (
288     itemtype    IN varchar2,
289     itemkey     IN varchar2,
290     actid       IN number,
291     funcmode    IN varchar2,
292     resultout   IN OUT NOCOPY varchar2);
293 
294 
295 /*-----------------------------------------------------
296  * PROCEDURE update_status_error
297  * ----------------------------------------------------
298  * Update status to error.
299  * ---------------------------------------------------*/
300 
301 /*PROCEDURE update_status_error (
302     itemtype    IN varchar2,
303     itemkey     IN varchar2,
304     actid       IN number,
305     funcmode    IN varchar2,
306     resultout   IN OUT NOCOPY varchar2);
307 */
308 
309 
310 /*-----------------------------------------------------
311  * PROCEDURE update_status_rejected
312  * ----------------------------------------------------
313  * Update status to rejected.
314  * ---------------------------------------------------*/
315 
316 procedure update_status_rejected (
317     itemtype    in varchar2,
318     itemkey     in varchar2,
319     actid       in number,
320     funcmode    in varchar2,
321     resultout   in OUT NOCOPY varchar2);
322 
323 
324 /*-----------------------------------------------------
325  * PROCEDURE update_status_approved
326  * ----------------------------------------------------
327  * Update status to approved.
328  * ---------------------------------------------------*/
329 
330 procedure update_status_approved (
331     itemtype    in varchar2,
332     itemkey     in varchar2,
333     actid       in number,
334     funcmode    in varchar2,
335     resultout   in OUT NOCOPY varchar2);
336 
337 /*-----------------------------------------------------
338  * PROCEDURE approve_ntf
339  * ----------------------------------------------------
340  * Approve notification process from UI.
341  * ---------------------------------------------------*/
342 
343 procedure approve_ntf (
344     p_batch_id    in varchar2,
345     p_trx_id      in varchar2,
346     p_eventkey    in varchar2);
347 
348 
349 /*-----------------------------------------------------
350  * PROCEDURE reject_ntf
351  * ----------------------------------------------------
352  * Reject notification process from UI.
353  * ---------------------------------------------------*/
354 
355 procedure reject_ntf (
356     p_batch_id    in varchar2,
357     p_trx_id      in varchar2,
358     p_eventkey    in varchar2);
359 
360 /*-----------------------------------------------------
361  * PROCEDURE recipient_interco_acct
362  * ----------------------------------------------------
363  * Insert a default intercompany account for recipient
364  * accounting to fun_dist_lines
365  * ---------------------------------------------------*/
366 
367 procedure recipient_interco_acct (
368     itemtype    in varchar2,
369     itemkey     in varchar2,
370     actid       in number,
371     funcmode    in varchar2,
372     resultout   in OUT NOCOPY varchar2);
373 
374 
375 /*-----------------------------------------------------
376  * PROCEDURE check_acct_dist
377  * ----------------------------------------------------
378  * Call transaction API to validate account distributions
379  * ---------------------------------------------------*/
380 
381 procedure check_acct_dist (
382     itemtype    in varchar2,
383     itemkey     in varchar2,
384     actid       in number,
385     funcmode    in varchar2,
386     resultout   in OUT NOCOPY varchar2);
387 
388 
389 FUNCTION make_batch_rec (
390     p_batch_id    IN number) RETURN fun_trx_pvt.batch_rec_type;
391 
392 FUNCTION make_trx_rec (
393     p_trx_id    IN number) RETURN fun_trx_pvt.trx_rec_type;
394 
395 FUNCTION make_dist_lines_tbl (
396     p_trx_id    IN number) RETURN fun_trx_pvt.dist_line_tbl_type;
397 
398 
399 /* Start of changes for AME Uptake, 3671923. Bidisha S, 08 Jun 2004 */
400 /* ---------------------------------------------------------------------------
401 Name      : check_ui_apprvl_action
402 Pre-reqs  : None.
403 Modifies  : None.
404 Function  : This function is called by the Recipient Main workflow
405             to check if an approval action was taken in the wflow
406             even before an approval notification was sent.
407 Parameters:
408     IN    : itemtype  - Workflow Item Type
409             itemkey   - Workflow Item Key
410             actid     - Workflow Activity Id
411             funcmode  - Workflow Function Mode
412     OUT   : resultout - Result of the workflow function
413 Notes     : None.
414 Testing   : This function will be tested via workflow FUNRMAIN
415 ------------------------------------------------------------------------------*/
416 PROCEDURE check_ui_apprvl_action(
417     itemtype   IN  VARCHAR2,
418     itemkey    IN  VARCHAR2,
419     actid      IN  NUMBER,
420     funcmode   IN  VARCHAR2,
421     resultout  OUT NOCOPY VARCHAR2 ) ;
422 
423 /* End of changes for AME Uptake, 3671923. Bidisha S, 07 Jun 2004 */
424 
425 /* ---------------------------------------------------------------------------
429 Function  : This function is called by the update_status_approved
426 Name      : generate_interco_acct
427 Pre-reqs  : None.
428 Modifies  : None.
430             in recipient workflow to generate the intercompany accouns
431             before the status has been set to approved
432 Parameters:
433     IN    : p_trx_id  -- fun_trx_headers.trx_id
434     OUT   : x_status  -- FND_API.G_RET_STS_SUCCESS, ..UNEXP,..ERROR
435             x_msg_count -- Number of messages
436             x_msg_data  -- Message data
437 Notes     : None.
438 Testing   : This function will be tested via workflow FUNRMAIN
439 ------------------------------------------------------------------------------*/
440 PROCEDURE generate_interco_acct (
441     p_trx_id    IN NUMBER,
442     x_status    IN OUT NOCOPY VARCHAR2,
443     x_msg_count IN OUT NOCOPY NUMBER,
444     x_msg_data  IN OUT NOCOPY VARCHAR2);
445 
446 
447 /* ---------------------------------------------------------------------------
448 Name      : get_default_sla_ccid
449 Pre-reqs  : None.
450 Modifies  : None.
451 Function  : This function is called by recipient_interco_acct
452             to get the default ccid from SLA
453 Parameters:
454     IN    : p_trx_id  -- fun_trx_headers.trx_id
455     OUT   : x_status  -- FND_API.G_RET_STS_SUCCESS, ..UNEXP,..ERROR
456             x_msg_count -- Number of messages
457             x_msg_data  -- Message data
458             x_ccid      -- CCID
459 Notes     : None.
460 Testing   : This function will be tested via workflow FUNRMAIN
461 ------------------------------------------------------------------------------*/
462 PROCEDURE get_default_sla_ccid (
463     p_trx_id    IN NUMBER,
464     x_ccid      IN OUT NOCOPY NUMBER,
465     x_status    IN OUT NOCOPY VARCHAR2,
466     x_msg_count IN OUT NOCOPY NUMBER,
467     x_msg_data  IN OUT NOCOPY VARCHAR2);
468 
469 /*-----------------------------------------------------
470  * PROCEDURE generate_acct_lines
471  * ----------------------------------------------------
472  * Generate Intercompany Accounting Lines
473  * ---------------------------------------------------*/
474 
475 PROCEDURE generate_acct_lines (
476     itemtype    IN varchar2,
477     itemkey     IN varchar2,
478     actid       IN number,
479     funcmode    IN varchar2,
480     resultout   IN OUT NOCOPY varchar2);
481 
482 /*-----------------------------------------------------
483  * PROCEDURE create_wf_roles
484  * ----------------------------------------------------
485  * Generate wf roles. Bug No: 5897122.
486  * ---------------------------------------------------*/
487     procedure create_wf_roles (
488     trx_id      IN VARCHAR2);
489 END;