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