1 Package Body pay_dte_upd as
2 /* $Header: pydterhi.pkb 115.6 2002/12/06 16:15:56 jford noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- | Private Global Definitions |
6 -- ----------------------------------------------------------------------------
7 --
8 g_package varchar2(33) := ' pay_dte_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_dte_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_datetracked_events Row
69 --
70 update pay_datetracked_events
71 set
72 datetracked_event_id = p_rec.datetracked_event_id
73 ,event_group_id = p_rec.event_group_id
74 ,dated_table_id = p_rec.dated_table_id
75 ,column_name = p_rec.column_name
76 ,update_type = p_rec.update_type
77 ,business_group_id = p_rec.business_group_id
78 ,legislation_code = p_rec.legislation_code
79 ,object_version_number = p_rec.object_version_number
80 ,proration_style = p_rec.proration_style
81 where datetracked_event_id = p_rec.datetracked_event_id;
82 --
83 --
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 --
91 pay_dte_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 --
96 pay_dte_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 --
101 pay_dte_shd.constraint_error
102 (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
103 When Others Then
104 --
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 structure.
122 --
123 -- Post Success:
124 -- Processing continues.
125 --
126 -- Post Failure:
127 -- If an error has occurred, an error message and exception wil 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
141 (p_rec in pay_dte_shd.g_rec_type
142 ) is
143 --
144 l_proc varchar2(72) := g_package||'pre_update';
145 --
146 Begin
147 hr_utility.set_location('Entering:'||l_proc, 5);
148 --
149 hr_utility.set_location(' Leaving:'||l_proc, 10);
150 End pre_update;
151 --
152 -- ----------------------------------------------------------------------------
153 -- |-----------------------------< post_update >------------------------------|
154 -- ----------------------------------------------------------------------------
155 -- {Start Of Comments}
156 --
157 -- Description:
158 -- This private procedure contains any processing which is required after the
159 -- update dml.
160 --
161 -- Prerequisites:
162 -- This is an internal procedure which is called from the upd procedure.
163 --
164 -- In Parameters:
165 -- A Pl/Sql record structure.
166 --
167 -- Post Success:
168 -- Processing continues.
169 --
170 -- Post Failure:
171 -- If an error has occurred, an error message and exception will be raised
172 -- but not handled.
173 --
174 -- Developer Implementation Notes:
175 -- Any post-processing required after the update dml is issued should be
176 -- coded within this procedure. It is important to note that any 3rd party
177 -- maintenance should be reviewed before placing in this procedure.
178 --
179 -- Access Status:
180 -- Internal Row Handler Use Only.
181 --
182 -- {End Of Comments}
183 -- ----------------------------------------------------------------------------
184 Procedure post_update
185 (p_effective_date in date
186 ,p_rec in pay_dte_shd.g_rec_type
187 ) is
188 --
189 l_proc varchar2(72) := g_package||'post_update';
190 --
191 Begin
192 hr_utility.set_location('Entering:'||l_proc, 5);
193 begin
194 --
195 pay_dte_rku.after_update
196 (p_effective_date => p_effective_date
197 ,p_datetracked_event_id
198 => p_rec.datetracked_event_id
199 ,p_event_group_id
200 => p_rec.event_group_id
201 ,p_dated_table_id
202 => p_rec.dated_table_id
203 ,p_column_name
204 => p_rec.column_name
205 ,p_update_type
206 => p_rec.update_type
207 ,p_business_group_id
208 => p_rec.business_group_id
209 ,p_legislation_code
210 => p_rec.legislation_code
211 ,p_object_version_number
212 => p_rec.object_version_number
213 ,p_proration_style
214 => p_rec.proration_style
215 ,p_event_group_id_o
216 => pay_dte_shd.g_old_rec.event_group_id
217 ,p_dated_table_id_o
218 => pay_dte_shd.g_old_rec.dated_table_id
219 ,p_column_name_o
220 => pay_dte_shd.g_old_rec.column_name
221 ,p_update_type_o
222 => pay_dte_shd.g_old_rec.update_type
223 ,p_business_group_id_o
224 => pay_dte_shd.g_old_rec.business_group_id
225 ,p_legislation_code_o
226 => pay_dte_shd.g_old_rec.legislation_code
227 ,p_object_version_number_o
228 => pay_dte_shd.g_old_rec.object_version_number
229 ,p_proration_style_o
230 => pay_dte_shd.g_old_rec.proration_style
231 );
232 --
233 exception
234 --
235 when hr_api.cannot_find_prog_unit then
236 --
237 hr_api.cannot_find_prog_unit_error
238 (p_module_name => 'PAY_DATETRACKED_EVENTS'
239 ,p_hook_type => 'AU');
240 --
241 end;
242 --
243 hr_utility.set_location(' Leaving:'||l_proc, 10);
244 End post_update;
245 --
246 -- ----------------------------------------------------------------------------
247 -- |-----------------------------< convert_defs >-----------------------------|
248 -- ----------------------------------------------------------------------------
249 -- {Start Of Comments}
250 --
251 -- Description:
252 -- The Convert_Defs procedure has one very important function:
253 -- It must return the record structure for the row with all system defaulted
254 -- values converted into its corresponding parameter value for update. When
255 -- we attempt to update a row through the Upd process , certain
256 -- parameters can be defaulted which enables flexibility in the calling of
257 -- the upd process (e.g. only attributes which need to be updated need to be
258 -- specified). For the upd process to determine which attributes
259 -- have NOT been specified we need to check if the parameter has a reserved
260 -- system default value. Therefore, for all parameters which have a
261 -- corresponding reserved system default mechanism specified we need to
262 -- check if a system default is being used. If a system default is being
263 -- used then we convert the defaulted value into its corresponding attribute
264 -- value held in the g_old_rec data structure.
265 --
266 -- Prerequisites:
267 -- This private function can only be called from the upd process.
268 --
269 -- In Parameters:
270 -- A Pl/Sql record structure.
271 --
272 -- Post Success:
273 -- The record structure will be returned with all system defaulted parameter
274 -- values converted into its current row attribute value.
275 --
276 -- Post Failure:
277 -- No direct error handling is required within this function. Any possible
278 -- errors within this procedure will be a PL/SQL value error due to
279 -- conversion of datatypes or data lengths.
280 --
281 -- Developer Implementation Notes:
282 -- None.
283 --
284 -- Access Status:
285 -- Internal Row Handler Use Only.
286 --
287 -- {End Of Comments}
288 -- ----------------------------------------------------------------------------
289 Procedure convert_defs
290 (p_rec in out nocopy pay_dte_shd.g_rec_type
291 ) is
292 --
293 Begin
294 --
295 -- We must now examine each argument value in the
296 -- p_rec plsql record structure
297 -- to see if a system default is being used. If a system default
298 -- is being used then we must set to the 'current' argument value.
299 --
300 If (p_rec.event_group_id = hr_api.g_number) then
301 p_rec.event_group_id :=
302 pay_dte_shd.g_old_rec.event_group_id;
303 End If;
304 If (p_rec.dated_table_id = hr_api.g_number) then
305 p_rec.dated_table_id :=
306 pay_dte_shd.g_old_rec.dated_table_id;
307 End If;
308 If (p_rec.column_name = hr_api.g_varchar2) then
309 p_rec.column_name :=
310 pay_dte_shd.g_old_rec.column_name;
311 End If;
312 If (p_rec.update_type = hr_api.g_varchar2) then
313 p_rec.update_type :=
314 pay_dte_shd.g_old_rec.update_type;
315 End If;
316 If (p_rec.business_group_id = hr_api.g_number) then
317 p_rec.business_group_id :=
318 pay_dte_shd.g_old_rec.business_group_id;
319 End If;
320 If (p_rec.legislation_code = hr_api.g_varchar2) then
321 p_rec.legislation_code :=
322 pay_dte_shd.g_old_rec.legislation_code;
323 End If;
324 If (p_rec.proration_style = hr_api.g_varchar2) then
325 p_rec.proration_style :=
326 pay_dte_shd.g_old_rec.proration_style;
327 End If;
328 --
329 End convert_defs;
330 --
331 -- ----------------------------------------------------------------------------
332 -- |---------------------------------< upd >----------------------------------|
333 -- ----------------------------------------------------------------------------
334 Procedure upd
335 (p_effective_date in date
336 ,p_rec in out nocopy pay_dte_shd.g_rec_type
337 ) is
338 --
339 l_proc varchar2(72) := g_package||'upd';
340 --
341 Begin
342 hr_utility.set_location('Entering:'||l_proc, 5);
343 --
344 -- We must lock the row which we need to update.
345 --
346 pay_dte_shd.lck
347 (p_rec.datetracked_event_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 pay_dte_bus.update_validate
359 (p_effective_date
360 ,p_rec
361 );
362 --
363 -- Call the supporting pre-update operation
364 --
365 pay_dte_upd.pre_update(p_rec);
366 --
367 -- Update the row.
368 --
369 pay_dte_upd.update_dml(p_rec);
370 --
371 -- Call the supporting post-update operation
372 --
373 pay_dte_upd.post_update
374 (p_effective_date
375 ,p_rec
376 );
377 End upd;
378 --
379 -- ----------------------------------------------------------------------------
380 -- |---------------------------------< upd >----------------------------------|
381 -- ----------------------------------------------------------------------------
382 Procedure upd
383 (p_effective_date in date
384 ,p_datetracked_event_id in number
385 ,p_object_version_number in out nocopy number
386 ,p_event_group_id in number default hr_api.g_number
387 ,p_dated_table_id in number default hr_api.g_number
388 ,p_update_type in varchar2 default hr_api.g_varchar2
389 ,p_column_name in varchar2 default hr_api.g_varchar2
390 ,p_business_group_id in number default hr_api.g_number
391 ,p_legislation_code in varchar2 default hr_api.g_varchar2
392 ,p_proration_style in varchar2 default hr_api.g_varchar2
393 ) is
394 --
395 l_rec pay_dte_shd.g_rec_type;
396 l_proc varchar2(72) := g_package||'upd';
397 --
398 Begin
399 hr_utility.set_location('Entering:'||l_proc, 5);
400 --
401 -- Call conversion function to turn arguments into the
402 -- l_rec structure.
403 --
404 l_rec :=
405 pay_dte_shd.convert_args
406 (p_datetracked_event_id
407 ,p_event_group_id
408 ,p_dated_table_id
409 ,p_column_name
410 ,p_update_type
411 ,p_business_group_id
412 ,p_legislation_code
413 ,p_object_version_number
414 ,p_proration_style
415 );
416 --
417 -- Having converted the arguments into the
418 -- plsql record structure we call the corresponding record
419 -- business process.
420 --
421 pay_dte_upd.upd
422 (p_effective_date
423 ,l_rec
424 );
425 p_object_version_number := l_rec.object_version_number;
426 --
427 hr_utility.set_location(' Leaving:'||l_proc, 10);
428 End upd;
429 --
430 end pay_dte_upd;