1 package MSC_LOG AUTHID CURRENT_USER as
2 /* $Header: MSCLOGS.pls 115.0 2003/06/26 17:58:47 pabram noship $ */
3
4 /*
5 ** Writes the message to the log file for the spec'd level and module
6 ** if logging is enabled for this level and module
7 */
8 PROCEDURE STRING(LOG_LEVEL IN NUMBER,
9 MODULE IN VARCHAR2,
10 MESSAGE IN VARCHAR2);
11
12 /*
13 ** Writes the message with context information to the log file for
14 ** the spec'd level and module if logging is enabled for this level
15 ** and module
16 */
17 PROCEDURE STRING_WITH_CONTEXT(LOG_LEVEL IN NUMBER,
18 MODULE IN VARCHAR2,
19 MESSAGE IN VARCHAR2,
20 ENCODED IN VARCHAR2 DEFAULT NULL,
21 NODE IN VARCHAR2 DEFAULT NULL,
22 NODE_IP_ADDRESS IN VARCHAR2 DEFAULT NULL,
23 PROCESS_ID IN VARCHAR2 DEFAULT NULL,
24 JVM_ID IN VARCHAR2 DEFAULT NULL,
25 THREAD_ID IN VARCHAR2 DEFAULT NULL,
26 AUDSID IN NUMBER DEFAULT NULL,
27 DB_INSTANCE IN NUMBER DEFAULT NULL);
28
29 /*
30 ** Writes a message to the log file if this level and module is enabled
31 ** The message gets set previously with FND_MESSAGE.SET_NAME,
32 ** SET_TOKEN, etc.
33 ** The message is popped off the message dictionary stack, if POP_MESSAGE
34 ** is TRUE. Pass FALSE for POP_MESSAGE if the message will also be
35 ** displayed to the user later.
36 ** Example usage:
37 ** FND_MESSAGE.SET_NAME(...); -- Set message
38 ** FND_MESSAGE.SET_TOKEN(...); -- Set token in message
39 ** FND_LOG.MESSAGE(..., FALSE); -- Log message
40 ** FND_MESSAGE.ERROR; -- Display message
41 */
42 PROCEDURE MESSAGE(LOG_LEVEL IN NUMBER,
43 MODULE IN VARCHAR2,
44 POP_MESSAGE IN BOOLEAN DEFAULT NULL);
45
46 /*
47 ** Writes a message with context to the log file if this level and
48 ** module is enabled. This requires that the message was set
49 ** previously with FND_MESSAGE.SET_NAME, SET_TOKEN, etc.
50 ** The message is popped off the message dictionary stack, if POP_MESSAGE
51 ** is TRUE. Pass FALSE for POP_MESSAGE if the message will also be
52 ** displayed to the user later. If POP_MESSAGE isn't passed, the
53 ** message will not be popped off the stack, so it must be displayed
54 ** or explicitly cleared later on.
55 */
56 PROCEDURE MESSAGE_WITH_CONTEXT(LOG_LEVEL IN NUMBER,
57 MODULE IN VARCHAR2,
58 POP_MESSAGE IN BOOLEAN DEFAULT NULL, --Default FALSE
59 NODE IN VARCHAR2 DEFAULT NULL,
60 NODE_IP_ADDRESS IN VARCHAR2 DEFAULT NULL,
61 PROCESS_ID IN VARCHAR2 DEFAULT NULL,
62 JVM_ID IN VARCHAR2 DEFAULT NULL,
63 THREAD_ID IN VARCHAR2 DEFAULT NULL,
64 AUDSID IN NUMBER DEFAULT NULL,
65 DB_INSTANCE IN NUMBER DEFAULT NULL);
66
67 /*
68 ** Tests whether logging is enabled for this level and module, to
69 ** avoid the performance penalty of building long debug message
70 ** strings unnecessarily.
71 */
72 FUNCTION TEST(LOG_LEVEL IN NUMBER,
73 MODULE IN VARCHAR2) RETURN BOOLEAN;
74 end MSC_LOG;
[Home] [Help]