1 package ff_utils AUTHID CURRENT_USER as
2 /* $Header: ffutil.pkh 115.2 2002/05/31 07:13:29 pkm ship $ */
3 /*
4 * Debug global variable
5 */
6 g_debug_level binary_integer;
7
8 /*
9 * The following constants define the debugging levels
10 * that are available.
11 */
12 ROUTING constant binary_integer := 1;
13
14 ---------------------------- set_debug ----------------------------------------
15 /*
16 NAME
17 set_debug
18 DESCRIPTION
19 Sets the debugging option to appropriate level.
20 NOTES
21 This procedure is used to set the value of a global
22 variable that, in turn, controls debugging output.
23 */
24 procedure set_debug
25 (
26 p_debug_level in binary_integer
27 );
28
29 ------------------------------ assert -----------------------------------------
30 /*
31 NAME
32 assert
33 DESCRIPTION
34 Raise assert error if expression is FALSE.
35 NOTES
36 The procedure takes two parameters. The first is an expression
37 that should resolve to a boolean. If this is FALSE, an error
38 is raised. The position that this error occurred is indicated
39 by the second parameter, which is unique within the code, and
40 by convension is in the form '<procedure_name>:<number>', e.g.
41 'load_formula:2'.
42
43 This procedure should be used to test 'impossible' conditions
44 have not occurred. It should not be used as a substitute for
45 common user errors.
46 */
47
48 procedure assert
49 (
50 p_expression in boolean,
51 p_location in varchar2
52 );
53
54 --------------------------------- entry ---------------------------------------
55 /*
56 NAME
57 entry
58 DESCRIPTION
59 Outputs a TRACE message to indicate enty to a function.
60 NOTES
61 Output controlled by current debug level.
62 */
63 procedure entry
64 (
65 p_procedure_name in varchar2
66 );
67
68 --------------------------------- exit ----------------------------------------
69 /*
70 NAME
71 exit
72 DESCRIPTION
73 Outputs a TRACE message to indicate exit from a function.
74 NOTES
75 Output controlled by current debug level.
76 */
77 procedure exit
78 (
79 p_procedure_name in varchar2
80 );
81
82 end ff_utils;