1 Package Body ben_bai_upd as
2 /* $Header: bebairhi.pkb 115.7 2002/12/13 06:21:35 hmani ship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- | Private Global Definitions |
6 -- ----------------------------------------------------------------------------
7 --
8 g_package varchar2(33) := ' ben_bai_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(p_rec in out nocopy ben_bai_shd.g_rec_type) is
55 --
56 l_proc varchar2(72) := g_package||'update_dml';
57 --
58 Begin
59 hr_utility.set_location('Entering:'||l_proc, 5);
60 --
61 -- Increment the object version
62 --
63 p_rec.object_version_number := p_rec.object_version_number + 1;
64 --
65 ben_bai_shd.g_api_dml := true; -- Set the api dml status
66 --
67 -- Update the ben_batch_actn_item_info Row
68 --
69 update ben_batch_actn_item_info
70 set
71 batch_actn_item_id = p_rec.batch_actn_item_id,
72 benefit_action_id = p_rec.benefit_action_id,
73 person_id = p_rec.person_id,
74 actn_typ_id = p_rec.actn_typ_id,
75 cmpltd_dt = p_rec.cmpltd_dt,
76 due_dt = p_rec.due_dt,
77 rqd_flag = p_rec.rqd_flag,
78 actn_cd = p_rec.actn_cd,
79 business_group_id = p_rec.business_group_id,
80 object_version_number = p_rec.object_version_number
81 where batch_actn_item_id = p_rec.batch_actn_item_id;
82 --
83 ben_bai_shd.g_api_dml := false; -- Unset the api dml status
84 --
85 hr_utility.set_location(' Leaving:'||l_proc, 10);
86 --
87 Exception
88 When hr_api.check_integrity_violated Then
89 -- A check constraint has been violated
90 ben_bai_shd.g_api_dml := false; -- Unset the api dml status
91 ben_bai_shd.constraint_error
92 (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
93 When hr_api.parent_integrity_violated Then
94 -- Parent integrity has been violated
95 ben_bai_shd.g_api_dml := false; -- Unset the api dml status
96 ben_bai_shd.constraint_error
97 (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
98 When hr_api.unique_integrity_violated Then
99 -- Unique integrity has been violated
100 ben_bai_shd.g_api_dml := false; -- Unset the api dml status
101 ben_bai_shd.constraint_error
102 (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
103 When Others Then
104 ben_bai_shd.g_api_dml := false; -- Unset the api dml status
105 Raise;
106 End update_dml;
107 --
108 -- ----------------------------------------------------------------------------
109 -- |------------------------------< pre_update >------------------------------|
110 -- ----------------------------------------------------------------------------
111 -- {Start Of Comments}
112 --
113 -- Description:
114 -- This private procedure contains any processing which is required before
115 -- the update dml.
116 --
117 -- Prerequisites:
118 -- This is an internal procedure which is called from the upd procedure.
119 --
120 -- In Parameters:
121 -- A Pl/Sql record structre.
122 --
123 -- Post Success:
124 -- Processing continues.
125 --
126 -- Post Failure:
127 -- If an error has occurred, an error message and exception will be raised
128 -- but not handled.
129 --
130 -- Developer Implementation Notes:
131 -- Any pre-processing required before the update dml is issued should be
132 -- coded within this procedure. It is important to note that any 3rd party
133 -- maintenance should be reviewed before placing in this procedure.
134 --
135 -- Access Status:
136 -- Internal Row Handler Use Only.
137 --
138 -- {End Of Comments}
139 -- ----------------------------------------------------------------------------
140 Procedure pre_update(p_rec in ben_bai_shd.g_rec_type) is
141 --
142 l_proc varchar2(72) := g_package||'pre_update';
143 --
144 Begin
145 hr_utility.set_location('Entering:'||l_proc, 5);
146 --
147 hr_utility.set_location(' Leaving:'||l_proc, 10);
148 End pre_update;
149 --
150 -- ----------------------------------------------------------------------------
151 -- |-----------------------------< post_update >------------------------------|
152 -- ----------------------------------------------------------------------------
153 -- {Start Of Comments}
154 --
155 -- Description:
156 -- This private procedure contains any processing which is required after the
157 -- update dml.
158 --
159 -- Prerequisites:
160 -- This is an internal procedure which is called from the upd procedure.
161 --
162 -- In Parameters:
163 -- A Pl/Sql record structre.
164 --
165 -- Post Success:
166 -- Processing continues.
167 --
168 -- Post Failure:
169 -- If an error has occurred, an error message and exception will be raised
170 -- but not handled.
171 --
172 -- Developer Implementation Notes:
173 -- Any post-processing required after the update dml is issued should be
174 -- coded within this procedure. It is important to note that any 3rd party
175 -- maintenance should be reviewed before placing in this procedure.
176 --
177 -- Access Status:
178 -- Internal Row Handler Use Only.
179 --
180 -- {End Of Comments}
181 -- ----------------------------------------------------------------------------
182 Procedure post_update(
183 p_effective_date in date,p_rec in ben_bai_shd.g_rec_type) is
184 --
185 l_proc varchar2(72) := g_package||'post_update';
186 --
187 Begin
188 hr_utility.set_location('Entering:'||l_proc, 5);
189 --
190 --
191 -- Start of API User Hook for post_update.
192 --
193 begin
194 --
195 ben_bai_rku.after_update
196 (
197 p_batch_actn_item_id =>p_rec.batch_actn_item_id
198 ,p_benefit_action_id =>p_rec.benefit_action_id
199 ,p_person_id =>p_rec.person_id
200 ,p_actn_typ_id =>p_rec.actn_typ_id
201 ,p_cmpltd_dt =>p_rec.cmpltd_dt
202 ,p_due_dt =>p_rec.due_dt
203 ,p_rqd_flag =>p_rec.rqd_flag
204 ,p_actn_cd =>p_rec.actn_cd
205 ,p_business_group_id =>p_rec.business_group_id
206 ,p_object_version_number =>p_rec.object_version_number
207 ,p_effective_date =>p_effective_date
208 ,p_benefit_action_id_o =>ben_bai_shd.g_old_rec.benefit_action_id
209 ,p_person_id_o =>ben_bai_shd.g_old_rec.person_id
210 ,p_actn_typ_id_o =>ben_bai_shd.g_old_rec.actn_typ_id
211 ,p_cmpltd_dt_o =>ben_bai_shd.g_old_rec.cmpltd_dt
212 ,p_due_dt_o =>ben_bai_shd.g_old_rec.due_dt
213 ,p_rqd_flag_o =>ben_bai_shd.g_old_rec.rqd_flag
214 ,p_actn_cd_o =>ben_bai_shd.g_old_rec.actn_cd
215 ,p_business_group_id_o =>ben_bai_shd.g_old_rec.business_group_id
216 ,p_object_version_number_o =>ben_bai_shd.g_old_rec.object_version_number
217 );
218 --
219 exception
220 --
221 when hr_api.cannot_find_prog_unit then
222 --
223 hr_api.cannot_find_prog_unit_error
224 (p_module_name => 'ben_batch_actn_item_info'
225 ,p_hook_type => 'AU');
226 --
227 end;
228 --
229 -- End of API User Hook for post_update.
230 --
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 structre.
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 conversion
268 -- 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(p_rec in out nocopy ben_bai_shd.g_rec_type) is
279 --
280 l_proc varchar2(72) := g_package||'convert_defs';
281 --
282 Begin
283 --
284 hr_utility.set_location('Entering:'||l_proc, 5);
285 --
286 -- We must now examine each argument value in the
287 -- p_rec plsql record structure
288 -- to see if a system default is being used. If a system default
289 -- is being used then we must set to the 'current' argument value.
290 --
291 If (p_rec.benefit_action_id = hr_api.g_number) then
292 p_rec.benefit_action_id :=
293 ben_bai_shd.g_old_rec.benefit_action_id;
294 End If;
295 If (p_rec.person_id = hr_api.g_number) then
296 p_rec.person_id :=
297 ben_bai_shd.g_old_rec.person_id;
298 End If;
299 If (p_rec.actn_typ_id = hr_api.g_number) then
300 p_rec.actn_typ_id :=
301 ben_bai_shd.g_old_rec.actn_typ_id;
302 End If;
303 If (p_rec.cmpltd_dt = hr_api.g_date) then
304 p_rec.cmpltd_dt :=
305 ben_bai_shd.g_old_rec.cmpltd_dt;
306 End If;
307 If (p_rec.due_dt = hr_api.g_date) then
308 p_rec.due_dt :=
309 ben_bai_shd.g_old_rec.due_dt;
310 End If;
311 If (p_rec.rqd_flag = hr_api.g_varchar2) then
312 p_rec.rqd_flag :=
313 ben_bai_shd.g_old_rec.rqd_flag;
314 End If;
315 If (p_rec.actn_cd = hr_api.g_varchar2) then
316 p_rec.actn_cd :=
317 ben_bai_shd.g_old_rec.actn_cd;
318 End If;
319 If (p_rec.business_group_id = hr_api.g_number) then
320 p_rec.business_group_id :=
321 ben_bai_shd.g_old_rec.business_group_id;
322 End If;
323
324 --
325 hr_utility.set_location(' Leaving:'||l_proc, 10);
326 --
327 End convert_defs;
328 --
329 -- ----------------------------------------------------------------------------
330 -- |---------------------------------< upd >----------------------------------|
331 -- ----------------------------------------------------------------------------
332 Procedure upd
333 (
334 p_effective_date in date,
335 p_rec in out nocopy ben_bai_shd.g_rec_type
336 ) is
337 --
338 l_proc varchar2(72) := g_package||'upd';
339 --
340 Begin
341 hr_utility.set_location('Entering:'||l_proc, 5);
342 --
343 -- We must lock the row which we need to update.
344 --
345 ben_bai_shd.lck
346 (
347 p_rec.batch_actn_item_id,
348 p_rec.object_version_number
349 );
350 --
351 -- 1. During an update system defaults are used to determine if
352 -- arguments have been defaulted or not. We must therefore
353 -- derive the full record structure values to be updated.
354 --
355 -- 2. Call the supporting update validate operations.
356 --
357 convert_defs(p_rec);
358 ben_bai_bus.update_validate(p_rec
359 ,p_effective_date);
360 --
361 -- Call the supporting pre-update operation
362 --
363 pre_update(p_rec);
364 --
365 -- Update the row.
366 --
367 update_dml(p_rec);
368 --
369 -- Call the supporting post-update operation
370 --
371 post_update(
372 p_effective_date,p_rec);
373 End upd;
374 --
375 -- ----------------------------------------------------------------------------
376 -- |---------------------------------< upd >----------------------------------|
377 -- ----------------------------------------------------------------------------
378 Procedure upd
379 (
380 p_effective_date in date,
381 p_batch_actn_item_id in number,
382 p_benefit_action_id in number default hr_api.g_number,
383 p_person_id in number default hr_api.g_number,
384 p_actn_typ_id in number default hr_api.g_number,
385 p_cmpltd_dt in date default hr_api.g_date,
386 p_due_dt in date default hr_api.g_date,
387 p_rqd_flag in varchar2 default hr_api.g_varchar2,
388 p_actn_cd in varchar2 default hr_api.g_varchar2,
389 p_business_group_id in number default hr_api.g_number,
390 p_object_version_number in out nocopy number
391 ) is
392 --
393 l_rec ben_bai_shd.g_rec_type;
394 l_proc varchar2(72) := g_package||'upd';
395 --
396 Begin
397 hr_utility.set_location('Entering:'||l_proc, 5);
398 --
399 -- Call conversion function to turn arguments into the
400 -- l_rec structure.
401 --
402 l_rec :=
403 ben_bai_shd.convert_args
404 (
405 p_batch_actn_item_id,
406 p_benefit_action_id,
407 p_person_id,
408 p_actn_typ_id,
409 p_cmpltd_dt,
410 p_due_dt,
411 p_rqd_flag,
412 p_actn_cd,
413 p_business_group_id,
414 p_object_version_number
415 );
416 --
417 -- Having converted the arguments into the
418 -- plsql record structure we call the corresponding record
419 -- business process.
420 --
421 upd(
422 p_effective_date,l_rec);
423 p_object_version_number := l_rec.object_version_number;
424 --
425 hr_utility.set_location(' Leaving:'||l_proc, 10);
426 End upd;
427 --
428 end ben_bai_upd;
[Home] [Help]