1 Package Body pay_esu_upd as
2 /* $Header: pyesurhi.pkb 115.1 2003/08/15 02:39:10 thabara noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- | Private Global Definitions |
6 -- ----------------------------------------------------------------------------
7 --
8 g_package varchar2(33) := ' pay_esu_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_esu_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 -- Increment the object version
64 p_rec.object_version_number := p_rec.object_version_number + 1;
65 --
66 --
67 --
68 -- Update the pay_element_span_usages Row
69 --
70 update pay_element_span_usages
71 set
72 element_span_usage_id = p_rec.element_span_usage_id
73 ,time_span_id = p_rec.time_span_id
74 ,retro_component_usage_id = p_rec.retro_component_usage_id
75 ,adjustment_type = p_rec.adjustment_type
76 ,retro_element_type_id = p_rec.retro_element_type_id
77 ,object_version_number = p_rec.object_version_number
78 where element_span_usage_id = p_rec.element_span_usage_id;
79 --
80 --
81 --
82 hr_utility.set_location(' Leaving:'||l_proc, 10);
83 --
84 Exception
85 When hr_api.check_integrity_violated Then
86 -- A check constraint has been violated
87 --
88 pay_esu_shd.constraint_error
89 (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
90 When hr_api.parent_integrity_violated Then
91 -- Parent integrity has been violated
92 --
93 pay_esu_shd.constraint_error
94 (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
95 When hr_api.unique_integrity_violated Then
96 -- Unique integrity has been violated
97 --
98 pay_esu_shd.constraint_error
99 (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
100 When Others Then
101 --
102 Raise;
103 End update_dml;
104 --
105 -- ----------------------------------------------------------------------------
106 -- |------------------------------< pre_update >------------------------------|
107 -- ----------------------------------------------------------------------------
108 -- {Start Of Comments}
109 --
110 -- Description:
111 -- This private procedure contains any processing which is required before
112 -- the update dml.
113 --
114 -- Prerequisites:
115 -- This is an internal procedure which is called from the upd procedure.
116 --
117 -- In Parameters:
118 -- A Pl/Sql record structure.
119 --
120 -- Post Success:
121 -- Processing continues.
122 --
123 -- Post Failure:
124 -- If an error has occurred, an error message and exception wil be raised
125 -- but not handled.
126 --
127 -- Developer Implementation Notes:
128 -- Any pre-processing required before the update dml is issued should be
129 -- coded within this procedure. It is important to note that any 3rd party
130 -- maintenance should be reviewed before placing in this procedure.
131 --
132 -- Access Status:
133 -- Internal Row Handler Use Only.
134 --
135 -- {End Of Comments}
136 -- ----------------------------------------------------------------------------
137 Procedure pre_update
138 (p_rec in pay_esu_shd.g_rec_type
139 ) is
140 --
141 l_proc varchar2(72) := g_package||'pre_update';
142 --
143 Begin
144 hr_utility.set_location('Entering:'||l_proc, 5);
145 --
146 hr_utility.set_location(' Leaving:'||l_proc, 10);
147 End pre_update;
148 --
149 -- ----------------------------------------------------------------------------
150 -- |-----------------------------< post_update >------------------------------|
151 -- ----------------------------------------------------------------------------
152 -- {Start Of Comments}
153 --
154 -- Description:
155 -- This private procedure contains any processing which is required after
156 -- the update dml.
157 --
158 -- Prerequisites:
159 -- This is an internal procedure which is called from the upd procedure.
160 --
161 -- In Parameters:
162 -- A Pl/Sql record structure.
163 --
164 -- Post Success:
165 -- Processing continues.
166 --
167 -- Post Failure:
168 -- If an error has occurred, an error message and exception will be raised
169 -- but not handled.
170 --
171 -- Developer Implementation Notes:
172 -- Any post-processing required after the update dml is issued should be
173 -- coded within this procedure. It is important to note that any 3rd party
174 -- maintenance should be reviewed before placing in this procedure.
175 --
176 -- Access Status:
177 -- Internal Row Handler Use Only.
178 --
179 -- {End Of Comments}
180 -- ----------------------------------------------------------------------------
181 Procedure post_update
182 (p_effective_date in date
183 ,p_rec in pay_esu_shd.g_rec_type
184 ) is
185 --
186 l_proc varchar2(72) := g_package||'post_update';
187 --
188 Begin
189 hr_utility.set_location('Entering:'||l_proc, 5);
190 begin
191 --
192 pay_esu_rku.after_update
193 (p_effective_date => p_effective_date
194 ,p_element_span_usage_id
195 => p_rec.element_span_usage_id
196 ,p_business_group_id
197 => p_rec.business_group_id
198 ,p_legislation_code
199 => p_rec.legislation_code
200 ,p_time_span_id
201 => p_rec.time_span_id
202 ,p_retro_component_usage_id
203 => p_rec.retro_component_usage_id
204 ,p_adjustment_type
205 => p_rec.adjustment_type
206 ,p_retro_element_type_id
207 => p_rec.retro_element_type_id
208 ,p_object_version_number
209 => p_rec.object_version_number
210 ,p_business_group_id_o
211 => pay_esu_shd.g_old_rec.business_group_id
212 ,p_legislation_code_o
213 => pay_esu_shd.g_old_rec.legislation_code
214 ,p_time_span_id_o
215 => pay_esu_shd.g_old_rec.time_span_id
216 ,p_retro_component_usage_id_o
217 => pay_esu_shd.g_old_rec.retro_component_usage_id
218 ,p_adjustment_type_o
219 => pay_esu_shd.g_old_rec.adjustment_type
220 ,p_retro_element_type_id_o
221 => pay_esu_shd.g_old_rec.retro_element_type_id
222 ,p_object_version_number_o
223 => pay_esu_shd.g_old_rec.object_version_number
224 );
225 --
226 exception
227 --
228 when hr_api.cannot_find_prog_unit then
229 --
230 hr_api.cannot_find_prog_unit_error
231 (p_module_name => 'PAY_ELEMENT_SPAN_USAGES'
232 ,p_hook_type => 'AU');
233 --
234 end;
235 --
236 hr_utility.set_location(' Leaving:'||l_proc, 10);
237 End post_update;
238 --
239 -- ----------------------------------------------------------------------------
240 -- |-----------------------------< convert_defs >-----------------------------|
241 -- ----------------------------------------------------------------------------
242 -- {Start Of Comments}
243 --
244 -- Description:
245 -- The Convert_Defs procedure has one very important function:
246 -- It must return the record structure for the row with all system defaulted
247 -- values converted into its corresponding parameter value for update. When
248 -- we attempt to update a row through the Upd process , certain
249 -- parameters can be defaulted which enables flexibility in the calling of
250 -- the upd process (e.g. only attributes which need to be updated need to be
251 -- specified). For the upd process to determine which attributes
252 -- have NOT been specified we need to check if the parameter has a reserved
253 -- system default value. Therefore, for all parameters which have a
254 -- corresponding reserved system default mechanism specified we need to
255 -- check if a system default is being used. If a system default is being
256 -- used then we convert the defaulted value into its corresponding attribute
257 -- value held in the g_old_rec data structure.
258 --
259 -- Prerequisites:
260 -- This private function can only be called from the upd process.
261 --
262 -- In Parameters:
263 -- A Pl/Sql record structure.
264 --
265 -- Post Success:
266 -- The record structure will be returned with all system defaulted parameter
267 -- values converted into its current row attribute value.
268 --
269 -- Post Failure:
270 -- No direct error handling is required within this function. Any possible
271 -- errors within this procedure will be a PL/SQL value error due to
272 -- conversion of datatypes or data lengths.
273 --
274 -- Developer Implementation Notes:
275 -- None.
276 --
277 -- Access Status:
278 -- Internal Row Handler Use Only.
279 --
280 -- {End Of Comments}
281 -- ----------------------------------------------------------------------------
282 Procedure convert_defs
283 (p_rec in out nocopy pay_esu_shd.g_rec_type
284 ) is
285 --
286 Begin
287 --
288 -- We must now examine each argument value in the
289 -- p_rec plsql record structure
290 -- to see if a system default is being used. If a system default
291 -- is being used then we must set to the 'current' argument value.
292 --
293 If (p_rec.business_group_id = hr_api.g_number) then
294 p_rec.business_group_id :=
295 pay_esu_shd.g_old_rec.business_group_id;
296 End If;
297 If (p_rec.legislation_code = hr_api.g_varchar2) then
298 p_rec.legislation_code :=
299 pay_esu_shd.g_old_rec.legislation_code;
300 End If;
301 If (p_rec.time_span_id = hr_api.g_number) then
302 p_rec.time_span_id :=
303 pay_esu_shd.g_old_rec.time_span_id;
304 End If;
305 If (p_rec.retro_component_usage_id = hr_api.g_number) then
306 p_rec.retro_component_usage_id :=
307 pay_esu_shd.g_old_rec.retro_component_usage_id;
308 End If;
309 If (p_rec.adjustment_type = hr_api.g_varchar2) then
310 p_rec.adjustment_type :=
311 pay_esu_shd.g_old_rec.adjustment_type;
312 End If;
313 If (p_rec.retro_element_type_id = hr_api.g_number) then
314 p_rec.retro_element_type_id :=
315 pay_esu_shd.g_old_rec.retro_element_type_id;
316 End If;
317 --
318 End convert_defs;
319 --
320 -- ----------------------------------------------------------------------------
321 -- |---------------------------------< upd >----------------------------------|
322 -- ----------------------------------------------------------------------------
323 Procedure upd
324 (p_effective_date in date
325 ,p_rec in out nocopy pay_esu_shd.g_rec_type
326 ) is
327 --
328 l_proc varchar2(72) := g_package||'upd';
329 --
330 Begin
331 hr_utility.set_location('Entering:'||l_proc, 5);
332 --
333 -- We must lock the row which we need to update.
334 --
335 pay_esu_shd.lck
336 (p_rec.element_span_usage_id
337 ,p_rec.object_version_number
338 );
339 --
340 -- 1. During an update system defaults are used to determine if
341 -- arguments have been defaulted or not. We must therefore
342 -- derive the full record structure values to be updated.
343 --
344 -- 2. Call the supporting update validate operations.
345 --
346 convert_defs(p_rec);
347 pay_esu_bus.update_validate
348 (p_effective_date
349 ,p_rec
350 );
351 --
352 -- Call to raise any errors on multi-message list
353 hr_multi_message.end_validation_set;
354 --
355 -- Call the supporting pre-update operation
356 --
357 pay_esu_upd.pre_update(p_rec);
358 --
359 -- Update the row.
360 --
361 pay_esu_upd.update_dml(p_rec);
362 --
363 -- Call the supporting post-update operation
364 --
365 pay_esu_upd.post_update
366 (p_effective_date
367 ,p_rec
368 );
369 --
370 -- Call to raise any errors on multi-message list
371 hr_multi_message.end_validation_set;
372 End upd;
373 --
374 -- ----------------------------------------------------------------------------
375 -- |---------------------------------< upd >----------------------------------|
376 -- ----------------------------------------------------------------------------
377 Procedure upd
378 (p_effective_date in date
379 ,p_element_span_usage_id in number
380 ,p_object_version_number in out nocopy number
381 ,p_time_span_id in number default hr_api.g_number
382 ,p_retro_component_usage_id in number default hr_api.g_number
383 ,p_retro_element_type_id in number default hr_api.g_number
384 ,p_adjustment_type in varchar2 default hr_api.g_varchar2
385 ) is
386 --
387 l_rec pay_esu_shd.g_rec_type;
388 l_proc varchar2(72) := g_package||'upd';
389 --
390 Begin
391 hr_utility.set_location('Entering:'||l_proc, 5);
392 --
393 -- Call conversion function to turn arguments into the
394 -- l_rec structure.
395 --
396 l_rec :=
397 pay_esu_shd.convert_args
398 (p_element_span_usage_id
399 ,hr_api.g_number
400 ,hr_api.g_varchar2
401 ,p_time_span_id
402 ,p_retro_component_usage_id
403 ,p_adjustment_type
404 ,p_retro_element_type_id
405 ,p_object_version_number
406 );
407 --
408 -- Having converted the arguments into the
409 -- plsql record structure we call the corresponding record
410 -- business process.
411 --
412 pay_esu_upd.upd
413 (p_effective_date
414 ,l_rec
415 );
416 p_object_version_number := l_rec.object_version_number;
417 --
418 hr_utility.set_location(' Leaving:'||l_proc, 10);
419 End upd;
420 --
421 end pay_esu_upd;
[Home] [Help]