[Home] [Help]
PACKAGE: APPS.PO_LOG
Source
1 PACKAGE PO_LOG AUTHID CURRENT_USER AS
2 -- $Header: PO_LOG.pls 120.1 2011/12/09 13:07:38 snelloru ship $
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 --new proc
195 PROCEDURE stmt_all_session_gt(
196 p_module_base IN VARCHAR2
197 , p_position IN NUMBER
198 , p_record_identifier IN VARCHAR2
199 );
200
201
202 PROCEDURE stmt_table(
203 p_module_base IN VARCHAR2
204 , p_position IN NUMBER
205 , p_table_name IN VARCHAR2
206 , p_rowid_tbl IN PO_TBL_VARCHAR2000
207 , p_column_name_tbl IN PO_TBL_VARCHAR30 DEFAULT NULL
208 );
209
210 -- PROCEDURE-level logging.
211
212 PROCEDURE proc_begin(
213 p_module_base IN VARCHAR2
214 );
215
216 PROCEDURE proc_begin(
217 p_module_base IN VARCHAR2
218 , p_parameter_name IN VARCHAR2
219 , p_parameter_value IN VARCHAR2
220 );
221
222 PROCEDURE proc_begin(
223 p_module_base IN VARCHAR2
224 , p_parameter_name IN VARCHAR2
225 , p_parameter_value IN NUMBER
226 );
227
228 PROCEDURE proc_begin(
229 p_module_base IN VARCHAR2
230 , p_parameter_name IN VARCHAR2
231 , p_parameter_value IN DATE
232 );
233
234 PROCEDURE proc_begin(
235 p_module_base IN VARCHAR2
236 , p_parameter_name IN VARCHAR2
237 , p_parameter_value IN BOOLEAN
238 );
239
240 PROCEDURE proc_begin(
241 p_module_base IN VARCHAR2
242 , p_parameter_name IN VARCHAR2
243 , p_parameter_value IN PO_TBL_NUMBER
244 );
245
246 PROCEDURE proc_begin(
247 p_module_base IN VARCHAR2
248 , p_parameter_name IN VARCHAR2
249 , p_parameter_value IN PO_TBL_DATE
250 );
251
252 PROCEDURE proc_begin(
253 p_module_base IN VARCHAR2
254 , p_parameter_name IN VARCHAR2
255 , p_parameter_value IN PO_TBL_VARCHAR1
256 );
257
258 PROCEDURE proc_begin(
259 p_module_base IN VARCHAR2
260 , p_parameter_name IN VARCHAR2
261 , p_parameter_value IN PO_TBL_VARCHAR5
262 );
263
264 PROCEDURE proc_begin(
265 p_module_base IN VARCHAR2
266 , p_parameter_name IN VARCHAR2
267 , p_parameter_value IN PO_TBL_VARCHAR30
268 );
269
270 PROCEDURE proc_begin(
271 p_module_base IN VARCHAR2
272 , p_parameter_name IN VARCHAR2
273 , p_parameter_value IN PO_TBL_VARCHAR100
274 );
275
276 PROCEDURE proc_begin(
277 p_module_base IN VARCHAR2
278 , p_parameter_name IN VARCHAR2
279 , p_parameter_value IN PO_TBL_VARCHAR2000
280 );
281
282 PROCEDURE proc_begin(
283 p_module_base IN VARCHAR2
284 , p_parameter_name IN VARCHAR2
285 , p_parameter_value IN PO_TBL_VARCHAR4000
286 );
287
288 PROCEDURE proc_end(
289 p_module_base IN VARCHAR2
290 );
291
292 PROCEDURE proc_end(
293 p_module_base IN VARCHAR2
294 , p_parameter_name IN VARCHAR2
295 , p_parameter_value IN VARCHAR2
296 );
297
298 PROCEDURE proc_end(
299 p_module_base IN VARCHAR2
300 , p_parameter_name IN VARCHAR2
301 , p_parameter_value IN NUMBER
302 );
303
304 PROCEDURE proc_end(
305 p_module_base IN VARCHAR2
306 , p_parameter_name IN VARCHAR2
307 , p_parameter_value IN DATE
308 );
309
310 PROCEDURE proc_end(
311 p_module_base IN VARCHAR2
312 , p_parameter_name IN VARCHAR2
313 , p_parameter_value IN BOOLEAN
314 );
315
316 PROCEDURE proc_end(
317 p_module_base IN VARCHAR2
318 , p_parameter_name IN VARCHAR2
319 , p_parameter_value IN PO_TBL_NUMBER
320 );
321
322 PROCEDURE proc_end(
323 p_module_base IN VARCHAR2
324 , p_parameter_name IN VARCHAR2
325 , p_parameter_value IN PO_TBL_DATE
326 );
327
328 PROCEDURE proc_end(
329 p_module_base IN VARCHAR2
330 , p_parameter_name IN VARCHAR2
331 , p_parameter_value IN PO_TBL_VARCHAR1
332 );
333
334 PROCEDURE proc_end(
335 p_module_base IN VARCHAR2
336 , p_parameter_name IN VARCHAR2
337 , p_parameter_value IN PO_TBL_VARCHAR5
338 );
339
340 PROCEDURE proc_end(
341 p_module_base IN VARCHAR2
342 , p_parameter_name IN VARCHAR2
343 , p_parameter_value IN PO_TBL_VARCHAR30
344 );
345
346 PROCEDURE proc_end(
347 p_module_base IN VARCHAR2
348 , p_parameter_name IN VARCHAR2
349 , p_parameter_value IN PO_TBL_VARCHAR100
350 );
351
352 PROCEDURE proc_end(
353 p_module_base IN VARCHAR2
354 , p_parameter_name IN VARCHAR2
355 , p_parameter_value IN PO_TBL_VARCHAR2000
356 );
357
358 PROCEDURE proc_end(
359 p_module_base IN VARCHAR2
360 , p_parameter_name IN VARCHAR2
361 , p_parameter_value IN PO_TBL_VARCHAR4000
362 );
363
364 PROCEDURE proc_return(
365 p_module_base IN VARCHAR2
366 , p_return_value IN VARCHAR2
367 );
368
369 PROCEDURE proc_return(
370 p_module_base IN VARCHAR2
371 , p_return_value IN NUMBER
372 );
373
374 PROCEDURE proc_return(
375 p_module_base IN VARCHAR2
376 , p_return_value IN DATE
377 );
378
379 PROCEDURE proc_return(
380 p_module_base IN VARCHAR2
381 , p_return_value IN BOOLEAN
382 );
383
384 PROCEDURE proc_return(
385 p_module_base IN VARCHAR2
386 , p_return_value IN PO_TBL_NUMBER
387 );
388
389 PROCEDURE proc_return(
390 p_module_base IN VARCHAR2
391 , p_return_value IN PO_TBL_DATE
392 );
393
394 PROCEDURE proc_return(
395 p_module_base IN VARCHAR2
396 , p_return_value IN PO_TBL_VARCHAR1
397 );
398
399 PROCEDURE proc_return(
400 p_module_base IN VARCHAR2
401 , p_return_value IN PO_TBL_VARCHAR5
402 );
403
404 PROCEDURE proc_return(
405 p_module_base IN VARCHAR2
406 , p_return_value IN PO_TBL_VARCHAR30
407 );
408
409 PROCEDURE proc_return(
410 p_module_base IN VARCHAR2
411 , p_return_value IN PO_TBL_VARCHAR100
412 );
413
414 PROCEDURE proc_return(
415 p_module_base IN VARCHAR2
416 , p_return_value IN PO_TBL_VARCHAR2000
417 );
418
419 PROCEDURE proc_return(
420 p_module_base IN VARCHAR2
421 , p_return_value IN PO_TBL_VARCHAR4000
422 );
423
424 PROCEDURE proc_raise(
425 p_module_base IN VARCHAR2
426 );
427
428 -- EVENT-level logging.
429
430 PROCEDURE event(
431 p_module_base IN VARCHAR2
432 , p_position IN NUMBER
433 , p_message_text IN VARCHAR2
434 );
435
436 -- EXCEPTION-level logging.
437
438 PROCEDURE exc(
439 p_module_base IN VARCHAR2
440 , p_position IN NUMBER
444 -- Generic level logging for different data types.
441 , p_message_text IN VARCHAR2 DEFAULT NULL
442 );
443
445
446 PROCEDURE log(
447 p_log_level IN NUMBER
448 , p_module_base IN VARCHAR2
449 , p_module_suffix IN VARCHAR2
450 , p_variable_name IN VARCHAR2
451 , p_variable_value IN PO_VALIDATION_RESULTS_TYPE
452 );
453
454 END PO_LOG;