1 PACKAGE fnd_set AS
2 /* $Header: AFRSSETS.pls 120.3 2006/04/06 01:57:42 ktanneru ship $ */
3 /*#
4 * Includes procedures for creating concurrentprogram request sets, adding programs to a request set, deletingprograms from a
5 * request set, and defining parameters for request sets. If an error is detected, the "ORA-06501: PL/SQL: internal error" is raised.
6 * The error message can be retrieved by a call to the functionfnd_set.message(). Some errors are not trapped by the package,
7 * notably "duplicate value on index".
8 * @rep:scope public
9 * @rep:product FND
10 * @rep:displayname Request Set
11 * @rep:category BUSINESS_ENTITY FND_CP_REQUEST_SET
12 * @rep:lifecycle active
13 * @rep:compatibility S
14 */
15
16 PROCEDURE debug_on ;
17
18
19 PROCEDURE debug_off ;
20
21 --
22 -- Procedure
23 -- SET_SESSION_MODE
24 --
25 -- Purpose
26 -- Sets the package mode for the current session.
27 --
28 -- Arguments:
29 -- session_mode - 'seed_data' if new data is for Datamerge.
30 -- 'customer_data' is the default.
31 --
32 PROCEDURE set_session_mode(session_mode IN VARCHAR2);
33
34
35 -- Function
36 -- MESSAGE
37 --
38 -- Purpose
39 -- Return an error message. Messages are set when
40 -- validation (program) errors occur.
41 --
42 /*#
43 * Use the message function to return an error message. Messages are set when any validation errors occur.
44 * @return err_msg Returns error message
45 * @rep:displayname Message
46 * @rep:scope public
47 * @rep:lifecycle active
48 * @rep:compatibility S
49 */
50 FUNCTION message RETURN VARCHAR2 ;
51
52
53
54 -- Procedure
55 -- CREATE_SET
56 --
57 -- Purpose
58 -- Register a request set.
59 --
60 -- Arguments
61 -- name - Name of request set.
62 -- short_name - Short name. Dev key.
63 -- application - Short name of set's application.
64 -- description - Optional description of the set.
65 -- owner - Optional user ID of set owner. (e.g. SYSADMIN)
66 -- start_date - Date set becomes effective.
67 -- end_date - Optional date set becomes outdated.
68 -- print_together - 'Y' or 'N'
69 -- incompatibilities_allowed - 'Y' or 'N'
70 -- language_code - Language code for the above data. (e.g. US)
71 --
72 /*#
73 * Registers a request set for use within the concurrent processing system
74 * @param name The name of the new request set
75 * @param short_name The short name of the request set
76 * @param application The application that owns the request set
77 * @param description An optional description of the set
78 * @param owner An optional oracle application user ID identifying the set owner
79 * @param start_date The date the set becomes effective
80 * @param end_date An optional date on which the set becomes outdated
81 * @param print_together Specify 'Y' or 'N' to indicate whether all the reports in a set should print at the same time
82 * @param incompatibilities_allowed Specify 'Y' or 'N' to indicate whether to allow incompatibilities for this set
83 * @param language_code Language code for the above data
84 * @return none
85 * @rep:displayname Create Request Set
86 * @rep:scope public
87 * @rep:lifecycle active
88 * @rep:compatibility S
89 */
90 PROCEDURE create_set( name IN VARCHAR2,
91 short_name IN VARCHAR2,
92 application IN VARCHAR2,
93 description IN VARCHAR2 DEFAULT NULL,
94 owner IN VARCHAR2 DEFAULT NULL,
95 start_date IN DATE DEFAULT SYSDATE,
96 end_date IN DATE DEFAULT NULL,
97 print_together IN VARCHAR2 DEFAULT 'N',
98 incompatibilities_allowed IN VARCHAR2 DEFAULT 'N',
99 language_code IN VARCHAR2 DEFAULT 'US');
100
101
102 -- Procedure
103 -- Incompatibility
104 --
105 -- Purpose
106 -- Register an incompatibility for a set or stage.
107 --
108 -- Examples:
109 -- 1. Set X is incompatible with program Y
110 -- fnd_set.incompatibility(request_set=>'X',
111 -- application=>'APPX',
112 -- inc_prog_short_name=>'Y',
113 -- inc_prog_application=>'APPY');
114 --
115 -- 2. Set X is incompatible withset Y.
116 -- fnd_set.incompatibility(request_set=>'X',
117 -- application=>'APPX',
118 -- inc_request_set=>'Y',
119 -- inc_set_application=>'APPY');
120 --
121 -- 3. Set X is incompatible with stage 2 of set Y.
122 -- fnd_set.incompatibility(request_set=>'X',
123 -- application=>'APPX',
124 -- inc_request_set=>'Y',
125 -- inc_set_application=>'APPY',
126 -- inc_stage_number=>2);
127 --
128 -- 4. Stage 3 of set X is incompatable with program Y.
129 -- fnd_set.incompatibility(request_set=>'X',
130 -- application=>'APPX',
131 -- stage_number=>3,
132 -- inc_prog_short_name=>'Y',
133 -- inc_prog_application=>'APPY');
134 --
135 --
136 -- Arguments
137 -- request_set - Request set short name.
138 -- application - Application short name of request set.
139 -- stage - Stage short name (for stage incompatibility).
140 -- inc_prog - Short name of the incompatible program.
141 -- inc_prog_application- Application of the incompatible program.
142 -- inc_request_set - Sort name of the incompatible reuqest set.
143 -- inc_set_application - Applicaiton short name of the incompatible set.
144 -- inc_stage - Stage short name to the incompatible stage.
145 -- inc_type - Incompatibility type - (D)omain-specific or (G)lobal
146 --
147 /*#
148 * Registers an incompatibility for a set or a stage
149 * @param request_set The short name of the request set
150 * @param application The short name of the application that owns the request set
151 * @param stage The short name of the stage
152 * @param inc_prog The short name of the incompatible program
153 * @param inc_prog_application The short name of the application that owns the incompatible program
154 * @param inc_request_set The short name of the incompatible request set
155 * @param inc_set_application The short name of the application that owns the incompatible request set
156 * @param inc_stage The short name of the incompatible stage
157 * @param inc_type The type of incompatibility. 'D' if Domain-specific, 'G' if Global.
158 * @rep:displayname Register Incompatibility
159 * @rep:scope public
160 * @rep:lifecycle active
161 * @rep:compatibility S
162 */
163 PROCEDURE incompatibility(request_set IN VARCHAR2,
164 application IN VARCHAR2,
165 stage IN VARCHAR2 DEFAULT NULL,
166 inc_prog IN VARCHAR2 DEFAULT NULL,
167 inc_prog_application IN VARCHAR2 DEFAULT NULL,
168 inc_request_set IN VARCHAR2 DEFAULT NULL,
169 inc_set_application IN VARCHAR2 DEFAULT NULL,
170 inc_stage IN VARCHAR2 DEFAULT NULL,
171 inc_type IN VARCHAR2 DEFAULT 'D');
172
173
174
175 -- Procedure
176 -- ADD_STAGE
177 --
178 -- Purpose
179 -- Add a stage to a request set.
180 --
181 -- Arguments
182 -- name - Stage name.
183 -- request_set - Short name of request set.
184 -- set_application - Application short name of the request_set.
185 -- short_name - Stage short (non-translated) name.
186 -- description - Stage description.
187 -- display_sequence - Display sequence.
188 -- function_short_name - Function (executable) short name.
189 -- function_application - Function application short name.
190 -- critical - Is this a "critical" stage? (Use in set outcome.)
191 -- incompatibilities_allowed - 'Y' or 'N'
192 -- start_stage - Is this the start stage for the set? 'Y' or 'N'
193 -- language_code - Language code for the above data. (e.g. US)
194 --
195 /*#
196 * Adds a stage to a request set
197 * @param name Name of the stage
198 * @param request_set The short name of the request set
199 * @param set_application The short name of the application that owns the request set
200 * @param short_name The short name of the stage
201 * @param description The description of the stage
202 * @param display_sequence The display sequence
203 * @param function_short_name Accept the default, 'FNDRSSTE', the Standard Stage Evaluation function
204 * @param function_application Accept the default, 'FND'
205 * @param critical Specify 'Y' if the return value of the stage affects the completion status of the request set
206 * @param incompatibilities_allowed Specify 'Y' or 'N' to allow the incompatibilities for this program or not
207 * @param start_stage Specify 'Y' or 'N' to indicate whether this stage is the start stage for the set
208 * @param language_code The language code for the above data
209 * @rep:displayname Add Stage to Request Set
210 * @rep:scope public
211 * @rep:lifecycle active
212 * @rep:compatibility S
213 */
214 PROCEDURE add_stage(name IN VARCHAR2,
215 request_set IN VARCHAR2,
216 set_application IN VARCHAR2,
217 short_name IN VARCHAR2,
218 description IN VARCHAR2 DEFAULT NULL,
219 display_sequence IN NUMBER,
220 function_short_name IN VARCHAR2
221 DEFAULT 'FNDRSSTE',
222 function_application IN VARCHAR2 DEFAULT 'FND',
223 critical IN VARCHAR2 DEFAULT 'N',
224 incompatibilities_allowed IN VARCHAR2 DEFAULT 'N',
225 start_stage IN VARCHAR2 DEFAULT 'N',
226 language_code IN VARCHAR2 DEFAULT 'US'
227 );
228
229
230 -- Procedure
231 -- Link_Stages
232 --
233 -- Purpose
234 -- Link Two Stages.
235 --
236 -- Arguments
237 -- request_set - Short name of request set.
238 -- set_application - Application of the request set.
239 -- from_stage - From stage short name.
240 -- to_stage - To stage short name. (null to erase a link)
241 -- success - Create success link. 'Y' or 'N'
242 -- warning - Create warning link. 'Y' or 'N'
243 -- error - Create error link. 'Y' or 'N'
244 --
245 /*#
246 * Links two stages in a given request set
247 * @param request_set The short name of the request set
248 * @param set_application The short name of the application that owns the request set
249 * @param from_stage The short name of the 'from' stage
250 * @param to_stage The short name of the 'to' stage
251 * @param success Create success link, specify 'Y' or 'N'
252 * @param warning Create warning link, specify 'Y' or 'N'
253 * @param error Create error link, specify 'Y' or 'N'
254 * @rep:displayname Link Stages
255 * @rep:scope public
256 * @rep:lifecycle active
257 * @rep:compatibility S
258 */
259 procedure link_stages (request_set varchar2,
260 set_application varchar2,
261 from_stage varchar2,
262 to_stage varchar2 default null,
263 success varchar2 default 'N',
264 warning varchar2 default 'N',
265 error varchar2 default 'N');
266
267
268 -- Procedure
269 -- ADD_PROGRAM
270 --
271 -- Purpose
272 -- Add a concurrent program to a request set stage.
273 --
274 -- Arguments
275 -- program - Short name of the program. (e.g. FNDSCRMT)
276 -- program_application - Application short name of the program.(e.g. 'FND')
277 -- request_set - Short name of request set.
278 -- set_application - Application of the request set.
279 -- stage - Stage short name.
280 -- program_sequence - Must be unique!
281 -- critical - Can this program affect the stage outcome?
282 -- number_of_copies - Copies to Print. (optional)
283 -- save_output - 'Y' or 'N'
284 -- style - Print style name. (optional)
285 -- printer - Printer name. (optional)
286 --
287 /*#
288 * Adds a concurrent program to a stage in a given request set
289 * @param program The short name that is used as the developer name of the concurrent program
290 * @param program_application The short name of the application that owns the concurrent program
291 * @param request_set The short name of the request set
292 * @param set_application The application that owns the request set
293 * @param stage The short name of the stage
294 * @param program_sequence The sequence number of this program in the stage
295 * @param critical Specify 'Y' if this program can affect the stage's outcome
296 * @param number_of_copies An optional default for the number of copies to print
297 * @param save_output Specify 'Y' to allow users to save output
298 * @param style Optionally provide a default print style
299 * @param printer Optionally provide a default printer
300 * @rep:displayname Add Program
301 * @rep:scope public
302 * @rep:lifecycle active
303 * @rep:compatibility S
304 */
305 PROCEDURE add_program(program IN VARCHAR2,
306 program_application IN VARCHAR2,
307 request_set IN VARCHAR2,
308 set_application IN VARCHAR2,
309 stage IN VARCHAR2,
310 program_sequence IN NUMBER,
311 critical IN VARCHAR2 DEFAULT 'Y',
312 number_of_copies IN NUMBER DEFAULT 0,
313 save_output IN VARCHAR2 DEFAULT 'Y',
314 style IN VARCHAR2 DEFAULT NULL,
315 printer IN VARCHAR2 DEFAULT NULL);
316
317
318 -- Procedure
319 -- REMOVE_STAGE
320 --
321 -- Purpose
322 -- Remove a stage from a request set.
323 --
324 -- Arguments
325 -- request_set - Short name of request set.
326 -- set_application - Application short name of the request set.
327 -- stage - Stage short name.
328 --
329 /*#
330 * Removes a Stage from a given request set
331 * @param request_set The short name of the request set
332 * @param set_application The short name of the application that owns the request set
333 * @param stage The short name of the stage
334 * @rep:displayname Remove Stage
335 * @rep:scope public
336 * @rep:lifecycle active
337 * @rep:compatibility S
338 */
339 PROCEDURE remove_stage(request_set IN VARCHAR2,
340 set_application IN VARCHAR2,
341 stage IN VARCHAR2);
342
343
344
345 -- Procedure
346 -- REMOVE_PROGRAM
347 --
348 -- Purpose
349 -- Remove a concurrent program from a request set.
350 --
351 -- Arguments
352 -- program - Short name of the program. (e.g. FNDSCRMT)
353 -- program_application - Application of the program. (e.g. 'FND')
354 -- request_set - Short name of request set.
355 -- set_application - Application short name of the request set.
356 -- stage - Stage short name.
357 -- program_sequence - Program sequence number.
358 --
362 * @param program_application The short name of the application that owns the program
359 /*#
360 * Removes a concurrent program from a stage in a request set
361 * @param program The short name used as the developer name of the concurrent program
363 * @param request_set The short name of the request set
364 * @param set_application The short name of the application that owns the request set
365 * @param stage The short name of the stage
366 * @param program_sequence The sequence number of this program in the stage
367 * @rep:displayname Remove Program
368 * @rep:scope public
369 * @rep:lifecycle active
370 * @rep:compatibility S
371 */
372 PROCEDURE remove_program(program IN VARCHAR2,
373 program_application IN VARCHAR2,
374 request_set IN VARCHAR2,
375 set_application IN VARCHAR2,
376 stage IN VARCHAR2,
377 program_sequence IN NUMBER);
378
379
380
381 -- Procedure
382 -- PROGRAM_PARAMETER
383 --
384 -- Purpose
385 -- Register a parameter for a request set program
386 --
387 -- Arguments:
388 -- program - e.g. FNDSCRMT
389 -- application - Program application. e.g.'FND'
390 -- request_set - Short name of request set.
391 -- set_application - Application short name of the request set.
392 -- stage - Stage_short_name.
393 -- program_sequence - Program sequence number.
394 -- parameter - Name of the program parameter. (NOT the prompt!)
395 -- display - 'Y' or 'N'
396 -- modify - 'Y' or 'N'
397 -- shared_parameter - Name of shared parameter. (optional)
398 -- default_type - 'Constant', 'Profile', 'SQL Statement', 'Segment'
399 -- (Optional)
400 -- default_value - Parameter default (Required if default_type is not
401 -- Null)
402 --
403 /*#
404 * Registers the shared parameter information and the request set level overrides of program parameter attributes
405 * @param program The short name used as the developer name of the concurrent program
406 * @param program_application The short name of the application that owns the concurrent program
407 * @param request_set The short name of the request set
408 * @param set_application The short name of the application that owns the request set
409 * @param stage The short name of the stage
410 * @param program_sequence The sequence number of this program in the stage
411 * @param parameter The name of the program parameter
412 * @param display Specify 'Y' to display parameter, and 'N' to hide it
413 * @param modify Specify 'Y' to allow users to modify the parameter value, and 'N' to prevent it
414 * @param shared_parameter If the parameter uses a shared parameter enter the shared parameter name here
415 * @param default_type If the parameters uses a default, enter the type here
416 * @param default_value If the parameter uses a default, enter a value appropriate for the default here
417 * @rep:displayname Register program parameter
418 * @rep:scope public
419 * @rep:lifecycle active
420 * @rep:compatibility S
421 */
422 PROCEDURE program_parameter(
423 program IN VARCHAR2,
424 program_application IN VARCHAR2,
425 request_set IN VARCHAR2,
426 set_application IN VARCHAR2,
427 stage IN VARCHAR2,
428 program_sequence IN NUMBER,
429 parameter IN VARCHAR2,
430 display IN VARCHAR2 DEFAULT 'Y',
431 modify IN VARCHAR2 DEFAULT 'Y',
432 shared_parameter IN VARCHAR2 DEFAULT NULL,
433 default_type IN VARCHAR2 DEFAULT NULL,
434 default_value IN VARCHAR2 DEFAULT NULL);
435
436
437
438
439 -- Procedure
440 -- ADD_SET_TO_GROUP
441 --
442 -- Purpose
443 -- Add a request set to a request group.
444 --
445 -- Arguments
446 -- request_set - Short name of set.
447 -- set_application - Application short name of the set.
448 -- request_group - Name of request group.
449 -- group_application - Application of the request group.
450 --
451 /*#
452 * Adds a request set to a specific request group
453 * @param request_set The short name of the request set to add to request group
454 * @param set_application The short name of the application that owns the request set
455 * @param request_group The request group to which the request set has to be added
456 * @param group_application The application that owns the request group
457 * @rep:displayname Add Request Set to Group
458 * @rep:scope public
459 * @rep:lifecycle active
460 * @rep:compatibility S
461 */
462 PROCEDURE add_set_to_group(request_set IN VARCHAR2,
463 set_application IN VARCHAR2,
464 request_group IN VARCHAR2,
465 group_application IN VARCHAR2);
466
467
468
469 -- Procedure
470 -- REMOVE_SET_FROM_GROUP
471 --
472 -- Purpose
473 -- Remove a set from a request group.
474 --
475 -- Arguments
476 -- request_set - Short name of set.
480 --
477 -- set_application - Application short name of the set.
478 -- request_group - Name of request group.
479 -- group_application - Application of the request group.
481 /*#
482 * Removes request set from a specific request group
483 * @param request_set The short name of the request set to remove from the request group
484 * @param set_application The application that owns the request group
485 * @param request_group The request group from the request set has to be removed
486 * @param group_application The application that owns the request group
487 * @rep:displayname Remove Set from Group
488 * @rep:scope public
489 * @rep:lifecycle active
490 * @rep:compatibility S
491 */
492 PROCEDURE remove_set_from_group(request_set IN VARCHAR2,
493 set_application IN VARCHAR2,
494 request_group IN VARCHAR2,
495 group_application IN VARCHAR2);
496
497
498
499
500 -- Procedure
501 -- DELETE_PROGRAM_PARAMETER
502 --
503 -- Purpose
504 -- Delete a concurrent program request set parameter.
505 --
506 -- Arguments
507 -- program - Short name of the program. (e.g. FNDSCRMT)
508 -- program_application - Application short name of the program. (e.g. 'FND')
509 -- request_set - Short name of request set.
510 -- set_application - Application short name of the request set.
511 -- stage - Stage short name.
512 -- program_sequence - Program sequence number.
513 -- parameter - Name of the program parameter. (NOT the prompt!)
514 --
515 /*#
516 * Removes a concurrent request parameter for a program in a request set
517 * @param program The short name used as the developer name of the program
518 * @param program_application The short name of the application that owns the program
519 * @param request_set The short name of the request set
520 * @param set_application The short name of the application that owns the request set
521 * @param stage The short name of the stage
522 * @param program_sequence The sequence number of this program in the stage
523 * @param parameter The name of the program parameter to delete
524 * @rep:displayname Delete program parameter
525 * @rep:scope public
526 * @rep:lifecycle active
527 * @rep:compatibility S
528 */
529 PROCEDURE delete_program_parameter(program IN VARCHAR2,
530 program_application IN VARCHAR2,
531 request_set IN VARCHAR2 DEFAULT NULL,
532 stage IN VARCHAR2,
533 set_application IN VARCHAR2,
534 program_sequence IN NUMBER,
535 parameter IN VARCHAR2);
536
537
538
539 -- Procedure
540 -- DELETE_SET
541 --
542 -- Purpose
543 -- Delete a request set, and references to that set.
544 --
545 -- Arguments
546 -- request_set - Short name of the set.
547 -- application - Application short name of the set.
548 --
549 /*#
550 * Deletes a Request Set from the concurrent processing system
551 * @param request_set The short name of the request set to delete
552 * @param application The short name of the application that owns the request set
553 * @rep:displayname Delete Request Set
554 * @rep:scope public
555 * @rep:lifecycle active
556 * @rep:compatibility S
557 */
558 PROCEDURE delete_set(request_set IN VARCHAR2,
559 application IN VARCHAR2);
560
561
562
563
564 -- Procedure
565 -- DELETE_INCOMPATIBILITY
566 --
567 -- Purpose
568 -- Delete a request set incompatibility rule.
569 --
570 -- Arguments
571 -- request_set - Short name of the request set.
572 -- application - Application short name of the request set.
573 -- stage - Stage short name (for stage incompatibility).
574 -- inc_prog - Short name of the incompatible program.
575 -- inc_prog_application- Application of the incompatible program.
576 -- inc_request_set - Sort name of the incompatible reuqest set.
577 -- inc_set_application - Application short name of the incompatible set.
578 -- inc_stage - Stage short name the incompatible stage.
579 --
580 -- See examples from fnd_set.incompatibility() for argument usage.
581 --
582 /*#
583 * Deletes a request incompatibility rule
584 * @param request_set The short name of the request set
585 * @param application The short name of the application that owns the request set
586 * @param stage The short name of the stage
587 * @param inc_prog The short name of the incompatible program
588 * @param inc_prog_application The short name of the application that owns the incompatible program
589 * @param inc_request_set The short name of the incompatible request set
590 * @param inc_set_application The short name of the application that owns the incompatible request set
591 * @param inc_stage The short name of the incompatible stage
592 * @rep:displayname Delete Incompatibility
593 * @rep:scope public
594 * @rep:lifecycle active
595 * @rep:compatibility S
596 */
597 PROCEDURE delete_incompatibility(request_set IN VARCHAR2,
598 application IN VARCHAR2,
599 stage IN VARCHAR2 DEFAULT NULL,
603 inc_set_application IN VARCHAR2 DEFAULT NULL,
600 inc_prog IN VARCHAR2 DEFAULT NULL,
601 inc_prog_application IN VARCHAR2 DEFAULT NULL,
602 inc_request_set IN VARCHAR2 DEFAULT NULL,
604 inc_stage IN VARCHAR2 DEFAULT NULL);
605
606
607
608 -- Function
609 -- INCOMPATIBILITY_EXISTS
610 --
611 -- Purpose
612 -- Return TRUE if an incompatibility exists.
613 --
614 -- Arguments
615 -- request_set - Short name of the request set.
616 -- application - Application short name of the request set.
617 -- stage - Stage number (for stage incompatibility).
618 -- inc_prog - Short name of the incompatible program.
619 -- inc_prog_application- Application of the incompatible program.
620 -- inc_request_set - Sort name of the incompatible reuqest set.
621 -- inc_set_application - Application short name of the incompatible set.
622 -- inc_stage - Stage number to the incompatible stage.
623 --
624 -- See examples from fnd_set.incompatibility() for argument usage.
625 --
626 FUNCTION incompatibility_exists(request_set IN VARCHAR2,
627 application IN VARCHAR2,
628 stage IN VARCHAR2 DEFAULT NULL,
629 inc_prog IN VARCHAR2 DEFAULT NULL,
630 inc_prog_application IN VARCHAR2 DEFAULT NULL,
631 inc_request_set IN VARCHAR2 DEFAULT NULL,
632 inc_set_application IN VARCHAR2 DEFAULT NULL,
633 inc_stage IN VARCHAR2 DEFAULT NULL)
634 return boolean;
635
636
637
638 -- Function
639 -- REQUEST_SET_EXISTS
640 --
641 -- Purpose
642 -- Returns TRUE if a request set exists.
643 --
644 -- Arguments
645 -- request_set - Short name of the set.
646 -- application - Application short name of the request set.
647 --
648 FUNCTION request_set_exists(request_set IN VARCHAR2,
649 application IN VARCHAR2) RETURN BOOLEAN;
650
651
652 -- Function
653 -- STAGE_IN_SET
654 --
655 -- Purpose
656 -- Return TRUE if a stage is in a request set.
657 --
658 -- Arguments
659 -- stage - Stage short name.
660 -- request_set - Short name of request set.
661 -- set_application - Application short name of the request set.
662 -- program_sequence - Program sequence number.
663 --
664 FUNCTION stage_in_set(stage IN VARCHAR2,
665 request_set IN VARCHAR2,
666 set_application IN VARCHAR2)
667 RETURN BOOLEAN;
668
669
670 -- Function
671 -- PROGRAM_IN_STAGE
672 --
673 -- Purpose
674 -- Return TRUE if a program is in a request set stage.
675 --
676 -- Arguments
677 -- program - Short name of the program.
678 -- program_application - Application short name of the program.
679 -- request_set - Short name of request set.
680 -- set_application - Application short name of the request set.
681 -- stage - Stage short name.
682 -- program_sequence - Program sequence number.
683 --
684 FUNCTION program_in_stage(program IN VARCHAR2,
685 program_application IN VARCHAR2,
686 request_set IN VARCHAR2,
687 set_application IN VARCHAR2,
688 stage IN VARCHAR2,
689 program_sequence IN NUMBER)
690 RETURN BOOLEAN;
691
692
693 -- Function
694 -- PROGRAM_PARAMETER_EXISTS
695 --
696 -- Purpose
697 -- Return TRUE if a parameter has been registered for a request set.
698 --
699 -- Arguments
700 -- program - Short name of the program.
701 -- program_application - Application short name of the program.
702 -- request_set - Short name of request set.
703 -- set_application - Application short name of the request set.
704 -- stage - Stage short name.
705 -- program_sequence - Program sequence number.
706 -- parameter - Name of the program parameter. (NOT the prompt!)
707 --
708 FUNCTION program_parameter_exists(program IN VARCHAR2,
709 program_application IN VARCHAR2,
710 request_set IN VARCHAR2,
711 set_application IN VARCHAR2,
712 stage IN VARCHAR2,
713 program_sequence IN NUMBER,
714 parameter IN VARCHAR2)
715 RETURN BOOLEAN;
716
717
718 -- Function
719 -- SET_IN_GROUP
720 --
721 -- Purpose
722 -- Return TRUE if a request set is in a request group.
723 --
724 -- Arguments
725 -- request_set - Short name of set.
726 -- set_application - Application short name of the set.
727 -- request_group - Name of request group.
728 -- group_application - Application of the request group.
729 --
730 FUNCTION set_in_group(request_set IN VARCHAR2 DEFAULT NULL,
734 RETURN BOOLEAN;
731 set_application IN VARCHAR2,
732 request_group IN VARCHAR2,
733 group_application IN VARCHAR2)
735
736 -- Procedure
737 -- STAGE_FUNCTION
738 --
739 -- Purpose
740 -- Register a request set stage function.
741 --
742 -- Arguments
743 -- function_name - Name of function. (e.g. 'My Function')
744 -- application - Short name of function's application.
745 -- (e.g. 'FND')
746 -- short_name - Short (non-translated) name of the function.
747 -- description - Optional description of the function.
748 -- plsql_name - Name of pl/sql stored function.
749 -- icon_name - For future web interface. Use null for now.
750 -- language_code - Language code for the name and description.
751 -- (e.g. 'US')
752 --
753 PROCEDURE stage_function(function_name IN VARCHAR2,
754 application IN VARCHAR2,
755 short_name IN VARCHAR2,
756 description IN VARCHAR2 DEFAULT NULL,
757 plsql_name IN VARCHAR2,
758 icon_name IN VARCHAR2 DEFAULT NULL,
759 language_code IN VARCHAR2 DEFAULT 'US');
760
761
762 -- Function
763 -- FUNCTION_EXISTS
764 --
765 -- Purpose
766 -- Return TRUE if a stage function exists.
767 --
768 -- Arguments
769 -- funct - Short name of the function.
770 -- application - Application short name of the function.
771 --
772 FUNCTION function_exists(function_short_name IN VARCHAR2,
773 application IN VARCHAR2) RETURN BOOLEAN;
774
775
776 -- Function
777 -- DELETE_FUNCTION
778 --
779 -- Purpose
780 -- Delete a stage function.
781 --
782 -- Arguments
783 -- function_short_name - Short name of the function.
784 -- application - Application short name of the function.
785 --
786 PROCEDURE delete_function(function_short_name IN VARCHAR2,
787 application IN VARCHAR2);
788
789
790 -- Function
791 -- FUNCTION_IN_GROUP
792 --
793 -- Purpose
794 -- Return TRUE if a stage is in a request group.
795 --
796 -- Arguments
797 -- function_short_name - Short name of set.
798 -- function_application - Application short name of the function.
799 -- request_group - Name of request group.
800 -- group_application - Application of the request group.
801 --
802 FUNCTION function_in_group(function_short_name IN VARCHAR2,
803 function_application IN VARCHAR2,
804 request_group IN VARCHAR2,
805 group_application IN VARCHAR2)
806 RETURN BOOLEAN;
807
808 -- Function
809 -- ADD_FUNCTION_TO_GROUP
810 --
811 -- Purpose
812 -- Adds a stage function to a request_group.
813 --
814 -- Arguments
815 -- function_short_name - Short name of set.
816 -- function_application - Application short name of the function.
817 -- request_group - Name of request group.
818 -- group_application - Application of the request group.
819 --
820 procedure add_function_to_group(function_short_name IN VARCHAR2,
821 function_application IN VARCHAR2,
822 request_group IN VARCHAR2,
823 group_application IN VARCHAR2);
824
825
826 -- Function
827 -- REMOVE_FUNCTION_FROM_GROUP
828 --
829 -- Purpose
830 -- Removes a stage function from a request_group.
831 --
832 -- Arguments
833 -- function_short_name - Short name of set.
834 -- function_application - Application short name of the function.
835 -- request_group - Name of request group.
836 -- group_application - Application of the request group.
837 --
838 procedure remove_function_from_group(function_short_name IN VARCHAR2,
839 function_application IN VARCHAR2,
840 request_group IN VARCHAR2,
841 group_application IN VARCHAR2);
842
843
844 -- Procedure
845 -- FUNCTION_PARAMETER
846 --
847 -- Purpose
848 -- Register a request set stage function parameter.
849 --
850 -- Arguments
851 -- function_short_name - Short (non-translated) name of the function.
852 -- application - Short name of function's application.
853 -- (e.g. 'FND')
854 -- paramter_name - Displayed name of parameter.
855 -- parameter_short_name - Short (non-translated) name of parameter.
856 -- description - Optional description of the function.
857 -- language_code - Language code for the name and description.
858 -- (e.g. 'US')
859 --
860 PROCEDURE function_parameter(function_short_name IN VARCHAR2,
861 application IN VARCHAR2,
862 parameter_name IN VARCHAR2,
866
863 parameter_short_name IN VARCHAR2,
864 description IN VARCHAR2 DEFAULT NULL,
865 language_code IN VARCHAR2 DEFAULT 'US');
867
868 -- Function
869 -- FUNCTION_PARAMETER_EXISTS
870 --
871 -- Purpose
872 -- Return TRUE if a stage function parameter exists.
873 --
874 -- Arguments
875 -- function_short_name - Short name of the function.
876 -- application - Application short name of the function.
877 -- parameter - Short (non-translated) name of parameter.
878 --
879 FUNCTION function_parameter_exists(function_short_name IN VARCHAR2,
880 application IN VARCHAR2,
881 parameter IN VARCHAR2)
882 RETURN BOOLEAN;
883
884
885 -- Function
886 -- DELETE_FUNCTION_PARAMETER
887 --
888 -- Purpose
889 -- Delete a stage function parameter.
890 --
891 -- Arguments
892 -- function_short_name - Short name of the function.
893 -- application - Application short name of the function.
894 -- parameter - Short (non-translated) name of parameter.
895 --
896 PROCEDURE delete_function_parameter(function_short_name IN VARCHAR2,
897 application IN VARCHAR2,
898 parameter IN VARCHAR2);
899
900
901 -- Function
902 -- FUNCTION_PARAMETER_VALUE
903 --
904 -- Purpose
905 -- Sets the value of a stage function parameter for a given stage.
906 --
907 -- Arguments
908 -- request_set - Short name of the request set.
909 -- set_application - Application short name of the set.
910 -- stage_short_name - Short name of stage.
911 -- parameter_short_name - Short name of parameter.
912 -- value - Value to which the paraemter is to be set.
913 --
914 PROCEDURE function_parameter_value(request_set IN VARCHAR2,
915 set_application IN VARCHAR2,
916 stage IN VARCHAR2,
917 parameter IN VARCHAR2,
918 value IN VARCHAR2);
919
920
921 -- Function
922 -- RESTART_REQUEST_SET
923 --
924 -- Purpose
925 -- Restarts an Request Set only if one of it's stages were failed in the last run.
926 --
927 -- Arguments
928 -- request_set_id - request_id of request set
929 --
930 -- Return
931 -- returns true if request set can be restarted, otherwise false.
932 --
933 FUNCTION restart_request_set( request_set_id IN number) RETURN BOOLEAN;
934
935
936
937 END fnd_set;
[Home] [Help]