DBA Data[Home] [Help]

PACKAGE BODY: APPS.XLA_MESSAGES_PKG

Source


1 PACKAGE BODY xla_messages_pkg AS
2 /* $Header: xlacmmsg.pkb 120.3 2003/02/25 01:28:02 sasingha ship $ */
3 /*======================================================================+
4 |             Copyright (c) 1995-2002 Oracle Corporation                |
5 |                       Redwood Shores, CA, USA                         |
6 |                         All rights reserved.                          |
7 +=======================================================================+
8 | PACKAGE NAME                                                          |
9 |    xla_messages_pkg                                                   |
10 |                                                                       |
11 | DESCRIPTION                                                           |
12 |    XLA Messages Package                                               |
13 |                                                                       |
14 | HISTORY                                                               |
15 |    07-Dec-95 P. Labrevois    Created                                  |
16 |    07-Feb-01                 Adapted for XLA                          |
17 |                                                                       |
18 +======================================================================*/
19 
20 /*======================================================================+
21 |                                                                       |
22 |                                                                       |
23 |                                                                       |
24 |                                                                       |
25 |                                                                       |
26 |                                                                       |
27 |                                                                       |
28 |                                                                       |
29 |                                                                       |
30 |                                                                       |
31 | build_message                                                         |
32 |                                                                       |
33 |                                                                       |
34 |                                                                       |
35 |                                                                       |
36 |                                                                       |
37 |                                                                       |
38 |                                                                       |
39 |                                                                       |
40 |                                                                       |
41 |                                                                       |
42 +======================================================================*/
43 
44 
45 /*======================================================================+
46 |                                                                       |
47 | build_message                                                         |
48 |                                                                       |
49 | Build the message, to token is passed.                                |
50 |                                                                       |
51 +======================================================================*/
52 PROCEDURE build_message
53   (p_appli_s_name                 IN  VARCHAR2
54   ,p_msg_name                     IN  VARCHAR2)
55 
56 IS
57 
58 BEGIN
59 fnd_message.set_name
60   (p_appli_s_name
61   ,p_msg_name);
62 
63 --
64 -- Store the message number in a global
65 --
66 g_message_number := fnd_message.get_number
67   (p_appli_s_name
68   ,p_msg_name);
69 END build_message;
70 
71 
72 /*======================================================================+
73 |                                                                       |
74 | build_message                                                         |
75 |                                                                       |
76 | Build the message, completed with the value for 1 token               |
77 |                                                                       |
78 +======================================================================*/
79 PROCEDURE build_message
80   (p_appli_s_name                 IN  VARCHAR2
81   ,p_msg_name                     IN  VARCHAR2
82   ,p_token_1                      IN  VARCHAR2
83   ,p_value_1                      IN  VARCHAR2)
84 
85 IS
86 
87 BEGIN
88 build_message
89   (p_appli_s_name
90   ,p_msg_name);
91 
92 fnd_message.set_token
93   (p_token_1
94   ,p_value_1);
95 END build_message;
96 
97 
98 /*======================================================================+
99 |                                                                       |
100 | Public Procedure                                                      |
101 |                                                                       |
102 | build_message                                                         |
103 |                                                                       |
104 | Build the message, completed with the value for 2 token               |
105 |                                                                       |
106 +======================================================================*/
107 PROCEDURE build_message
108   (p_appli_s_name                 IN  VARCHAR2
109   ,p_msg_name                     IN  VARCHAR2
110   ,p_token_1                      IN  VARCHAR2
111   ,p_value_1                      IN  VARCHAR2
112   ,p_token_2                      IN  VARCHAR2
113   ,p_value_2                      IN  VARCHAR2)
114 
115 IS
116 
117 BEGIN
118 build_message
119   (p_appli_s_name
120   ,p_msg_name
121   ,p_token_1
122   ,p_value_1);
123 
124 fnd_message.set_token
125   (p_token_2
126   ,p_value_2);
127 END build_message;
128 
129 
130 /*======================================================================+
131 |                                                                       |
132 | Public Procedure                                                      |
133 |                                                                       |
134 | build_message                                                         |
135 |                                                                       |
136 | Build the message, completed with the value for 3 token               |
137 |                                                                       |
138 +======================================================================*/
139 PROCEDURE build_message
140   (p_appli_s_name                 IN  VARCHAR2
141   ,p_msg_name                     IN  VARCHAR2
142   ,p_token_1                      IN  VARCHAR2
143   ,p_value_1                      IN  VARCHAR2
144   ,p_token_2                      IN  VARCHAR2
145   ,p_value_2                      IN  VARCHAR2
146   ,p_token_3                      IN  VARCHAR2
147   ,p_value_3                      IN  VARCHAR2)
148 
149 IS
150 
151 BEGIN
152 build_message
153   (p_appli_s_name
154   ,p_msg_name
155   ,p_token_1
156   ,p_value_1
157   ,p_token_2
158   ,p_value_2);
159 
160 fnd_message.set_token
161   (p_token_3
162   ,p_value_3);
163 END build_message;
164 
165 
166 /*======================================================================+
167 |                                                                       |
168 | Public Procedure                                                      |
169 |                                                                       |
170 | build_message                                                         |
171 |                                                                       |
172 | Build the message, completed with the value for 4 token               |
173 |                                                                       |
174 +======================================================================*/
175 PROCEDURE build_message
176   (p_appli_s_name                 IN  VARCHAR2
177   ,p_msg_name                     IN  VARCHAR2
178   ,p_token_1                      IN  VARCHAR2
179   ,p_value_1                      IN  VARCHAR2
180   ,p_token_2                      IN  VARCHAR2
181   ,p_value_2                      IN  VARCHAR2
182   ,p_token_3                      IN  VARCHAR2
183   ,p_value_3                      IN  VARCHAR2
184   ,p_token_4                      IN  VARCHAR2
185   ,p_value_4                      IN  VARCHAR2)
186 
187 IS
188 
189 BEGIN
190 build_message
191   (p_appli_s_name
192   ,p_msg_name
193   ,p_token_1
194   ,p_value_1
195   ,p_token_2
196   ,p_value_2
197   ,p_token_3
198   ,p_value_3);
199 
200 fnd_message.set_token
201   (p_token_4
202   ,p_value_4);
203 END build_message;
204 
205 
206 /*======================================================================+
207 |                                                                       |
208 | Public Procedure                                                      |
209 |                                                                       |
210 | build_message                                                         |
211 |                                                                       |
212 | Build the message, completed with the value for 5 token               |
213 |                                                                       |
214 +======================================================================*/
215 PROCEDURE build_message
216   (p_appli_s_name                 IN  VARCHAR2
217   ,p_msg_name                     IN  VARCHAR2
218   ,p_token_1                      IN  VARCHAR2
219   ,p_value_1                      IN  VARCHAR2
220   ,p_token_2                      IN  VARCHAR2
221   ,p_value_2                      IN  VARCHAR2
222   ,p_token_3                      IN  VARCHAR2
223   ,p_value_3                      IN  VARCHAR2
224   ,p_token_4                      IN  VARCHAR2
225   ,p_value_4                      IN  VARCHAR2
226   ,p_token_5                      IN  VARCHAR2
227   ,p_value_5                      IN  VARCHAR2)
228 
229 IS
230 
231 BEGIN
232 build_message
233   (p_appli_s_name
234   ,p_msg_name
235   ,p_token_1
236   ,p_value_1
237   ,p_token_2
238   ,p_value_2
239   ,p_token_3
240   ,p_value_3
241   ,p_token_4
242   ,p_value_4);
243 
244 fnd_message.set_token
245   (p_token_5
246   ,p_value_5);
247 END build_message;
248 
249 
250 /*======================================================================+
251 |                                                                       |
252 | Public Procedure                                                      |
253 |                                                                       |
254 | build_message                                                         |
255 |                                                                       |
256 | Build the message, completed with the value for 6 token               |
257 |                                                                       |
258 +======================================================================*/
259 PROCEDURE build_message
260   (p_appli_s_name                 IN  VARCHAR2
261   ,p_msg_name                     IN  VARCHAR2
262   ,p_token_1                      IN  VARCHAR2
263   ,p_value_1                      IN  VARCHAR2
264   ,p_token_2                      IN  VARCHAR2
265   ,p_value_2                      IN  VARCHAR2
266   ,p_token_3                      IN  VARCHAR2
267   ,p_value_3                      IN  VARCHAR2
268   ,p_token_4                      IN  VARCHAR2
269   ,p_value_4                      IN  VARCHAR2
270   ,p_token_5                      IN  VARCHAR2
271   ,p_value_5                      IN  VARCHAR2
272   ,p_token_6                      IN  VARCHAR2
273   ,p_value_6                      IN  VARCHAR2)
274 
275 IS
276 
277 BEGIN
278 build_message
279   (p_appli_s_name
280   ,p_msg_name
281   ,p_token_1
282   ,p_value_1
283   ,p_token_2
284   ,p_value_2
285   ,p_token_3
286   ,p_value_3
287   ,p_token_4
288   ,p_value_4
289   ,p_token_5
290   ,p_value_5);
291 
292 fnd_message.set_token
293   (p_token_6
294   ,p_value_6);
295 END build_message;
296 
297 
298 /*======================================================================+
299 |                                                                       |
300 |                                                                       |
301 |                                                                       |
302 |                                                                       |
303 |                                                                       |
304 |                                                                       |
305 |                                                                       |
306 |                                                                       |
307 |                                                                       |
308 |                                                                       |
309 | get_message_prefixed                                                  |
310 |                                                                       |
311 |                                                                       |
312 |                                                                       |
313 |                                                                       |
314 |                                                                       |
315 |                                                                       |
316 |                                                                       |
317 |                                                                       |
318 |                                                                       |
319 |                                                                       |
320 +======================================================================*/
321 
322 /*======================================================================+
323 |                                                                       |
324 | Public Function                                                       |
325 |                                                                       |
326 | get_message_prefixed                                                  |
327 |                                                                       |
328 | Return the message from the message stack, prefixed with the message  |
329 | number.                                                               |
330 +======================================================================*/
331 FUNCTION  get_message_prefixed
332 RETURN VARCHAR2
333 
334 IS
335 
336 BEGIN
337 IF xla_environment_pkg.g_release_name IN ('11.5','12.0') THEN
338    IF g_message_number IS NULL THEN
339       RETURN SUBSTR(fnd_message.get,1,2000);
340    ELSE
341       RETURN SUBSTR('XLA-'
342                ||   TO_CHAR(g_message_number)
343                ||   xla_environment_pkg.g_chr_newline
344                ||   xla_environment_pkg.g_chr_newline
345                ||   fnd_message.get
346                ||   xla_environment_pkg.g_chr_newline,1,2000);
347    END IF;
348 ELSE
349    RETURN SUBSTR(fnd_message.get,1,241);
350 END IF;
351 END get_message_prefixed;
352 
353 
354 /*======================================================================+
355 |                                                                       |
356 |                                                                       |
357 |                                                                       |
358 |                                                                       |
359 |                                                                       |
360 |                                                                       |
361 |                                                                       |
362 |                                                                       |
363 |                                                                       |
364 |                                                                       |
365 | get_message                                                           |
366 |                                                                       |
367 |                                                                       |
368 |                                                                       |
369 |                                                                       |
370 |                                                                       |
371 |                                                                       |
372 |                                                                       |
373 |                                                                       |
374 |                                                                       |
375 |                                                                       |
376 +======================================================================*/
377 
378 
379 /*======================================================================+
380 |                                                                       |
381 | Public Function                                                       |
382 |                                                                       |
383 | get_message                                                           |
384 |                                                                       |
385 | Return the message from the message stack.                            |
386 +======================================================================*/
387 FUNCTION  get_message
388 RETURN VARCHAR2
389 
390 IS
391 
392 BEGIN
393 IF xla_environment_pkg.g_release_name IN ('11.5','12.0') THEN
394    RETURN SUBSTR(fnd_message.get,1,2000);
395 ELSE
396    RETURN SUBSTR(fnd_message.get,1,241);
397 END IF;
398 END get_message;
399 
400 
401 /*======================================================================+
402 |                                                                       |
403 | Public Function                                                       |
404 |                                                                       |
405 | get_message                                                           |
406 |                                                                       |
407 | Return the message not associated with any token.                     |
408 |                                                                       |
409 +======================================================================*/
410 FUNCTION  get_message
411   (p_appli_s_name                 IN  VARCHAR2
412   ,p_msg_name                     IN  VARCHAR2)
413 RETURN VARCHAR2
414 
415 IS
416 
417 BEGIN
418 build_message
419   (p_appli_s_name
420   ,p_msg_name);
421 
422 RETURN get_message;
423 END get_message;
424 
425 
426 /*======================================================================+
427 |                                                                       |
428 | Public Function                                                       |
429 |                                                                       |
430 | get_message                                                           |
431 |                                                                       |
432 | Return the message completed with the value for 1 token.              |
433 |                                                                       |
434 +======================================================================*/
435 FUNCTION  get_message
436   (p_appli_s_name                 IN  VARCHAR2
437   ,p_msg_name                     IN  VARCHAR2
438   ,p_token_1                      IN  VARCHAR2
439   ,p_value_1                      IN  VARCHAR2)
440 RETURN VARCHAR2
441 
442 IS
443 BEGIN
444 build_message
445   (p_appli_s_name
446   ,p_msg_name
447   ,p_token_1
448   ,p_value_1);
449 
450 RETURN get_message;
451 END get_message;
452 
453 
454 /*======================================================================+
455 |                                                                       |
456 | Public Function                                                       |
457 |                                                                       |
458 | get_message                                                           |
459 |                                                                       |
460 | Return the message completed with the value for 2 token.              |
461 |                                                                       |
462 +======================================================================*/
463 FUNCTION  get_message
464   (p_appli_s_name                 IN  VARCHAR2
465   ,p_msg_name                     IN  VARCHAR2
466   ,p_token_1                      IN  VARCHAR2
467   ,p_value_1                      IN  VARCHAR2
468   ,p_token_2                      IN  VARCHAR2
469   ,p_value_2                      IN  VARCHAR2)
470 RETURN VARCHAR2
471 
472 IS
473 BEGIN
474 build_message
475   (p_appli_s_name
476   ,p_msg_name
477   ,p_token_1
478   ,p_value_1
479   ,p_token_2
480   ,p_value_2);
481 
482 RETURN get_message;
483 END get_message;
484 
485 
486 /*======================================================================+
487 |                                                                       |
488 | Public Function                                                       |
489 |                                                                       |
490 | get_message                                                           |
491 |                                                                       |
492 | Return the message completed with the value for 3 token.              |
493 |                                                                       |
494 +======================================================================*/
495 FUNCTION  get_message
496   (p_appli_s_name                 IN  VARCHAR2
497   ,p_msg_name                     IN  VARCHAR2
498   ,p_token_1                      IN  VARCHAR2
499   ,p_value_1                      IN  VARCHAR2
500   ,p_token_2                      IN  VARCHAR2
501   ,p_value_2                      IN  VARCHAR2
502   ,p_token_3                      IN  VARCHAR2
503   ,p_value_3                      IN  VARCHAR2)
504 RETURN VARCHAR2
505 
506 IS
507 BEGIN
508 build_message
509   (p_appli_s_name
510   ,p_msg_name
511   ,p_token_1
512   ,p_value_1
513   ,p_token_2
514   ,p_value_2
515   ,p_token_3
516   ,p_value_3);
517 
518 RETURN get_message;
519 END get_message;
520 
521 
522 /*======================================================================+
523 |                                                                       |
524 | Public Function                                                       |
525 |                                                                       |
526 | get_message                                                           |
527 |                                                                       |
528 | Return the message completed with the value for 4 token.              |
529 |                                                                       |
530 +======================================================================*/
531 FUNCTION  get_message
532   (p_appli_s_name                 IN  VARCHAR2
533   ,p_msg_name                     IN  VARCHAR2
534   ,p_token_1                      IN  VARCHAR2
535   ,p_value_1                      IN  VARCHAR2
536   ,p_token_2                      IN  VARCHAR2
537   ,p_value_2                      IN  VARCHAR2
538   ,p_token_3                      IN  VARCHAR2
539   ,p_value_3                      IN  VARCHAR2
540   ,p_token_4                      IN  VARCHAR2
541   ,p_value_4                      IN  VARCHAR2)
542 RETURN VARCHAR2
543 
544 IS
545 BEGIN
546 build_message
547   (p_appli_s_name
548   ,p_msg_name
549   ,p_token_1
550   ,p_value_1
551   ,p_token_2
552   ,p_value_2
553   ,p_token_3
554   ,p_value_3
555   ,p_token_4
556   ,p_value_4);
557 
558 RETURN get_message;
559 END get_message;
560 
561 
562 /*======================================================================+
563 |                                                                       |
564 | Public Function                                                       |
565 |                                                                       |
566 | get_message                                                           |
567 |                                                                       |
568 | Return the message completed with the value for 5 token.              |
569 |                                                                       |
570 +======================================================================*/
571 FUNCTION  get_message
572   (p_appli_s_name                 IN  VARCHAR2
573   ,p_msg_name                     IN  VARCHAR2
574   ,p_token_1                      IN  VARCHAR2
575   ,p_value_1                      IN  VARCHAR2
576   ,p_token_2                      IN  VARCHAR2
577   ,p_value_2                      IN  VARCHAR2
578   ,p_token_3                      IN  VARCHAR2
579   ,p_value_3                      IN  VARCHAR2
580   ,p_token_4                      IN  VARCHAR2
581   ,p_value_4                      IN  VARCHAR2
582   ,p_token_5                      IN  VARCHAR2
583   ,p_value_5                      IN  VARCHAR2)
584 RETURN VARCHAR2
585 
586 IS
587 BEGIN
588 build_message
589   (p_appli_s_name
590   ,p_msg_name
591   ,p_token_1
592   ,p_value_1
593   ,p_token_2
594   ,p_value_2
595   ,p_token_3
596   ,p_value_3
597   ,p_token_4
598   ,p_value_4
599   ,p_token_5
600   ,p_value_5);
601 
602 RETURN get_message;
603 END get_message;
604 
605 
606 /*======================================================================+
607 |                                                                       |
608 | Public Function                                                       |
609 |                                                                       |
610 | get_message                                                           |
611 |                                                                       |
612 | Return the message completed with the value for 6 token.              |
613 |                                                                       |
614 +======================================================================*/
615 FUNCTION  get_message
616   (p_appli_s_name                 IN  VARCHAR2
617   ,p_msg_name                     IN  VARCHAR2
618   ,p_token_1                      IN  VARCHAR2
619   ,p_value_1                      IN  VARCHAR2
620   ,p_token_2                      IN  VARCHAR2
621   ,p_value_2                      IN  VARCHAR2
622   ,p_token_3                      IN  VARCHAR2
623   ,p_value_3                      IN  VARCHAR2
624   ,p_token_4                      IN  VARCHAR2
625   ,p_value_4                      IN  VARCHAR2
626   ,p_token_5                      IN  VARCHAR2
627   ,p_value_5                      IN  VARCHAR2
628   ,p_token_6                      IN  VARCHAR2
629   ,p_value_6                      IN  VARCHAR2)
630 RETURN VARCHAR2
631 
632 IS
633 BEGIN
634 build_message
635   (p_appli_s_name
636   ,p_msg_name
637   ,p_token_1
638   ,p_value_1
639   ,p_token_2
640   ,p_value_2
641   ,p_token_3
642   ,p_value_3
643   ,p_token_4
644   ,p_value_4
645   ,p_token_5
646   ,p_value_5
647   ,p_token_6
648   ,p_value_6);
649 
650 RETURN get_message;
651 END get_message;
652 
653 
654 END xla_messages_pkg;