1 PACKAGE FA_DEBUG_PKG as
2 /* $Header: FADEBUGS.pls 120.3 2005/06/25 00:34:30 snarayan ship $ */
3
4 -- Procedure Initialize
5 --
6 -- Usage Used by server program to intialize the global
7 -- debug message table and set the debug flag
8 -- Desc Clears the FA_DEBUG_TABLE and reset the index
9 -- and counter of debug table
10 --
11 PROCEDURE Initialize;
12
13
14 -- Function Print_Debug
15 --
16 -- Usage Used by server program to check the debug flag
17 -- Desc Returns TRUE if debug flag is 'YES'
18 -- otherwise returns FALSE
19 --
20 FUNCTION Print_Debug RETURN BOOLEAN;
21
22
23 -- Procedure Add
24 --
25 -- Usage Used by server programs to add debug message to
26 -- debug message table
27 --
28 -- Desc This procedure is oeverloaded.
29 -- There are four datatypes differing in Value parameter:
30 -- Base :
31 -- Value VARCHAR2
32 -- first overloaded procedure :
33 -- Value NUMBER
34 -- second overloaded procedure :
35 -- Value DATE
36 -- fourth overloaded procedure :
37 -- Value BOOLEAN
38 --
39 -- Parameters fname IN Calling function name
40 -- elemen IN variable name
41 -- value IN value of variable
42 --
43 PROCEDURE Add
44 ( fname in varchar2,
45 element in varchar2,
46 value in varchar2,
47 p_log_level_rec in fa_api_types.log_level_rec_type default null);
48
49 PROCEDURE Add
50 ( fname in varchar2,
51 element in varchar2,
52 value in number,
53 p_log_level_rec in fa_api_types.log_level_rec_type default null);
54
55 PROCEDURE Add
56 ( fname in varchar2,
57 element in varchar2,
58 value in date,
59 p_log_level_rec in fa_api_types.log_level_rec_type default null);
60
61 PROCEDURE Add
62 ( fname in varchar2,
63 element in varchar2,
64 value in boolean,
65 p_log_level_rec in fa_api_types.log_level_rec_type default null);
66
67
68 -- Procedure Get_Debug_Messages
69 --
70 -- Usage Used by client program to get debug messages from debug
71 -- table
72 --
73 -- Desc Returns 10 messages at a time when the procedure is called
74 -- Also returns a flag to indicate the index is at the end
75 -- of debug table
76 --
77 PROCEDURE Get_Debug_Messages
78 ( d_mesg1 out nocopy varchar2,
79 d_mesg2 out nocopy varchar2,
80 d_mesg3 out nocopy varchar2,
81 d_mesg4 out nocopy varchar2,
82 d_mesg5 out nocopy varchar2,
83 d_mesg6 out nocopy varchar2,
84 d_mesg7 out nocopy varchar2,
85 d_mesg8 out nocopy varchar2,
86 d_mesg9 out nocopy varchar2,
87 d_mesg10 out nocopy varchar2,
88 d_more_mesgs out nocopy boolean);
89
90
91 -- Procedure Set_Debug_Flag
92 --
93 -- Usage Used by internal deveoplers to set the debug flag
94 -- to 'YES'
95 --
96 PROCEDURE Set_Debug_Flag
97 ( debug_flag in varchar2 := 'YES');
98
99
100 -- Procedure Reset_Index
101 --
102 -- Usage Used by internal developer to move the index
103 -- of debug table
104 --
105 PROCEDURE Reset_Index
106 ( d_index in number);
107
108
109 -- Procedure Dump_Debug_Messages
110 --
111 -- Usage Used by internal developers to print all messages
112 -- of debug table
113 --
114 PROCEDURE Dump_Debug_Messages
115 ( target_str in varchar2);
116
117
118 -- Procedure Dump_Debug_Messages
119 --
120 -- Usage Used to add all messages to the fnd message stack
121 -- max_mesgs is not currently used
122 --
123 PROCEDURE Dump_Debug_Messages
124 ( max_mesgs in number := NULL);
125
126
127 -- Procedure Write_Debug_Log
128 --
129 -- Usage To get messages from debug message stack and write to log file.
130 --
131 PROCEDURE Write_Debug_Log;
132
133
134 END FA_DEBUG_PKG;
[Home] [Help]