1 Package Body pqp_atd_del as
2 /* $Header: pqatdrhi.pkb 115.10 2003/02/17 22:13:56 tmehra ship $ */
3
4 ----------------------------------------------------------------------------
5 --| Private Global Definitions |
6 ----------------------------------------------------------------------------
7
8 g_package varchar2(33) := ' pqp_atd_del.'; -- Global package name
9
10 ----------------------------------------------------------------------------
11 -- |------------------------------< delete_dml >------------------------------|
12 ----------------------------------------------------------------------------
13 -- {Start Of Comments}
14 --
15 -- Description:
16 -- This procedure controls the actual dml delete logic. The functions of
17 -- this procedure are as follows:
18 -- 1) To set and unset the g_api_dml status as required (as we are about to
19 -- perform dml).
20 -- 2) To delete the specified row from the schema using the primary key in
21 -- the predicates.
22 -- 3) To trap any constraint violations that may have occurred.
23 -- 4) To raise any other errors.
24 --
25 -- Prerequisites:
26 -- This is an internal private procedure which must be called from the del
27 -- procedure.
28 --
29 -- In Parameters:
30 -- A Pl/Sql record structre.
31 --
32 -- Post Success:
33 -- The specified row will be delete from the schema.
34 --
35 -- Post Failure:
36 -- On the delete dml failure it is important to note that we always reset the
37 -- g_api_dml status to false.
38 -- If a child integrity constraint violation is raised the
39 -- constraint_error procedure will be called.
40 -- If any other error is reported, the error will be raised after the
41 -- g_api_dml status is reset.
42 --
43 -- Developer Implementation Notes:
44 -- None.
45 --
46 -- Access Status:
47 -- Internal Row Handler Use Only.
48 --
49 -- {End Of Comments}
50 ----------------------------------------------------------------------------
51 Procedure delete_dml(p_rec in pqp_atd_shd.g_rec_type) is
52
53 l_proc varchar2(72) := g_package||'delete_dml';
54
55 Begin
56 hr_utility.set_location('Entering:'||l_proc, 5);
57 --
58 pqp_atd_shd.g_api_dml := true; -- Set the api dml status
59 --
60 -- Delete the pqp_alien_transaction_data row.
61 --
62 delete from pqp_alien_transaction_data
63 where alien_transaction_id = p_rec.alien_transaction_id;
64 --
65 pqp_atd_shd.g_api_dml := false; -- Unset the api dml status
66 --
67 hr_utility.set_location(' Leaving:'||l_proc, 10);
68
69 Exception
70 When hr_api.child_integrity_violated then
71 -- Child integrity has been violated
72 pqp_atd_shd.g_api_dml := false; -- Unset the api dml status
73 pqp_atd_shd.constraint_error
74 (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
75 When Others Then
76 pqp_atd_shd.g_api_dml := false; -- Unset the api dml status
77 Raise;
78 End delete_dml;
79
80 ----------------------------------------------------------------------------
81 -- |------------------------------< pre_delete >------------------------------|
82 ----------------------------------------------------------------------------
83 -- {Start Of Comments}
84 --
85 -- Description:
86 -- This private procedure contains any processing which is required before
87 -- the delete dml.
88 --
89 -- Prerequisites:
90 -- This is an internal procedure which is called from the del procedure.
91 --
92 -- In Parameters:
93 -- A Pl/Sql record structre.
94 --
95 -- Post Success:
96 -- Processing continues.
97 --
98 -- Post Failure:
99 -- If an error has occurred, an error message and exception will be raised
100 -- but not handled.
101 --
102 -- Developer Implementation Notes:
103 -- Any pre-processing required before the delete dml is issued should be
104 -- coded within this procedure. It is important to note that any 3rd party
105 -- maintenance should be reviewed before placing in this procedure.
106 --
107 -- Access Status:
108 -- Internal Row Handler Use Only.
109 --
110 -- {End Of Comments}
111 ----------------------------------------------------------------------------
112 Procedure pre_delete(p_rec in pqp_atd_shd.g_rec_type) is
113
114 l_proc varchar2(72) := g_package||'pre_delete';
115
116 Begin
117 hr_utility.set_location('Entering:'||l_proc, 5);
118 --
119 hr_utility.set_location(' Leaving:'||l_proc, 10);
120 End pre_delete;
121
122 ----------------------------------------------------------------------------
123 -- |-----------------------------< post_delete >------------------------------|
124 ----------------------------------------------------------------------------
125 -- {Start Of Comments}
126 --
127 -- Description:
128 -- This private procedure contains any processing which is required after the
129 -- delete dml.
130 --
131 -- Prerequisites:
132 -- This is an internal procedure which is called from the del procedure.
133 --
134 -- In Parameters:
135 -- A Pl/Sql record structre.
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 -- Any post-processing required after the delete dml is issued should be
146 -- coded within this procedure. It is important to note that any 3rd party
147 -- maintenance should be reviewed before placing in this procedure.
148 --
149 -- Access Status:
150 -- Internal table Handler Use Only.
151 --
152 -- {End Of Comments}
153 ----------------------------------------------------------------------------
154 Procedure post_delete(
155 p_effective_date in date,p_rec in pqp_atd_shd.g_rec_type) is
156
157 l_proc varchar2(72) := g_package||'post_delete';
158
159 Begin
160 hr_utility.set_location('Entering:'||l_proc, 5);
161
162 --
163 -- Start of API User Hook for post_delete.
164 --
165 begin
166 --
167 pqp_atd_rkd.after_delete
168 (
169 p_alien_transaction_id =>p_rec.alien_transaction_id
170 ,p_person_id_o =>pqp_atd_shd.g_old_rec.person_id
171 ,p_data_source_type_o =>pqp_atd_shd.g_old_rec.data_source_type
172 ,p_tax_year_o =>pqp_atd_shd.g_old_rec.tax_year
173 ,p_income_code_o =>pqp_atd_shd.g_old_rec.income_code
174 ,p_withholding_rate_o =>pqp_atd_shd.g_old_rec.withholding_rate
175 ,p_income_code_sub_type_o =>pqp_atd_shd.g_old_rec.income_code_sub_type
176 ,p_exemption_code_o =>pqp_atd_shd.g_old_rec.exemption_code
177 ,p_maximum_benefit_amount_o =>pqp_atd_shd.g_old_rec.maximum_benefit_amount
178 ,p_retro_lose_ben_amt_flag_o =>pqp_atd_shd.g_old_rec.retro_lose_ben_amt_flag
179 ,p_date_benefit_ends_o =>pqp_atd_shd.g_old_rec.date_benefit_ends
180 ,p_retro_lose_ben_date_flag_o =>pqp_atd_shd.g_old_rec.retro_lose_ben_date_flag
181 ,p_current_residency_status_o =>pqp_atd_shd.g_old_rec.current_residency_status
182 ,p_nra_to_ra_date_o =>pqp_atd_shd.g_old_rec.nra_to_ra_date
183 ,p_target_departure_date_o =>pqp_atd_shd.g_old_rec.target_departure_date
184 ,p_tax_residence_country_code_o =>pqp_atd_shd.g_old_rec.tax_residence_country_code
185 ,p_treaty_info_update_date_o =>pqp_atd_shd.g_old_rec.treaty_info_update_date
186 ,p_nra_exempt_from_fica_o =>pqp_atd_shd.g_old_rec.nra_exempt_from_fica
187 ,p_student_exempt_from_fica_o =>pqp_atd_shd.g_old_rec.student_exempt_from_fica
188 ,p_addl_withholding_flag_o =>pqp_atd_shd.g_old_rec.addl_withholding_flag
189 ,p_addl_withholding_amt_o =>pqp_atd_shd.g_old_rec.addl_withholding_amt
190 ,p_addl_wthldng_amt_period_ty_o=>pqp_atd_shd.g_old_rec.addl_wthldng_amt_period_type
191 ,p_personal_exemption_o =>pqp_atd_shd.g_old_rec.personal_exemption
192 ,p_addl_exemption_allowed_o =>pqp_atd_shd.g_old_rec.addl_exemption_allowed
193 ,p_number_of_days_in_usa_o =>pqp_atd_shd.g_old_rec.number_of_days_in_usa
194 ,p_wthldg_allow_eligible_flag_o =>pqp_atd_shd.g_old_rec.wthldg_allow_eligible_flag
195 ,p_treaty_ben_allowed_flag_o =>pqp_atd_shd.g_old_rec.treaty_ben_allowed_flag
196 ,p_treaty_benefits_start_date_o =>pqp_atd_shd.g_old_rec.treaty_benefits_start_date
197 ,p_ra_effective_date_o =>pqp_atd_shd.g_old_rec.ra_effective_date
198 ,p_state_code_o =>pqp_atd_shd.g_old_rec.state_code
199 ,p_state_honors_treaty_flag_o =>pqp_atd_shd.g_old_rec.state_honors_treaty_flag
200 ,p_ytd_payments_o =>pqp_atd_shd.g_old_rec.ytd_payments
201 ,p_ytd_w2_payments_o =>pqp_atd_shd.g_old_rec.ytd_w2_payments
202 ,p_ytd_w2_withholding_o =>pqp_atd_shd.g_old_rec.ytd_w2_withholding
203 ,p_ytd_withholding_allowance_o =>pqp_atd_shd.g_old_rec.ytd_withholding_allowance
204 ,p_ytd_treaty_payments_o =>pqp_atd_shd.g_old_rec.ytd_treaty_payments
205 ,p_ytd_treaty_withheld_amt_o =>pqp_atd_shd.g_old_rec.ytd_treaty_withheld_amt
206 ,p_record_source_o =>pqp_atd_shd.g_old_rec.record_source
207 ,p_visa_type_o =>pqp_atd_shd.g_old_rec.visa_type
208 ,p_j_sub_type_o =>pqp_atd_shd.g_old_rec.j_sub_type
209 ,p_primary_activity_o =>pqp_atd_shd.g_old_rec.primary_activity
210 ,p_non_us_country_code_o =>pqp_atd_shd.g_old_rec.non_us_country_code
211 ,p_citizenship_country_code_o =>pqp_atd_shd.g_old_rec.citizenship_country_code
212 ,p_constant_addl_tax_o =>pqp_atd_shd.g_old_rec.constant_addl_tax
213 ,p_date_8233_signed_o =>pqp_atd_shd.g_old_rec.date_8233_signed
214 ,p_date_w4_signed_o =>pqp_atd_shd.g_old_rec.date_w4_signed
215 ,p_error_indicator_o =>pqp_atd_shd.g_old_rec.error_indicator
216 ,p_prev_er_treaty_benefit_amt_o =>pqp_atd_shd.g_old_rec.prev_er_treaty_benefit_amt
217 ,p_error_text_o =>pqp_atd_shd.g_old_rec.error_text
218 ,p_object_version_number_o =>pqp_atd_shd.g_old_rec.object_version_number
219 ,p_current_analysis_o =>pqp_atd_shd.g_old_rec.current_analysis
220 ,p_forecast_income_code_o =>pqp_atd_shd.g_old_rec.forecast_income_code
221 );
222 --
223 exception
224 --
225 when hr_api.cannot_find_prog_unit then
226 --
227 hr_api.cannot_find_prog_unit_error
228 (p_module_name => 'PQP_ALIEN_TRANS_DATA'
229 ,p_hook_type => 'AD');
230 --
231 end;
232 --
233 -- End of API User Hook for post_delete.
234 --
235 --
236 hr_utility.set_location(' Leaving:'||l_proc, 10);
237 End post_delete;
238
239 ----------------------------------------------------------------------------
240 -- |---------------------------------< del >----------------------------------|
241 ----------------------------------------------------------------------------
242 Procedure del
243 (
244 p_effective_date in date,
245 p_rec in pqp_atd_shd.g_rec_type
246 ) is
247
248 l_proc varchar2(72) := g_package||'del';
249
250 Begin
251 hr_utility.set_location('Entering:'||l_proc, 5);
252 --
253 -- We must lock the row which we need to delete.
254 --
255 pqp_atd_shd.lck
256 (
257 p_rec.alien_transaction_id,
258 p_rec.object_version_number
259 );
260 --
261 -- Call the supporting delete validate operation
262 --
263 pqp_atd_bus.delete_validate(p_rec
264 ,p_effective_date);
265 --
266 -- Call the supporting pre-delete operation
267 --
268 pre_delete(p_rec);
269 --
270 -- Delete the row.
271 --
272 delete_dml(p_rec);
273 --
274 -- Call the supporting post-delete operation
275 --
276 post_delete(
277 p_effective_date,p_rec);
278 End del;
279
280 ----------------------------------------------------------------------------
281 -- |---------------------------------< del >----------------------------------|
282 ----------------------------------------------------------------------------
283 Procedure del
284 (
285 p_effective_date in date,
286 p_alien_transaction_id in number,
287 p_object_version_number in number
288 ) is
289
290 l_rec pqp_atd_shd.g_rec_type;
291 l_proc varchar2(72) := g_package||'del';
292
293 Begin
294 hr_utility.set_location('Entering:'||l_proc, 5);
295 --
296 -- As the delete procedure accepts a plsql record structure we do need to
297 -- convert the arguments into the record structure.
298 -- We don't need to call the supplied conversion argument routine as we
299 -- only need a few attributes.
300 --
301 l_rec.alien_transaction_id:= p_alien_transaction_id;
302 l_rec.object_version_number := p_object_version_number;
303 --
304 -- Having converted the arguments into the pqp_atd_rec
305 -- plsql record structure we must call the corresponding entity
306 -- business process
307 --
308 del(
309 p_effective_date,l_rec);
310 --
311 hr_utility.set_location(' Leaving:'||l_proc, 10);
312 END del;
313
314 END pqp_atd_del;