1 Package Body pay_etu_upd as
2 /* $Header: pyeturhi.pkb 120.1 2005/11/08 04:51:49 pgongada noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- | Private Global Definitions |
6 -- ----------------------------------------------------------------------------
7 --
8 g_package varchar2(33) := ' pay_etu_upd.'; -- Global package name
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------------< dt_update_dml >-----------------------------|
12 -- ----------------------------------------------------------------------------
13 -- {Start Of Comments}
14 --
15 -- Description:
16 -- This procedure controls the execution of dml from the datetrack mode
17 -- of CORRECTION only. It is important to note that the object version
18 -- number is only increment by 1 because the datetrack correction is
19 -- soley for one datetracked row.
20 -- This procedure controls the actual dml update logic. The functions of this
21 -- procedure are as follows:
22 -- 1) Get the next object_version_number.
23 -- 2) To set and unset the g_api_dml status as required (as we are about to
24 -- perform dml).
25 -- 3) To update the specified row in the schema using the primary key in
26 -- the predicates.
27 -- 4) To trap any constraint violations that may have occurred.
28 -- 5) To raise any other errors.
29 --
30 -- Prerequisites:
31 -- This is an internal private procedure which must be called from the
32 -- update_dml procedure.
33 --
34 -- In Parameters:
35 -- A Pl/Sql record structure.
36 --
37 -- Post Success:
38 -- The specified row will be updated in the schema.
39 --
40 -- Post Failure:
41 -- On the update dml failure it is important to note that we always reset the
42 -- g_api_dml status to false.
43 -- If a check or unique integrity constraint violation is raised the
44 -- constraint_error procedure will be called.
45 -- If any other error is reported, the error will be raised after the
46 -- g_api_dml status is reset.
47 --
48 -- Developer Implementation Notes:
49 -- The update 'set' arguments list should be modified if any of your
50 -- attributes are not updateable.
51 --
52 -- Access Status:
53 -- Internal Row Handler Use Only.
54 --
55 -- {End Of Comments}
56 -- ----------------------------------------------------------------------------
57 Procedure dt_update_dml
58 (p_rec in out nocopy pay_etu_shd.g_rec_type
59 ,p_effective_date in date
60 ,p_datetrack_mode in varchar2
61 ,p_validation_start_date in date
62 ,p_validation_end_date in date
63 ) is
64 --
65 l_proc varchar2(72) := g_package||'dt_update_dml';
66 --
67 Begin
68 hr_utility.set_location('Entering:'||l_proc, 5);
69 --
70 If (p_datetrack_mode = hr_api.g_correction) then
71 hr_utility.set_location(l_proc, 10);
72 --
73 -- Because we are updating a row we must get the next object
74 -- version number.
75 --
76 p_rec.object_version_number :=
77 dt_api.get_object_version_number
78 (p_base_table_name => 'pay_element_type_usages_f'
79 ,p_base_key_column => 'element_type_usage_id'
80 ,p_base_key_value => p_rec.element_type_usage_id
81 );
82 --
83 --
84 --
85 -- Update the pay_element_type_usages_f Row
86 --
87 update pay_element_type_usages_f
88 set
89 run_type_id = p_rec.run_type_id
90 ,element_type_id = p_rec.element_type_id
91 ,inclusion_flag = p_rec.inclusion_flag
92 ,object_version_number = p_rec.object_version_number
93 ,element_type_usage_id = p_rec.element_type_usage_id
94 ,business_group_id = p_rec.business_group_id
95 ,legislation_code = p_rec.legislation_code
96 ,usage_type = p_rec.usage_type
97 where element_type_usage_id = p_rec.element_type_usage_id
98 and effective_start_date = p_validation_start_date
99 and effective_end_date = p_validation_end_date;
100 --
101 --
102 --
103 -- Set the effective start and end dates
104 --
105 p_rec.effective_start_date := p_validation_start_date;
106 p_rec.effective_end_date := p_validation_end_date;
107 End If;
108 --
109 hr_utility.set_location(' Leaving:'||l_proc, 15);
110 Exception
111 When hr_api.check_integrity_violated Then
112 -- A check constraint has been violated
113 --
114 pay_etu_shd.constraint_error
115 (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
116 When hr_api.unique_integrity_violated Then
117 -- Unique integrity has been violated
118 --
119 pay_etu_shd.constraint_error
120 (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
121 When Others Then
122 --
123 Raise;
124 End dt_update_dml;
125 --
126 -- ----------------------------------------------------------------------------
127 -- |------------------------------< update_dml >------------------------------|
128 -- ----------------------------------------------------------------------------
129 -- {Start Of Comments}
130 --
131 -- Description:
132 -- This procedure calls the dt_update_dml control logic which handles
133 -- the actual datetrack dml.
134 --
135 -- Prerequisites:
136 -- This is an internal private procedure which must be called from the upd
137 -- procedure.
138 --
139 -- In Parameters:
140 -- A Pl/Sql record structre.
141 --
142 -- Post Success:
143 -- Processing contines.
144 --
145 -- Post Failure:
146 -- No specific error handling is required within this procedure.
147 --
148 -- Developer Implementation Notes:
149 -- The update 'set' arguments list should be modified if any of your
150 -- attributes are not updateable.
151 --
152 -- Access Status:
153 -- Internal Row Handler Use Only.
154 --
155 -- {End Of Comments}
156 -- ----------------------------------------------------------------------------
157 Procedure update_dml
158 (p_rec in out nocopy pay_etu_shd.g_rec_type
159 ,p_effective_date in date
160 ,p_datetrack_mode in varchar2
161 ,p_validation_start_date in date
162 ,p_validation_end_date in date
163 ) is
164 --
165 l_proc varchar2(72) := g_package||'update_dml';
166 --
167 Begin
168 hr_utility.set_location('Entering:'||l_proc, 5);
169 --
170 pay_etu_upd.dt_update_dml
171 (p_rec => p_rec
172 ,p_effective_date => p_effective_date
173 ,p_datetrack_mode => p_datetrack_mode
174 ,p_validation_start_date => p_validation_start_date
175 ,p_validation_end_date => p_validation_end_date
176 );
177 --
178 hr_utility.set_location(' Leaving:'||l_proc, 10);
179 End update_dml;
180 --
181 -- ----------------------------------------------------------------------------
182 -- |----------------------------< dt_pre_update >-----------------------------|
183 -- ----------------------------------------------------------------------------
184 -- {Start Of Comments}
185 --
186 -- Description:
187 -- The dt_pre_update procedure controls the execution
188 -- of dml for the datetrack modes of: UPDATE, UPDATE_OVERRIDE
189 -- and UPDATE_CHANGE_INSERT only. The execution required is as
190 -- follows:
191 --
192 -- 1) Providing the datetrack update mode is not 'CORRECTION'
193 -- then set the effective end date of the current row (this
194 -- will be the validation_start_date - 1).
195 -- 2) If the datetrack mode is 'UPDATE_OVERRIDE' then call the
196 -- corresponding delete_dml process to delete any future rows
197 -- where the effective_start_date is greater than or equal to
198 -- the validation_start_date.
199 -- 3) Call the insert_dml process to insert the new updated row
200 -- details.
201 --
202 -- Prerequisites:
203 -- This is an internal procedure which is called from the
204 -- pre_update procedure.
205 --
206 -- In Parameters:
207 --
208 -- Post Success:
209 -- Processing continues.
210 --
211 -- Post Failure:
212 -- If an error has occurred, an error message and exception will be raised
213 -- but not handled.
214 --
215 -- Developer Implementation Notes:
216 -- This is an internal procedure which is required by Datetrack. Don't
217 -- remove or modify.
218 --
219 -- Access Status:
220 -- Internal Row Handler Use Only.
221 --
222 -- {End Of Comments}
223 -- ----------------------------------------------------------------------------
224 Procedure dt_pre_update
225 (p_rec in out nocopy pay_etu_shd.g_rec_type
226 ,p_effective_date in date
227 ,p_datetrack_mode in varchar2
228 ,p_validation_start_date in date
229 ,p_validation_end_date in date
230 ) is
231 --
232 l_proc varchar2(72) := g_package||'dt_pre_update';
233 l_dummy_version_number number;
234 --
235 Begin
236 hr_utility.set_location('Entering:'||l_proc, 5);
237 If (p_datetrack_mode <> hr_api.g_correction) then
238 --
239 -- Update the current effective end date
240 --
241 pay_etu_shd.upd_effective_end_date
242 (p_effective_date => p_effective_date
243 ,p_base_key_value => p_rec.element_type_usage_id
244 ,p_new_effective_end_date => (p_validation_start_date - 1)
245 ,p_validation_start_date => p_validation_start_date
246 ,p_validation_end_date => p_validation_end_date
247 ,p_object_version_number => l_dummy_version_number
248 );
249 --
250 If (p_datetrack_mode = hr_api.g_update_override) then
251 --
252 -- As the datetrack mode is 'UPDATE_OVERRIDE' then we must
253 -- delete any future rows
254 --
255 pay_etu_del.delete_dml
256 (p_rec => p_rec
257 ,p_effective_date => p_effective_date
258 ,p_datetrack_mode => p_datetrack_mode
259 ,p_validation_start_date => p_validation_start_date
260 ,p_validation_end_date => p_validation_end_date
261 );
262 End If;
263 --
264 -- We must now insert the updated row
265 --
266 pay_etu_ins.insert_dml
267 (p_rec => p_rec
268 ,p_effective_date => p_effective_date
269 ,p_datetrack_mode => p_datetrack_mode
270 ,p_validation_start_date => p_validation_start_date
271 ,p_validation_end_date => p_validation_end_date
272 );
273 End If;
274 hr_utility.set_location(' Leaving:'||l_proc, 20);
275 End dt_pre_update;
276 --
277 -- ----------------------------------------------------------------------------
278 -- |------------------------------< pre_update >------------------------------|
279 -- ----------------------------------------------------------------------------
280 -- {Start Of Comments}
281 --
282 -- Description:
283 -- This private procedure contains any processing which is required before
284 -- the update dml.
285 --
286 -- Prerequisites:
287 -- This is an internal procedure which is called from the upd procedure.
288 --
289 -- In Parameters:
290 -- A Pl/Sql record structure.
291 --
292 -- Post Success:
293 -- Processing continues.
294 --
295 -- Post Failure:
296 -- If an error has occurred, an error message and exception will be raised
297 -- but not handled.
298 --
299 -- Developer Implementation Notes:
300 -- Any pre-processing required before the update dml is issued should be
301 -- coded within this procedure. It is important to note that any 3rd party
302 -- maintenance should be reviewed before placing in this procedure. The call
303 -- to the dt_update_dml procedure should NOT be removed.
304 --
305 -- Access Status:
306 -- Internal Row Handler Use Only.
307 --
308 -- {End Of Comments}
309 -- ----------------------------------------------------------------------------
310 Procedure pre_update
311 (p_rec in out nocopy pay_etu_shd.g_rec_type
312 ,p_effective_date in date
313 ,p_datetrack_mode in varchar2
314 ,p_validation_start_date in date
315 ,p_validation_end_date in date
316 ) is
317 --
318 l_proc varchar2(72) := g_package||'pre_update';
319 --
320 Begin
321 hr_utility.set_location('Entering:'||l_proc, 5);
322 --
323 --
324 --
325 dt_pre_update
326 (p_rec => p_rec
327 ,p_effective_date => p_effective_date
328 ,p_datetrack_mode => p_datetrack_mode
329 ,p_validation_start_date => p_validation_start_date
330 ,p_validation_end_date => p_validation_end_date
331 );
332 --
333 hr_utility.set_location(' Leaving:'||l_proc, 10);
334 End pre_update;
335 --
336 -- ----------------------------------------------------------------------------
337 -- |----------------------------< post_update >-------------------------------|
338 -- ----------------------------------------------------------------------------
339 -- {Start Of Comments}
340 --
341 -- Description:
342 -- This private procedure contains any processing which is required after the
343 -- update dml.
344 --
345 -- Prerequisites:
346 -- This is an internal procedure which is called from the upd procedure.
347 --
348 -- In Parameters:
349 -- A Pl/Sql record structure.
350 --
351 -- Post Success:
352 -- Processing continues.
353 --
354 -- Post Failure:
355 -- If an error has occurred, an error message and exception will be raised
356 -- but not handled.
357 --
358 -- Developer Implementation Notes:
359 -- Any post-processing required after the update dml is issued should be
360 -- coded within this procedure. It is important to note that any 3rd party
361 -- maintenance should be reviewed before placing in this procedure.
362 --
363 -- Access Status:
364 -- Internal Row Handler Use Only.
365 --
366 -- {End Of Comments}
367 -- ----------------------------------------------------------------------------
368 Procedure post_update
369 (p_rec in pay_etu_shd.g_rec_type
370 ,p_effective_date in date
371 ,p_datetrack_mode in varchar2
372 ,p_validation_start_date in date
373 ,p_validation_end_date in date
374 ) is
375 --
376 l_proc varchar2(72) := g_package||'post_update';
377 --
378 Begin
379 hr_utility.set_location('Entering:'||l_proc, 5);
380 begin
381 --
382 pay_etu_rku.after_update
383 (p_effective_date
384 => p_effective_date
385 ,p_datetrack_mode
386 => p_datetrack_mode
387 ,p_validation_start_date
388 => p_validation_start_date
389 ,p_validation_end_date
390 => p_validation_end_date
391 ,p_effective_start_date
392 => p_rec.effective_start_date
393 ,p_effective_end_date
394 => p_rec.effective_end_date
395 ,p_object_version_number
396 => p_rec.object_version_number
397 ,p_element_type_usage_id
398 => p_rec.element_type_usage_id
399 ,p_inclusion_flag
400 => p_rec.inclusion_flag
401 ,p_usage_type
402 => p_rec.usage_type
403 ,p_run_type_id_o
404 => pay_etu_shd.g_old_rec.run_type_id
405 ,p_element_type_id_o
406 => pay_etu_shd.g_old_rec.element_type_id
407 ,p_inclusion_flag_o
408 => pay_etu_shd.g_old_rec.inclusion_flag
409 ,p_effective_start_date_o
410 => pay_etu_shd.g_old_rec.effective_start_date
411 ,p_effective_end_date_o
412 => pay_etu_shd.g_old_rec.effective_end_date
413 ,p_object_version_number_o
414 => pay_etu_shd.g_old_rec.object_version_number
415 ,p_business_group_id_o
416 => pay_etu_shd.g_old_rec.business_group_id
417 ,p_legislation_code_o
418 => pay_etu_shd.g_old_rec.legislation_code
419 ,p_usage_type_o
420 => pay_etu_shd.g_old_rec.usage_type
421 );
422 --
423 exception
424 --
425 when hr_api.cannot_find_prog_unit then
426 --
427 hr_api.cannot_find_prog_unit_error
428 (p_module_name => 'PAY_ELEMENT_TYPE_USAGES_F'
429 ,p_hook_type => 'AU');
430 --
431 end;
432 --
433 hr_utility.set_location(' Leaving:'||l_proc, 10);
434 End post_update;
435 --
436 -- ----------------------------------------------------------------------------
437 -- |-----------------------------< convert_defs >-----------------------------|
438 -- ----------------------------------------------------------------------------
439 -- {Start Of Comments}
440 --
441 -- Description:
442 -- The Convert_Defs procedure has one very important function:
443 -- It must return the record structure for the row with all system defaulted
444 -- values converted into its corresponding parameter value for update. When
445 -- we attempt to update a row through the Upd process , certain
446 -- parameters can be defaulted which enables flexibility in the calling of
447 -- the upd process (e.g. only attributes which need to be updated need to be
448 -- specified). For the upd process to determine which attributes
449 -- have NOT been specified we need to check if the parameter has a reserved
450 -- system default value. Therefore, for all parameters which have a
451 -- corresponding reserved system default mechanism specified we need to
452 -- check if a system default is being used. If a system default is being
453 -- used then we convert the defaulted value into its corresponding attribute
454 -- value held in the g_old_rec data structure.
455 --
456 -- Prerequisites:
457 -- This private function can only be called from the upd process.
458 --
459 -- In Parameters:
460 -- A Pl/Sql record structure.
461 --
462 -- Post Success:
463 -- The record structure will be returned with all system defaulted parameter
464 -- values converted into its current row attribute value.
465 --
466 -- Post Failure:
467 -- No direct error handling is required within this function. Any possible
468 -- errors within this procedure will be a PL/SQL value error due to
469 -- conversion of datatypes or data lengths.
470 --
471 -- Developer Implementation Notes:
472 -- None.
473 --
474 -- Access Status:
475 -- Internal Row Handler Use Only.
476 --
477 -- {End Of Comments}
478 -- ----------------------------------------------------------------------------
479 Procedure convert_defs
480 (p_rec in out nocopy pay_etu_shd.g_rec_type
481 ) is
482 --
483 Begin
484 --
485 -- We must now examine each argument value in the
486 -- p_rec plsql record structure
487 -- to see if a system default is being used. If a system default
488 -- is being used then we must set to the 'current' argument value.
489 --
490 If (p_rec.run_type_id = hr_api.g_number) then
491 p_rec.run_type_id :=
492 pay_etu_shd.g_old_rec.run_type_id;
493 End If;
494 If (p_rec.element_type_id = hr_api.g_number) then
495 p_rec.element_type_id :=
496 pay_etu_shd.g_old_rec.element_type_id;
497 End If;
498 If (p_rec.inclusion_flag = hr_api.g_varchar2) then
499 p_rec.inclusion_flag :=
500 pay_etu_shd.g_old_rec.inclusion_flag;
501 End If;
502 If (p_rec.business_group_id = hr_api.g_number) then
503 p_rec.business_group_id :=
504 pay_etu_shd.g_old_rec.business_group_id;
505 End If;
506 If (p_rec.legislation_code = hr_api.g_varchar2) then
507 p_rec.legislation_code :=
508 pay_etu_shd.g_old_rec.legislation_code;
509 End If;
510 If (p_rec.usage_type = hr_api.g_varchar2) then
511 p_rec.usage_type :=
512 pay_etu_shd.g_old_rec.usage_type;
513 End If;
514 --
515 End convert_defs;
516 --
517 -- ----------------------------------------------------------------------------
518 -- |---------------------------------< upd >----------------------------------|
519 -- ----------------------------------------------------------------------------
520 Procedure upd
521 (p_effective_date in date
522 ,p_datetrack_mode in varchar2
523 ,p_rec in out nocopy pay_etu_shd.g_rec_type
524 ) is
525 --
526 l_proc varchar2(72) := g_package||'upd';
527 l_validation_start_date date;
528 l_validation_end_date date;
529 --
530 Begin
531 hr_utility.set_location('Entering:'||l_proc, 5);
532 --
533 -- Ensure that the DateTrack update mode is valid
534 --
535 dt_api.validate_dt_upd_mode(p_datetrack_mode => p_datetrack_mode);
536 --
537 -- We must lock the row which we need to update.
538 --
539 pay_etu_shd.lck
540 (p_effective_date => p_effective_date
541 ,p_datetrack_mode => p_datetrack_mode
542 ,p_element_type_usage_id => p_rec.element_type_usage_id
543 ,p_object_version_number => p_rec.object_version_number
544 ,p_validation_start_date => l_validation_start_date
545 ,p_validation_end_date => l_validation_end_date
546 );
547 --
548 -- 1. During an update system defaults are used to determine if
549 -- arguments have been defaulted or not. We must therefore
550 -- derive the full record structure values to be updated.
551 --
552 -- 2. Call the supporting update validate operations.
553 --
554 pay_etu_upd.convert_defs(p_rec);
555 --
556 pay_etu_bus.update_validate
557 (p_rec => p_rec
558 ,p_effective_date => p_effective_date
559 ,p_datetrack_mode => p_datetrack_mode
560 ,p_validation_start_date => l_validation_start_date
561 ,p_validation_end_date => l_validation_end_date
562 );
563 --
564 -- Call the supporting pre-update operation
565 --
566 pre_update
567 (p_rec => p_rec
568 ,p_effective_date => p_effective_date
569 ,p_datetrack_mode => p_datetrack_mode
570 ,p_validation_start_date => l_validation_start_date
571 ,p_validation_end_date => l_validation_end_date
572 );
573 --
574 -- Update the row.
575 --
576 update_dml
577 (p_rec => p_rec
578 ,p_effective_date => p_effective_date
579 ,p_datetrack_mode => p_datetrack_mode
580 ,p_validation_start_date => l_validation_start_date
581 ,p_validation_end_date => l_validation_end_date
582 );
583 --
584 -- Call the supporting post-update operation
585 --
586 post_update
587 (p_rec => p_rec
588 ,p_effective_date => p_effective_date
589 ,p_datetrack_mode => p_datetrack_mode
590 ,p_validation_start_date => l_validation_start_date
591 ,p_validation_end_date => l_validation_end_date
592 );
593 End upd;
594 --
595 -- ----------------------------------------------------------------------------
596 -- |------------------------------< upd >-------------------------------------|
597 -- ----------------------------------------------------------------------------
598 Procedure upd
599 (p_effective_date in date
600 ,p_datetrack_mode in varchar2
601 ,p_inclusion_flag in varchar2 default hr_api.g_varchar2
602 ,p_element_type_usage_id in number
603 ,p_usage_type in varchar2 default hr_api.g_varchar2
604 ,p_object_version_number in out nocopy number
605 ,p_effective_start_date out nocopy date
606 ,p_effective_end_date out nocopy date
607 ) is
608 --
609 l_rec pay_etu_shd.g_rec_type;
610 l_proc varchar2(72) := g_package||'upd';
611 --
612 Begin
613 hr_utility.set_location('Entering:'||l_proc, 5);
614 --
615 -- Call conversion function to turn arguments into the
616 -- l_rec structure.
617 --
618 l_rec :=
619 pay_etu_shd.convert_args
620 (hr_api.g_number
621 ,hr_api.g_number
622 ,p_inclusion_flag
623 ,null
624 ,null
625 ,p_object_version_number
626 ,p_element_type_usage_id
627 ,hr_api.g_number
628 ,hr_api.g_varchar2
629 ,p_usage_type
630 );
631 --
632 -- Having converted the arguments into the
633 -- plsql record structure we call the corresponding record
634 -- business process.
635 --
636 pay_etu_upd.upd
637 (p_effective_date
638 ,p_datetrack_mode
639 ,l_rec
640 );
641 --
642 -- Set the out parameters
643 --
644 p_object_version_number := l_rec.object_version_number;
645 p_effective_start_date := l_rec.effective_start_date;
646 p_effective_end_date := l_rec.effective_end_date;
647 --
648 --
649 hr_utility.set_location(' Leaving:'||l_proc, 10);
650 End upd;
651 --
652 end pay_etu_upd;
[Home] [Help]