DBA Data[Home] [Help]

PACKAGE BODY: APPS.PAY_BDT_UPD

Source


1 Package Body pay_bdt_upd as
2 /* $Header: pybdtrhi.pkb 120.3 2005/11/24 05:36 arashid noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |                     Private Global Definitions                           |
6 -- ----------------------------------------------------------------------------
7 --
8 g_package  varchar2(33) := '  pay_bdt_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_bdt_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_balance_dimensions_tl Row
67   --
68   update pay_balance_dimensions_tl
69     set
70      balance_dimension_id            = p_rec.balance_dimension_id
71     ,language                        = p_rec.language
72     ,source_lang                     = p_rec.source_lang
73     ,dimension_name                  = p_rec.dimension_name
74     ,database_item_suffix            = p_rec.database_item_suffix
75     ,description                     = p_rec.description
76     where balance_dimension_id = p_rec.balance_dimension_id
77     and language = p_rec.language;
78   --
79   --
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     --
87     pay_bdt_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     --
92     pay_bdt_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     --
97     pay_bdt_shd.constraint_error
98       (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
99   When Others Then
100     --
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 structure.
118 --
119 -- Post Success:
120 --   Processing continues.
121 --
122 -- Post Failure:
123 --   If an error has occurred, an error message and exception wil 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
137   (p_rec in pay_bdt_shd.g_rec_type
138   ) is
139 --
140   l_proc  varchar2(72) := g_package||'pre_update';
141 --
142 Begin
143   hr_utility.set_location('Entering:'||l_proc, 5);
144   --
145   hr_utility.set_location(' Leaving:'||l_proc, 10);
146 End pre_update;
147 --
148 -- ----------------------------------------------------------------------------
149 -- |-----------------------------< post_update >------------------------------|
150 -- ----------------------------------------------------------------------------
151 -- {Start Of Comments}
152 --
153 -- Description:
154 --   This private procedure contains any processing which is required after
155 --   the update dml.
156 --
157 -- Prerequisites:
158 --   This is an internal procedure which is called from the upd procedure.
159 --
160 -- In Parameters:
161 --   A Pl/Sql record structure.
162 --
163 -- Post Success:
164 --   Processing continues.
165 --
166 -- Post Failure:
167 --   If an error has occurred, an error message and exception will be raised
168 --   but not handled.
169 --
170 -- Developer Implementation Notes:
171 --   Any post-processing required after the update dml is issued should be
172 --   coded within this procedure. It is important to note that any 3rd party
173 --   maintenance should be reviewed before placing in this procedure.
174 --
175 -- Access Status:
176 --   Internal Row Handler Use Only.
177 --
178 -- {End Of Comments}
179 -- ----------------------------------------------------------------------------
180 Procedure post_update
181   (p_rec                          in pay_bdt_shd.g_rec_type
182   ) is
183 --
184   l_proc  varchar2(72) := g_package||'post_update';
185 --
186 Begin
187   hr_utility.set_location('Entering:'||l_proc, 5);
188   begin
189     --
190     pay_bdt_rku.after_update
191       (p_balance_dimension_id
192       => p_rec.balance_dimension_id
193       ,p_language
194       => p_rec.language
195       ,p_source_lang
196       => p_rec.source_lang
197       ,p_dimension_name
198       => p_rec.dimension_name
199       ,p_database_item_suffix
200       => p_rec.database_item_suffix
201       ,p_description
202       => p_rec.description
203       ,p_source_lang_o
204       => pay_bdt_shd.g_old_rec.source_lang
205       ,p_dimension_name_o
206       => pay_bdt_shd.g_old_rec.dimension_name
207       ,p_database_item_suffix_o
208       => pay_bdt_shd.g_old_rec.database_item_suffix
209       ,p_description_o
210       => pay_bdt_shd.g_old_rec.description
211       );
212     --
213   exception
214     --
215     when hr_api.cannot_find_prog_unit then
216       --
217       hr_api.cannot_find_prog_unit_error
218         (p_module_name => 'PAY_BALANCE_DIMENSIONS_TL'
219         ,p_hook_type   => 'AU');
220       --
221   end;
222   --
223   hr_utility.set_location(' Leaving:'||l_proc, 10);
224 End post_update;
225 --
226 -- ----------------------------------------------------------------------------
227 -- |-----------------------------< convert_defs >-----------------------------|
228 -- ----------------------------------------------------------------------------
229 -- {Start Of Comments}
230 --
231 -- Description:
232 --   The Convert_Defs procedure has one very important function:
233 --   It must return the record structure for the row with all system defaulted
234 --   values converted into its corresponding parameter value for update. When
235 --   we attempt to update a row through the Upd process , certain
236 --   parameters can be defaulted which enables flexibility in the calling of
237 --   the upd process (e.g. only attributes which need to be updated need to be
238 --   specified). For the upd process to determine which attributes
239 --   have NOT been specified we need to check if the parameter has a reserved
240 --   system default value. Therefore, for all parameters which have a
241 --   corresponding reserved system default mechanism specified we need to
242 --   check if a system default is being used. If a system default is being
243 --   used then we convert the defaulted value into its corresponding attribute
244 --   value held in the g_old_rec data structure.
245 --
246 -- Prerequisites:
247 --   This private function can only be called from the upd process.
248 --
249 -- In Parameters:
250 --   A Pl/Sql record structure.
251 --
252 -- Post Success:
253 --   The record structure will be returned with all system defaulted parameter
254 --   values converted into its current row attribute value.
255 --
256 -- Post Failure:
257 --   No direct error handling is required within this function. Any possible
258 --   errors within this procedure will be a PL/SQL value error due to
259 --   conversion of datatypes or data lengths.
260 --
261 -- Developer Implementation Notes:
262 --   None.
263 --
264 -- Access Status:
265 --   Internal Row Handler Use Only.
266 --
267 -- {End Of Comments}
268 -- ----------------------------------------------------------------------------
269 Procedure convert_defs
270   (p_rec in out nocopy pay_bdt_shd.g_rec_type
271   ) is
272 --
273 Begin
274   --
275   -- We must now examine each argument value in the
276   -- p_rec plsql record structure
277   -- to see if a system default is being used. If a system default
278   -- is being used then we must set to the 'current' argument value.
279   --
280   If (p_rec.source_lang = hr_api.g_varchar2) then
281     p_rec.source_lang :=
282     pay_bdt_shd.g_old_rec.source_lang;
283   End If;
284   If (p_rec.dimension_name = hr_api.g_varchar2) then
285     p_rec.dimension_name :=
286     pay_bdt_shd.g_old_rec.dimension_name;
287   End If;
288   If (p_rec.database_item_suffix = hr_api.g_varchar2) then
289     p_rec.database_item_suffix :=
290     pay_bdt_shd.g_old_rec.database_item_suffix;
291   End If;
292   If (p_rec.description = hr_api.g_varchar2) then
293     p_rec.description :=
294     pay_bdt_shd.g_old_rec.description;
295   End If;
296   --
297 End convert_defs;
298 --
299 -- ----------------------------------------------------------------------------
300 -- |---------------------------------< upd >----------------------------------|
301 -- ----------------------------------------------------------------------------
302 Procedure upd
303   (p_rec                          in out nocopy pay_bdt_shd.g_rec_type
304   ) is
305 --
306   l_proc  varchar2(72) := g_package||'upd';
307 --
308 Begin
309   hr_utility.set_location('Entering:'||l_proc, 5);
310   --
311   -- We must lock the row which we need to update.
312   --
313   pay_bdt_shd.lck
314     (p_rec.balance_dimension_id
315     ,p_rec.language
316     );
317   --
318   -- 1. During an update system defaults are used to determine if
319   --    arguments have been defaulted or not. We must therefore
320   --    derive the full record structure values to be updated.
321   --
322   -- 2. Call the supporting update validate operations.
323   --
324   convert_defs(p_rec);
325   pay_bdt_bus.update_validate
326      (p_rec
327      );
328   --
329   -- Call to raise any errors on multi-message list
330   hr_multi_message.end_validation_set;
331   --
332   -- Call the supporting pre-update operation
333   --
334   pay_bdt_upd.pre_update(p_rec);
335   --
336   -- Update the row.
337   --
338   pay_bdt_upd.update_dml(p_rec);
339   --
340   -- Call the supporting post-update operation
341   --
342   --pay_bdt_upd.post_update(p_rec);
343   --
344   -- Call to raise any errors on multi-message list
345   hr_multi_message.end_validation_set;
346 End upd;
347 --
348 -- ----------------------------------------------------------------------------
349 -- |---------------------------------< upd >----------------------------------|
350 -- ----------------------------------------------------------------------------
351 Procedure upd
352   (p_balance_dimension_id         in     number
353   ,p_language                     in     varchar2
354   ,p_source_lang                  in     varchar2  default hr_api.g_varchar2
355   ,p_dimension_name               in     varchar2  default hr_api.g_varchar2
356   ,p_database_item_suffix         in     varchar2  default hr_api.g_varchar2
357   ,p_description                  in     varchar2  default hr_api.g_varchar2
358   ) is
359 --
360   l_rec   pay_bdt_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_bdt_shd.convert_args
371   (p_balance_dimension_id
372   ,p_language
373   ,p_source_lang
374   ,p_dimension_name
375   ,p_database_item_suffix
376   ,p_description
377   );
378   --
379   -- Having converted the arguments into the
380   -- plsql record structure we call the corresponding record
381   -- business process.
382   --
383   pay_bdt_upd.upd
384      (l_rec
385      );
386   --
387   --
388   hr_utility.set_location(' Leaving:'||l_proc, 10);
389 End upd;
390 --
391 -- ----------------------------------------------------------------------------
392 -- |------------------------------< upd_tl >----------------------------------|
393 -- ----------------------------------------------------------------------------
394 Procedure upd_tl
395   (p_language_code                 in varchar2
396   ,p_balance_dimension_id         in number
397   ,p_dimension_name               in varchar2 default hr_api.g_varchar2
398   ,p_database_item_suffix         in varchar2 default hr_api.g_varchar2
399   ,p_description                  in varchar2 default hr_api.g_varchar2
400   ,p_record_dbi_changes           in boolean default false
401   ) is
402   --
403   -- Cursor to obtain the translation rows where the language or
404   -- source_lang match the specified language.
405   --
406   cursor csr_upd_langs is
407     select bdt.language
408     ,      bdt.database_item_suffix
409       from pay_balance_dimensions_tl bdt
410      where bdt.balance_dimension_id = p_balance_dimension_id
411        and p_language_code in (bdt.language
412                               ,bdt.source_lang);
413   --
414   l_proc  varchar2(72) := g_package||'upd_tl';
415   l_leg_code varchar2(100);
416   l_langs    dbms_sql.varchar2s;
417   i          binary_integer := 1;
418   --
419 Begin
420   hr_utility.set_location('Entering:'||l_proc,10);
421   if p_record_dbi_changes then
422     l_leg_code := pay_bdt_bus.return_legislation_code
423                   (p_balance_dimension_id => p_balance_dimension_id
424                   ,p_language             => p_language_code
425                   );
426   end if;
427   --
428   -- Update the translated values for every matching row
429   -- setting SOURCE_LANG to the specified language.
430   --
431   for l_lang in csr_upd_langs loop
432     pay_bdt_upd.upd
433       (p_balance_dimension_id        => p_balance_dimension_id
434       ,p_language                    => l_lang.language
435       ,p_source_lang                 => p_language_code
436       ,p_dimension_name              => p_dimension_name
437       ,p_database_item_suffix        => p_database_item_suffix
438       ,p_description                 => p_description
439       );
440     --
441     -- Record the affected rows in PAY_DYNDBI_CHANGES. This is only
442     -- done if translations are supported and if the translation is
443     -- actually different.
444     --
445     if p_record_dbi_changes and
446        ff_dbi_utils_pkg.translations_supported
447        (p_legislation_code => l_leg_code
448        ) then
449       if upper(p_database_item_suffix) <>
450          upper(l_lang.database_item_suffix) then
451         l_langs(i) := l_lang.language;
452         i := i + 1;
453       end if;
454     end if;
455   end loop;
456   --
457   hr_utility.set_location(' Leaving:'||l_proc,20);
458   --
459   -- Write any changes to PAY_DYNDBI_CHANGES.
460   --
461   if p_record_dbi_changes and l_langs.count > 0 then
462     pay_dyndbi_changes_pkg.balance_dimension_change
463     (p_balance_dimension_id => p_balance_dimension_id
464     ,p_languages            => l_langs
465     );
466   end if;
467   --
468   hr_utility.set_location(' Leaving:'||l_proc,30);
469 End upd_tl;
470 --
471 end pay_bdt_upd;