DBA Data[Home] [Help]

PACKAGE BODY: APPS.PAY_FED_DEL

Source


1 Package Body pay_fed_del as
2 /* $Header: pyfedrhi.pkb 120.1.12000000.4 2007/07/26 11:08:20 vaprakas noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |                     Private Global Definitions                           |
6 -- ----------------------------------------------------------------------------
7 --
8 g_package  varchar2(33) := '  pay_fed_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 structre.
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_fed_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) is
59 --
60   l_proc      varchar2(72) := g_package||'dt_delete_dml';
61 --
62 Begin
63   hr_utility.set_location('Entering:'||l_proc, 5);
64   If (p_datetrack_mode = 'DELETE_NEXT_CHANGE') then
65     hr_utility.set_location(l_proc, 10);
66     pay_fed_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_us_emp_fed_tax_rules_f
72     where       emp_fed_tax_rule_id = p_rec.emp_fed_tax_rule_id
73     and   effective_start_date = p_validation_start_date;
74     --
75     pay_fed_shd.g_api_dml := false;   -- Unset the api dml status
76   Else
77     hr_utility.set_location(l_proc, 15);
78     pay_fed_shd.g_api_dml := true;  -- Set the api dml status
79     --
80     -- Delete the row(s) where the effective start date is greater than
81     -- or equal to the validation start date.
82     --
83     delete from pay_us_emp_fed_tax_rules_f
84     where        emp_fed_tax_rule_id = p_rec.emp_fed_tax_rule_id
85     and   effective_start_date >= p_validation_start_date;
86     --
87     pay_fed_shd.g_api_dml := false;   -- Unset the api dml status
88   End If;
89   --
90   hr_utility.set_location(' Leaving:'||l_proc, 20);
91 --
92 Exception
93   When Others Then
94     pay_fed_shd.g_api_dml := false;   -- Unset the api dml status
95     Raise;
96 End dt_delete_dml;
97 --
98 -- ----------------------------------------------------------------------------
99 -- |------------------------------< delete_dml >------------------------------|
100 -- ----------------------------------------------------------------------------
101 Procedure delete_dml
102       (p_rec                   in out nocopy pay_fed_shd.g_rec_type,
103        p_effective_date        in      date,
104        p_datetrack_mode        in      varchar2,
105        p_validation_start_date in      date,
106        p_validation_end_date   in      date) is
107 --
108   l_proc      varchar2(72) := g_package||'delete_dml';
109 --
110 Begin
111   hr_utility.set_location('Entering:'||l_proc, 5);
112   --
113   dt_delete_dml(p_rec                  => p_rec,
114             p_effective_date        => p_effective_date,
115             p_datetrack_mode        => p_datetrack_mode,
116             p_validation_start_date => p_validation_start_date,
117             p_validation_end_date   => p_validation_end_date);
118   --
119   hr_utility.set_location(' Leaving:'||l_proc, 10);
120 End delete_dml;
121 --
122 -- ----------------------------------------------------------------------------
123 -- |----------------------------< dt_pre_delete >-----------------------------|
124 -- ----------------------------------------------------------------------------
125 -- {Start Of Comments}
126 --
127 -- Description:
128 --   The dt_pre_delete process controls the execution of dml
129 --   for the datetrack modes: DELETE, FUTURE_CHANGE
130 --   and DELETE_NEXT_CHANGE only.
131 --
132 -- Prerequisites:
133 --   This is an internal procedure which is called from the pre_delete
134 --   procedure.
135 --
136 -- In Parameters:
137 --   A Pl/Sql record structre.
138 --
139 -- Post Success:
140 --   Processing continues.
141 --
142 -- Post Failure:
143 --   If an error has occurred, an error message and exception will be raised
144 --   but not handled.
145 --
146 -- Developer Implementation Notes:
147 --   This is an internal procedure which is required by Datetrack. Don't
148 --   remove or modify.
149 --
150 -- Access Status:
151 --   Internal Row Handler Use Only.
152 --
153 -- {End Of Comments}
154 -- ----------------------------------------------------------------------------
155 Procedure dt_pre_delete
156       (p_rec                   in out nocopy pay_fed_shd.g_rec_type,
157        p_effective_date        in      date,
158        p_datetrack_mode        in      varchar2,
159        p_validation_start_date in      date,
160        p_validation_end_date   in      date) is
161 --
162   l_proc      varchar2(72) := g_package||'dt_pre_delete';
163 --
164 Begin
165   hr_utility.set_location('Entering:'||l_proc, 5);
166   --
167   If (p_datetrack_mode <> 'ZAP') then
168     --
169     p_rec.effective_start_date := pay_fed_shd.g_old_rec.effective_start_date;
170     --
171     If (p_datetrack_mode = '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_fed_shd.upd_effective_end_date
180       (p_effective_date         => p_effective_date,
181        p_base_key_value         => p_rec.emp_fed_tax_rule_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   Else
187     p_rec.effective_start_date := null;
188     p_rec.effective_end_date   := null;
189   End If;
190   hr_utility.set_location(' Leaving:'||l_proc, 10);
191 End dt_pre_delete;
192 --
193 -- ----------------------------------------------------------------------------
194 -- |------------------------------< pre_delete >------------------------------|
195 -- ----------------------------------------------------------------------------
196 -- {Start Of Comments}
197 --
198 -- Description:
199 --   This private procedure contains any processing which is required before
200 --   the delete dml.
201 --
202 -- Prerequisites:
203 --   This is an internal procedure which is called from the del procedure.
204 --
205 -- In Parameters:
206 --   A Pl/Sql record structre.
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 --   Any pre-processing required before the delete dml is issued should be
217 --   coded within this procedure. It is important to note that any 3rd party
218 --   maintenance should be reviewed before placing in this procedure. The call
219 --   to the dt_delete_dml procedure should NOT be removed.
220 --
221 -- Access Status:
222 --   Internal Row Handler Use Only.
223 --
224 -- {End Of Comments}
225 -- ----------------------------------------------------------------------------
226 Procedure pre_delete
227       (p_rec                   in out nocopy pay_fed_shd.g_rec_type,
228        p_effective_date        in      date,
229        p_datetrack_mode        in      varchar2,
230        p_validation_start_date in      date,
231        p_validation_end_date   in      date) is
232 --
233   l_proc      varchar2(72) := g_package||'pre_delete';
234 --
235   --
236 --
237 Begin
238   hr_utility.set_location('Entering:'||l_proc, 5);
239   --
240   --
241   --
242   dt_pre_delete
243     (p_rec                   => p_rec,
244      p_effective_date        => p_effective_date,
245      p_datetrack_mode        => p_datetrack_mode,
246      p_validation_start_date => p_validation_start_date,
247      p_validation_end_date   => p_validation_end_date);
248   --
249   hr_utility.set_location(' Leaving:'||l_proc, 10);
250 End pre_delete;
251 --
252 -- ----------------------------------------------------------------------------
253 -- |-----------------------------< post_delete >------------------------------|
254 -- ----------------------------------------------------------------------------
255 -- {Start Of Comments}
256 --
257 -- Description:
258 --   This private procedure contains any processing which is required after the
259 --   delete dml.
260 --
261 -- Prerequisites:
262 --   This is an internal procedure which is called from the del procedure.
263 --
264 -- In Parameters:
265 --   A Pl/Sql record structre.
266 --
267 -- Post Success:
268 --   Processing continues.
269 --
270 -- Post Failure:
271 --   If an error has occurred, an error message and exception will be raised
272 --   but not handled.
273 --
274 -- Developer Implementation Notes:
275 --   Any post-processing required after the delete dml is issued should be
276 --   coded within this procedure. It is important to note that any 3rd party
277 --   maintenance should be reviewed before placing in this procedure.
278 --
279 -- Access Status:
280 --   Internal Row Handler Use Only.
281 --
282 -- {End Of Comments}
283 -- ----------------------------------------------------------------------------
284 Procedure post_delete
285       (p_rec                   in pay_fed_shd.g_rec_type,
286        p_effective_date        in date,
287        p_datetrack_mode        in varchar2,
288        p_validation_start_date in date,
289        p_validation_end_date   in date) is
290 --
291   l_proc      varchar2(72) := g_package||'post_delete';
292 --
293 Begin
294   hr_utility.set_location('Entering:'||l_proc, 5);
295 --
296   --
297   -- Start of API User Hook for post_delete.
298   --
299   begin
300     --
301  /*    pay_fed_rkd.after_delete
302       (
303   p_emp_fed_tax_rule_id        =>p_rec.emp_fed_tax_rule_id
304  ,p_datetrack_mode             =>p_datetrack_mode
305  ,p_effective_date             =>p_effective_date
306  ,p_object_version_number      =>p_rec.object_version_number
307  ,p_validation_start_date      =>p_validation_start_date
308  ,p_validation_end_date        =>p_validation_end_date
309  ,p_effective_start_date       =>p_rec.effective_start_date
310  ,p_effective_end_date         =>p_rec.effective_end_date
311  ,p_effective_start_date_o     =>pay_fed_shd.g_old_rec.effective_start_date
312  ,p_effective_end_date_o       =>pay_fed_shd.g_old_rec.effective_end_date
313  ,p_assignment_id_o            =>pay_fed_shd.g_old_rec.assignment_id
314  ,p_sui_state_code_o           =>pay_fed_shd.g_old_rec.sui_state_code
315  ,p_sui_jurisdiction_code_o    =>pay_fed_shd.g_old_rec.sui_jurisdiction_code
316  ,p_business_group_id_o        =>pay_fed_shd.g_old_rec.business_group_id
317  ,p_additional_wa_amount_o     =>pay_fed_shd.g_old_rec.additional_wa_amount
318  ,p_filing_status_code_o       =>pay_fed_shd.g_old_rec.filing_status_code
319  ,p_fit_override_amount_o      =>pay_fed_shd.g_old_rec.fit_override_amount
320  ,p_fit_override_rate_o        =>pay_fed_shd.g_old_rec.fit_override_rate
321  ,p_withholding_allowances_o   =>pay_fed_shd.g_old_rec.withholding_allowances
322  ,p_cumulative_taxation_o      =>pay_fed_shd.g_old_rec.cumulative_taxation
323  ,p_eic_filing_status_code_o   =>pay_fed_shd.g_old_rec.eic_filing_status_code
324  ,p_fit_additional_tax_o       =>pay_fed_shd.g_old_rec.fit_additional_tax
325  ,p_fit_exempt_o               =>pay_fed_shd.g_old_rec.fit_exempt
326  ,p_futa_tax_exempt_o          =>pay_fed_shd.g_old_rec.futa_tax_exempt
327  ,p_medicare_tax_exempt_o      =>pay_fed_shd.g_old_rec.medicare_tax_exempt
328  ,p_ss_tax_exempt_o            =>pay_fed_shd.g_old_rec.ss_tax_exempt
329  ,p_wage_exempt_o              =>pay_fed_shd.g_old_rec.wage_exempt
330  ,p_statutory_employee_o       =>pay_fed_shd.g_old_rec.statutory_employee
331  ,p_w2_filed_year_o            =>pay_fed_shd.g_old_rec.w2_filed_year
332  ,p_supp_tax_override_rate_o   =>pay_fed_shd.g_old_rec.supp_tax_override_rate
333  ,p_excessive_wa_reject_date_o =>pay_fed_shd.g_old_rec.excessive_wa_reject_date
334  ,p_object_version_number_o    =>pay_fed_shd.g_old_rec.object_version_number
335       );
336     --
337   exception
338     --
339     when hr_api.cannot_find_prog_unit then
340       --
341       hr_api.cannot_find_prog_unit_error
342         (p_module_name => 'PAY_US_EMP_FED_TAX_RULES_F
343         ,p_hook_type   => 'AD');
344       --
345  */
346     null;
347     --
348   end;
349   --
350   -- End of API User Hook for post_delete.
351   --
352   --
353   hr_utility.set_location(' Leaving:'||l_proc, 10);
354 End post_delete;
355 --
356 -- ----------------------------------------------------------------------------
357 -- |---------------------------------< del >----------------------------------|
358 -- ----------------------------------------------------------------------------
359 Procedure del
360   (
361    p_rec                in out nocopy       pay_fed_shd.g_rec_type
362   ,p_effective_date     in       date
363   ,p_datetrack_mode     in       varchar2
364   ,p_delete_routine     in    varchar2   default null
365   ) is
366 --
367   l_proc            varchar2(72) := g_package||'del';
368   l_validation_start_date      date;
369   l_validation_end_date        date;
370 --
371 Begin
372   hr_utility.set_location('Entering:'||l_proc, 5);
373   --
374   -- Ensure that the DateTrack delete mode is valid
375   --
376   dt_api.validate_dt_del_mode(p_datetrack_mode => p_datetrack_mode);
377   --
378   -- We must lock the row which we need to delete.
379   --
380   pay_fed_shd.lck
381       (p_effective_date        => p_effective_date,
382        p_datetrack_mode        => p_datetrack_mode,
383        p_emp_fed_tax_rule_id   => p_rec.emp_fed_tax_rule_id,
384        p_object_version_number => p_rec.object_version_number,
385        p_validation_start_date => l_validation_start_date,
386        p_validation_end_date   => l_validation_end_date);
387   --
388   -- Call the supporting delete validate operation
389   --
390   pay_fed_bus.delete_validate
391       (p_rec                   => p_rec
392       ,p_effective_date        => p_effective_date
393       ,p_datetrack_mode        => p_datetrack_mode
394       ,p_validation_start_date => l_validation_start_date
395       ,p_validation_end_date   => l_validation_end_date
396       ,p_delete_routine        => p_delete_routine
397       );
398   --
399   -- Call the supporting pre-delete operation
400   --
401   pre_delete
402       (p_rec                   => p_rec,
403        p_effective_date        => p_effective_date,
404        p_datetrack_mode        => p_datetrack_mode,
405        p_validation_start_date => l_validation_start_date,
406        p_validation_end_date   => l_validation_end_date);
407   --
408   -- Delete the row.
409   --
410   delete_dml
411       (p_rec                   => p_rec,
412        p_effective_date        => p_effective_date,
413        p_datetrack_mode        => p_datetrack_mode,
414        p_validation_start_date => l_validation_start_date,
415        p_validation_end_date   => l_validation_end_date);
416   --
417   -- Call the supporting post-delete operation
418   --
419   post_delete
420       (p_rec                   => p_rec,
421        p_effective_date        => p_effective_date,
422        p_datetrack_mode        => p_datetrack_mode,
423        p_validation_start_date => l_validation_start_date,
424        p_validation_end_date   => l_validation_end_date);
425 End del;
426 --
427 -- ----------------------------------------------------------------------------
428 -- |---------------------------------< del >----------------------------------|
429 -- ----------------------------------------------------------------------------
430 Procedure del
431   (
432    p_emp_fed_tax_rule_id   in     number
433   ,p_effective_start_date     out nocopy date
434   ,p_effective_end_date       out nocopy date
435   ,p_object_version_number in out nocopy number
436   ,p_effective_date        in     date
437   ,p_datetrack_mode        in     varchar2
438   ,p_delete_routine        in     varchar2   default null
439   ) is
440 --
441   l_rec            pay_fed_shd.g_rec_type;
442   l_proc      varchar2(72) := g_package||'del';
443 --
444 Begin
445   hr_utility.set_location('Entering:'||l_proc, 5);
446   --
447   -- As the delete procedure accepts a plsql record structure we do need to
448   -- convert the  arguments into the record structure.
449   -- We don't need to call the supplied conversion argument routine as we
450   -- only need a few attributes.
451   --
452   l_rec.emp_fed_tax_rule_id         := p_emp_fed_tax_rule_id;
453   l_rec.object_version_number       := p_object_version_number;
454   --
455   -- Having converted the arguments into the pay_fed_rec
456   -- plsql record structure we must call the corresponding entity
457   -- business process
458   --
459   del(l_rec, p_effective_date
460            , p_datetrack_mode
461            , p_delete_routine
462       );
463   --
464   -- Set the out arguments
465   --
466   p_object_version_number := l_rec.object_version_number;
467   p_effective_start_date  := l_rec.effective_start_date;
468   p_effective_end_date    := l_rec.effective_end_date;
469   --
470   hr_utility.set_location(' Leaving:'||l_proc, 10);
471 End del;
472 --
473 end pay_fed_del;