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