1 Package Body pay_puc_upd as
2 /* $Header: pypucrhi.pkb 115.1 2003/10/29 21:15 tvankayl noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- | Private Global Definitions |
6 -- ----------------------------------------------------------------------------
7 --
8 g_package varchar2(33) := ' pay_puc_upd.'; -- Global package name
9 --
10 -- ----------------------------------------------------------------------------
11 -- |------------------------------< update_dml >------------------------------|
12 -- ----------------------------------------------------------------------------
13 -- {Start Of Comments}
14 --
15 -- Description:
16 -- This procedure controls the actual dml update logic. The processing of
17 -- this procedure is:
18 -- 1) Increment the object_version_number by 1 if the object_version_number
19 -- is defined as an attribute for this entity.
20 -- 2) To set and unset the g_api_dml status as required (as we are about to
21 -- perform dml).
22 -- 3) To update the specified row in the schema using the primary key in
23 -- the predicates.
24 -- 4) To trap any constraint violations that may have occurred.
25 -- 5) To raise any other errors.
26 --
27 -- Prerequisites:
28 -- This is an internal private procedure which must be called from the upd
29 -- procedure.
30 --
31 -- In Parameters:
32 -- A Pl/Sql record structre.
33 --
34 -- Post Success:
35 -- The specified row will be updated in the schema.
36 --
37 -- Post Failure:
38 -- On the update dml failure it is important to note that we always reset the
39 -- g_api_dml status to false.
40 -- If a check, unique or parent integrity constraint violation is raised the
41 -- constraint_error procedure will be called.
42 -- If any other error is reported, the error will be raised after the
43 -- g_api_dml status is reset.
44 --
45 -- Developer Implementation Notes:
46 -- The update 'set' attribute list should be modified if any of your
47 -- attributes are not updateable.
48 --
49 -- Access Status:
50 -- Internal Row Handler Use Only.
51 --
52 -- {End Of Comments}
53 -- ----------------------------------------------------------------------------
54 Procedure update_dml
55 (p_rec in out nocopy pay_puc_shd.g_rec_type
56 ) is
57 --
58 l_proc varchar2(72) := g_package||'update_dml';
59 --
60 Begin
61 hr_utility.set_location('Entering:'||l_proc, 5);
62 --
63 -- Increment the object version
64 p_rec.object_version_number := p_rec.object_version_number + 1;
65 --
66 pay_puc_shd.g_api_dml := true; -- Set the api dml status
67 --
68 -- Update the pay_user_columns Row
69 --
70 update pay_user_columns
71 set
72 formula_id = p_rec.formula_id
73 ,user_column_name = p_rec.user_column_name
74 ,object_version_number = p_rec.object_version_number
75 where user_column_id = p_rec.user_column_id;
76 --
77 pay_puc_shd.g_api_dml := false; -- Unset the api dml status
78 --
79 hr_utility.set_location(' Leaving:'||l_proc, 10);
80 --
81 Exception
82 When hr_api.check_integrity_violated Then
83 -- A check constraint has been violated
84 pay_puc_shd.g_api_dml := false; -- Unset the api dml status
85 pay_puc_shd.constraint_error
86 (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
87 When hr_api.parent_integrity_violated Then
88 -- Parent integrity has been violated
89 pay_puc_shd.g_api_dml := false; -- Unset the api dml status
90 pay_puc_shd.constraint_error
91 (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
92 When hr_api.unique_integrity_violated Then
93 -- Unique integrity has been violated
94 pay_puc_shd.g_api_dml := false; -- Unset the api dml status
95 pay_puc_shd.constraint_error
96 (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
97 When Others Then
98 pay_puc_shd.g_api_dml := false; -- Unset the api dml status
99 Raise;
100 End update_dml;
101 --
102 -- ----------------------------------------------------------------------------
103 -- |------------------------------< pre_update >------------------------------|
104 -- ----------------------------------------------------------------------------
105 -- {Start Of Comments}
106 --
107 -- Description:
108 -- This private procedure contains any processing which is required before
109 -- the update dml.
110 --
111 -- Prerequisites:
112 -- This is an internal procedure which is called from the upd procedure.
113 --
114 -- In Parameters:
115 -- A Pl/Sql record structure.
116 --
117 -- Post Success:
118 -- Processing continues.
119 --
120 -- Post Failure:
121 -- If an error has occurred, an error message and exception wil be raised
122 -- but not handled.
123 --
124 -- Developer Implementation Notes:
125 -- Any pre-processing required before the update dml is issued should be
126 -- coded within this procedure. It is important to note that any 3rd party
127 -- maintenance should be reviewed before placing in this procedure.
128 --
129 -- Access Status:
130 -- Internal Row Handler Use Only.
131 --
132 -- {End Of Comments}
133 -- ----------------------------------------------------------------------------
134 Procedure pre_update
135 (p_rec in pay_puc_shd.g_rec_type
136 ) is
137 --
138 l_proc varchar2(72) := g_package||'pre_update';
139 --
140 Begin
141 hr_utility.set_location('Entering:'||l_proc, 5);
142 --
143 hr_utility.set_location(' Leaving:'||l_proc, 10);
144 End pre_update;
145 --
146 -- ----------------------------------------------------------------------------
147 -- |-----------------------------< post_update >------------------------------|
148 -- ----------------------------------------------------------------------------
149 -- {Start Of Comments}
150 --
151 -- Description:
152 -- This private procedure contains any processing which is required after
153 -- the update dml.
154 --
155 -- Prerequisites:
156 -- This is an internal procedure which is called from the upd procedure.
157 --
158 -- In Parameters:
159 -- A Pl/Sql record structure.
160 --
161 -- Post Success:
162 -- Processing continues.
163 --
164 -- Post Failure:
165 -- If an error has occurred, an error message and exception will be raised
166 -- but not handled.
167 --
168 -- Developer Implementation Notes:
169 -- Any post-processing required after the update dml is issued should be
170 -- coded within this procedure. It is important to note that any 3rd party
171 -- maintenance should be reviewed before placing in this procedure.
172 --
173 -- Access Status:
174 -- Internal Row Handler Use Only.
175 --
176 -- {End Of Comments}
177 -- ----------------------------------------------------------------------------
178 Procedure post_update
179 (p_rec in pay_puc_shd.g_rec_type
180 ,p_formula_warning in boolean
181 ) is
182 --
183 l_proc varchar2(72) := g_package||'post_update';
184 --
185 Begin
186 hr_utility.set_location('Entering:'||l_proc, 5);
187 begin
188 --
189 pay_puc_rku.after_update
190 (p_user_column_id
191 => p_rec.user_column_id
192 ,p_formula_id
193 => p_rec.formula_id
194 ,p_user_column_name
195 => p_rec.user_column_name
196 ,p_object_version_number
197 => p_rec.object_version_number
198 ,p_formula_warning
199 => p_formula_warning
200 ,p_business_group_id_o
201 => pay_puc_shd.g_old_rec.business_group_id
202 ,p_legislation_code_o
203 => pay_puc_shd.g_old_rec.legislation_code
204 ,p_user_table_id_o
205 => pay_puc_shd.g_old_rec.user_table_id
206 ,p_formula_id_o
207 => pay_puc_shd.g_old_rec.formula_id
208 ,p_user_column_name_o
209 => pay_puc_shd.g_old_rec.user_column_name
210 ,p_object_version_number_o
211 => pay_puc_shd.g_old_rec.object_version_number
212 );
213 --
214 exception
215 --
216 when hr_api.cannot_find_prog_unit then
217 --
218 hr_api.cannot_find_prog_unit_error
219 (p_module_name => 'PAY_USER_COLUMNS'
220 ,p_hook_type => 'AU');
221 --
222 end;
223 --
224 hr_utility.set_location(' Leaving:'||l_proc, 10);
225 End post_update;
226 --
227 -- ----------------------------------------------------------------------------
228 -- |-----------------------------< convert_defs >-----------------------------|
229 -- ----------------------------------------------------------------------------
230 -- {Start Of Comments}
231 --
232 -- Description:
233 -- The Convert_Defs procedure has one very important function:
234 -- It must return the record structure for the row with all system defaulted
235 -- values converted into its corresponding parameter value for update. When
236 -- we attempt to update a row through the Upd process , certain
237 -- parameters can be defaulted which enables flexibility in the calling of
238 -- the upd process (e.g. only attributes which need to be updated need to be
239 -- specified). For the upd process to determine which attributes
240 -- have NOT been specified we need to check if the parameter has a reserved
241 -- system default value. Therefore, for all parameters which have a
242 -- corresponding reserved system default mechanism specified we need to
243 -- check if a system default is being used. If a system default is being
244 -- used then we convert the defaulted value into its corresponding attribute
245 -- value held in the g_old_rec data structure.
246 --
247 -- Prerequisites:
248 -- This private function can only be called from the upd process.
249 --
250 -- In Parameters:
251 -- A Pl/Sql record structure.
252 --
253 -- Post Success:
254 -- The record structure will be returned with all system defaulted parameter
255 -- values converted into its current row attribute value.
256 --
257 -- Post Failure:
258 -- No direct error handling is required within this function. Any possible
259 -- errors within this procedure will be a PL/SQL value error due to
260 -- conversion of datatypes or data lengths.
261 --
262 -- Developer Implementation Notes:
263 -- None.
264 --
265 -- Access Status:
266 -- Internal Row Handler Use Only.
267 --
268 -- {End Of Comments}
269 -- ----------------------------------------------------------------------------
270 Procedure convert_defs
271 (p_rec in out nocopy pay_puc_shd.g_rec_type
272 ) is
273 --
274 Begin
275 --
276 -- We must now examine each argument value in the
277 -- p_rec plsql record structure
278 -- to see if a system default is being used. If a system default
279 -- is being used then we must set to the 'current' argument value.
280 --
281 If (p_rec.business_group_id = hr_api.g_number) then
282 p_rec.business_group_id :=
283 pay_puc_shd.g_old_rec.business_group_id;
284 End If;
285 If (p_rec.legislation_code = hr_api.g_varchar2) then
286 p_rec.legislation_code :=
287 pay_puc_shd.g_old_rec.legislation_code;
288 End If;
289 If (p_rec.user_table_id = hr_api.g_number) then
290 p_rec.user_table_id :=
291 pay_puc_shd.g_old_rec.user_table_id;
292 End If;
293 If (p_rec.formula_id = hr_api.g_number) then
294 p_rec.formula_id :=
295 pay_puc_shd.g_old_rec.formula_id;
296 End If;
297 If (p_rec.user_column_name = hr_api.g_varchar2) then
298 p_rec.user_column_name :=
299 pay_puc_shd.g_old_rec.user_column_name;
300 End If;
301 --
302 End convert_defs;
303 --
304 -- ----------------------------------------------------------------------------
305 -- |---------------------------------< upd >----------------------------------|
306 -- ----------------------------------------------------------------------------
307 Procedure upd
308 (p_rec in out nocopy pay_puc_shd.g_rec_type
309 ,p_formula_warning out nocopy boolean
310 ) is
311 --
312 l_proc varchar2(72) := g_package||'upd';
313 l_formula_warning boolean;
314 --
315 Begin
316 hr_utility.set_location('Entering:'||l_proc, 5);
317 --
318 -- We must lock the row which we need to update.
319 --
320 pay_puc_shd.lck
321 (p_rec.user_column_id
322 ,p_rec.object_version_number
323 );
324 --
325 -- 1. During an update system defaults are used to determine if
326 -- arguments have been defaulted or not. We must therefore
327 -- derive the full record structure values to be updated.
328 --
329 -- 2. Call the supporting update validate operations.
330 --
331 convert_defs(p_rec);
332 pay_puc_bus.update_validate
333 (p_rec
334 ,l_formula_warning
335 );
336 --
337 -- Call to raise any errors on multi-message list
338 hr_multi_message.end_validation_set;
339 --
340 -- Call the supporting pre-update operation
341 --
342 pay_puc_upd.pre_update(p_rec);
343 --
344 -- Update the row.
345 --
346 pay_puc_upd.update_dml(p_rec);
347 --
348 -- Call the supporting post-update operation
349 --
350 pay_puc_upd.post_update
351 (p_rec
352 ,l_formula_warning
353 );
354 --
355 -- Call to raise any errors on multi-message list
356 hr_multi_message.end_validation_set;
357 --
358 p_formula_warning := l_formula_warning;
359 End upd;
360 --
361 -- ----------------------------------------------------------------------------
362 -- |---------------------------------< upd >----------------------------------|
363 -- ----------------------------------------------------------------------------
364 Procedure upd
365 (p_user_column_id in number
366 ,p_object_version_number in out nocopy number
367 ,p_user_column_name in varchar2 default hr_api.g_varchar2
368 ,p_formula_id in number default hr_api.g_number
369 ,p_formula_warning out nocopy boolean
370 ) is
371 --
372 l_rec pay_puc_shd.g_rec_type;
373 l_proc varchar2(72) := g_package||'upd';
374 --
375 Begin
376 hr_utility.set_location('Entering:'||l_proc, 5);
377 --
378 -- Call conversion function to turn arguments into the
379 -- l_rec structure.
380 --
381 l_rec :=
382 pay_puc_shd.convert_args
383 (p_user_column_id
384 ,hr_api.g_number
385 ,hr_api.g_varchar2
386 ,hr_api.g_number
387 ,p_formula_id
388 ,p_user_column_name
389 ,p_object_version_number
390 );
391 --
392 -- Having converted the arguments into the
393 -- plsql record structure we call the corresponding record
394 -- business process.
395 --
396 pay_puc_upd.upd
397 (l_rec
398 ,p_formula_warning
399 );
400 p_object_version_number := l_rec.object_version_number;
401 --
402 hr_utility.set_location(' Leaving:'||l_proc, 10);
403 End upd;
404 --
405 end pay_puc_upd;
[Home] [Help]