DBA Data[Home] [Help]

PACKAGE: APPS.FND_CONC_GLOBAL

Source


1 package FND_CONC_GLOBAL as
2 /* $Header: AFCPGBLS.pls 120.3 2006/04/05 01:36:41 ktanneru ship $ */
3 /*#
4  * This package is used for submitting sub-requests from PL/SQL concurrent programs.
5  * @rep:scope public
6  * @rep:product FND
7  * @rep:displayname Concurrent Global package
8  * @rep:category BUSINESS_ENTITY FND_CP_REQUEST
9  * @rep:lifecycle active
10  * @rep:compatibility S
11  */
12 
13 /*
14 ** CONC_COPIES - Number of copies to print for a concurrent process
15 */
16 function CONC_COPIES return number;
17 pragma restrict_references (CONC_COPIES, WNDS, WNPS);
18 
19 /*
20 ** CONC_HOLD - Temporarily hold a concurrent process
21 */
22 function CONC_HOLD return varchar2;
23 pragma restrict_references (CONC_HOLD, WNDS, WNPS);
24 
25 /*
26 ** CONC_PRIORITY - Priority for running a concurrent process
27 */
28 function CONC_PRIORITY return number;
29 pragma restrict_references (CONC_PRIORITY, WNDS, WNPS);
30 
31 /*
32 ** CONC_SAVE_OUTPUT - Save the output form a concurrent process
33 */
34 function CONC_SAVE_OUTPUT return varchar2;
35 pragma restrict_references (CONC_SAVE_OUTPUT, WNDS, WNPS);
36 
37 /*
38 ** CONC_SINGLE_THREAD - Single thread process the concurrent process
39 */
40 function CONC_SINGLE_THREAD return varchar2;
41 pragma restrict_references (CONC_SINGLE_THREAD, WNDS, WNPS);
42 
43 /*
44 ** PRINTER
45 */
46 function PRINTER return varchar2;
47 pragma restrict_references (PRINTER, WNDS, WNPS);
48 
49 /*
50 ** CONC_PRIORITY_REQUEST
51 */
52 function CONC_PRIORITY_REQUEST return number;
53 pragma restrict_references (CONC_PRIORITY_REQUEST, WNDS, WNPS);
54 
55 /*
56 ** CONC_PRINT_TOGETHER
57 */
58 function CONC_PRINT_TOGETHER return varchar2;
59 pragma restrict_references (CONC_PRINT_TOGETHER, WNDS, WNPS);
60 
61 /*
62 ** CONC_PRINT_OUTPUT
63 */
64 function CONC_PRINT_OUTPUT return varchar2;
65 pragma restrict_references (CONC_PRINT_OUTPUT, WNDS, WNPS);
66 
67 /*
68 ** REQUEST_DATA
69 */
70 
71 /*#
72  * Returns the state information saved by the parent request prior to being paused.
73  * @return Returns Request data
74  * @rep:displayname Get Request Data
75  * @rep:scope public
76  * @rep:lifecycle active
77  * @rep:compatibility S
78  */
79 function REQUEST_DATA return varchar2;
80 pragma restrict_references (REQUEST_DATA, WNDS, WNPS);
81 
82 /*
83 ** Override_OPS_INST_NUM
84 ** Used by Transaction Managers and Concurrent Managers.
85 ** INTERNAL AOL USE ONLY
86 */
87 procedure Override_OPS_INST_NUM(Inst_num in number);
88 
89 /*
90 ** OPS_INST_NUM
91 */
92 function OPS_INST_NUM return number;
93 pragma restrict_references (OPS_INST_NUM, WNDS, WNPS);
94 
95 /*
96 ** INITIALIZE
97 ** Set new values for CPM globals.
98 ** INTERNAL AOL USE ONLY
99 */
100 procedure INITIALIZE(conc_copies in number,
101 		     conc_hold in varchar2,
102 		     conc_priority in number,
103 		     conc_save_output in varchar2,
104 		     conc_single_thread in varchar2,
105 		     printer in varchar2,
106 		     conc_priority_request in number,
107 		     conc_print_together in varchar2,
108 		     conc_print_output in varchar2,
109 		     request_data in varchar2,
110 		     db_temp_dir in varchar2);
111 
112 /*
113 ** GET_REQ_GLOBALS
114 ** Used by CM to get values for special globals.
115 ** INTERNAL AOL USE ONLY
116 */
117 procedure GET_REQ_GLOBALS(conc_status         out nocopy varchar2,
118 		          request_data        out nocopy varchar2,
119 		          conc_restart_time   out nocopy varchar2,
120 			  release_sub_request out nocopy varchar2);
121 
122 /*
123 ** SET_REQ_GLOBALS
124 ** Used by CM to set values for special globals.
125 ** INTERNAL AOL USE ONLY
126 */
127 /*#
128  * Set the values for special global variables.
129  * @param conc_status Status of the parent request. This must be set to 'PAUSED'.
130  * @param request_data State information of the parent request. This will be used when the request is restarted.
131  * @param conc_restart_time Time (in the future) at which the parent should be restarted.
132  * @param release_sub_request Obsolete parameter (Do not use).
133  * @rep:displayname Set Request Globals
134  * @rep:scope public
135  * @rep:lifecycle active
136  * @rep:compatibility S
137  */
138 procedure SET_REQ_GLOBALS(conc_status         in varchar2 default null,
139 		          request_data        in varchar2 default null,
140 		          conc_restart_time   in varchar2 default null,
141 			  release_sub_request in varchar2 default null);
142 
143 
144 
145 end FND_CONC_GLOBAL;