DBA Data[Home] [Help]

PACKAGE BODY: APPS.PAY_ETT_UPD

Source


1 Package Body pay_ett_upd as
2 /* $Header: pyettrhi.pkb 120.1 2005/10/04 22:03:25 pgongada noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |                     Private Global Definitions                           |
6 -- ----------------------------------------------------------------------------
7 --
8 g_package  varchar2(33) := '  pay_ett_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_ett_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_element_types_f_tl Row
67   --
68   update pay_element_types_f_tl
69     set
70      element_type_id                 = p_rec.element_type_id
71     ,element_name                    = p_rec.element_name
72     ,reporting_name                  = p_rec.reporting_name
73     ,description                     = p_rec.description
74     ,language                        = p_rec.language
75     ,source_lang                     = p_rec.source_lang
76     where element_type_id = p_rec.element_type_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_ett_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_ett_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_ett_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_ett_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_ett_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_ett_rku.after_update
191       (p_element_type_id
192       => p_rec.element_type_id
193       ,p_element_name
194       => p_rec.element_name
195       ,p_reporting_name
196       => p_rec.reporting_name
197       ,p_description
198       => p_rec.description
199       ,p_language
200       => p_rec.language
201       ,p_source_lang
202       => p_rec.source_lang
203       ,p_element_name_o
204       => pay_ett_shd.g_old_rec.element_name
205       ,p_reporting_name_o
206       => pay_ett_shd.g_old_rec.reporting_name
207       ,p_description_o
208       => pay_ett_shd.g_old_rec.description
209       ,p_source_lang_o
210       => pay_ett_shd.g_old_rec.source_lang
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_ELEMENT_TYPES_F_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_ett_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.element_name = hr_api.g_varchar2) then
281     p_rec.element_name :=
282     pay_ett_shd.g_old_rec.element_name;
283   End If;
284   If (p_rec.reporting_name = hr_api.g_varchar2) then
285     p_rec.reporting_name :=
286     pay_ett_shd.g_old_rec.reporting_name;
287   End If;
288   If (p_rec.description = hr_api.g_varchar2) then
289     p_rec.description :=
290     pay_ett_shd.g_old_rec.description;
291   End If;
292   If (p_rec.source_lang = hr_api.g_varchar2) then
293     p_rec.source_lang :=
294     pay_ett_shd.g_old_rec.source_lang;
295   End If;
296   --
297 End convert_defs;
298 --
299 -- ----------------------------------------------------------------------------
300 -- |---------------------------------< upd >----------------------------------|
301 -- ----------------------------------------------------------------------------
302 Procedure upd
303   (p_rec                          in out nocopy pay_ett_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_ett_shd.lck
314     (p_rec.element_type_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_ett_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_ett_upd.pre_update(p_rec);
335   --
336   -- Update the row.
337   --
338   pay_ett_upd.update_dml(p_rec);
339   --
340   -- Call the supporting post-update operation
341   --
342   pay_ett_upd.post_update
343      (p_rec
344      );
345   --
346   -- Call to raise any errors on multi-message list
347   hr_multi_message.end_validation_set;
348 End upd;
349 --
350 -- ----------------------------------------------------------------------------
351 -- |---------------------------------< upd >----------------------------------|
352 -- ----------------------------------------------------------------------------
353 Procedure upd
354   (p_element_type_id              in     number
355   ,p_element_name                 in     varchar2  default hr_api.g_varchar2
356   ,p_language                     in     varchar2
357   ,p_source_lang                  in     varchar2  default hr_api.g_varchar2
358   ,p_reporting_name               in     varchar2  default hr_api.g_varchar2
359   ,p_description                  in     varchar2  default hr_api.g_varchar2
360   ) is
361 --
362   l_rec   pay_ett_shd.g_rec_type;
363   l_proc  varchar2(72) := g_package||'upd';
364 --
365 Begin
366   hr_utility.set_location('Entering:'||l_proc, 5);
367   --
368   -- Call conversion function to turn arguments into the
369   -- l_rec structure.
370   --
371   l_rec :=
372   pay_ett_shd.convert_args
373   (p_element_type_id
374   ,p_element_name
375   ,p_reporting_name
376   ,p_description
377   ,p_language
378   ,p_source_lang
379   );
380   --
381   -- Having converted the arguments into the
382   -- plsql record structure we call the corresponding record
383   -- business process.
384   --
385   pay_ett_upd.upd
386      (l_rec
387      );
388   --
389   --
390   hr_utility.set_location(' Leaving:'||l_proc, 10);
391 End upd;
392 --
393 -- ----------------------------------------------------------------------------
394 -- |------------------------------< upd_tl >----------------------------------|
395 -- ----------------------------------------------------------------------------
396 Procedure upd_tl
397   (p_language_code                 in varchar2
398   ,p_element_type_id              in number
399   ,p_element_name                 in varchar2 default hr_api.g_varchar2
400   ,p_reporting_name               in varchar2 default hr_api.g_varchar2
401   ,p_description                  in varchar2 default hr_api.g_varchar2
402   ) is
403   --
404   -- Cursor to obtain the translation rows where the language or
405   -- source_lang match the specified language.
406   --
407   cursor csr_upd_langs is
408     select ett.language
409       from pay_element_types_f_tl ett
410      where ett.element_type_id = p_element_type_id
411        and p_language_code in (ett.language
412                               ,ett.source_lang);
413   --
414   l_proc  varchar2(72) := g_package||'upd_tl';
415   --
416 Begin
417   hr_utility.set_location('Entering:'||l_proc,10);
418   --
419   -- Update the translated values for every matching row
420   -- setting SOURCE_LANG to the specified language.
421   --
422   for l_lang in csr_upd_langs loop
423     pay_ett_upd.upd
424       (p_element_type_id             => p_element_type_id
425       ,p_language                    => l_lang.language
426       ,p_source_lang                 => p_language_code
427       ,p_element_name                => p_element_name
428       ,p_reporting_name              => p_reporting_name
429       ,p_description                 => p_description
430       );
431   end loop;
432   --
433   hr_utility.set_location(' Leaving:'||l_proc,20);
434 End upd_tl;
435 --
436 end pay_ett_upd;