1 package FND_AMP_PRIVATE AUTHID CURRENT_USER as
2 /* $Header: AFCPAMPS.pls 120.2.12000000.2 2007/10/05 19:51:53 ckclark ship $ */
3
4 --
5 -- Package
6 -- FND_AMP_PRIVATE
7 -- Purpose
8 -- Utilities for the Applications Management Pack
9 -- History
10 --
11 -- PUBLIC VARIABLES
12 --
13
14 -- Exceptions
15
16 -- Exception Pragmas
17
18 --
19 -- PUBLIC FUNCTIONS
20 --
21
22 --
23 -- Name
24 -- why_wait
25 -- Purpose
26 -- Returns a translated string describing the reaons why request1
27 -- is waiting on request2. If request1 is not waiting on request2,
28 -- then null is returned.
29 --
30 -- Request2 must be a pending or running program queued ahead of
31 -- request1, in the same conflict domain, with a queue_method_code of
32 -- 'B'. No checks are made on these constraints,
33 -- since this procedure is part of a data gatherer select
34 -- statement that must run fast.
35 --
36 --
37 function why_wait (request_id1 in number,
38 single_thread_flag1 in varchar2,
39 request_limit1 in varchar2,
40 requested_by1 in number,
41 program_appl1 in number,
42 program_id1 in number,
43 status_code1 in varchar2,
44 request_id2 in number,
45 single_thread_flag2 in varchar2,
46 request_limit2 in varchar2,
47 requested_by2 in number,
48 run_alone_flag2 in varchar2,
49 program_appl2 in number,
50 program_id2 in number,
51 is_sub_request2 in varchar2,
52 parent_request2 in number) return varchar2;
53
54 pragma restrict_references (why_wait, WNDS);
55
56
57 --
58 -- Name
59 -- get_phase
60 -- Purpose
61 -- Returns a translated phase description.
62 --
63 function get_phase (pcode in char,
64 scode in char,
65 hold in char,
66 enbld in char,
67 stdate in date,
68 rid in number) return varchar2;
69
70 pragma restrict_references (get_phase, WNDS);
71
72 --
73 -- Name
74 -- get_status
75 -- Purpose
76 -- Returns a translated status description.
77 --
78 function get_status (pcode in char,
79 scode in char,
80 hold in char,
81 enbld in char,
82 stdate in date,
83 rid in number) return varchar2;
84
85 pragma restrict_references (get_status, WNDS);
86
87
88 --
89 -- Name
90 -- kill_session
91 -- Purpose
92 -- Kills a session given an audsid.
93 --
94 -- Parameters:
95 -- audsid - ID of session to kill.
96 -- message - Oracle error message.
97 -- inst_id - Instance ID of session.
98 --
99 -- Returns:
100 -- 0 - Oracle error. Check message.
101 -- 1 - Session not found.
102 -- 2 - Success.
103 --
104 function kill_session (audsid in number,
105 message in out NOCOPY varchar2,
106 inst_id in number default 1) return number;
107
108
109 --
110 -- Name
111 -- cancel_request
112 -- Purpose
113 -- Cancel or terminate a request.
114 -- Make sure fnd_global.apps_initialize was called first.
115 --
116 -- WARNING: A commit will be issued on success.
117 --
118 -- Parameters:
119 -- req_id - ID of request to cancel.
120 -- message - Error message.
121 --
122 -- Returns:
123 -- 0 - Oracle error. Check message.
124 -- 1 - Could not lock request row
125 -- 2 - Request has already completed.
126 -- 3 - Request cancelled.
127 -- 4 - Request marked for termination.
128 --
129 function cancel_request ( req_id in number,
130 message in out NOCOPY varchar2) return number;
131
132
133 --
134 -- Name
135 -- toggle_hold
136 -- Purpose
137 -- Toggles the hold flag for a concurrent request.
138 -- Make sure fnd_global.apps_initialize was called first.
139 --
140 -- WARNING: A commit will be issued on success.
141 --
142 -- Parameters:
143 -- req_id - ID of request to toggle.
144 -- message - Error message.
145 --
146 -- Returns:
147 -- 0 - Oracle error. Check message.
148 -- 1 - Could not lock request row
149 -- 2 - Request has already started.
150 -- 3 - Request placed on hold.
151 -- 4 - Request hold removed.
152 --
153 function toggle_request_hold ( req_id in number,
154 message in out NOCOPY varchar2) return number;
155
156
157 --
158 -- Name
159 -- alter_priority
160 -- Purpose
161 -- Alters the priority for a concurrent request.
162 -- Make sure fnd_global.apps_initialize was called first.
163 --
164 -- WARNING: A commit will be issued on success.
165 --
166 -- Parameters:
167 -- req_id - ID of request to toggle.
168 -- new_priority - New priority.
169 -- message - Error message.
170 --
171 -- Returns:
172 -- 0 - Oracle error. Check message.
173 -- 1 - Could not lock request row
174 -- 2 - Request has already started.
175 -- 3 - Request priority altered.
176 --
177 function alter_request_priority ( req_id in number,
178 new_priority in number,
179 message in out NOCOPY varchar2) return number;
180
181
182
183
184
185 end FND_AMP_PRIVATE;
[Home] [Help]