1 package PV_MESSAGE AUTHID CURRENT_USER as
2 /* $Header: pvxvmsgs.pls 115.6 2002/12/11 10:41:48 anubhavk ship $ */
3
4
5 /*
6 ** SET_NAME - sets the message name
7 */
8 procedure SET_NAME(APPLICATION in varchar2, NAME in varchar2);
9 pragma restrict_references(SET_NAME, WNDS);
10
11 /*
12 ** SET_TOKEN - defines a message token with a value
13 */
14 procedure SET_TOKEN(TOKEN in varchar2,
15 VALUE in varchar2,
16 TRANSLATE in boolean default false);
17 pragma restrict_references(SET_TOKEN, WNDS);
18
19 /*
20 ** RETRIEVE - gets the message and token data, clears message buffer
21 */
22 procedure RETRIEVE(MSGOUT out nocopy varchar2);
23 pragma restrict_references(RETRIEVE, WNDS);
24
25 /*
26 ** CLEAR - clears the message buffer
27 */
28 procedure CLEAR;
29 pragma restrict_references(CLEAR, WNDS);
30
31 /*
32 ** GET_STRING- get a particular translated message
33 ** from the message dictionary database.
34 **
35 ** This is a one-call interface for when you just want to get a
36 ** message without doing any token substitution.
37 ** Returns NULL if the message cannot be found.
38 */
39 function GET_STRING(APPIN in varchar2,
40 NAMEIN in varchar2) return varchar2;
41 pragma restrict_references(GET_STRING, WNDS, WNPS);
42
43 /*
44 ** GET_NUMBER- get the message number of a particular message.
45 **
46 ** Returns 0 if the message has no message number,
47 ** or if its message number is zero.
48 ** NULL if the message can't be found.
49 */
50 function GET_NUMBER(APPIN in varchar2,
51 NAMEIN in varchar2) return NUMBER;
52 pragma restrict_references(GET_NUMBER, WNDS, WNPS);
53
54 /*
55 ** GET- get a translated and token substituted message
56 ** from the message dictionary database.
57 ** Returns NULL if the message cannot be found.
58 */
59 function GET return varchar2;
60 pragma restrict_references(GET, WNDS);
61
62 /*
63 ** GET_ENCODED- Get an encoded message from the message stack.
64 */
65 function GET_ENCODED return varchar2;
66 pragma restrict_references(GET_ENCODED, WNDS);
67
68 /*
69 ** PARSE_ENCODED- Parse the message name and application short name
70 ** out nocopy of a message in "encoded" format.
71 */
72 procedure PARSE_ENCODED(ENCODED_MESSAGE IN varchar2,
73 APP_SHORT_NAME OUT NOCOPY varchar2,
74 MESSAGE_NAME OUT NOCOPY varchar2);
75 pragma restrict_references(PARSE_ENCODED, WNDS, WNPS);
76
77 /*
78 ** SET_ENCODED- Set an encoded message onto the message stack
79 */
80 procedure SET_ENCODED(ENCODED_MESSAGE IN varchar2);
81 pragma restrict_references(SET_ENCODED, WNDS);
82
83 /*
84 ** raise_error - raises the error to the calling entity
85 ** via raise_application_error() prodcedure
86 */
87 procedure RAISE_ERROR;
88 pragma restrict_references(RAISE_ERROR, WNDS, WNPS);
89
90 end pv_message;
[Home] [Help]