1 Package Body pay_pur_del as
2 /* $Header: pypurrhi.pkb 120.1.12010000.2 2009/12/23 09:46:10 asnell ship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- | Private Global Definitions |
6 -- ----------------------------------------------------------------------------
7 --
8 g_package varchar2(33) := ' pay_pur_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_pur_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 pay_pur_shd.g_api_dml := true; -- Set the api dml status
67 --
68 -- Delete the where the effective start date is equal
69 -- to the validation end date.
70 --
71 delete from pay_user_rows_f
72 where user_row_id = p_rec.user_row_id
73 and effective_start_date = p_validation_start_date;
74 --
75 pay_pur_shd.g_api_dml := false; -- Unset the api dml status
76 Else
77 pay_pur_shd.g_api_dml := true; -- Set the api dml status
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_user_rows_f
83 where user_row_id = p_rec.user_row_id
84 and effective_start_date >= p_validation_start_date;
85 --
86 pay_pur_shd.g_api_dml := false; -- Unset the api dml status
87 End If;
88 --
89 hr_utility.set_location(' Leaving:'||l_proc, 20);
90 --
91 Exception
92 When Others Then
93 pay_pur_shd.g_api_dml := false; -- Unset the api dml status
94 Raise;
95 --
96 End dt_delete_dml;
97 --
98 -- ----------------------------------------------------------------------------
99 -- ----------------------< delete_app_ownerships >----------------------------|
100 -- ----------------------------------------------------------------------------
101 --
102 -- Description:
103 -- Deletes row(s) from hr_application_ownerships depending on the mode that
104 -- the row handler has been called in.
105 --
106 -- ----------------------------------------------------------------------------
107 PROCEDURE delete_app_ownerships(p_pk_column IN varchar2
108 ,p_pk_value IN varchar2
109 ,p_datetrack_mode IN varchar2) IS
110 --
111 BEGIN
112 --
113 IF ((hr_startup_data_api_support.return_startup_mode
114 IN ('STARTUP','GENERIC')) AND
115 p_datetrack_mode = 'ZAP') THEN
116 --
117 DELETE FROM hr_application_ownerships
118 WHERE key_name = p_pk_column
119 AND key_value = p_pk_value;
120 --
121 END IF;
122 END delete_app_ownerships;
123 --
124 -- ----------------------------------------------------------------------------
125 -- ----------------------< delete_app_ownerships >----------------------------|
126 -- ----------------------------------------------------------------------------
127 PROCEDURE delete_app_ownerships(p_pk_column IN varchar2
128 ,p_pk_value IN number
129 ,p_datetrack_mode IN varchar2) IS
130 --
131 BEGIN
132 delete_app_ownerships(p_pk_column,
133 to_char(p_pk_value),
134 p_datetrack_mode
135 );
136 END delete_app_ownerships;
137 --
138 -- ----------------------------------------------------------------------------
139 -- |------------------------------< delete_dml >------------------------------|
140 -- ----------------------------------------------------------------------------
141 Procedure delete_dml
142 (p_rec in out nocopy pay_pur_shd.g_rec_type
143 ,p_effective_date in date
144 ,p_datetrack_mode in varchar2
145 ,p_validation_start_date in date
146 ,p_validation_end_date in date
147 ) is
148 --
149 l_proc varchar2(72) := g_package||'delete_dml';
150 --
151 Begin
152 hr_utility.set_location('Entering:'||l_proc, 5);
153 --
154 pay_pur_del.dt_delete_dml
155 (p_rec => p_rec
156 ,p_effective_date => p_effective_date
157 ,p_datetrack_mode => p_datetrack_mode
158 ,p_validation_start_date => p_validation_start_date
159 ,p_validation_end_date => p_validation_end_date
160 );
161 --
162 hr_utility.set_location(' Leaving:'||l_proc, 10);
163 End delete_dml;
164 --
165 -- ----------------------------------------------------------------------------
166 -- |----------------------------< dt_pre_delete >-----------------------------|
167 -- ----------------------------------------------------------------------------
168 -- {Start Of Comments}
169 --
170 -- Description:
171 -- The dt_pre_delete process controls the execution of dml
172 -- for the datetrack modes: DELETE, FUTURE_CHANGE
173 -- and DELETE_NEXT_CHANGE only.
174 --
175 -- Prerequisites:
176 -- This is an internal procedure which is called from the pre_delete
177 -- procedure.
178 --
179 -- In Parameters:
180 -- A Pl/Sql record structure.
181 --
182 -- Post Success:
183 -- Processing continues.
184 --
185 -- Post Failure:
186 -- If an error has occurred, an error message and exception will be raised
187 -- but not handled.
188 --
189 -- Developer Implementation Notes:
190 -- This is an internal procedure which is required by Datetrack. Don't
191 -- remove or modify.
192 --
193 -- Access Status:
194 -- Internal Row Handler Use Only.
195 --
196 -- {End Of Comments}
197 -- ----------------------------------------------------------------------------
198 Procedure dt_pre_delete
199 (p_rec in out nocopy pay_pur_shd.g_rec_type
200 ,p_effective_date in date
201 ,p_datetrack_mode in varchar2
202 ,p_validation_start_date in date
203 ,p_validation_end_date in date
204 ) is
205 --
206 l_proc varchar2(72) := g_package||'dt_pre_delete';
207 --
208 Begin
209 hr_utility.set_location('Entering:'||l_proc, 5);
210 --
211 If (p_datetrack_mode <> hr_api.g_zap) then
212 --
213 p_rec.effective_start_date
214 := pay_pur_shd.g_old_rec.effective_start_date;
215 --
216 If (p_datetrack_mode = hr_api.g_delete) then
217 p_rec.effective_end_date := p_validation_start_date - 1;
218 Else
219 p_rec.effective_end_date := p_validation_end_date;
220 End If;
221 --
222 -- Update the current effective end date record
223 --
224 pay_pur_shd.upd_effective_end_date
225 (p_effective_date => p_effective_date
226 ,p_base_key_value => p_rec.user_row_id
227 ,p_new_effective_end_date => p_rec.effective_end_date
228 ,p_validation_start_date => p_validation_start_date
229 ,p_validation_end_date => p_validation_end_date
230 ,p_object_version_number => p_rec.object_version_number
231 );
232 Else
233 p_rec.effective_start_date := null;
234 p_rec.effective_end_date := null;
235 End If;
236 hr_utility.set_location(' Leaving:'||l_proc, 10);
237 End dt_pre_delete;
238 --
239 -- ----------------------------------------------------------------------------
240 -- |------------------------------< pre_delete >------------------------------|
241 -- ----------------------------------------------------------------------------
242 -- {Start Of Comments}
243 --
244 -- Description:
245 -- This private procedure contains any processing which is required before
246 -- the delete dml.
247 --
248 -- Prerequisites:
249 -- This is an internal procedure which is called from the del procedure.
250 --
251 -- In Parameters:
252 -- A Pl/Sql record structure.
253 --
254 -- Post Success:
255 -- Processing continues.
256 --
257 -- Post Failure:
258 -- If an error has occurred, an error message and exception will be raised
259 -- but not handled.
260 --
261 -- Developer Implementation Notes:
262 -- Any pre-processing required before the delete dml is issued should be
263 -- coded within this procedure. It is important to note that any 3rd party
264 -- maintenance should be reviewed before placing in this procedure. The call
265 -- to the dt_delete_dml procedure should NOT be removed.
266 --
267 -- Access Status:
268 -- Internal Row Handler Use Only.
269 --
270 -- {End Of Comments}
271 -- ----------------------------------------------------------------------------
272 Procedure pre_delete
273 (p_rec in out nocopy pay_pur_shd.g_rec_type
274 ,p_effective_date in date
275 ,p_datetrack_mode in varchar2
276 ,p_validation_start_date in date
277 ,p_validation_end_date in date
278 ) is
279 --
280 l_proc varchar2(72) := g_package||'pre_delete';
281 --
282 --
283 --
284 Begin
285 hr_utility.set_location('Entering:'||l_proc, 5);
286 --
287 --
288 --
289 pay_pur_del.dt_pre_delete
290 (p_rec => p_rec
291 ,p_effective_date => p_effective_date
292 ,p_datetrack_mode => p_datetrack_mode
293 ,p_validation_start_date => p_validation_start_date
294 ,p_validation_end_date => p_validation_end_date
295 );
296 --
297 hr_utility.set_location(' Leaving:'||l_proc, 10);
298 End pre_delete;
299 --
300 -- ----------------------------------------------------------------------------
301 -- |----------------------------< post_delete >-------------------------------|
302 -- ----------------------------------------------------------------------------
303 -- {Start Of Comments}
304 --
305 -- Description:
306 -- This private procedure contains any processing which is required after
307 -- the delete dml.
308 --
309 -- Prerequisites:
310 -- This is an internal procedure which is called from the del procedure.
311 --
312 -- In Parameters:
313 -- A Pl/Sql record structure.
314 --
315 -- Post Success:
316 -- Processing continues.
317 --
318 -- Post Failure:
319 -- If an error has occurred, an error message and exception will be raised
320 -- but not handled.
321 --
322 -- Developer Implementation Notes:
323 -- Any post-processing required after the delete dml is issued should be
324 -- coded within this procedure. It is important to note that any 3rd party
325 -- maintenance should be reviewed before placing in this procedure.
326 --
327 -- Access Status:
328 -- Internal Row Handler Use Only.
329 --
330 -- {End Of Comments}
331 -- ----------------------------------------------------------------------------
332 Procedure post_delete
333 (p_rec in pay_pur_shd.g_rec_type
334 ,p_effective_date in date
335 ,p_datetrack_mode in varchar2
336 ,p_disable_range_overlap_check in boolean
337 ,p_validation_start_date in date
338 ,p_validation_end_date in date
339 ) is
340 --
341 l_proc varchar2(72) := g_package||'post_delete';
342 --
343 Begin
344 hr_utility.set_location('Entering:'||l_proc, 5);
345 begin
346 --
347 -- Delete ownerships if applicable
348 delete_app_ownerships
349 ('USER_ROW_ID', p_rec.user_row_id
350 ,p_datetrack_mode
351 );
352 --
353 pay_pur_rkd.after_delete
354 (p_effective_date
355 => p_effective_date
356 ,p_datetrack_mode
357 => p_datetrack_mode
358 ,p_validation_start_date
359 => p_validation_start_date
360 ,p_validation_end_date
361 => p_validation_end_date
362 ,p_user_row_id
363 => p_rec.user_row_id
364 ,p_effective_start_date
365 => p_rec.effective_start_date
366 ,p_effective_end_date
367 => p_rec.effective_end_date
368 ,p_disable_range_overlap_check
369 => p_disable_range_overlap_check
370 ,p_effective_start_date_o
371 => pay_pur_shd.g_old_rec.effective_start_date
372 ,p_effective_end_date_o
373 => pay_pur_shd.g_old_rec.effective_end_date
374 ,p_business_group_id_o
375 => pay_pur_shd.g_old_rec.business_group_id
376 ,p_legislation_code_o
377 => pay_pur_shd.g_old_rec.legislation_code
378 ,p_user_table_id_o
379 => pay_pur_shd.g_old_rec.user_table_id
380 ,p_row_low_range_or_name_o
381 => pay_pur_shd.g_old_rec.row_low_range_or_name
382 ,p_display_sequence_o
383 => pay_pur_shd.g_old_rec.display_sequence
384 ,p_row_high_range_o
385 => pay_pur_shd.g_old_rec.row_high_range
386 ,p_object_version_number_o
387 => pay_pur_shd.g_old_rec.object_version_number
388 );
389 --
390 exception
391 --
392 when hr_api.cannot_find_prog_unit then
393 --
394 hr_api.cannot_find_prog_unit_error
395 (p_module_name => 'PAY_USER_ROWS_F'
396 ,p_hook_type => 'AD');
397 --
398 end;
399 --
400 hr_utility.set_location(' Leaving:'||l_proc, 10);
401 End post_delete;
402 --
403 -- ----------------------------------------------------------------------------
404 -- |---------------------------------< del >----------------------------------|
405 -- ----------------------------------------------------------------------------
406 Procedure del
407 (p_effective_date in date
408 ,p_datetrack_mode in varchar2
409 ,p_rec in out nocopy pay_pur_shd.g_rec_type
410 ,p_disable_range_overlap_check in boolean default false
411 ) is
412 --
413 l_proc varchar2(72) := g_package||'del';
414 l_validation_start_date date;
415 l_validation_end_date date;
416 --
417 Begin
418 hr_utility.set_location('Entering:'||l_proc, 5);
419 --
420 -- Ensure that the DateTrack delete mode is valid
421 --
422 dt_api.validate_dt_del_mode(p_datetrack_mode => p_datetrack_mode);
423 --
424 -- We must lock the row which we need to delete.
425 --
426 pay_pur_shd.lck
427 (p_effective_date => p_effective_date
428 ,p_datetrack_mode => p_datetrack_mode
429 ,p_user_row_id => p_rec.user_row_id
430 ,p_object_version_number => p_rec.object_version_number
431 ,p_validation_start_date => l_validation_start_date
432 ,p_validation_end_date => l_validation_end_date
433 );
434 --
435 -- Call the supporting delete validate operation
436 --
437 pay_pur_bus.delete_validate
438 (p_rec => p_rec
439 ,p_effective_date => p_effective_date
440 ,p_datetrack_mode => p_datetrack_mode
441 ,p_disable_range_overlap_check => p_disable_range_overlap_check
442 ,p_validation_start_date => l_validation_start_date
443 ,p_validation_end_date => l_validation_end_date
444 );
445 --
446 -- Call to raise any errors on multi-message list
447 hr_multi_message.end_validation_set;
448 --
449 -- Call the supporting pre-delete operation
450 --
451 pay_pur_del.pre_delete
452 (p_rec => p_rec
453 ,p_effective_date => p_effective_date
454 ,p_datetrack_mode => p_datetrack_mode
455 ,p_validation_start_date => l_validation_start_date
456 ,p_validation_end_date => l_validation_end_date
457 );
458 --
459 -- Delete the row.
460 --
461 pay_pur_del.delete_dml
462 (p_rec => p_rec
463 ,p_effective_date => p_effective_date
464 ,p_datetrack_mode => p_datetrack_mode
465 ,p_validation_start_date => l_validation_start_date
466 ,p_validation_end_date => l_validation_end_date
467 );
468 -- Call the supporting post-delete operation
469 --
470 pay_pur_del.post_delete
471 (p_rec => p_rec
472 ,p_effective_date => p_effective_date
473 ,p_datetrack_mode => p_datetrack_mode
474 ,p_disable_range_overlap_check => p_disable_range_overlap_check
475 ,p_validation_start_date => l_validation_start_date
476 ,p_validation_end_date => l_validation_end_date
477 );
478 --
479 -- Call to raise any errors on multi-message list
480 hr_multi_message.end_validation_set;
481 --
482 hr_utility.set_location(' Leaving:'||l_proc, 5);
483 End del;
484 --
485 -- ----------------------------------------------------------------------------
486 -- |--------------------------------< del >-----------------------------------|
487 -- ----------------------------------------------------------------------------
488 Procedure del
489 (p_effective_date in date
490 ,p_datetrack_mode in varchar2
491 ,p_user_row_id in number
492 ,p_object_version_number in out nocopy number
493 ,p_disable_range_overlap_check in boolean default false
494 ,p_effective_start_date out nocopy date
495 ,p_effective_end_date out nocopy date
496 ) is
497 --
498 l_rec pay_pur_shd.g_rec_type;
499 l_proc varchar2(72) := g_package||'del';
500 --
501 Begin
502 hr_utility.set_location('Entering:'||l_proc, 5);
503 --
504 -- As the delete procedure accepts a plsql record structure we do need to
505 -- convert the arguments into the record structure.
506 -- We don't need to call the supplied conversion argument routine as we
507 -- only need a few attributes.
508 --
509 l_rec.user_row_id := p_user_row_id;
510 l_rec.object_version_number := p_object_version_number;
511 --
512 -- Having converted the arguments into the pay_pur_rec
513 -- plsql record structure we must call the corresponding entity
514 -- business process
515 --
516 pay_pur_del.del
517 (p_effective_date
518 ,p_datetrack_mode
519 ,l_rec
520 ,p_disable_range_overlap_check
521 );
522 --
523 --
524 -- Set the out arguments
525 --
526 p_object_version_number := l_rec.object_version_number;
527 p_effective_start_date := l_rec.effective_start_date;
528 p_effective_end_date := l_rec.effective_end_date;
529 --
530 hr_utility.set_location(' Leaving:'||l_proc, 10);
531 End del;
532 --
533 end pay_pur_del;