1 package gl_message AUTHID CURRENT_USER as
2 /* $Header: gluplmgs.pls 120.1 2004/05/08 01:06:48 xiwu noship $ */
3
4 FUNCTION Get_Message ( msg_name VARCHAR2,
5 show_num VARCHAR2 ) RETURN VARCHAR2;
6
7 -- **************************************************************
8
9 FUNCTION Msg_Tkn_Expand(msg VARCHAR2,
10 t1 VARCHAR2,
11 v1 VARCHAR2) RETURN VARCHAR2;
12
13 -- *************************************************************
14
15 FUNCTION Get_Message(msg_name VARCHAR2,
16 show_num VARCHAR2,
17 t1 VARCHAR2,
18 v1 VARCHAR2) RETURN VARCHAR2;
19
20 -- **************************************************************
21
22 FUNCTION Get_Message(msg_name VARCHAR2,
23 show_num VARCHAR2,
24 t1 VARCHAR2,
25 v1 VARCHAR2,
26 t2 VARCHAR2,
27 v2 VARCHAR2) RETURN VARCHAR2;
28
29 -- **************************************************************
30
31 FUNCTION Get_Message(msg_name VARCHAR2,
32 show_num VARCHAR2,
33 t1 VARCHAR2,
34 v1 VARCHAR2,
35 t2 VARCHAR2,
36 v2 VARCHAR2,
37 t3 VARCHAR2,
38 v3 VARCHAR2) RETURN VARCHAR2;
39
40 -- ***************************************************************
41
42 FUNCTION Get_Message(msg_name VARCHAR2,
43 show_num VARCHAR2,
44 t1 VARCHAR2,
45 v1 VARCHAR2,
46 t2 VARCHAR2,
47 v2 VARCHAR2,
48 t3 VARCHAR2,
49 v3 VARCHAR2,
50 t4 VARCHAR2,
51 v4 VARCHAR2) RETURN VARCHAR2;
52
53 -- *****************************************************************
54 -- FUNCTION
55 -- Write_Buffer
56 -- Purpose
57 -- This Function used to write message name and actual message
58 -- (with token values) to buffer.
59 -- History
60 -- 10-04-2001 Srini Pala Created
61 -- Arguments
62 -- msg_name Name of the message
63 -- token_num Number of tokens exist in the message
64 -- t1 Name of the first token
65 -- v1 Value of the first token
66 -- t2 Name of the second token
67 -- v2 Value of the second token
68 -- t3 Name of the third token
69 -- v3 Value of the third token
70 -- t4 Name of the fourth token
71 -- v4 Value of the fourth token
72 -- t5 Name of the fifth token
73 -- v5 Value of the fifth token
74
75 -- Example
76 -- GL_MESSAGE.Write_Buffer('SHRD0117',2,''NUM','10','TABLE','GL_BALANCES')
77 --
78
79 FUNCTION Write_Buffer(msg_name VARCHAR2,
80 token_num NUMBER DEFAULT 0,
81 t1 VARCHAR2 DEFAULT NULL,
82 v1 VARCHAR2 DEFAULT NULL,
83 t2 VARCHAR2 DEFAULT NULL,
84 v2 VARCHAR2 DEFAULT NULL,
85 t3 VARCHAR2 DEFAULT NULL,
86 v3 VARCHAR2 DEFAULT NULL,
87 t4 VARCHAR2 DEFAULT NULL,
88 v4 VARCHAR2 DEFAULT NULL,
89 t5 VARCHAR2 DEFAULT NULL,
90 v5 VARCHAR2 DEFAULT NULL) RETURN VARCHAR2;
91
92 -- *******************************************************************
93
94 PROCEDURE Set_Language ( lang_id NUMBER ) ;
95
96 -- ********************************************************************
97 -- Procedure
98 -- Write_Log
99 -- Purpose
100 -- This prodcedure is similar to Write_Buffer () but used to write
101 -- meesage name and actual message (with token values) to a Log file.
102 -- History
103 -- 10-04-2001 Srini Pala Created
104 -- 02-27-2002 Srini Pala Name changed to Write_Log
105 -- Arguments
106 -- msg_name Name of the message
107 -- token_num Number of tokens exist in the message
108 -- t1 Name of the first token
109 -- v1 Value of the first token
110 -- t2 Name of the second token
111 -- v2 Value of the second token
112 -- t3 Name of the third token
113 -- v3 Value of the third token
114 -- t4 Name of the fourth token
115 -- v4 Value of the fourth token
116 -- t5 Name of the fifth token
117 -- v5 Value of the fifth token
118
119 -- Example
120 -- GL_MESSAGE.Write_Log('SHRD0117',2,''NUM','10','TABLE','GL_BALANCES')
121 --
122
123
124 PROCEDURE Write_Log (msg_name VARCHAR2,
125 token_num NUMBER DEFAULT 0,
126 t1 VARCHAR2 DEFAULT NULL,
127 v1 VARCHAR2 DEFAULT NULL,
128 t2 VARCHAR2 DEFAULT NULL,
129 v2 VARCHAR2 DEFAULT NULL,
130 t3 VARCHAR2 DEFAULT NULL,
131 v3 VARCHAR2 DEFAULT NULL,
132 t4 VARCHAR2 DEFAULT NULL,
133 v4 VARCHAR2 DEFAULT NULL,
134 t5 VARCHAR2 DEFAULT NULL,
135 v5 VARCHAR2 DEFAULT NULL,
136 log_level NUMBER DEFAULT 0,
137 module VARCHAR2 DEFAULT NULL);
138 -- ******************************************************************
139 -- Procedure
140 -- Func_Succ
141 -- Purpose
142 -- This prodcedure is used to write
143 -- the symbol '<< ' to indicate leaving function with successful completion
144 -- func_name (passed as parameter to the procedure)
145 -- system date and time ('HH24:MI:SS') to the Log file.
146 -- History
147 -- 10-04-2001 Srini Pala Created
148 -- Arguments
149 -- func_name Name of the leaving function
150 -- Example
151 -- GL_MESSAGE.Func_succ('Gl_Message')
152 --
153
154 PROCEDURE Func_Succ(func_name VARCHAR2,
155 log_level NUMBER DEFAULT 0,
156 module VARCHAR2 DEFAULT NULL);
157
158 -- ******************************************************************
159
160 -- Procedure
161 -- Func_Fail
162 -- Purpose
163 -- This prodcedure is used to write
164 -- the symbol '<x ' to indicate leaving function wnen it fails
165 -- func_name ( passed as parameter to the procedure)
166 -- system date and time ('HH24:MI:SS') to the Log file.
167 -- History
168 -- 10-04-2001 Srini Pala Created
169 -- Arguments
170 -- func_name Name of the leaving function
171 -- Example
172 -- GL_MESSAGE.Func_Fail('Gl_Message')
173
174
175 PROCEDURE Func_Fail(func_name VARCHAR2,
176 log_level NUMBER DEFAULT 0,
177 module VARCHAR2 DEFAULT NULL);
178 -- ******************************************************************
179
180 -- Procedure
181 -- Func_Ent
182 -- Purpose
183 -- This prodcedure is used to writes
184 -- the symbol '>> ' to indicate entering a function
185 -- func_name, passed as parameter to the procedure
186 -- system date and time ('HH24:MI:SS' ) to the Log file.
187 -- History
188 -- 10-04-2001 Srini Pala Created
189 -- Arguments
190 -- func_name Name of the leaving function
191 -- Example
192 -- GL_MESSAGE.Func_Ent('Gl_Message')
193 --
194
195 PROCEDURE Func_Ent(func_name VARCHAR2,
196 log_level NUMBER DEFAULT 0,
197 module VARCHAR2 DEFAULT NULL);
198
199 -- ******************************************************************
200
201
202 -- Procedure
203 -- Write_Output
204 -- Purpose
205 -- This prodcedure is similar to Write_Log () but used to write
206 -- message name and actual message (with token values) to a Output file.
207 -- History
208 -- 02-27-2002 Srini Pala Created
209 -- Arguments
210 -- msg_name Name of the message
211 -- token_num Number of tokens exist in the message
212 -- t1 Name of the first token
213 -- v1 Value of the first token
214 -- t2 Name of the second token
215 -- v2 Value of the second token
216 -- t3 Name of the third token
217 -- v3 Value of the third token
218 -- t4 Name of the fourth token
219 -- v4 Value of the fourth token
220 -- t5 Name of the fifth token
221 -- v5 Value of the fifth token
222
223 -- Example
224 -- GL_MESSAGE.Write_Output('SHRD0117',2,''NUM','10','TABLE','GL_BALANCES')
225 --
226
227
228 PROCEDURE Write_Output(msg_name VARCHAR2,
229 token_num NUMBER DEFAULT 0,
230 t1 VARCHAR2 DEFAULT NULL,
231 v1 VARCHAR2 DEFAULT NULL,
232 t2 VARCHAR2 DEFAULT NULL,
233 v2 VARCHAR2 DEFAULT NULL,
234 t3 VARCHAR2 DEFAULT NULL,
235 v3 VARCHAR2 DEFAULT NULL,
236 t4 VARCHAR2 DEFAULT NULL,
237 v4 VARCHAR2 DEFAULT NULL,
238 t5 VARCHAR2 DEFAULT NULL,
239 v5 VARCHAR2 DEFAULT NULL);
240
241 -- ******************************************************************
242
243 -- Procedure
244 -- Write_Fndlog_Msg
245 -- Purpose
246 -- This prodcedure is similar to Write_Log() but it will write to
247 -- fnd log only, it won't write to request log.
248 -- History
249 -- 04-30-2004 Jennifer Wu Created
250 -- Arguments
251 -- msg_name Name of the message
252 -- token_num Number of tokens exist in the message
253 -- t1 Name of the first token
254 -- v1 Value of the first token
255 -- t2 Name of the second token
256 -- v2 Value of the second token
257 -- t3 Name of the third token
258 -- v3 Value of the third token
259 -- t4 Name of the fourth token
260 -- v4 Value of the fourth token
261 -- t5 Name of the fifth token
262 -- v5 Value of the fifth token
263 -- log_level Levels in FND_LOG...
264 -- module Represents the source of the message
265 -- message Message body.
266
267 -- Example
268 -- GL_MESSAGE.Write_Fndlog_Msg('SHRD0117',2,''NUM','10','TABLE',
269 -- 'GL_BALANCES',FND_LOG.EVENT, 'ORACLE.APPS.GL.JAHE', )
270 --
271 PROCEDURE Write_Fndlog_Msg (msg_name VARCHAR2,
272 token_num NUMBER DEFAULT 0,
273 t1 VARCHAR2 DEFAULT NULL,
274 v1 VARCHAR2 DEFAULT NULL,
275 t2 VARCHAR2 DEFAULT NULL,
276 v2 VARCHAR2 DEFAULT NULL,
277 t3 VARCHAR2 DEFAULT NULL,
278 v3 VARCHAR2 DEFAULT NULL,
279 t4 VARCHAR2 DEFAULT NULL,
280 v4 VARCHAR2 DEFAULT NULL,
281 t5 VARCHAR2 DEFAULT NULL,
282 v5 VARCHAR2 DEFAULT NULL,
283 log_level NUMBER,
284 module VARCHAR2);
285
286 -- ******************************************************************
287 -- Procedure
288 -- Write_Fndlog_String
289 -- Purpose
290 -- This procedure writes the message to the log file for the
291 -- specified level and module if logging is enabled for this level
292 -- and module.
293 -- History
294 -- 04-30-2004 Jennifer Wu Created
295 -- Arguments
296 -- log_level FND_LOG.LEVEL_UNEXPECTED 6
297 -- FND_LOG.LEVEL_ERROR 5
298 -- FND_LOG.LEVEL_EXCEPTION 4
299 -- FND_LOG.LEVEL_EVENT 3
300 -- FND_LOG.LEVEL_PROCEDURE 2
301 -- FND_LOG.LEVEL_STATEMENT 1
302 -- module Represents the source of the message
303 -- message Message body.
304
305 -- Example
306 -- GL_MESSAGE.Write_Fndlog_String('SHRD0117',2,''NUM','10','TABLE',
307 -- 'GL_BALANCES', FND_LOG.EVENT, 'ORACLE.APPS.GL.JAHE', )
308 --
309
310
311 PROCEDURE Write_Fndlog_String (log_level NUMBER,
312 module VARCHAR2,
313 message VARCHAR2);
314
315 -- ******************************************************************
316 END Gl_Message;
317