1 Package Body pay_rcu_upd as
2 /* $Header: pyrcurhi.pkb 120.1 2005/06/20 05:01:52 tvankayl noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- | Private Global Definitions |
6 -- ----------------------------------------------------------------------------
7 --
8 g_package varchar2(33) := ' pay_rcu_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_rcu_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 --
67 --
68 -- Update the pay_retro_component_usages Row
69 --
70 update pay_retro_component_usages
71 set
72 retro_component_usage_id = p_rec.retro_component_usage_id
73 ,retro_component_id = p_rec.retro_component_id
74 ,creator_id = p_rec.creator_id
75 ,creator_type = p_rec.creator_type
76 ,default_component = p_rec.default_component
77 ,reprocess_type = p_rec.reprocess_type
78 ,object_version_number = p_rec.object_version_number
79 ,replace_run_flag = p_rec.replace_run_flag
80 ,use_override_dates = p_rec.use_override_dates
81 where retro_component_usage_id = p_rec.retro_component_usage_id;
82 --
83 --
84 --
85 hr_utility.set_location(' Leaving:'||l_proc, 10);
86 --
87 Exception
88 When hr_api.check_integrity_violated Then
89 -- A check constraint has been violated
90 --
91 pay_rcu_shd.constraint_error
92 (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
93 When hr_api.parent_integrity_violated Then
94 -- Parent integrity has been violated
95 --
96 pay_rcu_shd.constraint_error
97 (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
98 When hr_api.unique_integrity_violated Then
99 -- Unique integrity has been violated
100 --
101 pay_rcu_shd.constraint_error
102 (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
103 When Others Then
104 --
105 Raise;
106 End update_dml;
107 --
108 -- ----------------------------------------------------------------------------
109 -- |------------------------------< pre_update >------------------------------|
110 -- ----------------------------------------------------------------------------
111 -- {Start Of Comments}
112 --
113 -- Description:
114 -- This private procedure contains any processing which is required before
115 -- the update dml.
116 --
117 -- Prerequisites:
118 -- This is an internal procedure which is called from the upd procedure.
119 --
120 -- In Parameters:
121 -- A Pl/Sql record structure.
122 --
123 -- Post Success:
124 -- Processing continues.
125 --
126 -- Post Failure:
127 -- If an error has occurred, an error message and exception wil be raised
128 -- but not handled.
129 --
130 -- Developer Implementation Notes:
131 -- Any pre-processing required before the update dml is issued should be
132 -- coded within this procedure. It is important to note that any 3rd party
133 -- maintenance should be reviewed before placing in this procedure.
134 --
135 -- Access Status:
136 -- Internal Row Handler Use Only.
137 --
138 -- {End Of Comments}
139 -- ----------------------------------------------------------------------------
140 Procedure pre_update
141 (p_rec in pay_rcu_shd.g_rec_type
142 ) is
143 --
144 l_proc varchar2(72) := g_package||'pre_update';
145 --
146 Begin
147 hr_utility.set_location('Entering:'||l_proc, 5);
148 --
149 hr_utility.set_location(' Leaving:'||l_proc, 10);
150 End pre_update;
151 --
152 -- ----------------------------------------------------------------------------
153 -- |-----------------------------< post_update >------------------------------|
154 -- ----------------------------------------------------------------------------
155 -- {Start Of Comments}
156 --
157 -- Description:
158 -- This private procedure contains any processing which is required after
159 -- the update dml.
160 --
161 -- Prerequisites:
162 -- This is an internal procedure which is called from the upd procedure.
163 --
164 -- In Parameters:
165 -- A Pl/Sql record structure.
166 --
167 -- Post Success:
168 -- Processing continues.
169 --
170 -- Post Failure:
171 -- If an error has occurred, an error message and exception will be raised
172 -- but not handled.
173 --
174 -- Developer Implementation Notes:
175 -- Any post-processing required after the update dml is issued should be
176 -- coded within this procedure. It is important to note that any 3rd party
177 -- maintenance should be reviewed before placing in this procedure.
178 --
179 -- Access Status:
180 -- Internal Row Handler Use Only.
181 --
182 -- {End Of Comments}
183 -- ----------------------------------------------------------------------------
184 Procedure post_update
185 (p_effective_date in date
186 ,p_rec in pay_rcu_shd.g_rec_type
187 ) is
188 --
189 l_proc varchar2(72) := g_package||'post_update';
190 --
191 Begin
192 hr_utility.set_location('Entering:'||l_proc, 5);
193 begin
194 --
195 pay_rcu_rku.after_update
196 (p_effective_date => p_effective_date
197 ,p_retro_component_usage_id
198 => p_rec.retro_component_usage_id
199 ,p_business_group_id
200 => p_rec.business_group_id
201 ,p_legislation_code
202 => p_rec.legislation_code
203 ,p_retro_component_id
204 => p_rec.retro_component_id
205 ,p_creator_id
206 => p_rec.creator_id
207 ,p_creator_type
208 => p_rec.creator_type
209 ,p_default_component
210 => p_rec.default_component
211 ,p_reprocess_type
212 => p_rec.reprocess_type
213 ,p_object_version_number
214 => p_rec.object_version_number
215 ,p_replace_run_flag
216 => p_rec.replace_run_flag
217 ,p_use_override_dates
218 => p_rec.use_override_dates
219 ,p_business_group_id_o
220 => pay_rcu_shd.g_old_rec.business_group_id
221 ,p_legislation_code_o
222 => pay_rcu_shd.g_old_rec.legislation_code
223 ,p_retro_component_id_o
224 => pay_rcu_shd.g_old_rec.retro_component_id
225 ,p_creator_id_o
226 => pay_rcu_shd.g_old_rec.creator_id
227 ,p_creator_type_o
228 => pay_rcu_shd.g_old_rec.creator_type
229 ,p_default_component_o
230 => pay_rcu_shd.g_old_rec.default_component
231 ,p_reprocess_type_o
232 => pay_rcu_shd.g_old_rec.reprocess_type
233 ,p_object_version_number_o
234 => pay_rcu_shd.g_old_rec.object_version_number
235 ,p_replace_run_flag_o
236 => pay_rcu_shd.g_old_rec.replace_run_flag
237 ,p_use_override_dates_o
238 => pay_rcu_shd.g_old_rec.use_override_dates
239 );
240 --
241 exception
242 --
243 when hr_api.cannot_find_prog_unit then
244 --
245 hr_api.cannot_find_prog_unit_error
246 (p_module_name => 'PAY_RETRO_COMPONENT_USAGES'
247 ,p_hook_type => 'AU');
248 --
249 end;
250 --
251 hr_utility.set_location(' Leaving:'||l_proc, 10);
252 End post_update;
253 --
254 -- ----------------------------------------------------------------------------
255 -- |-----------------------------< convert_defs >-----------------------------|
256 -- ----------------------------------------------------------------------------
257 -- {Start Of Comments}
258 --
259 -- Description:
260 -- The Convert_Defs procedure has one very important function:
261 -- It must return the record structure for the row with all system defaulted
262 -- values converted into its corresponding parameter value for update. When
263 -- we attempt to update a row through the Upd process , certain
264 -- parameters can be defaulted which enables flexibility in the calling of
265 -- the upd process (e.g. only attributes which need to be updated need to be
266 -- specified). For the upd process to determine which attributes
267 -- have NOT been specified we need to check if the parameter has a reserved
268 -- system default value. Therefore, for all parameters which have a
269 -- corresponding reserved system default mechanism specified we need to
270 -- check if a system default is being used. If a system default is being
271 -- used then we convert the defaulted value into its corresponding attribute
272 -- value held in the g_old_rec data structure.
273 --
274 -- Prerequisites:
275 -- This private function can only be called from the upd process.
276 --
277 -- In Parameters:
278 -- A Pl/Sql record structure.
279 --
280 -- Post Success:
281 -- The record structure will be returned with all system defaulted parameter
282 -- values converted into its current row attribute value.
283 --
284 -- Post Failure:
285 -- No direct error handling is required within this function. Any possible
286 -- errors within this procedure will be a PL/SQL value error due to
287 -- conversion of datatypes or data lengths.
288 --
289 -- Developer Implementation Notes:
290 -- None.
291 --
292 -- Access Status:
293 -- Internal Row Handler Use Only.
294 --
295 -- {End Of Comments}
296 -- ----------------------------------------------------------------------------
297 Procedure convert_defs
298 (p_rec in out nocopy pay_rcu_shd.g_rec_type
299 ) is
300 --
301 Begin
302 --
303 -- We must now examine each argument value in the
304 -- p_rec plsql record structure
305 -- to see if a system default is being used. If a system default
306 -- is being used then we must set to the 'current' argument value.
307 --
308 If (p_rec.business_group_id = hr_api.g_number) then
309 p_rec.business_group_id :=
310 pay_rcu_shd.g_old_rec.business_group_id;
311 End If;
312 If (p_rec.legislation_code = hr_api.g_varchar2) then
313 p_rec.legislation_code :=
314 pay_rcu_shd.g_old_rec.legislation_code;
315 End If;
316 If (p_rec.retro_component_id = hr_api.g_number) then
317 p_rec.retro_component_id :=
318 pay_rcu_shd.g_old_rec.retro_component_id;
319 End If;
320 If (p_rec.creator_id = hr_api.g_number) then
321 p_rec.creator_id :=
322 pay_rcu_shd.g_old_rec.creator_id;
323 End If;
324 If (p_rec.creator_type = hr_api.g_varchar2) then
325 p_rec.creator_type :=
326 pay_rcu_shd.g_old_rec.creator_type;
327 End If;
328 If (p_rec.default_component = hr_api.g_varchar2) then
329 p_rec.default_component :=
330 pay_rcu_shd.g_old_rec.default_component;
331 End If;
332 If (p_rec.reprocess_type = hr_api.g_varchar2) then
333 p_rec.reprocess_type :=
334 pay_rcu_shd.g_old_rec.reprocess_type;
335 End If;
336 If (p_rec.replace_run_flag = hr_api.g_varchar2) then
337 p_rec.replace_run_flag :=
338 pay_rcu_shd.g_old_rec.replace_run_flag;
339 End If;
340 If (p_rec.use_override_dates = hr_api.g_varchar2) then
341 p_rec.use_override_dates :=
342 pay_rcu_shd.g_old_rec.use_override_dates;
343 End If;
344 --
345 End convert_defs;
346 --
347 -- ----------------------------------------------------------------------------
348 -- |---------------------------------< upd >----------------------------------|
349 -- ----------------------------------------------------------------------------
350 Procedure upd
351 (p_effective_date in date
352 ,p_rec in out nocopy pay_rcu_shd.g_rec_type
353 ) is
354 --
355 l_proc varchar2(72) := g_package||'upd';
356 --
357 Begin
358 hr_utility.set_location('Entering:'||l_proc, 5);
359 --
360 -- We must lock the row which we need to update.
361 --
362 pay_rcu_shd.lck
363 (p_rec.retro_component_usage_id
364 ,p_rec.object_version_number
365 );
366 --
367 -- 1. During an update system defaults are used to determine if
368 -- arguments have been defaulted or not. We must therefore
369 -- derive the full record structure values to be updated.
370 --
371 -- 2. Call the supporting update validate operations.
372 --
373 convert_defs(p_rec);
374 pay_rcu_bus.update_validate
375 (p_effective_date
376 ,p_rec
377 );
378 --
379 -- Call to raise any errors on multi-message list
380 hr_multi_message.end_validation_set;
381 --
382 -- Call the supporting pre-update operation
383 --
384 pay_rcu_upd.pre_update(p_rec);
385 --
386 -- Update the row.
387 --
388 pay_rcu_upd.update_dml(p_rec);
389 --
390 -- Call the supporting post-update operation
391 --
392 pay_rcu_upd.post_update
393 (p_effective_date
394 ,p_rec
395 );
396 --
397 -- Call to raise any errors on multi-message list
398 hr_multi_message.end_validation_set;
399 End upd;
400 --
401 -- ----------------------------------------------------------------------------
402 -- |---------------------------------< upd >----------------------------------|
403 -- ----------------------------------------------------------------------------
404 Procedure upd
405 (p_effective_date in date
406 ,p_retro_component_usage_id in number
407 ,p_object_version_number in out nocopy number
408 ,p_retro_component_id in number default hr_api.g_number
409 ,p_creator_id in number default hr_api.g_number
410 ,p_creator_type in varchar2 default hr_api.g_varchar2
411 ,p_default_component in varchar2 default hr_api.g_varchar2
412 ,p_reprocess_type in varchar2 default hr_api.g_varchar2
413 ,p_replace_run_flag in varchar2 default hr_api.g_varchar2
414 ,p_use_override_dates in varchar2 default hr_api.g_varchar2
415 ) is
416 --
417 l_rec pay_rcu_shd.g_rec_type;
418 l_proc varchar2(72) := g_package||'upd';
419 --
420 Begin
421 hr_utility.set_location('Entering:'||l_proc, 5);
422 --
423 -- Call conversion function to turn arguments into the
424 -- l_rec structure.
425 --
426 l_rec :=
427 pay_rcu_shd.convert_args
428 (p_retro_component_usage_id
429 ,hr_api.g_number
430 ,hr_api.g_varchar2
431 ,p_retro_component_id
432 ,p_creator_id
433 ,p_creator_type
434 ,p_default_component
435 ,p_reprocess_type
436 ,p_object_version_number
437 ,p_replace_run_flag
438 ,p_use_override_dates
439 );
440 --
441 -- Having converted the arguments into the
442 -- plsql record structure we call the corresponding record
443 -- business process.
444 --
445 pay_rcu_upd.upd
446 (p_effective_date
447 ,l_rec
448 );
449 p_object_version_number := l_rec.object_version_number;
450 --
451 hr_utility.set_location(' Leaving:'||l_proc, 10);
452 End upd;
453 --
454 end pay_rcu_upd;
[Home] [Help]