1 Package Body ben_xid_upd as
2 /* $Header: bexidrhi.pkb 115.7 2002/12/16 07:24:29 rpgupta ship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- | Private Global Definitions |
6 -- ----------------------------------------------------------------------------
7 --
8 g_package varchar2(33) := ' ben_xid_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_xid_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_xid_shd.g_api_dml := true; -- Set the api dml status
66 --
67 -- Update the ben_ext_incl_data_elmt Row
68 --
69 update ben_ext_incl_data_elmt
70 set
71 ext_incl_data_elmt_id = p_rec.ext_incl_data_elmt_id,
72 ext_rcd_in_file_id = p_rec.ext_rcd_in_file_id,
73 ext_data_elmt_id = p_rec.ext_data_elmt_id,
74 business_group_id = p_rec.business_group_id,
75 legislation_code = p_rec.legislation_code,
76 last_update_date = p_rec.last_update_date,
77 last_updated_by = p_rec.last_updated_by,
78 last_update_login = p_rec.last_update_login,
79 object_version_number = p_rec.object_version_number,
80 ext_data_elmt_in_rcd_id = p_rec.ext_data_elmt_in_rcd_id
81 where ext_incl_data_elmt_id = p_rec.ext_incl_data_elmt_id;
82 --
83 ben_xid_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_xid_shd.g_api_dml := false; -- Unset the api dml status
91 ben_xid_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_xid_shd.g_api_dml := false; -- Unset the api dml status
96 ben_xid_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_xid_shd.g_api_dml := false; -- Unset the api dml status
101 ben_xid_shd.constraint_error
102 (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
103 When Others Then
104 ben_xid_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_xid_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(p_rec in ben_xid_shd.g_rec_type) is
183 --
184 l_proc varchar2(72) := g_package||'post_update';
185 --
186 Begin
187 hr_utility.set_location('Entering:'||l_proc, 5);
188 --
189 --
190 -- Start of API User Hook for post_update.
191 --
192 begin
193 --
194 ben_xid_rku.after_update
195 (
196 p_ext_incl_data_elmt_id =>p_rec.ext_incl_data_elmt_id
197 ,p_ext_rcd_in_file_id =>p_rec.ext_rcd_in_file_id
198 ,p_ext_data_elmt_id =>p_rec.ext_data_elmt_id
199 ,p_business_group_id =>p_rec.business_group_id
200 ,p_legislation_code =>p_rec.legislation_code
201 ,p_object_version_number =>p_rec.object_version_number
202 ,p_ext_data_elmt_in_rcd_id =>p_rec.ext_data_elmt_in_rcd_id
203 ,p_ext_rcd_in_file_id_o =>ben_xid_shd.g_old_rec.ext_rcd_in_file_id
204 ,p_ext_data_elmt_id_o =>ben_xid_shd.g_old_rec.ext_data_elmt_id
205 ,p_business_group_id_o =>ben_xid_shd.g_old_rec.business_group_id
206 ,p_legislation_code_o =>ben_xid_shd.g_old_rec.legislation_code
207 ,p_object_version_number_o =>ben_xid_shd.g_old_rec.object_version_number
208 ,p_ext_data_elmt_in_rcd_id_o =>ben_xid_shd.g_old_rec.ext_data_elmt_in_rcd_id
209 );
210 --
211 exception
212 --
213 when hr_api.cannot_find_prog_unit then
214 --
215 hr_api.cannot_find_prog_unit_error
216 (p_module_name => 'ben_ext_incl_data_elmt'
217 ,p_hook_type => 'AU');
218 --
219 end;
220 --
221 -- End of API User Hook for post_update.
222 --
223 --
224 hr_utility.set_location(' Leaving:'||l_proc, 10);
225 End post_update;
226 --
227 -- ----------------------------------------------------------------------------
228 -- |-----------------------------< convert_defs >-----------------------------|
229 -- ----------------------------------------------------------------------------
230 -- {Start Of Comments}
231 --
232 -- Description:
233 -- The Convert_Defs procedure has one very important function:
234 -- It must return the record structure for the row with all system defaulted
235 -- values converted into its corresponding parameter value for update. When
236 -- we attempt to update a row through the Upd process , certain
237 -- parameters can be defaulted which enables flexibility in the calling of
238 -- the upd process (e.g. only attributes which need to be updated need to be
239 -- specified). For the upd process to determine which attributes
240 -- have NOT been specified we need to check if the parameter has a reserved
241 -- system default value. Therefore, for all parameters which have a
242 -- corresponding reserved system default mechanism specified we need to
243 -- check if a system default is being used. If a system default is being
244 -- used then we convert the defaulted value into its corresponding attribute
245 -- value held in the g_old_rec data structure.
246 --
247 -- Prerequisites:
248 -- This private function can only be called from the upd process.
249 --
250 -- In Parameters:
251 -- A Pl/Sql record structre.
252 --
253 -- Post Success:
254 -- The record structure will be returned with all system defaulted parameter
255 -- values converted into its current row attribute value.
256 --
257 -- Post Failure:
258 -- No direct error handling is required within this function. Any possible
259 -- errors within this procedure will be a PL/SQL value error due to conversion
260 -- of datatypes or data lengths.
261 --
262 -- Developer Implementation Notes:
263 -- None.
264 --
265 -- Access Status:
266 -- Internal Row Handler Use Only.
267 --
268 -- {End Of Comments}
269 -- ----------------------------------------------------------------------------
270 Procedure convert_defs(p_rec in out nocopy ben_xid_shd.g_rec_type) is
271 --
272 l_proc varchar2(72) := g_package||'convert_defs';
273 --
274 Begin
275 --
276 hr_utility.set_location('Entering:'||l_proc, 5);
277 --
278 -- We must now examine each argument value in the
279 -- p_rec plsql record structure
280 -- to see if a system default is being used. If a system default
281 -- is being used then we must set to the 'current' argument value.
282 --
283 If (p_rec.ext_rcd_in_file_id = hr_api.g_number) then
284 p_rec.ext_rcd_in_file_id :=
285 ben_xid_shd.g_old_rec.ext_rcd_in_file_id;
286 End If;
287 If (p_rec.ext_data_elmt_id = hr_api.g_number) then
288 p_rec.ext_data_elmt_id :=
289 ben_xid_shd.g_old_rec.ext_data_elmt_id;
290 End If;
291 If (p_rec.business_group_id = hr_api.g_number) then
292 p_rec.business_group_id :=
293 ben_xid_shd.g_old_rec.business_group_id;
294 End If;
295 If (p_rec.legislation_code = hr_api.g_varchar2) then
296 p_rec.legislation_code :=
297 ben_xid_shd.g_old_rec.legislation_code;
298 End If;
299 If (p_rec.ext_data_elmt_in_rcd_id = hr_api.g_number) then
300 p_rec.ext_data_elmt_in_rcd_id :=
301 ben_xid_shd.g_old_rec.ext_data_elmt_in_rcd_id;
302 End If;
303 --
304 hr_utility.set_location(' Leaving:'||l_proc, 10);
305 --
306 End convert_defs;
307 --
308 -- ----------------------------------------------------------------------------
309 -- |---------------------------------< upd >----------------------------------|
310 -- ----------------------------------------------------------------------------
311 Procedure upd
312 (
313 p_rec in out nocopy ben_xid_shd.g_rec_type
314 ) is
315 --
316 l_proc varchar2(72) := g_package||'upd';
317 --
318 Begin
319 hr_utility.set_location('Entering:'||l_proc, 5);
320 --
321 -- We must lock the row which we need to update.
322 --
323 ben_xid_shd.lck
324 (
325 p_rec.ext_incl_data_elmt_id,
326 p_rec.object_version_number
327 );
328 --
329 -- 1. During an update system defaults are used to determine if
330 -- arguments have been defaulted or not. We must therefore
331 -- derive the full record structure values to be updated.
332 --
333 -- 2. Call the supporting update validate operations.
334 --
335 convert_defs(p_rec);
336 ben_xid_bus.update_validate(p_rec);
337 --
338 -- Call the supporting pre-update operation
339 --
340 pre_update(p_rec);
341 --
342 -- Update the row.
343 --
344 update_dml(p_rec);
345 --
346 -- Call the supporting post-update operation
347 --
348 post_update(p_rec);
349 End upd;
350 --
351 -- ----------------------------------------------------------------------------
352 -- |---------------------------------< upd >----------------------------------|
353 -- ----------------------------------------------------------------------------
354 Procedure upd
355 (
356 p_ext_incl_data_elmt_id in number,
357 p_ext_rcd_in_file_id in number default hr_api.g_number,
358 p_ext_data_elmt_id in number default hr_api.g_number,
359 p_business_group_id in number default hr_api.g_number,
360 p_legislation_code in varchar2 default hr_api.g_varchar2,
361 p_last_update_date in date default hr_api.g_date,
362 p_creation_date in date default hr_api.g_date,
363 p_last_updated_by in number default hr_api.g_number,
364 p_last_update_login in number default hr_api.g_number,
365 p_created_by in number default hr_api.g_number,
366 p_object_version_number in out nocopy number,
367 p_ext_data_elmt_in_rcd_id in number default hr_api.g_number
368 ) is
369 --
370 l_rec ben_xid_shd.g_rec_type;
371 l_proc varchar2(72) := g_package||'upd';
372 --
373 Begin
374 hr_utility.set_location('Entering:'||l_proc, 5);
375 --
376 -- Call conversion function to turn arguments into the
377 -- l_rec structure.
378 --
379 l_rec :=
380 ben_xid_shd.convert_args
381 (
382 p_ext_incl_data_elmt_id,
383 p_ext_rcd_in_file_id,
384 p_ext_data_elmt_id,
385 p_business_group_id,
386 p_legislation_code,
387 p_last_update_date ,
388 p_creation_date ,
389 p_last_updated_by ,
390 p_last_update_login,
391 p_created_by ,
392 p_object_version_number,
393 p_ext_data_elmt_in_rcd_id
394 );
395 --
396 -- Having converted the arguments into the
397 -- plsql record structure we call the corresponding record
398 -- business process.
399 --
400 upd(l_rec);
401 p_object_version_number := l_rec.object_version_number;
402 --
403 hr_utility.set_location(' Leaving:'||l_proc, 10);
404 End upd;
405 --
406 end ben_xid_upd;
[Home] [Help]