1 Package Body pay_txr_upd as
2 /* $Header: pytxrrhi.pkb 120.2 2012/01/19 11:27:49 rpahune ship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- | Private Global Definitions |
6 -- ----------------------------------------------------------------------------
7 --
8 g_package varchar2(33) := ' pay_txr_upd.'; -- Global package name
9 --
10 -- ----------------------------------------------------------------------------
11 -- |------------------------------< update_dml >------------------------------|
12 -- ----------------------------------------------------------------------------
13 -- {Start Of Comments}
14 --
15 -- Description:
16 -- This procedure controls the actual dml update logic. The processing of
17 -- this procedure is:
18 -- 1) Increment the object_version_number by 1 if the object_version_number
19 -- is defined as an attribute for this entity.
20 -- 2) To set and unset the g_api_dml status as required (as we are about to
21 -- perform dml).
22 -- 3) To update the specified row in the schema using the primary key in
23 -- the predicates.
24 -- 4) To trap any constraint violations that may have occurred.
25 -- 5) To raise any other errors.
26 --
27 -- Prerequisites:
28 -- This is an internal private procedure which must be called from the upd
29 -- procedure.
30 --
31 -- In Parameters:
32 -- A Pl/Sql record structre.
33 --
34 -- Post Success:
35 -- The specified row will be updated in the schema.
36 --
37 -- Post Failure:
38 -- On the update dml failure it is important to note that we always reset the
39 -- g_api_dml status to false.
40 -- If a check, unique or parent integrity constraint violation is raised the
41 -- constraint_error procedure will be called.
42 -- If any other error is reported, the error will be raised after the
43 -- g_api_dml status is reset.
44 --
45 -- Developer Implementation Notes:
46 -- The update 'set' attribute list should be modified if any of your
47 -- attributes are not updateable.
48 --
49 -- Access Status:
50 -- Internal Row Handler Use Only.
51 --
52 -- {End Of Comments}
53 -- ----------------------------------------------------------------------------
54 Procedure update_dml
55 (p_rec in out nocopy pay_txr_shd.g_rec_type
56 ) is
57 --
58 l_proc varchar2(72) := g_package||'update_dml';
59 --
60 Begin
61 hr_utility.set_location('Entering:'||l_proc, 5);
62 --
63 --
64 --
65 --
66 -- Update the pay_taxability_rules Row
67 --
68 update pay_taxability_rules
69 set
70 jurisdiction_code = p_rec.jurisdiction_code
71 ,tax_type = p_rec.tax_type
72 ,tax_category = p_rec.tax_category
73 ,classification_id = p_rec.classification_id
74 ,taxability_rules_date_id = p_rec.taxability_rules_date_id
75 ,legislation_code = p_rec.legislation_code
76 ,status = p_rec.status
77 ,secondary_classification_id = p_rec.secondary_classification_id
78 where jurisdiction_code = p_rec.jurisdiction_code
79 and nvl(tax_type, 'X') = nvl(p_rec.tax_type, 'X')
80 and nvl(tax_category, 'X') = nvl(p_rec.tax_category, 'X')
81 and nvl(classification_id, 0) = nvl(p_rec.classification_id, 0)
82 and nvl(secondary_classification_id, 0) =
83 nvl(p_rec.secondary_classification_id, 0)
84 and taxability_rules_date_id = p_rec.taxability_rules_date_id;
85 --
86 --
87 --
88 hr_utility.set_location(' Leaving:'||l_proc, 10);
89 --
90 Exception
91 When hr_api.check_integrity_violated Then
92 -- A check constraint has been violated
93 --
94 pay_txr_shd.constraint_error
95 (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
96 When hr_api.parent_integrity_violated Then
97 -- Parent integrity has been violated
98 --
99 pay_txr_shd.constraint_error
100 (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
101 When hr_api.unique_integrity_violated Then
102 -- Unique integrity has been violated
103 --
104 pay_txr_shd.constraint_error
105 (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
106 When Others Then
107 --
108 Raise;
109 End update_dml;
110 --
111 -- ----------------------------------------------------------------------------
112 -- |------------------------------< pre_update >------------------------------|
113 -- ----------------------------------------------------------------------------
114 -- {Start Of Comments}
115 --
116 -- Description:
117 -- This private procedure contains any processing which is required before
118 -- the update dml.
119 --
120 -- Prerequisites:
121 -- This is an internal procedure which is called from the upd procedure.
122 --
123 -- In Parameters:
124 -- A Pl/Sql record structure.
125 --
126 -- Post Success:
127 -- Processing continues.
128 --
129 -- Post Failure:
130 -- If an error has occurred, an error message and exception wil be raised
131 -- but not handled.
132 --
133 -- Developer Implementation Notes:
134 -- Any pre-processing required before the update dml is issued should be
135 -- coded within this procedure. It is important to note that any 3rd party
136 -- maintenance should be reviewed before placing in this procedure.
137 --
138 -- Access Status:
139 -- Internal Row Handler Use Only.
140 --
141 -- {End Of Comments}
142 -- ----------------------------------------------------------------------------
143 Procedure pre_update
144 (p_rec in pay_txr_shd.g_rec_type
145 ) is
146 --
147 l_proc varchar2(72) := g_package||'pre_update';
148 --
149 Begin
150 hr_utility.set_location('Entering:'||l_proc, 5);
151 --
152 hr_utility.set_location(' Leaving:'||l_proc, 10);
153 End pre_update;
154 --
155 -- ----------------------------------------------------------------------------
156 -- |-----------------------------< post_update >------------------------------|
157 -- ----------------------------------------------------------------------------
158 -- {Start Of Comments}
159 --
160 -- Description:
161 -- This private procedure contains any processing which is required after
162 -- the update dml.
163 --
164 -- Prerequisites:
165 -- This is an internal procedure which is called from the upd procedure.
166 --
167 -- In Parameters:
168 -- A Pl/Sql record structure.
169 --
170 -- Post Success:
171 -- Processing continues.
172 --
173 -- Post Failure:
174 -- If an error has occurred, an error message and exception will be raised
175 -- but not handled.
176 --
177 -- Developer Implementation Notes:
178 -- Any post-processing required after the update dml is issued should be
179 -- coded within this procedure. It is important to note that any 3rd party
180 -- maintenance should be reviewed before placing in this procedure.
181 --
182 -- Access Status:
183 -- Internal Row Handler Use Only.
184 --
185 -- {End Of Comments}
186 -- ----------------------------------------------------------------------------
187 Procedure post_update
188 (p_effective_date in date
189 ,p_rec in pay_txr_shd.g_rec_type
190 ) is
191 --
192 l_proc varchar2(72) := g_package||'post_update';
193 --
194 Begin
195 hr_utility.set_location('Entering:'||l_proc, 5);
196 begin
197 --
198 pay_txr_rku.after_update
199 (p_effective_date => p_effective_date
200 ,p_jurisdiction_code
201 => p_rec.jurisdiction_code
202 ,p_tax_type
203 => p_rec.tax_type
204 ,p_tax_category
205 => p_rec.tax_category
206 ,p_classification_id
207 => p_rec.classification_id
208 ,p_taxability_rules_date_id
209 => p_rec.taxability_rules_date_id
210 ,p_legislation_code
211 => p_rec.legislation_code
212 ,p_status
213 => p_rec.status
214 ,p_legislation_code_o
215 => pay_txr_shd.g_old_rec.legislation_code
216 ,p_status_o
217 => pay_txr_shd.g_old_rec.status
218 ,p_secondary_classification_id
219 => p_rec.secondary_classification_id
220 );
221 --
222 exception
223 --
224 when hr_api.cannot_find_prog_unit then
225 --
226 hr_api.cannot_find_prog_unit_error
227 (p_module_name => 'PAY_TAXABILITY_RULES'
228 ,p_hook_type => 'AU');
229 --
230 end;
231 --
232 hr_utility.set_location(' Leaving:'||l_proc, 10);
233 End post_update;
234 --
235 -- ----------------------------------------------------------------------------
236 -- |-----------------------------< convert_defs >-----------------------------|
237 -- ----------------------------------------------------------------------------
238 -- {Start Of Comments}
239 --
240 -- Description:
241 -- The Convert_Defs procedure has one very important function:
242 -- It must return the record structure for the row with all system defaulted
243 -- values converted into its corresponding parameter value for update. When
244 -- we attempt to update a row through the Upd process , certain
245 -- parameters can be defaulted which enables flexibility in the calling of
246 -- the upd process (e.g. only attributes which need to be updated need to be
247 -- specified). For the upd process to determine which attributes
248 -- have NOT been specified we need to check if the parameter has a reserved
249 -- system default value. Therefore, for all parameters which have a
250 -- corresponding reserved system default mechanism specified we need to
251 -- check if a system default is being used. If a system default is being
252 -- used then we convert the defaulted value into its corresponding attribute
253 -- value held in the g_old_rec data structure.
254 --
255 -- Prerequisites:
256 -- This private function can only be called from the upd process.
257 --
258 -- In Parameters:
259 -- A Pl/Sql record structure.
260 --
261 -- Post Success:
262 -- The record structure will be returned with all system defaulted parameter
263 -- values converted into its current row attribute value.
264 --
265 -- Post Failure:
266 -- No direct error handling is required within this function. Any possible
267 -- errors within this procedure will be a PL/SQL value error due to
268 -- conversion of datatypes or data lengths.
269 --
270 -- Developer Implementation Notes:
271 -- None.
272 --
273 -- Access Status:
274 -- Internal Row Handler Use Only.
275 --
276 -- {End Of Comments}
277 -- ----------------------------------------------------------------------------
278 Procedure convert_defs
279 (p_rec in out nocopy pay_txr_shd.g_rec_type
280 ) is
281 --
282 Begin
283 --
284 -- We must now examine each argument value in the
285 -- p_rec plsql record structure
286 -- to see if a system default is being used. If a system default
287 -- is being used then we must set to the 'current' argument value.
288 --
289 If (p_rec.legislation_code = hr_api.g_varchar2) then
290 p_rec.legislation_code :=
291 pay_txr_shd.g_old_rec.legislation_code;
292 End If;
293 If (p_rec.status = hr_api.g_varchar2) then
294 p_rec.status :=
295 pay_txr_shd.g_old_rec.status;
296 End If;
297 --
298 End convert_defs;
299 --
300 -- ----------------------------------------------------------------------------
301 -- |---------------------------------< upd >----------------------------------|
302 -- ----------------------------------------------------------------------------
303 Procedure upd
304 (p_effective_date in date
305 ,p_rec in out nocopy pay_txr_shd.g_rec_type
306 ) is
307 --
308 l_proc varchar2(72) := g_package||'upd';
309 --
310 Begin
311 hr_utility.set_location('Entering:'||l_proc, 5);
312 --
313 -- We must lock the row which we need to update.
314 --
315 pay_txr_shd.lck
316 (p_rec.jurisdiction_code
317 ,p_rec.tax_type
318 ,p_rec.tax_category
319 ,p_rec.classification_id
320 ,p_rec.taxability_rules_date_id
321 ,p_rec.secondary_classification_id
322 );
323 --
324 -- 1. During an update system defaults are used to determine if
325 -- arguments have been defaulted or not. We must therefore
326 -- derive the full record structure values to be updated.
327 --
328 -- 2. Call the supporting update validate operations.
329 --
330 convert_defs(p_rec);
331 pay_txr_bus.update_validate
332 (p_effective_date
333 ,p_rec
334 );
335 --
336 -- Call to raise any errors on multi-message list
337 hr_multi_message.end_validation_set;
338 --
339 -- Call the supporting pre-update operation
340 --
341 pay_txr_upd.pre_update(p_rec);
342 --
343 -- Update the row.
344 --
345 pay_txr_upd.update_dml(p_rec);
346 --
347 -- Call the supporting post-update operation
348 --
349 pay_txr_upd.post_update
350 (p_effective_date
351 ,p_rec
352 );
353 --
354 -- Call to raise any errors on multi-message list
355 hr_multi_message.end_validation_set;
356 End upd;
357 --
358 -- ----------------------------------------------------------------------------
359 -- |---------------------------------< upd >----------------------------------|
360 -- ----------------------------------------------------------------------------
361 Procedure upd
362 (p_effective_date in date
363 ,p_jurisdiction_code in varchar2
364 ,p_tax_type in varchar2 default hr_api.g_varchar2
365 ,p_tax_category in varchar2 default hr_api.g_varchar2
366 ,p_classification_id in number default hr_api.g_number
367 ,p_taxability_rules_date_id in number
368 ,p_legislation_code in varchar2 default hr_api.g_varchar2
369 ,p_status in varchar2 default hr_api.g_varchar2
370 ,p_secondary_classification_id in number default hr_api.g_number
371 ) is
372 --
373 l_rec pay_txr_shd.g_rec_type;
374 l_proc varchar2(72) := g_package||'upd';
375 --
376 Begin
377 hr_utility.set_location('Entering:'||l_proc, 5);
378 --
379 -- Call conversion function to turn arguments into the
380 -- l_rec structure.
381 --
382 l_rec :=
383 pay_txr_shd.convert_args
384 (p_jurisdiction_code
385 ,p_tax_type
386 ,p_tax_category
387 ,p_classification_id
388 ,p_taxability_rules_date_id
389 ,p_legislation_code
390 ,p_status
391 ,p_secondary_classification_id
392 );
393 --
394 -- Having converted the arguments into the
395 -- plsql record structure we call the corresponding record
396 -- business process.
397 --
398 pay_txr_upd.upd
399 (p_effective_date
400 ,l_rec
401 );
402 --
403 --
404 hr_utility.set_location(' Leaving:'||l_proc, 10);
405 End upd;
406 --
407 end pay_txr_upd;
[Home] [Help]