[Home] [Help]
PACKAGE: APPS.PO_LOG
Source
1 PACKAGE PO_LOG AS
2 -- $Header: PO_LOG.pls 120.0 2005/06/02 01:46:40 appldev noship $
3
4 --
5 -- For more details on the PO logging strategy,
6 -- see the document at
7 -- /podev/po/internal/standards/logging/logging.xml
8 --
9
10 ---------------------------------------------------------------------------
11 -- CONSTANTS
12 ---------------------------------------------------------------------------
13
14 -- Constants to be used in generic level log routines for different data types.
15 c_STMT CONSTANT NUMBER := FND_LOG.LEVEL_STATEMENT;
16 c_PROC_BEGIN CONSTANT NUMBER := -1;
17 c_PROC_END CONSTANT NUMBER := -2;
18 c_PROC_RETURN CONSTANT NUMBER := -3;
19 c_PROC_RAISE CONSTANT NUMBER := -4;
20 c_EVENT CONSTANT NUMBER := FND_LOG.LEVEL_EVENT;
21 c_EXC CONSTANT NUMBER := FND_LOG.LEVEL_EXCEPTION;
22
23 --- Used as the p_rowid_tbl parameter to stmt_table
24 --- to indicate that all of the rows in the specified table
25 --- should be logged.
26 --- This is particularly useful for global temporary tables,
27 --- such as those used in submission check and encumbrance.
28 c_all_rows CONSTANT PO_TBL_VARCHAR2000 := PO_TBL_VARCHAR2000(CHR(0));
29
30 ---------------------------------------------------------------------------
31 -- VARIABLES
32 ---------------------------------------------------------------------------
33
34 --- Provided for convenience to callers of stmt_table.
35 d_rowid_tbl PO_TBL_VARCHAR2000;
36
37 --- Provided for convenience to callers of stmt_table.
38 d_column_tbl PO_TBL_VARCHAR30;
39
40 -- The following variables must be refreshed
41 -- whenever the Apps context changes.
42 -- The refresh should happen through a call to
43 -- PO_LOG.refresh_log_flags().
44 -- This should be done as part of package initialization
45 -- (in the initialization part of the package body),
46 -- and as a hook in the FND_GLOBAL.APPS_INITIALIZE procedure.
47 -- This can be accomplished through the
48 -- FND_PRODUCT_INITIALIZATION table and related package.
49
50 --- Indicates whether or not STATEMENT-level logging is active.
51 d_stmt BOOLEAN;
52
53 --- Indicates whether or not PROCEDURE-level logging is active.
54 d_proc BOOLEAN;
55
56 --- Indicates whether or not EVENT-level logging is active.
57 d_event BOOLEAN;
58
59 --- Indicates whether or not EXCEPTION-level logging is active.
60 d_exc BOOLEAN;
61
62 --- Indicates whether or not ERROR-level logging is active.
63 d_error BOOLEAN;
64
65 --- Indicates whether or not UNEXPECTED-level logging is active.
66 d_unexp BOOLEAN;
67
68
69
70 ---------------------------------------------------------------------------
71 -- PROCEDURES AND FUNCTIONS
72 ---------------------------------------------------------------------------
73
74 PROCEDURE enable_logging(
75 p_module IN VARCHAR2 DEFAULT 'p'||'o.%' -- GSCC File.Sql.6
76 , p_level IN NUMBER DEFAULT 1
77 );
78
79 PROCEDURE refresh_log_flags;
80
81 FUNCTION get_package_base(
82 p_package_name IN VARCHAR2
83 )
84 RETURN VARCHAR2;
85
86 FUNCTION get_subprogram_base(
87 p_package_base IN VARCHAR2
88 , p_subprogram_name IN VARCHAR2
89 )
90 RETURN VARCHAR2;
91
92
93
94
95 -- STATEMENT-level logging.
96
97 PROCEDURE stmt(
98 p_module_base IN VARCHAR2
99 , p_position IN NUMBER
100 , p_message_text IN VARCHAR2 DEFAULT NULL
101 );
102
103 PROCEDURE stmt(
104 p_module_base IN VARCHAR2
105 , p_position IN NUMBER
106 , p_variable_name IN VARCHAR2
107 , p_variable_value IN VARCHAR2
108 );
109
110 PROCEDURE stmt(
111 p_module_base IN VARCHAR2
112 , p_position IN NUMBER
113 , p_variable_name IN VARCHAR2
114 , p_variable_value IN NUMBER
115 );
116
117 PROCEDURE stmt(
118 p_module_base IN VARCHAR2
119 , p_position IN NUMBER
120 , p_variable_name IN VARCHAR2
121 , p_variable_value IN DATE
122 );
123
124 PROCEDURE stmt(
125 p_module_base IN VARCHAR2
126 , p_position IN NUMBER
127 , p_variable_name IN VARCHAR2
128 , p_variable_value IN BOOLEAN
129 );
130
131 PROCEDURE stmt(
132 p_module_base IN VARCHAR2
133 , p_position IN NUMBER
134 , p_variable_name IN VARCHAR2
135 , p_variable_value IN PO_TBL_NUMBER
136 );
137
138 PROCEDURE stmt(
139 p_module_base IN VARCHAR2
140 , p_position IN NUMBER
141 , p_variable_name IN VARCHAR2
142 , p_variable_value IN PO_TBL_DATE
143 );
144
145 PROCEDURE stmt(
146 p_module_base IN VARCHAR2
147 , p_position IN NUMBER
148 , p_variable_name IN VARCHAR2
149 , p_variable_value IN PO_TBL_VARCHAR1
150 );
151
152 PROCEDURE stmt(
153 p_module_base IN VARCHAR2
154 , p_position IN NUMBER
155 , p_variable_name IN VARCHAR2
156 , p_variable_value IN PO_TBL_VARCHAR5
157 );
158
159 PROCEDURE stmt(
160 p_module_base IN VARCHAR2
161 , p_position IN NUMBER
162 , p_variable_name IN VARCHAR2
163 , p_variable_value IN PO_TBL_VARCHAR30
164 );
165
166 PROCEDURE stmt(
167 p_module_base IN VARCHAR2
168 , p_position IN NUMBER
169 , p_variable_name IN VARCHAR2
170 , p_variable_value IN PO_TBL_VARCHAR100
171 );
172
173 PROCEDURE stmt(
174 p_module_base IN VARCHAR2
175 , p_position IN NUMBER
176 , p_variable_name IN VARCHAR2
177 , p_variable_value IN PO_TBL_VARCHAR2000
178 );
179
180 PROCEDURE stmt(
181 p_module_base IN VARCHAR2
182 , p_position IN NUMBER
183 , p_variable_name IN VARCHAR2
184 , p_variable_value IN PO_TBL_VARCHAR4000
185 );
186
187 PROCEDURE stmt_session_gt(
188 p_module_base IN VARCHAR2
189 , p_position IN NUMBER
190 , p_key IN NUMBER
191 , p_column_name_tbl IN PO_TBL_VARCHAR30 DEFAULT NULL
192 );
193
194 PROCEDURE stmt_table(
195 p_module_base IN VARCHAR2
196 , p_position IN NUMBER
197 , p_table_name IN VARCHAR2
198 , p_rowid_tbl IN PO_TBL_VARCHAR2000
199 , p_column_name_tbl IN PO_TBL_VARCHAR30 DEFAULT NULL
200 );
201
202 -- PROCEDURE-level logging.
203
204 PROCEDURE proc_begin(
205 p_module_base IN VARCHAR2
206 );
207
208 PROCEDURE proc_begin(
209 p_module_base IN VARCHAR2
210 , p_parameter_name IN VARCHAR2
211 , p_parameter_value IN VARCHAR2
212 );
213
214 PROCEDURE proc_begin(
215 p_module_base IN VARCHAR2
216 , p_parameter_name IN VARCHAR2
217 , p_parameter_value IN NUMBER
218 );
219
220 PROCEDURE proc_begin(
221 p_module_base IN VARCHAR2
222 , p_parameter_name IN VARCHAR2
223 , p_parameter_value IN DATE
224 );
225
226 PROCEDURE proc_begin(
227 p_module_base IN VARCHAR2
228 , p_parameter_name IN VARCHAR2
229 , p_parameter_value IN BOOLEAN
230 );
231
232 PROCEDURE proc_begin(
233 p_module_base IN VARCHAR2
234 , p_parameter_name IN VARCHAR2
235 , p_parameter_value IN PO_TBL_NUMBER
236 );
237
238 PROCEDURE proc_begin(
239 p_module_base IN VARCHAR2
240 , p_parameter_name IN VARCHAR2
241 , p_parameter_value IN PO_TBL_DATE
242 );
243
244 PROCEDURE proc_begin(
245 p_module_base IN VARCHAR2
246 , p_parameter_name IN VARCHAR2
247 , p_parameter_value IN PO_TBL_VARCHAR1
248 );
249
250 PROCEDURE proc_begin(
251 p_module_base IN VARCHAR2
252 , p_parameter_name IN VARCHAR2
253 , p_parameter_value IN PO_TBL_VARCHAR5
254 );
255
256 PROCEDURE proc_begin(
257 p_module_base IN VARCHAR2
258 , p_parameter_name IN VARCHAR2
259 , p_parameter_value IN PO_TBL_VARCHAR30
260 );
261
262 PROCEDURE proc_begin(
263 p_module_base IN VARCHAR2
264 , p_parameter_name IN VARCHAR2
265 , p_parameter_value IN PO_TBL_VARCHAR100
266 );
267
268 PROCEDURE proc_begin(
269 p_module_base IN VARCHAR2
270 , p_parameter_name IN VARCHAR2
271 , p_parameter_value IN PO_TBL_VARCHAR2000
272 );
273
274 PROCEDURE proc_begin(
275 p_module_base IN VARCHAR2
276 , p_parameter_name IN VARCHAR2
277 , p_parameter_value IN PO_TBL_VARCHAR4000
278 );
279
280 PROCEDURE proc_end(
281 p_module_base IN VARCHAR2
282 );
283
284 PROCEDURE proc_end(
285 p_module_base IN VARCHAR2
286 , p_parameter_name IN VARCHAR2
287 , p_parameter_value IN VARCHAR2
288 );
289
290 PROCEDURE proc_end(
291 p_module_base IN VARCHAR2
292 , p_parameter_name IN VARCHAR2
293 , p_parameter_value IN NUMBER
294 );
295
296 PROCEDURE proc_end(
297 p_module_base IN VARCHAR2
298 , p_parameter_name IN VARCHAR2
299 , p_parameter_value IN DATE
300 );
301
302 PROCEDURE proc_end(
303 p_module_base IN VARCHAR2
304 , p_parameter_name IN VARCHAR2
305 , p_parameter_value IN BOOLEAN
306 );
307
308 PROCEDURE proc_end(
309 p_module_base IN VARCHAR2
310 , p_parameter_name IN VARCHAR2
311 , p_parameter_value IN PO_TBL_NUMBER
312 );
313
314 PROCEDURE proc_end(
315 p_module_base IN VARCHAR2
316 , p_parameter_name IN VARCHAR2
317 , p_parameter_value IN PO_TBL_DATE
318 );
319
320 PROCEDURE proc_end(
321 p_module_base IN VARCHAR2
322 , p_parameter_name IN VARCHAR2
323 , p_parameter_value IN PO_TBL_VARCHAR1
324 );
325
326 PROCEDURE proc_end(
327 p_module_base IN VARCHAR2
328 , p_parameter_name IN VARCHAR2
329 , p_parameter_value IN PO_TBL_VARCHAR5
330 );
331
332 PROCEDURE proc_end(
333 p_module_base IN VARCHAR2
334 , p_parameter_name IN VARCHAR2
335 , p_parameter_value IN PO_TBL_VARCHAR30
336 );
337
338 PROCEDURE proc_end(
339 p_module_base IN VARCHAR2
340 , p_parameter_name IN VARCHAR2
341 , p_parameter_value IN PO_TBL_VARCHAR100
342 );
343
344 PROCEDURE proc_end(
345 p_module_base IN VARCHAR2
346 , p_parameter_name IN VARCHAR2
347 , p_parameter_value IN PO_TBL_VARCHAR2000
348 );
349
350 PROCEDURE proc_end(
351 p_module_base IN VARCHAR2
352 , p_parameter_name IN VARCHAR2
353 , p_parameter_value IN PO_TBL_VARCHAR4000
354 );
355
356 PROCEDURE proc_return(
357 p_module_base IN VARCHAR2
358 , p_return_value IN VARCHAR2
359 );
360
361 PROCEDURE proc_return(
362 p_module_base IN VARCHAR2
363 , p_return_value IN NUMBER
364 );
365
366 PROCEDURE proc_return(
367 p_module_base IN VARCHAR2
368 , p_return_value IN DATE
369 );
370
371 PROCEDURE proc_return(
372 p_module_base IN VARCHAR2
373 , p_return_value IN BOOLEAN
374 );
375
376 PROCEDURE proc_return(
377 p_module_base IN VARCHAR2
378 , p_return_value IN PO_TBL_NUMBER
379 );
380
381 PROCEDURE proc_return(
382 p_module_base IN VARCHAR2
383 , p_return_value IN PO_TBL_DATE
384 );
385
386 PROCEDURE proc_return(
387 p_module_base IN VARCHAR2
388 , p_return_value IN PO_TBL_VARCHAR1
389 );
390
391 PROCEDURE proc_return(
392 p_module_base IN VARCHAR2
393 , p_return_value IN PO_TBL_VARCHAR5
394 );
395
396 PROCEDURE proc_return(
397 p_module_base IN VARCHAR2
398 , p_return_value IN PO_TBL_VARCHAR30
399 );
400
401 PROCEDURE proc_return(
402 p_module_base IN VARCHAR2
403 , p_return_value IN PO_TBL_VARCHAR100
404 );
405
406 PROCEDURE proc_return(
407 p_module_base IN VARCHAR2
408 , p_return_value IN PO_TBL_VARCHAR2000
409 );
410
411 PROCEDURE proc_return(
412 p_module_base IN VARCHAR2
413 , p_return_value IN PO_TBL_VARCHAR4000
414 );
415
416 PROCEDURE proc_raise(
417 p_module_base IN VARCHAR2
418 );
419
420 -- EVENT-level logging.
421
422 PROCEDURE event(
423 p_module_base IN VARCHAR2
424 , p_position IN NUMBER
425 , p_message_text IN VARCHAR2
426 );
427
428 -- EXCEPTION-level logging.
429
430 PROCEDURE exc(
431 p_module_base IN VARCHAR2
432 , p_position IN NUMBER
433 , p_message_text IN VARCHAR2 DEFAULT NULL
434 );
435
436 -- Generic level logging for different data types.
437
438 PROCEDURE log(
439 p_log_level IN NUMBER
440 , p_module_base IN VARCHAR2
441 , p_module_suffix IN VARCHAR2
442 , p_variable_name IN VARCHAR2
443 , p_variable_value IN PO_VALIDATION_RESULTS_TYPE
444 );
445
446 END PO_LOG;