4 -- ----------------------------------------------------------------------------
1 Package Body pay_rft_upd as
2 /* $Header: pyrftrhi.pkb 120.0 2005/05/29 08:21 appldev noship $ */
3 --
5 -- | Private Global Definitions |
6 -- ----------------------------------------------------------------------------
7 --
8 g_package varchar2(33) := ' pay_rft_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_rft_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 --
64 --
65 --
66 -- Update the pay_report_format_mappings_tl Row
67 --
68 update pay_report_format_mappings_tl
69 set
70 report_format_mapping_id = p_rec.report_format_mapping_id
71 ,language = p_rec.language
72 ,source_lang = p_rec.source_lang
73 ,display_name = p_rec.display_name
74 where report_format_mapping_id = p_rec.report_format_mapping_id
75 and language = p_rec.language;
76 --
77 --
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 --
85 pay_rft_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 --
90 pay_rft_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 --
95 pay_rft_shd.constraint_error
96 (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
97 When Others Then
98 --
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_rft_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_rec in pay_rft_shd.g_rec_type
180 ) is
181 --
182 l_proc varchar2(72) := g_package||'post_update';
183 --
184 Begin
185 hr_utility.set_location('Entering:'||l_proc, 5);
186 --
187 hr_utility.set_location(' Leaving:'||l_proc, 10);
188 End post_update;
189 --
190 -- ----------------------------------------------------------------------------
191 -- |-----------------------------< convert_defs >-----------------------------|
192 -- ----------------------------------------------------------------------------
193 -- {Start Of Comments}
194 --
195 -- Description:
196 -- The Convert_Defs procedure has one very important function:
197 -- It must return the record structure for the row with all system defaulted
198 -- values converted into its corresponding parameter value for update. When
199 -- we attempt to update a row through the Upd process , certain
200 -- parameters can be defaulted which enables flexibility in the calling of
201 -- the upd process (e.g. only attributes which need to be updated need to be
202 -- specified). For the upd process to determine which attributes
203 -- have NOT been specified we need to check if the parameter has a reserved
204 -- system default value. Therefore, for all parameters which have a
205 -- corresponding reserved system default mechanism specified we need to
206 -- check if a system default is being used. If a system default is being
210 -- Prerequisites:
207 -- used then we convert the defaulted value into its corresponding attribute
208 -- value held in the g_old_rec data structure.
209 --
211 -- This private function can only be called from the upd process.
212 --
213 -- In Parameters:
214 -- A Pl/Sql record structure.
215 --
216 -- Post Success:
217 -- The record structure will be returned with all system defaulted parameter
218 -- values converted into its current row attribute value.
219 --
220 -- Post Failure:
221 -- No direct error handling is required within this function. Any possible
222 -- errors within this procedure will be a PL/SQL value error due to
223 -- conversion of datatypes or data lengths.
224 --
225 -- Developer Implementation Notes:
226 -- None.
227 --
228 -- Access Status:
229 -- Internal Row Handler Use Only.
230 --
231 -- {End Of Comments}
232 -- ----------------------------------------------------------------------------
233 Procedure convert_defs
234 (p_rec in out nocopy pay_rft_shd.g_rec_type
235 ) is
236 --
237 Begin
238 --
239 -- We must now examine each argument value in the
240 -- p_rec plsql record structure
241 -- to see if a system default is being used. If a system default
242 -- is being used then we must set to the 'current' argument value.
243 --
244 If (p_rec.source_lang = hr_api.g_varchar2) then
245 p_rec.source_lang :=
246 pay_rft_shd.g_old_rec.source_lang;
247 End If;
248 If (p_rec.display_name = hr_api.g_varchar2) then
249 p_rec.display_name :=
250 pay_rft_shd.g_old_rec.display_name;
251 End If;
252 --
253 End convert_defs;
254 --
255 -- ----------------------------------------------------------------------------
256 -- |---------------------------------< upd >----------------------------------|
257 -- ----------------------------------------------------------------------------
258 Procedure upd
259 (p_rec in out nocopy pay_rft_shd.g_rec_type
260 ) is
261 --
262 l_proc varchar2(72) := g_package||'upd';
263 --
264 Begin
265 hr_utility.set_location('Entering:'||l_proc, 5);
266 --
267 -- We must lock the row which we need to update.
268 --
269 pay_rft_shd.lck
270 (p_rec.report_format_mapping_id
271 ,p_rec.language
272 );
273 --
274 -- 1. During an update system defaults are used to determine if
275 -- arguments have been defaulted or not. We must therefore
276 -- derive the full record structure values to be updated.
277 --
278 -- 2. Call the supporting update validate operations.
279 --
280 convert_defs(p_rec);
281 pay_rft_bus.update_validate
282 (p_rec
283 );
284 --
285 -- Call to raise any errors on multi-message list
286 hr_multi_message.end_validation_set;
287 --
288 -- Call the supporting pre-update operation
289 --
290 pay_rft_upd.pre_update(p_rec);
291 --
292 -- Update the row.
293 --
294 pay_rft_upd.update_dml(p_rec);
295 --
296 -- Call the supporting post-update operation
297 --
298 pay_rft_upd.post_update
299 (p_rec
300 );
301 --
302 -- Call to raise any errors on multi-message list
303 hr_multi_message.end_validation_set;
304 End upd;
305 --
306 -- ----------------------------------------------------------------------------
307 -- |---------------------------------< upd >----------------------------------|
308 -- ----------------------------------------------------------------------------
309 Procedure upd
310 (p_report_format_mapping_id in number
311 ,p_language in varchar2
312 ,p_source_lang in varchar2 default hr_api.g_varchar2
313 ,p_display_name in varchar2 default hr_api.g_varchar2
314 ) is
315 --
316 l_rec pay_rft_shd.g_rec_type;
317 l_proc varchar2(72) := g_package||'upd';
318 --
319 Begin
320 hr_utility.set_location('Entering:'||l_proc, 5);
321 --
322 -- Call conversion function to turn arguments into the
323 -- l_rec structure.
324 --
325 l_rec :=
326 pay_rft_shd.convert_args
327 (p_report_format_mapping_id
328 ,p_language
329 ,p_source_lang
330 ,p_display_name
331 );
332 --
333 -- Having converted the arguments into the
334 -- plsql record structure we call the corresponding record
335 -- business process.
336 --
337 pay_rft_upd.upd
338 (l_rec
339 );
340 --
341 --
342 hr_utility.set_location(' Leaving:'||l_proc, 10);
343 End upd;
344 --
345 -- ----------------------------------------------------------------------------
346 -- |------------------------------< upd_tl >----------------------------------|
347 -- ----------------------------------------------------------------------------
348 Procedure upd_tl
349 (p_language_code in varchar2
350 ,p_report_format_mapping_id in number
351 ,p_display_name in varchar2 default hr_api.g_varchar2
352 ) is
353 --
354 -- Cursor to obtain the translation rows where the language or
355 -- source_lang match the specified language.
356 --
357 cursor csr_upd_langs is
358 select rft.language
359 from pay_report_format_mappings_tl rft
360 where rft.report_format_mapping_id = p_report_format_mapping_id
361 and p_language_code in (rft.language
362 ,rft.source_lang);
363 --
364 l_proc varchar2(72) := g_package||'upd_tl';
365 --
366 Begin
367 hr_utility.set_location('Entering:'||l_proc,10);
368 --
369 -- Update the translated values for every matching row
370 -- setting SOURCE_LANG to the specified language.
371 --
372 for l_lang in csr_upd_langs loop
373 pay_rft_upd.upd
374 (p_report_format_mapping_id => p_report_format_mapping_id
375 ,p_language => l_lang.language
376 ,p_source_lang => p_language_code
377 ,p_display_name => p_display_name
378 );
379 end loop;
380 --
381 hr_utility.set_location(' Leaving:'||l_proc,20);
382 End upd_tl;
383 --
384 end pay_rft_upd;