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