PACKAGE: APPS.AHL_DEBUG_PUB

Source

1 PACKAGE AHL_DEBUG_PUB AUTHID CURRENT_USER AS
2 /* $Header: AHLPDEBS.pls 115.4 2003/08/04 18:57:28 sikumar noship $ */
3 --------------------------------------
4 -- declaration of public global varibles
5 --------------------------------------
6 
7 G_FILE_DEBUG          BOOLEAN := FALSE;
8 
9 --------------------------------------
10 -- public procedures and functions
11 --------------------------------------
12 
13 /**
14  * PROCEDURE enable_debug
15  *
16  * DESCRIPTION
17  *     Enable file or dbms debug based on profile options.
18  *     AHL_API_FILE_DEBUG_ON : Turn on/off file debug, i.e. debug message
19  *                            will be written to a user specified file.
20  *                            The file name and file path is stored in
21  *                            profiles AHL_API_DEBUG_FILE_PATH and
22  *                            AHL_API_DEBUG_FILE_NAME. File path must be
23  *                            database writable.
24  *     AHL_API_DBMS_DEBUG_ON : Turn on/off dbms debug.
25  *
26  * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
27  *
28  * ARGUMENTS
29  *
30  * NOTES
31  *
32  * MODIFICATION HISTORY
33  *
34  *
35  *
36  */
37 
38 PROCEDURE enable_debug;
39 
40 /**
41  * PROCEDURE disable_debug
42  *
43  * DESCRIPTION
44  *     Disable file or dbms debug.
45  *
46  * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
47  *
48  * ARGUMENTS
49  *
50  * NOTES
51  *
52  * MODIFICATION HISTORY
53  *
54  *
55  *
56  */
57 
58 PROCEDURE disable_debug;
59 
60 /**
61  * PROCEDURE debug
62  *
63  * DESCRIPTION
64  *     Put debug message.
65  *
66  * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
67  *
68  * ARGUMENTS
69  *   IN:
70  *     p_message                      Message you want to put in log.
71  *     p_prefix                       Prefix of the message. Default value is
72  *                                    DEBUG.
73  * NOTES
74  *
75  * MODIFICATION HISTORY
76  *
77  *
78  *
79  */
80 
81 PROCEDURE debug (
82     p_message                               IN     VARCHAR2,
83     p_prefix                                IN     VARCHAR2 DEFAULT 'DEBUG'
84 );
85 
86 /**
87  * PROCEDURE log_app_messages
88  *
89  * DESCRIPTION
90  *     Put debug messages based on message count in message stack.
91  *
92  * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
93  *
94  * ARGUMENTS
95  *   IN:
96  *     p_msg_count                    Message count in message stack.
97  *     p_msg_data                     Message data if message count is 1.
98  *     p_msg_type                     Message type used as prefix of the message.
99  *
100  * NOTES
101  *
102  * MODIFICATION HISTORY
103  *
104  *
105  *
106  */
107 
108 PROCEDURE log_app_messages (
109     p_msg_count                             IN     NUMBER,
110     p_msg_data                              IN     VARCHAR2,
111     p_msg_type                              IN     VARCHAR2 DEFAULT 'ERROR'
112 );
113 
114 /**
115  * Function is_log_enabled RETURNS 'Y' or 'N'
116  *
117  * DESCRIPTION
118  *     Included for backward compatiablity to find out whether statement level logging is enabled.
119  *
120  * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED *
121  *
122  * NOTES
123  *
124  * MODIFICATION HISTORY
125  *
126  *
127  *
128  */
129 FUNCTION is_log_enabled RETURN VARCHAR2;
130 
131 END AHL_DEBUG_PUB;