[Home] [Help]
PACKAGE: CTXSYS.DRUE
Source
1 package drue authid current_user as
2
3 -- Public data structure
4
5 --
6 -- Public procedure prototypes
7 --
8
9 /*-------------------------------- push -------------------------------------*/
10 /*
11 NAME
12 push - PUSH an error onto the stack
13 DESCRIPTION
14
15 This function uses trusted callout drexrmessage to get the requested
16 error and push it on the stack. The function takes the facility and
17 nmenonic error symbol, and using the current language ID, retrieves
18 the error, and pushes it onto the stack.
19
20 ARGUMENTS
21
22 msgid - error code number
23
24 NOTES
25 The messages must have substition variables of the form
26 '%(number)s'. You cannot have a substitution variable without a
27 number (ex %s) or a substitution variable with a type other than s
28 (ex %(1)d)
29
30 EXCEPTIONS
31
32 RETURNS
33 none
34 */
35 procedure push(
36 msgid number,
37 arg1 varchar2 default NULL,
38 arg2 varchar2 default NULL,
39 arg3 varchar2 default NULL,
40 arg4 varchar2 default NULL,
41 arg5 varchar2 default NULL
42 );
43 --pragma restrict_references(push, wnds);
44
45 /*-----------------------------get_error_mesg --------------------------*/
46 function get_error_mesg(
47 msgid number,
48 arg1 varchar2 default NULL,
49 arg2 varchar2 default NULL,
50 arg3 varchar2 default NULL,
51 arg4 varchar2 default NULL,
52 arg5 varchar2 default NULL
53 ) return varchar2;
54
55 /*-------------------------- push_internal ---------------------------------*/
56 /*
57 NAME
58 push_internal - PUSH an internal error onto the stack
59 DESCRIPTION
60
61 This function pushes an internal error onto the stack.
62
63 ARGUMENTS
64 arg1..arg5 the arguments for the internal error, printed in
65 the brackets: DRG-123: internal error [arg1] [arg2] ...
66 NOTES
67
68 EXCEPTIONS
69
70 RETURNS
71 none
72 */
73 procedure push_internal(
74 arg1 varchar2 default NULL,
75 arg2 varchar2 default NULL,
76 arg3 varchar2 default NULL,
77 arg4 varchar2 default NULL,
78 arg5 varchar2 default NULL
79 );
80 --pragma restrict_references(push_internal, wnds);
81
82 /*--------------------------- get_stack -------------------------------------*/
83 /*
84 NAME
85 get_stack - return contents of stack, and clear the stack
86
87 DESCRIPTION
88
89 ARGUMENTS
90
91 notes
92
93
94 exceptions
95
96 returns
97 none
98 */
99 function get_stack return varchar2;
100
101 /*--------------------------- get_stack1 ------------------------------------*/
102 /*
103 NAME
104 get_stack1 - return contents of stack, and clear the stack
105
106 DESCRIPTION
107
108 ARGUMENTS
109
110 notes
111
112
113 exceptions
114
115 returns
116 none
117 */
118 function get_stack1 return varchar2;
119
120 /*-------------------------------- raise -------------------------------------*/
121 /*
122 NAME
123 raise - raise an exception, dumping the current stack
124 DESCRIPTION
125
126 ARGUMENTS
127
128 notes
129
130
131 exceptions
132
133 returns
134 none
135 */
136 procedure raise;
137
138 /*-------------------------------- error------------------------------------*/
139 /*
140 NAME
141 error - is there an error on the stack?
142 DESCRIPTION
143
144 ARGUMENTS
145
146 NOTES
147
148
149 EXCEPTIONS
150
151 RETURNS
152 TRUE/FALSE
153 */
154 function error return boolean;
155 pragma restrict_references(error, wnds);
156
157
158 /*-------------------------- text_on_stack ---------------------------------*/
159 /*
160 NAME
161 text_on_stack - push text directly on stack
162 DESCRIPTION
163
164 This function is used to push the stack returned from C onto the PL/SQL
165 stack.
166
167 ARGUMENTS
168
169 text - text to push
170
171 NOTES
172
173 EXCEPTIONS
174
175 RETURNS
176 none
177 */
178 procedure text_on_stack(
179 text varchar2,
180 comment varchar2 default null
181 );
182 -- pragma restrict_references(text_on_stack, wnds);
183
184 -- exceptions
185
186 /*-------------------------- getmsg ---------------------------------*/
187 /*
188 NAME
189 getmsg
190 DESCRIPTION
191
192 ARGUMENTS
193
194 NOTES
195
196 EXCEPTIONS
197
198 RETURNS
199 none
200 */
201 procedure getmsg(msgid in binary_integer, msgtext out varchar2);
202
203 /*-------------------------- clear_stack ---------------------------------*/
204 /*
205 NAME
206 clear_stack
207 DESCRIPTION
208
209 ARGUMENTS
210
211 NOTES
212
213 EXCEPTIONS
214
215 RETURNS
216 none
217 */
218 procedure clear_stack;
219
220 /*-------------------------- pop -----------------------------------------*/
221 /*
222 NAME
223 pop
224
225 DESCRIPTION
226 gets last errcode, errmsg, then clears stack
227
228 ARGUMENTS
229
230 NOTES
231
232 EXCEPTIONS
233
234 RETURNS
235 last errcode
236 */
237 procedure pop(errcode out number, errmsg out varchar2);
238
239 /*--------------------------- get_stack_noclear -----------------------------*/
240 /*
241 NAME
242 get_stack_noclear - return contents of stack without clearing the stack
243
244 DESCRIPTION
245
246 ARGUMENTS
247
248 notes
249
250
251 exceptions
252
253 returns
254 none
255 */
256 function get_stack_noclear return varchar2;
257
258
259 end drue;