1 Package Body pay_ppd_del as
2 /* $Header: pyppdrhi.pkb 120.2 2005/12/29 01:38 nprasath noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- | Private Global Definitions |
6 -- ----------------------------------------------------------------------------
7 --
8 g_package varchar2(33) := ' pay_ppd_del.'; -- Global package name
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------------< dt_delete_dml >-----------------------------|
12 -- ----------------------------------------------------------------------------
13 -- {Start Of Comments}
14 --
15 -- Description:
16 -- This procedure controls the actual dml delete logic for the datetrack
17 -- delete modes: ZAP, DELETE, FUTURE_CHANGE and DELETE_NEXT_CHANGE. The
18 -- execution is as follows:
19 -- 1) To set and unset the g_api_dml status as required (as we are about to
20 -- perform dml).
21 -- 2) If the delete mode is DELETE_NEXT_CHANGE then delete where the
22 -- effective start date is equal to the validation start date.
23 -- 3) If the delete mode is not DELETE_NEXT_CHANGE then delete
24 -- all rows for the entity where the effective start date is greater
25 -- than or equal to the validation start date.
26 -- 4) To raise any errors.
27 --
28 -- Prerequisites:
29 -- This is an internal private procedure which must be called from the
30 -- delete_dml procedure.
31 --
32 -- In Parameters:
33 -- A Pl/Sql record structure.
34 --
35 -- Post Success:
36 -- The specified row will be delete from the schema.
37 --
38 -- Post Failure:
39 -- On the delete dml failure it is important to note that we always reset the
40 -- g_api_dml status to false.
41 -- If any other error is reported, the error will be raised after the
42 -- g_api_dml status is reset.
43 --
44 -- Developer Implementation Notes:
45 -- This is an internal private procedure which must be called from the
46 -- delete_dml procedure.
47 --
48 -- Access Status:
49 -- Internal Row Handler Use Only.
50 --
51 -- {End Of Comments}
52 -- ----------------------------------------------------------------------------
53 Procedure dt_delete_dml
54 (p_rec in out nocopy pay_ppd_shd.g_rec_type
55 ,p_effective_date in date
56 ,p_datetrack_mode in varchar2
57 ,p_validation_start_date in date
58 ,p_validation_end_date in date
59 ) is
60 --
61 l_proc varchar2(72) := g_package||'dt_delete_dml';
62 --
63 Begin
64 hr_utility.set_location('Entering:'||l_proc, 5);
65 If (p_datetrack_mode = hr_api.g_delete_next_change) then
66 --
67 --
68 -- Delete the where the effective start date is equal
69 -- to the validation end date.
70 --
71 delete from pay_pl_paye_details_f
72 where paye_details_id = p_rec.paye_details_id
73 and effective_start_date = p_validation_start_date;
74 --
75 --
76 Else
77 --
78 --
79 -- Delete the row(s) where the effective start date is greater than
80 -- or equal to the validation start date.
81 --
82 delete from pay_pl_paye_details_f
83 where paye_details_id = p_rec.paye_details_id
84 and effective_start_date >= p_validation_start_date;
85 --
86 --
87 End If;
88 --
89 hr_utility.set_location(' Leaving:'||l_proc, 20);
90 --
91 End dt_delete_dml;
92 --
93 -- ----------------------------------------------------------------------------
94 -- |------------------------------< delete_dml >------------------------------|
95 -- ----------------------------------------------------------------------------
96 Procedure delete_dml
97 (p_rec in out nocopy pay_ppd_shd.g_rec_type
98 ,p_effective_date in date
99 ,p_datetrack_mode in varchar2
100 ,p_validation_start_date in date
101 ,p_validation_end_date in date
102 ) is
103 --
104 l_proc varchar2(72) := g_package||'delete_dml';
105 --
106 Begin
107 hr_utility.set_location('Entering:'||l_proc, 5);
108 --
109 pay_ppd_del.dt_delete_dml
110 (p_rec => p_rec
111 ,p_effective_date => p_effective_date
112 ,p_datetrack_mode => p_datetrack_mode
113 ,p_validation_start_date => p_validation_start_date
114 ,p_validation_end_date => p_validation_end_date
115 );
116 --
117 hr_utility.set_location(' Leaving:'||l_proc, 10);
118 End delete_dml;
119 --
120 -- ----------------------------------------------------------------------------
121 -- |----------------------------< dt_pre_delete >-----------------------------|
122 -- ----------------------------------------------------------------------------
123 -- {Start Of Comments}
124 --
125 -- Description:
126 -- The dt_pre_delete process controls the execution of dml
127 -- for the datetrack modes: DELETE, FUTURE_CHANGE
128 -- and DELETE_NEXT_CHANGE only.
129 --
130 -- Prerequisites:
131 -- This is an internal procedure which is called from the pre_delete
132 -- procedure.
133 --
134 -- In Parameters:
135 -- A Pl/Sql record structure.
136 --
137 -- Post Success:
138 -- Processing continues.
139 --
140 -- Post Failure:
141 -- If an error has occurred, an error message and exception will be raised
142 -- but not handled.
143 --
144 -- Developer Implementation Notes:
145 -- This is an internal procedure which is required by Datetrack. Don't
146 -- remove or modify.
147 --
148 -- Access Status:
149 -- Internal Row Handler Use Only.
150 --
151 -- {End Of Comments}
152 -- ----------------------------------------------------------------------------
153 Procedure dt_pre_delete
154 (p_rec in out nocopy pay_ppd_shd.g_rec_type
155 ,p_effective_date in date
156 ,p_datetrack_mode in varchar2
157 ,p_validation_start_date in date
158 ,p_validation_end_date in date
159 ) is
160 --
161 l_proc varchar2(72) := g_package||'dt_pre_delete';
162 --
163 Begin
164 hr_utility.set_location('Entering:'||l_proc, 5);
165 --
166 If (p_datetrack_mode <> hr_api.g_zap) then
167 --
168 p_rec.effective_start_date
169 := pay_ppd_shd.g_old_rec.effective_start_date;
170 --
171 If (p_datetrack_mode = hr_api.g_delete) then
172 p_rec.effective_end_date := p_validation_start_date - 1;
173 Else
174 p_rec.effective_end_date := p_validation_end_date;
175 End If;
176 --
177 -- Update the current effective end date record
178 --
179 pay_ppd_shd.upd_effective_end_date
180 (p_effective_date => p_effective_date
181 ,p_base_key_value => p_rec.paye_details_id
182 ,p_new_effective_end_date => p_rec.effective_end_date
183 ,p_validation_start_date => p_validation_start_date
184 ,p_validation_end_date => p_validation_end_date
185 ,p_object_version_number => p_rec.object_version_number
186 );
187 Else
188 p_rec.effective_start_date := null;
189 p_rec.effective_end_date := null;
190 End If;
191 hr_utility.set_location(' Leaving:'||l_proc, 10);
192 End dt_pre_delete;
193 --
194 -- ----------------------------------------------------------------------------
195 -- |------------------------------< pre_delete >------------------------------|
196 -- ----------------------------------------------------------------------------
197 -- {Start Of Comments}
198 --
199 -- Description:
200 -- This private procedure contains any processing which is required before
201 -- the delete dml.
202 --
203 -- Prerequisites:
204 -- This is an internal procedure which is called from the del procedure.
205 --
206 -- In Parameters:
207 -- A Pl/Sql record structure.
208 --
209 -- Post Success:
210 -- Processing continues.
211 --
212 -- Post Failure:
213 -- If an error has occurred, an error message and exception will be raised
214 -- but not handled.
215 --
216 -- Developer Implementation Notes:
217 -- Any pre-processing required before the delete dml is issued should be
218 -- coded within this procedure. It is important to note that any 3rd party
219 -- maintenance should be reviewed before placing in this procedure. The call
220 -- to the dt_delete_dml procedure should NOT be removed.
221 --
222 -- Access Status:
223 -- Internal Row Handler Use Only.
224 --
225 -- {End Of Comments}
226 -- ----------------------------------------------------------------------------
227 Procedure pre_delete
228 (p_rec in out nocopy pay_ppd_shd.g_rec_type
229 ,p_effective_date in date
230 ,p_datetrack_mode in varchar2
231 ,p_validation_start_date in date
232 ,p_validation_end_date in date
233 ) is
234 --
235 l_proc varchar2(72) := g_package||'pre_delete';
236 --
237 --
238 --
239 Begin
240 hr_utility.set_location('Entering:'||l_proc, 5);
241 --
242 --
243 --
244 pay_ppd_del.dt_pre_delete
245 (p_rec => p_rec
246 ,p_effective_date => p_effective_date
247 ,p_datetrack_mode => p_datetrack_mode
248 ,p_validation_start_date => p_validation_start_date
249 ,p_validation_end_date => p_validation_end_date
250 );
251 --
252 hr_utility.set_location(' Leaving:'||l_proc, 10);
253 End pre_delete;
254 --
255 -- ----------------------------------------------------------------------------
256 -- |----------------------------< post_delete >-------------------------------|
257 -- ----------------------------------------------------------------------------
258 -- {Start Of Comments}
259 --
260 -- Description:
261 -- This private procedure contains any processing which is required after
262 -- the delete dml.
263 --
264 -- Prerequisites:
265 -- This is an internal procedure which is called from the del procedure.
266 --
267 -- In Parameters:
268 -- A Pl/Sql record structure.
269 --
270 -- Post Success:
271 -- Processing continues.
272 --
273 -- Post Failure:
274 -- If an error has occurred, an error message and exception will be raised
275 -- but not handled.
276 --
277 -- Developer Implementation Notes:
278 -- Any post-processing required after the delete dml is issued should be
279 -- coded within this procedure. It is important to note that any 3rd party
280 -- maintenance should be reviewed before placing in this procedure.
281 --
282 -- Access Status:
283 -- Internal Row Handler Use Only.
284 --
285 -- {End Of Comments}
286 -- ----------------------------------------------------------------------------
287 Procedure post_delete
288 (p_rec in pay_ppd_shd.g_rec_type
289 ,p_effective_date in date
290 ,p_datetrack_mode in varchar2
291 ,p_validation_start_date in date
292 ,p_validation_end_date in date
293 ) is
294 --
295 l_proc varchar2(72) := g_package||'post_delete';
296 --
297 Begin
298 hr_utility.set_location('Entering:'||l_proc, 5);
299 begin
300 --
301 pay_ppd_rkd.after_delete
302 (p_effective_date
303 => p_effective_date
304 ,p_datetrack_mode
305 => p_datetrack_mode
306 ,p_validation_start_date
307 => p_validation_start_date
308 ,p_validation_end_date
309 => p_validation_end_date
310 ,p_paye_details_id
311 => p_rec.paye_details_id
312 ,p_effective_start_date
313 => p_rec.effective_start_date
314 ,p_effective_end_date
315 => p_rec.effective_end_date
316 ,p_effective_start_date_o
317 => pay_ppd_shd.g_old_rec.effective_start_date
321 => pay_ppd_shd.g_old_rec.per_or_asg_id
318 ,p_effective_end_date_o
319 => pay_ppd_shd.g_old_rec.effective_end_date
320 ,p_per_or_asg_id_o
322 ,p_business_group_id_o
323 => pay_ppd_shd.g_old_rec.business_group_id
324 ,p_contract_category_o
325 => pay_ppd_shd.g_old_rec.contract_category
326 ,p_object_version_number_o
327 => pay_ppd_shd.g_old_rec.object_version_number
328 ,p_tax_reduction_o
329 => pay_ppd_shd.g_old_rec.tax_reduction
330 ,p_tax_calc_with_spouse_child_o
331 => pay_ppd_shd.g_old_rec.tax_calc_with_spouse_child
332 ,p_income_reduction_o
333 => pay_ppd_shd.g_old_rec.income_reduction
334 ,p_income_reduction_amount_o
335 => pay_ppd_shd.g_old_rec.income_reduction_amount
336 ,p_rate_of_tax_o
337 => pay_ppd_shd.g_old_rec.rate_of_tax
338 ,p_program_id_o
339 => pay_ppd_shd.g_old_rec.program_id
340 ,p_program_login_id_o
341 => pay_ppd_shd.g_old_rec.program_login_id
342 ,p_program_application_id_o
343 => pay_ppd_shd.g_old_rec.program_application_id
344 ,p_request_id_o
345 => pay_ppd_shd.g_old_rec.request_id
346 );
347 --
348 exception
349 --
350 when hr_api.cannot_find_prog_unit then
351 --
352 hr_api.cannot_find_prog_unit_error
353 (p_module_name => 'PAY_PL_PAYE_DETAILS_F'
354 ,p_hook_type => 'AD');
355 --
356 end;
357 --
358 hr_utility.set_location(' Leaving:'||l_proc, 10);
359 End post_delete;
360 --
361 -- ----------------------------------------------------------------------------
362 -- |---------------------------------< del >----------------------------------|
363 -- ----------------------------------------------------------------------------
364 Procedure del
365 (p_effective_date in date
366 ,p_datetrack_mode in varchar2
367 ,p_rec in out nocopy pay_ppd_shd.g_rec_type
368 ) is
369 --
370 l_proc varchar2(72) := g_package||'del';
371 l_validation_start_date date;
372 l_validation_end_date date;
373 --
374 Begin
375 hr_utility.set_location('Entering:'||l_proc, 5);
376 --
377 -- Ensure that the DateTrack delete mode is valid
378 --
379 dt_api.validate_dt_del_mode(p_datetrack_mode => p_datetrack_mode);
380 --
381 -- We must lock the row which we need to delete.
382 --
383 pay_ppd_shd.lck
384 (p_effective_date => p_effective_date
385 ,p_datetrack_mode => p_datetrack_mode
386 ,p_paye_details_id => p_rec.paye_details_id
387 ,p_object_version_number => p_rec.object_version_number
388 ,p_validation_start_date => l_validation_start_date
389 ,p_validation_end_date => l_validation_end_date
390 );
391 --
392 -- Call the supporting delete validate operation
393 --
394 pay_ppd_bus.delete_validate
395 (p_rec => p_rec
396 ,p_effective_date => p_effective_date
397 ,p_datetrack_mode => p_datetrack_mode
398 ,p_validation_start_date => l_validation_start_date
399 ,p_validation_end_date => l_validation_end_date
400 );
401 --
402 -- Call to raise any errors on multi-message list
403 hr_multi_message.end_validation_set;
404 --
405 -- Call the supporting pre-delete operation
406 --
407 pay_ppd_del.pre_delete
408 (p_rec => p_rec
409 ,p_effective_date => p_effective_date
410 ,p_datetrack_mode => p_datetrack_mode
411 ,p_validation_start_date => l_validation_start_date
412 ,p_validation_end_date => l_validation_end_date
413 );
414 --
415 -- Delete the row.
416 --
417 pay_ppd_del.delete_dml
418 (p_rec => p_rec
419 ,p_effective_date => p_effective_date
420 ,p_datetrack_mode => p_datetrack_mode
421 ,p_validation_start_date => l_validation_start_date
422 ,p_validation_end_date => l_validation_end_date
423 );
424 -- Call the supporting post-delete operation
425 --
426 pay_ppd_del.post_delete
427 (p_rec => p_rec
428 ,p_effective_date => p_effective_date
429 ,p_datetrack_mode => p_datetrack_mode
430 ,p_validation_start_date => l_validation_start_date
431 ,p_validation_end_date => l_validation_end_date
432 );
433 --
434 -- Call to raise any errors on multi-message list
435 hr_multi_message.end_validation_set;
436 --
437 hr_utility.set_location(' Leaving:'||l_proc, 5);
438 End del;
439 --
440 -- ----------------------------------------------------------------------------
441 -- |--------------------------------< del >-----------------------------------|
442 -- ----------------------------------------------------------------------------
443 Procedure del
444 (p_effective_date in date
445 ,p_datetrack_mode in varchar2
446 ,p_paye_details_id in number
447 ,p_object_version_number in out nocopy number
448 ,p_effective_start_date out nocopy date
449 ,p_effective_end_date out nocopy date
450 ) is
451 --
452 l_rec pay_ppd_shd.g_rec_type;
453 l_proc varchar2(72) := g_package||'del';
454 --
455 Begin
456 hr_utility.set_location('Entering:'||l_proc, 5);
457 --
458 -- As the delete procedure accepts a plsql record structure we do need to
459 -- convert the arguments into the record structure.
460 -- We don't need to call the supplied conversion argument routine as we
461 -- only need a few attributes.
462 --
463 l_rec.paye_details_id := p_paye_details_id;
464 l_rec.object_version_number := p_object_version_number;
465 --
466 -- Having converted the arguments into the pay_ppd_rec
467 -- plsql record structure we must call the corresponding entity
468 -- business process
469 --
470 pay_ppd_del.del
471 (p_effective_date
472 ,p_datetrack_mode
473 ,l_rec
474 );
475 --
476 --
477 -- Set the out arguments
478 --
479 p_object_version_number := l_rec.object_version_number;
480 p_effective_start_date := l_rec.effective_start_date;
481 p_effective_end_date := l_rec.effective_end_date;
482 --
483 hr_utility.set_location(' Leaving:'||l_proc, 10);
484 End del;
485 --
486 end pay_ppd_del;