1 package ZPB_ERROR_HANDLER as
2 /* $Header: zpberrhandler.pls 120.0.12010.4 2006/08/03 13:36:33 appldev noship $ */
3
4
5 -------------------------------------------------------------------------------
6 -- HANDLE_EXCEPTION
7 --
8 -- Procedure to handle an exception. Will log the exception at level 4 -
9 -- EXCEPTION and register it to be displayed by OA. The process will be
10 -- returned to your code.
11 --
12 -- IN:
13 -- P_MODULE - The calling package
14 -- P_PROCEDURE - The calling procedure
15 -- P_MESSAGE - The Message name defined in FND_MESSAGES table. If
16 -- omitted, default message used and will pull message from
17 -- SQLERRM (meaning an exception must have been thrown).
18 -- TOKEN_# - Any tokens required in the message. Tokens go as a
19 -- a name/value. Omit if not applicable or using default.
20 --
21 -------------------------------------------------------------------------------
22 procedure HANDLE_EXCEPTION (P_MODULE in VARCHAR2,
23 P_PROCEDURE in VARCHAR2,
24 P_MESSAGE in VARCHAR2 default NULL,
25 TOKEN_1_NAME in VARCHAR2 default NULL,
26 TOKEN_1_VALUE in VARCHAR2 default NULL,
27 TOKEN_2_NAME in VARCHAR2 default NULL,
28 TOKEN_2_VALUE in VARCHAR2 default NULL,
29 TOKEN_3_NAME in VARCHAR2 default NULL,
30 TOKEN_3_VALUE in VARCHAR2 default NULL,
31 TOKEN_4_NAME in VARCHAR2 default NULL,
32 TOKEN_4_VALUE in VARCHAR2 default NULL,
33 TOKEN_5_NAME in VARCHAR2 default NULL,
34 TOKEN_5_VALUE in VARCHAR2 default NULL);
35
36 -------------------------------------------------------------------------------
37 -- INITIALIZE
38 --
39 -- Prcoedure that will initialize error handling. This MUST be called ONCE
40 -- each time OA calls a PL/SQL procedure before any error handling methods
41 -- are called.
42 --
43 -------------------------------------------------------------------------------
44 procedure INITIALIZE;
45
46 -------------------------------------------------------------------------------
47 -- Merges the return status, keeping the more severe error
48 --
49 -- IN:
50 -- P_CURR_STATUS - The Current Status
51 -- P_MERGED_STATUS - The status to merge into the current status
52 -------------------------------------------------------------------------------
53 procedure MERGE_STATUS (x_curr_status IN OUT NOCOPY VARCHAR2,
54 p_merge_status IN VARCHAR2);
55
56 -------------------------------------------------------------------------------
57 -- RAISE_EXCEPTION
58 --
59 -- Procedure to handle an exception. Will log the exception at level 4 -
60 -- EXCEPTION and raise a new SQLException. Processing will halt, and it is
61 -- up to the OA code to handle the SQLException properly.
62 --
63 -- IN:
64 -- P_MODULE - The calling package
65 -- P_PROCEDURE - The calling procedure
66 -- P_MESSAGE - The Message name defined in FND_MESSAGES table. If
67 -- omitted, default message used and will pull message from
68 -- SQLERRM (meaning an exception must have been thrown).
69 -- TOKEN_# - Any tokens required in the message. Tokens go as a
70 -- a name/value. Omit if not applicable or using default.
71 --
72 -------------------------------------------------------------------------------
73 procedure RAISE_EXCEPTION (P_MODULE in VARCHAR2,
74 P_PROCEDURE in VARCHAR2,
75 P_MESSAGE in VARCHAR2 default NULL,
76 TOKEN_1_NAME in VARCHAR2 default NULL,
77 TOKEN_1_VALUE in VARCHAR2 default NULL,
78 TOKEN_2_NAME in VARCHAR2 default NULL,
79 TOKEN_2_VALUE in VARCHAR2 default NULL,
80 TOKEN_3_NAME in VARCHAR2 default NULL,
81 TOKEN_3_VALUE in VARCHAR2 default NULL,
82 TOKEN_4_NAME in VARCHAR2 default NULL,
83 TOKEN_4_VALUE in VARCHAR2 default NULL,
84 TOKEN_5_NAME in VARCHAR2 default NULL,
85 TOKEN_5_VALUE in VARCHAR2 default NULL);
86
87 -------------------------------------------------------------------------------
88 -- REGISTER_CONFIRMATION
89 --
90 -- Procedure to register a confirmation box. Message will be logged at
91 -- level 3 - EVENT and register it to be displayed by OA. The process will
92 -- be returned to your code.
93 --
94 -- IN:
95 -- P_MODULE - The calling package
96 -- P_PROCEDURE - The calling procedure
97 -- P_MESSAGE - The Message name defined in FND_MESSAGES table. If
98 -- omitted, default message used and will pull message from
99 -- SQLERRM (meaning an exception must have been thrown).
100 -- TOKEN_# - Any tokens required in the message. Tokens go as a
101 -- a name/value. Omit if not applicable or using default.
102 --
103 -------------------------------------------------------------------------------
104 procedure REGISTER_CONFIRMATION (P_MODULE in VARCHAR2,
105 P_PROCEDURE in VARCHAR2,
106 P_MESSAGE in VARCHAR2,
107 TOKEN_1_NAME in VARCHAR2 default NULL,
108 TOKEN_1_VALUE in VARCHAR2 default NULL,
109 TOKEN_2_NAME in VARCHAR2 default NULL,
110 TOKEN_2_VALUE in VARCHAR2 default NULL,
111 TOKEN_3_NAME in VARCHAR2 default NULL,
112 TOKEN_3_VALUE in VARCHAR2 default NULL,
113 TOKEN_4_NAME in VARCHAR2 default NULL,
114 TOKEN_4_VALUE in VARCHAR2 default NULL,
115 TOKEN_5_NAME in VARCHAR2 default NULL,
116 TOKEN_5_VALUE in VARCHAR2 default NULL);
117
118 -------------------------------------------------------------------------------
119 -- REGISTER_ERROR
120 --
121 -- Procedure to register an error. Message will be logged at level 5 -
122 -- ERROR and register it to be displayed by OA. The process will be
123 -- returned to your code.
124 --
125 -- IN:
126 -- P_MODULE - The calling package
127 -- P_PROCEDURE - The calling procedure
128 -- P_MESSAGE - The Message name defined in FND_MESSAGES table. If
129 -- omitted, default message used and will pull message from
130 -- SQLERRM (meaning an exception must have been thrown).
131 -- TOKEN_# - Any tokens required in the message. Tokens go as a
132 -- a name/value. Omit if not applicable or using default.
133 --
134 -------------------------------------------------------------------------------
135 procedure REGISTER_ERROR (P_MODULE in VARCHAR2,
136 P_PROCEDURE in VARCHAR2,
137 P_MESSAGE in VARCHAR2,
138 TOKEN_1_NAME in VARCHAR2 default NULL,
139 TOKEN_1_VALUE in VARCHAR2 default NULL,
140 TOKEN_2_NAME in VARCHAR2 default NULL,
141 TOKEN_2_VALUE in VARCHAR2 default NULL,
142 TOKEN_3_NAME in VARCHAR2 default NULL,
143 TOKEN_3_VALUE in VARCHAR2 default NULL,
144 TOKEN_4_NAME in VARCHAR2 default NULL,
145 TOKEN_4_VALUE in VARCHAR2 default NULL,
146 TOKEN_5_NAME in VARCHAR2 default NULL,
147 TOKEN_5_VALUE in VARCHAR2 default NULL);
148
149 -------------------------------------------------------------------------------
150 -- REGISTER_INFORMATION
151 --
152 -- Procedure to register an information box. Message will be logged at
153 -- level 5 - ERROR and register it to be displayed by OA. The process will
154 -- be returned to your code.
155 --
156 -- IN:
157 -- P_MODULE - The calling package
158 -- P_PROCEDURE - The calling procedure
159 -- P_MESSAGE - The Message name defined in FND_MESSAGES table. If
160 -- omitted, default message used and will pull message from
161 -- SQLERRM (meaning an exception must have been thrown).
162 -- TOKEN_# - Any tokens required in the message. Tokens go as a
163 -- a name/value. Omit if not applicable or using default.
164 --
165 -------------------------------------------------------------------------------
166 procedure REGISTER_INFORMATION (P_MODULE in VARCHAR2,
167 P_PROCEDURE in VARCHAR2,
168 P_MESSAGE in VARCHAR2,
169 TOKEN_1_NAME in VARCHAR2 default NULL,
170 TOKEN_1_VALUE in VARCHAR2 default NULL,
171 TOKEN_2_NAME in VARCHAR2 default NULL,
172 TOKEN_2_VALUE in VARCHAR2 default NULL,
173 TOKEN_3_NAME in VARCHAR2 default NULL,
174 TOKEN_3_VALUE in VARCHAR2 default NULL,
175 TOKEN_4_NAME in VARCHAR2 default NULL,
176 TOKEN_4_VALUE in VARCHAR2 default NULL,
177 TOKEN_5_NAME in VARCHAR2 default NULL,
178 TOKEN_5_VALUE in VARCHAR2 default NULL);
179
180 -------------------------------------------------------------------------------
181 -- REGISTER_WARNING
182 --
183 -- Procedure to register a warning. Message will be logged at level 5 -
184 -- ERROR and register it to be displayed by OA. The process will be
185 -- returned to your code.
186 --
187 -- IN:
188 -- P_MODULE - The calling package
189 -- P_PROCEDURE - The calling procedure
190 -- P_MESSAGE - The Message name defined in FND_MESSAGES table. If
191 -- omitted, default message used and will pull message from
192 -- SQLERRM (meaning an exception must have been thrown).
193 -- TOKEN_# - Any tokens required in the message. Tokens go as a
194 -- a name/value. Omit if not applicable or using default.
195 --
196 -------------------------------------------------------------------------------
197 procedure REGISTER_WARNING (P_MODULE in VARCHAR2,
198 P_PROCEDURE in VARCHAR2,
199 P_MESSAGE in VARCHAR2,
200 TOKEN_1_NAME in VARCHAR2 default NULL,
201 TOKEN_1_VALUE in VARCHAR2 default NULL,
202 TOKEN_2_NAME in VARCHAR2 default NULL,
203 TOKEN_2_VALUE in VARCHAR2 default NULL,
204 TOKEN_3_NAME in VARCHAR2 default NULL,
205 TOKEN_3_VALUE in VARCHAR2 default NULL,
206 TOKEN_4_NAME in VARCHAR2 default NULL,
207 TOKEN_4_VALUE in VARCHAR2 default NULL,
208 TOKEN_5_NAME in VARCHAR2 default NULL,
209 TOKEN_5_VALUE in VARCHAR2 default NULL);
210
211 -------------------------------------------------------------------------------
212 -- SET_CONC_REQ_STATUS
213 --
214 -- Sets the return status of a concurrent request:
215 --
216 -- IN:
217 -- P_STATUS - Can be one of:
218 -- S = SUCCESS
219 -- W = WARNING
220 -- E = ERROR
221 -------------------------------------------------------------------------------
222 procedure SET_CONC_REQ_STATUS (P_STATUS in VARCHAR2);
223
224
225 -------------------------------------------------------------------------------
226 -- INIT_CONC_REQ_STATUS
227 --
228 -- Initializes pkg variables to support concurrent request warning:
229 -- pv_status is intialized to NULL
230 -------------------------------------------------------------------------------
231 -- A. Budnik 05/09/2006 b 5170327 retcode conc warnings from AW dml |
232 procedure INIT_CONC_REQ_STATUS;
233
234
235 -------------------------------------------------------------------------------
236 -- GET_CONC_REQ_STATUS
237 --
238 -- This function returns status set by PUT_CONC_REQ_STATUS and converts it to the
239 -- retcode expected by a concurrent program.
240 -- IN:
241 -- l_conc_retcode can be:
242 -- SUCCESS: S = 0
243 -- WARNING: W = 1
244 -- ERROR: E = 2
245 -------------------------------------------------------------------------------
246 -- A. Budnik 05/09/2006 b 5170327 retcode conc warnings from AW dml |
247
248 function GET_CONC_REQ_STATUS return varchar2;
249
250 end ZPB_ERROR_HANDLER;
[Home] [Help]