1 package FND_SUBMIT as
2 /* $Header: AFCPRSSS.pls 120.4.12000000.3 2007/10/05 13:03:41 ggupta ship $ */
3 /*#
4 * This package contains the APIs for request set submission.
5 * @rep:scope public
6 * @rep:product FND
7 * @rep:displayname Request Set Submission
8 * @rep:category BUSINESS_ENTITY FND_CP_REQUEST_SET
9 * @rep:lifecycle active
10 * @rep:compatibility S
11 */
12
13 --
14 -- Package
15 -- FND_SUBMIT
16 --
17 -- Purpose
18 -- Concurrent processing related utilities
19 --
20 -- History
21 -- 11-SEP-98 Venkat Created
22 --
23
24 --
25 -- PUBLIC VARIABLES
26 --
27
28 -- Exceptions
29
30 -- Exception Pragmas
31
32 --
33 -- PUBLIC FUNCTIONS
34 --
35
36 --
37 -- Name
38 -- set_mode
39 -- Purpose
40 -- Called before submitting request to set mode to 'database trigger'
41 --
42 -- Arguments
43 -- db_trigger - Set to TRUE for database trigger mode
44 --
45 /*#
46 * Sets the mode if the request is submitted from a database trigger
47 * @param db_trigger Set to TRUE if the trigger is submitted from a database trigger
48 * @return Returns TRUE on successful completion, FALSE otherwise
49 * @rep:displayname Set Mode
50 * @rep:scope public
51 * @rep:lifecycle active
52 * @rep:compatibility S
53 */
54 function set_mode (db_trigger IN boolean) return boolean;
55
56 --
57 -- Name
58 -- set_nls_options
59 -- Purpose
60 -- Called before submitting request to set request attributes
61 --
62 -- Arguments
63 -- implicit - nature of the request to be submitted
64 -- - NO/YES/ERROR/WARNING
65 -- protected - Is the request protected against updates
66 -- - YES/NO default is NO
67 -- language - NLS language
68 -- territory - Language territory
69 --
70 /*#
71 * Sets request attributes (language-based attributes)
72 * @param language The NLS language
73 * @param territory The language territory
74 * @return Returns TRUE on successful completion, otherwise FALSE
75 * @rep:displayname Set NLS options
76 * @rep:scope public
77 * @rep:lifecycle active
78 * @rep:compatibility S
79 */
80 --
81 -- bug5676655/5709193
82 --
83 function set_nls_options( language IN varchar2 default NULL,
84 territory IN varchar2 default NULL,
85 numeric_characters IN varchar2 default NULL)
86 return boolean;
87
88 --
89 -- Name
90 -- set_repeat_options
91 -- Purpose
92 -- Called before submitting request if the request to be submitted
93 -- is a repeating request.
94 --
95 -- Arguments
96 -- repeat_time - Time of day at which it has to be repeated
97 -- repeat_interval - Frequency at which it has to be repeated
98 -- - This will be used/applied only when repeat_time
99 -- - is NULL
100 -- repeat_unit - Unit for repeat interval. Default is DAYS
101 -- - MONTHS/DAYS/HOURS/MINUTES
102 -- repeat_type - Apply repeat interval from START or END of request
103 -- - default is START. START/END
104 -- repeat_end_time - Time at which the repetition should be stopped
105 --
106 /*#
107 * Sets the repeat options for the request set before submitting a concurrent request
108 * @param repeat_time Time of the day at which request set is to be repeated
109 * @param repeat_interval Frequency at which the request set has to be repeated
110 * @param repeat_unit Unit for the repeat interval
111 * @param repeat_type Specifies whether the repeat interval should apply from the start or end of the previous request
112 * @param repeat_end_time Time at which the repetitions should end
113 * @return Returns TRUE on successful completion, FALSE otherwise
114 * @rep:displayname Set Repeat Options
115 * @rep:scope public
116 * @rep:lifecycle active
117 * @rep:compatibility S
118 */
119 function set_repeat_options (repeat_time IN varchar2 default NULL,
120 repeat_interval IN number default NULL,
121 repeat_unit IN varchar2 default 'DAYS',
122 repeat_type IN varchar2 default 'START',
123 repeat_end_time IN varchar2 default NULL)
124 return boolean;
125
126 --
127 -- Name
128 -- set_rel_class_options
129 -- Purpose
130 -- Called before submitting request if the request to be submitted
131 -- is using the new scheduler functionality.
132 --
133 -- Arguments
134 -- application - Application Name of Release Class
135 -- class_name - (Developer) Name of Release Class
136 -- cancel_or_hold - Cancel or hold flag
137 -- stale_date - Cancel request on or after this time if not run
138 --
139 /*#
140 * Sets some of the advanced scheduling features available in the concurrent processing system
141 * @param application The short name of the application associated with the release class
142 * @param class_name The developer name of the release class
143 * @param cancel_or_hold Cancel or hold flag
144 * @param stale_date Cancel this request after this date if the request has not yet run
145 * @return Returns TRUE on successful completion, FALSE otherwise
146 * @rep:displayname Set Release Class Options
147 * @rep:scope public
148 * @rep:lifecycle active
149 * @rep:compatibility S
150 */
151 function set_rel_class_options (application IN varchar2 default NULL,
152 class_name IN varchar2 default NULL,
153 cancel_or_hold IN varchar2 default 'H',
154 stale_date IN varchar2 default NULL)
155 return boolean;
156
157 --
158 -- Name
159 -- set_org_id
160 -- Purpose
161 -- Called before submitting request if the program is 'Sinle' multi org catagory.,
162 --
163 -- Arguments
164 -- org_id - Operating unit id
165 --
166 procedure set_org_id(org_id IN number default NULL);
167
168 --
169 -- Name
170 -- set_print_options
171 -- Purpose
172 -- Called before submitting request if the printing of output has
173 -- to be controlled with specific printer/style/copies etc.,
174 --
175 -- Arguments
176 -- printer - Printer name where the request o/p should be sent
177 -- style - Print style that needs to be used for printing
178 -- copies - Number of copies to print
179 -- save_output - Should the output file be saved after printing
180 -- - Default is TRUE. TRUE/FALSE
181 -- print_together - Applies only for sub requests. If 'Y', output
182 -- - will not be printed until all the sub requests
183 -- - complete. Default is 'N'. ( Y/N )
184 --
185 /*#
186 * Sets request set print options like printer, print style, copies, etc. for a given request (context-sensitive)
187 * @param printer Printer name for the output
188 * @param style Print style to be used for printing
189 * @param copies Number of copies to print
190 * @param save_output Specify TRUE if the output should be saved after printing, FALSE Otherwise
191 * @param print_together Applicable only to subrequests. If 'Y' the output will not be printed until all the sub-requests are completed. Default is 'N'
192 * @rep:displayname Set print options
193 * @rep:scope public
194 * @rep:lifecycle active
195 * @rep:compatibility S
196 */
197 function set_print_options (printer IN varchar2 default NULL,
198 style IN varchar2 default NULL,
199 copies IN number default NULL,
200 save_output IN boolean default TRUE,
201 print_together IN varchar2 default 'N')
202 return boolean;
203
204
205 --
206 -- Name
207 -- add_printer
208 -- Purpose
209 -- Called after set print options to add a printer to the
210 -- print list.
211 --
212 -- Arguments
213 -- printer - Printer name where the request o/p should be sent
214 -- copies - Number of copies to print
215 /*#
216 * Adds printer to the printer list (context-sensitive, i.e. works on the request that is currently in context)
217 * @param printer Printer name where the printer output should be sent
218 * @param copies Number of copies to print
219 * @return Returns TRUE on successful completion, FALSE otherwise
220 * @rep:displayname Add Printer
221 * @rep:scope public
222 * @rep:lifecycle active
223 * @rep:compatibility S
224 */
225 function add_printer (printer in varchar2 default null,
226 copies in number default null) return boolean;
227
228 --
229 -- Name
230 -- add_notification
231 -- Purpose
232 -- Called before submission to add a user to the notify list.
233 --
234 -- Arguments
235 -- User - User name.
236 /*#
237 * Adds user to the notification list of a particular request (context-sensitive i.e. works on the request currently in context)
238 * @param user User name
239 * @return Returns TRUE on successful completion, FALSE otherwise
240 * @rep:displayname Add Notification
241 * @rep:scope public
242 * @rep:lifecycle active
243 * @rep:compatibility S
244 */
245 function add_notification (
246 user in varchar2,
247 on_normal in varchar2 default 'Y',
248 on_warning in varchar2 default 'N',
249 on_error in varchar2 default 'N' ) return boolean;
250
251
252 -- --
253 -- Name
254 -- set_request_set
255 -- Purpose
256 --
257 -- To set the request set context. Call this function at very
258 -- beginning of the submission of a concurrent request set transaction.
259 -- Call this function after calling the optional functions SET_MODE,
260 -- SET_REL_CLASS_OPTIONS, SET_REPEAT_OPTIONS.
261 -- It returns TRUE on sucessful completion, and FALSE otherwise.
262 -- Arguments
263 -- application - Application short name
264 -- request_set - Developer Request set name
265 --
266 /*#
267 * Sets the request set context
268 * @param request_set The short name of the request set
269 * @param application The short name of the application that owns the request set
270 * @return Returns TRUE on successful completion, FALSE otherwise
271 * @rep:displayname Set Request Set Context
272 * @rep:scope public
273 * @rep:lifecycle active
274 * @rep:compatibility S
275 */
276 function set_request_set (
277 application IN varchar2,
278 request_set IN varchar2
279 ) return boolean;
280
281 --
282 -- Name
283 -- submit_program
284 -- Purpose
285 -- Submits concurrent request for the program in the request set to be
286 -- processed by a concurrent manager.
287 -- Before calling this function you may want to call the optional functions
288 -- SET_PRINT_OPTIONS, ADD_PRINTER, ADD_NOTIFICATION, SET_NLS_OPTIONS.
289 -- Call submit_program for each program (report) in the request set.
290 -- You must call set_request_set before calling this function. You have to
291 -- call set_request_set only once for all the submit_program calls for that
292 -- request set.
293 -- This function returns TRUE on successful completion,
294 -- and FALSE otherwise.
295 --
296 -- Arguments
297 -- application - Short name of application under which the program
298 -- - is registered
299 -- program - concurrent program name for which the request has
300 -- - to be submitted
301 -- stage - stage name for which the request has to be submitted
302 --
303 -- argument1..100 - Optional. Arguments for the concurrent request
304 --
305 /*#
306 * Submits a program for execution in the concurrent processing system
307 * @param application The short name of the application associated with the program within a report set
308 * @param program The short name of the program with the report set
309 * @param stage The developer name of the request set stage that the program belongs to
310 * @param argument1 Argument for concurrent request
311 * @param argument2 Argument for concurrent request
312 * @param argument3 Argument for concurrent request
313 * @param argument4 Argument for concurrent request
314 * @param argument5 Argument for concurrent request
315 * @param argument6 Argument for concurrent request
316 * @param argument7 Argument for concurrent request
317 * @param argument8 Argument for concurrent request
318 * @param argument9 Argument for concurrent request
319 * @param argument10 Argument for concurrent request
320 * @param argument11 Argument for concurrent request
321 * @param argument12 Argument for concurrent request
322 * @param argument13 Argument for concurrent request
323 * @param argument14 Argument for concurrent request
324 * @param argument15 Argument for concurrent request
325 * @param argument16 Argument for concurrent request
326 * @param argument17 Argument for concurrent request
327 * @param argument18 Argument for concurrent request
328 * @param argument19 Argument for concurrent request
329 * @param argument20 Argument for concurrent request
330 * @param argument21 Argument for concurrent request
331 * @param argument22 Argument for concurrent request
332 * @param argument23 Argument for concurrent request
333 * @param argument24 Argument for concurrent request
334 * @param argument25 Argument for concurrent request
335 * @param argument26 Argument for concurrent request
336 * @param argument27 Argument for concurrent request
337 * @param argument28 Argument for concurrent request
338 * @param argument29 Argument for concurrent request
339 * @param argument30 Argument for concurrent request
340 * @param argument31 Argument for concurrent request
341 * @param argument32 Argument for concurrent request
342 * @param argument33 Argument for concurrent request
343 * @param argument34 Argument for concurrent request
344 * @param argument35 Argument for concurrent request
345 * @param argument36 Argument for concurrent request
346 * @param argument37 Argument for concurrent request
347 * @param argument38 Argument for concurrent request
348 * @param argument39 Argument for concurrent request
349 * @param argument40 Argument for concurrent request
350 * @param argument41 Argument for concurrent request
351 * @param argument42 Argument for concurrent request
352 * @param argument43 Argument for concurrent request
356 * @param argument47 Argument for concurrent request
353 * @param argument44 Argument for concurrent request
354 * @param argument45 Argument for concurrent request
355 * @param argument46 Argument for concurrent request
357 * @param argument48 Argument for concurrent request
358 * @param argument49 Argument for concurrent request
359 * @param argument50 Argument for concurrent request
360 * @param argument51 Argument for concurrent request
361 * @param argument52 Argument for concurrent request
362 * @param argument53 Argument for concurrent request
363 * @param argument54 Argument for concurrent request
364 * @param argument55 Argument for concurrent request
365 * @param argument56 Argument for concurrent request
366 * @param argument57 Argument for concurrent request
367 * @param argument58 Argument for concurrent request
368 * @param argument59 Argument for concurrent request
369 * @param argument60 Argument for concurrent request
370 * @param argument61 Argument for concurrent request
371 * @param argument62 Argument for concurrent request
372 * @param argument63 Argument for concurrent request
373 * @param argument64 Argument for concurrent request
374 * @param argument65 Argument for concurrent request
375 * @param argument66 Argument for concurrent request
376 * @param argument67 Argument for concurrent request
377 * @param argument68 Argument for concurrent request
378 * @param argument69 Argument for concurrent request
379 * @param argument70 Argument for concurrent request
380 * @param argument71 Argument for concurrent request
381 * @param argument72 Argument for concurrent request
382 * @param argument73 Argument for concurrent request
383 * @param argument74 Argument for concurrent request
384 * @param argument75 Argument for concurrent request
385 * @param argument76 Argument for concurrent request
386 * @param argument77 Argument for concurrent request
387 * @param argument78 Argument for concurrent request
388 * @param argument79 Argument for concurrent request
389 * @param argument80 Argument for concurrent request
390 * @param argument81 Argument for concurrent request
391 * @param argument82 Argument for concurrent request
392 * @param argument83 Argument for concurrent request
393 * @param argument84 Argument for concurrent request
394 * @param argument85 Argument for concurrent request
395 * @param argument86 Argument for concurrent request
396 * @param argument87 Argument for concurrent request
397 * @param argument88 Argument for concurrent request
398 * @param argument89 Argument for concurrent request
399 * @param argument90 Argument for concurrent request
400 * @param argument91 Argument for concurrent request
401 * @param argument92 Argument for concurrent request
402 * @param argument93 Argument for concurrent request
403 * @param argument94 Argument for concurrent request
404 * @param argument95 Argument for concurrent request
405 * @param argument96 Argument for concurrent request
406 * @param argument97 Argument for concurrent request
407 * @param argument98 Argument for concurrent request
408 * @param argument99 Argument for concurrent request
409 * @param argument100 Argument for concurrent request
410 * @return Returns TRUE on successful completion, FALSE otherwise
411 * @rep:displayname Submit Program
412 * @rep:scope public
413 * @rep:lifecycle active
414 * @rep:compatibility S
415 */
416 function submit_program (
417 application IN varchar2 default NULL,
418 program IN varchar2 default NULL,
419 stage IN varchar2 default NULL,
420 argument1 IN varchar2 default CHR(0),
421 argument2 IN varchar2 default CHR(0),
422 argument3 IN varchar2 default CHR(0),
423 argument4 IN varchar2 default CHR(0),
424 argument5 IN varchar2 default CHR(0),
428 argument9 IN varchar2 default CHR(0),
425 argument6 IN varchar2 default CHR(0),
426 argument7 IN varchar2 default CHR(0),
427 argument8 IN varchar2 default CHR(0),
429 argument10 IN varchar2 default CHR(0),
430 argument11 IN varchar2 default CHR(0),
431 argument12 IN varchar2 default CHR(0),
432 argument13 IN varchar2 default CHR(0),
433 argument14 IN varchar2 default CHR(0),
434 argument15 IN varchar2 default CHR(0),
435 argument16 IN varchar2 default CHR(0),
436 argument17 IN varchar2 default CHR(0),
437 argument18 IN varchar2 default CHR(0),
438 argument19 IN varchar2 default CHR(0),
439 argument20 IN varchar2 default CHR(0),
440 argument21 IN varchar2 default CHR(0),
441 argument22 IN varchar2 default CHR(0),
442 argument23 IN varchar2 default CHR(0),
443 argument24 IN varchar2 default CHR(0),
444 argument25 IN varchar2 default CHR(0),
445 argument26 IN varchar2 default CHR(0),
446 argument27 IN varchar2 default CHR(0),
447 argument28 IN varchar2 default CHR(0),
448 argument29 IN varchar2 default CHR(0),
449 argument30 IN varchar2 default CHR(0),
450 argument31 IN varchar2 default CHR(0),
451 argument32 IN varchar2 default CHR(0),
452 argument33 IN varchar2 default CHR(0),
453 argument34 IN varchar2 default CHR(0),
454 argument35 IN varchar2 default CHR(0),
455 argument36 IN varchar2 default CHR(0),
456 argument37 IN varchar2 default CHR(0),
457 argument38 IN varchar2 default CHR(0),
458 argument39 IN varchar2 default CHR(0),
459 argument40 IN varchar2 default CHR(0),
460 argument41 IN varchar2 default CHR(0),
461 argument42 IN varchar2 default CHR(0),
462 argument43 IN varchar2 default CHR(0),
463 argument44 IN varchar2 default CHR(0),
464 argument45 IN varchar2 default CHR(0),
465 argument46 IN varchar2 default CHR(0),
466 argument47 IN varchar2 default CHR(0),
467 argument48 IN varchar2 default CHR(0),
468 argument49 IN varchar2 default CHR(0),
469 argument50 IN varchar2 default CHR(0),
470 argument51 IN varchar2 default CHR(0),
471 argument52 IN varchar2 default CHR(0),
472 argument53 IN varchar2 default CHR(0),
473 argument54 IN varchar2 default CHR(0),
474 argument55 IN varchar2 default CHR(0),
475 argument56 IN varchar2 default CHR(0),
476 argument57 IN varchar2 default CHR(0),
477 argument58 IN varchar2 default CHR(0),
478 argument59 IN varchar2 default CHR(0),
479 argument60 IN varchar2 default CHR(0),
480 argument61 IN varchar2 default CHR(0),
481 argument62 IN varchar2 default CHR(0),
482 argument63 IN varchar2 default CHR(0),
483 argument64 IN varchar2 default CHR(0),
484 argument65 IN varchar2 default CHR(0),
485 argument66 IN varchar2 default CHR(0),
486 argument67 IN varchar2 default CHR(0),
487 argument68 IN varchar2 default CHR(0),
488 argument69 IN varchar2 default CHR(0),
489 argument70 IN varchar2 default CHR(0),
490 argument71 IN varchar2 default CHR(0),
491 argument72 IN varchar2 default CHR(0),
492 argument73 IN varchar2 default CHR(0),
493 argument74 IN varchar2 default CHR(0),
494 argument75 IN varchar2 default CHR(0),
495 argument76 IN varchar2 default CHR(0),
496 argument77 IN varchar2 default CHR(0),
497 argument78 IN varchar2 default CHR(0),
498 argument79 IN varchar2 default CHR(0),
499 argument80 IN varchar2 default CHR(0),
500 argument81 IN varchar2 default CHR(0),
501 argument82 IN varchar2 default CHR(0),
502 argument83 IN varchar2 default CHR(0),
503 argument84 IN varchar2 default CHR(0),
504 argument85 IN varchar2 default CHR(0),
505 argument86 IN varchar2 default CHR(0),
506 argument87 IN varchar2 default CHR(0),
507 argument88 IN varchar2 default CHR(0),
508 argument89 IN varchar2 default CHR(0),
509 argument90 IN varchar2 default CHR(0),
510 argument91 IN varchar2 default CHR(0),
511 argument92 IN varchar2 default CHR(0),
512 argument93 IN varchar2 default CHR(0),
513 argument94 IN varchar2 default CHR(0),
514 argument95 IN varchar2 default CHR(0),
515 argument96 IN varchar2 default CHR(0),
516 argument97 IN varchar2 default CHR(0),
517 argument98 IN varchar2 default CHR(0),
518 argument99 IN varchar2 default CHR(0),
519 argument100 IN varchar2 default CHR(0))
520 return boolean;
521
522 -- --
523 -- Name
524 -- submit_set
525 -- Purpose
526 -- Call this function to submit the request set which is set by using the
527 -- set_request_set.
528 -- It will check whether each program in the request set is submitted
529 -- by using submit_program or not.
530 -- If the request completes successfully, this function returns the
531 -- concurrent request ID of the parent request set; otherwise;
532 -- it returns 0.
533 -- Arguments
534 -- None
535 /*#
536 * Submits a request set for execution in the concurrent processing system
537 * @param start_time The time at which the request should start running
538 * @param sub_request Set to TRUE if the request is submitted from another request and should be treated as a sub-request
539 * @return Returns the concurrent program ID on successful submission, otherwise it returns '0'
540 * @rep:displayname Message
541 * @rep:scope public
542 * @rep:lifecycle active
543 * @rep:compatibility S
544 */
545 function submit_set ( start_time IN varchar2 default null,
546 sub_request In boolean default FALSE)
547 return integer;
548
549 procedure set_dest_ops(ops_id IN number default NULL);
550
551
552 --
553 -- Name
554 -- add_layout
555 -- Purpose
556 -- Called before submission to add layout options to a request.
557 --
558 -- Arguments
559 -- template_appl_name - Template application short name
560 -- template_code - Template code
561 -- template_language - ISO 2-letter language code
562 -- template_territory - ISO 2-letter territory code
563 -- output_format - Output format type of the final output
564 function add_layout(template_appl_name in varchar2,
565 template_code in varchar2,
566 template_language in varchar2,
567 template_territory in varchar2,
568 output_format in varchar2) return boolean;
569
570 -- Bug5680619 & 5680669
571 -- Name
572 -- justify_program
573 -- Purpose
574 -- It lists all the disabled program in request set
575 -- Call this function at the first step of the submission of a concurrent
576 -- request set transaction.
577 -- It returns a string containing all disabled program name based on
578 -- the criticality
579 -- Arguments
580 -- template_appl_name - Template application short name
581 -- template_request_set_name - Template Request Set Name
582
583 function justify_program(template_appl_name in varchar2,
584 template_request_set_name in varchar2) return varchar2;
585
586 end FND_SUBMIT;
[Home] [Help]