DBA Data[Home] [Help]

PACKAGE BODY: APPS.PAY_PTT_UPD

Source


1 Package Body pay_ptt_upd as
2 /* $Header: pypttrhi.pkb 120.0 2005/05/29 07:56 appldev noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |                     Private Global Definitions                           |
6 -- ----------------------------------------------------------------------------
7 --
8 g_package  varchar2(33) := '  pay_ptt_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_ptt_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_user_tables_tl Row
67   --
68   update pay_user_tables_tl
69     set
70      user_table_id                   = p_rec.user_table_id
71     ,language                        = p_rec.language
72     ,source_lang                     = p_rec.source_lang
73     ,user_table_name                 = p_rec.user_table_name
74     ,user_row_title                  = p_rec.user_row_title
75     where user_table_id = p_rec.user_table_id
76     and language = p_rec.language;
77   --
78   --
79   --
80   hr_utility.set_location(' Leaving:'||l_proc, 10);
81 --
82 Exception
83   When hr_api.check_integrity_violated Then
84     -- A check constraint has been violated
85     --
86     pay_ptt_shd.constraint_error
87       (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
88   When hr_api.parent_integrity_violated Then
89     -- Parent integrity has been violated
90     --
91     pay_ptt_shd.constraint_error
92       (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
93   When hr_api.unique_integrity_violated Then
94     -- Unique integrity has been violated
95     --
96     pay_ptt_shd.constraint_error
97       (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
98   When Others Then
99     --
100     Raise;
101 End update_dml;
102 --
103 -- ----------------------------------------------------------------------------
104 -- |------------------------------< pre_update >------------------------------|
105 -- ----------------------------------------------------------------------------
106 -- {Start Of Comments}
107 --
108 -- Description:
109 --   This private procedure contains any processing which is required before
110 --   the update dml.
111 --
112 -- Prerequisites:
113 --   This is an internal procedure which is called from the upd procedure.
114 --
115 -- In Parameters:
116 --   A Pl/Sql record structure.
117 --
118 -- Post Success:
119 --   Processing continues.
120 --
121 -- Post Failure:
122 --   If an error has occurred, an error message and exception wil be raised
123 --   but not handled.
124 --
125 -- Developer Implementation Notes:
126 --   Any pre-processing required before the update dml is issued should be
127 --   coded within this procedure. It is important to note that any 3rd party
128 --   maintenance should be reviewed before placing in this procedure.
129 --
130 -- Access Status:
131 --   Internal Row Handler Use Only.
132 --
133 -- {End Of Comments}
134 -- ----------------------------------------------------------------------------
135 Procedure pre_update
136   (p_rec in pay_ptt_shd.g_rec_type
137   ) is
138 --
139   l_proc  varchar2(72) := g_package||'pre_update';
140 --
141 Begin
142   hr_utility.set_location('Entering:'||l_proc, 5);
143   --
144   hr_utility.set_location(' Leaving:'||l_proc, 10);
145 End pre_update;
146 --
147 -- ----------------------------------------------------------------------------
148 -- |-----------------------------< post_update >------------------------------|
149 -- ----------------------------------------------------------------------------
150 -- {Start Of Comments}
151 --
152 -- Description:
153 --   This private procedure contains any processing which is required after
154 --   the update dml.
155 --
156 -- Prerequisites:
157 --   This is an internal procedure which is called from the upd procedure.
158 --
159 -- In Parameters:
160 --   A Pl/Sql record structure.
161 --
162 -- Post Success:
163 --   Processing continues.
164 --
165 -- Post Failure:
166 --   If an error has occurred, an error message and exception will be raised
167 --   but not handled.
168 --
169 -- Developer Implementation Notes:
170 --   Any post-processing required after the update dml is issued should be
171 --   coded within this procedure. It is important to note that any 3rd party
172 --   maintenance should be reviewed before placing in this procedure.
173 --
174 -- Access Status:
175 --   Internal Row Handler Use Only.
176 --
177 -- {End Of Comments}
178 -- ----------------------------------------------------------------------------
179 Procedure post_update
180   (p_rec                          in pay_ptt_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_ptt_rku.after_update
190       (p_user_table_id
191       => p_rec.user_table_id
192       ,p_language
193       => p_rec.language
194       ,p_source_lang
195       => p_rec.source_lang
196       ,p_user_table_name
197       => p_rec.user_table_name
198       ,p_user_row_title
199       => p_rec.user_row_title
200       ,p_source_lang_o
201       => pay_ptt_shd.g_old_rec.source_lang
202       ,p_user_table_name_o
203       => pay_ptt_shd.g_old_rec.user_table_name
204       ,p_user_row_title_o
205       => pay_ptt_shd.g_old_rec.user_row_title
206       );
207     --
208   exception
209     --
210     when hr_api.cannot_find_prog_unit then
211       --
212       hr_api.cannot_find_prog_unit_error
213         (p_module_name => 'PAY_USER_TABLES_TL'
214         ,p_hook_type   => 'AU');
215       --
216   end;
217   --
218   hr_utility.set_location(' Leaving:'||l_proc, 10);
219 End post_update;
220 --
221 -- ----------------------------------------------------------------------------
222 -- |-----------------------------< convert_defs >-----------------------------|
223 -- ----------------------------------------------------------------------------
224 -- {Start Of Comments}
225 --
226 -- Description:
227 --   The Convert_Defs procedure has one very important function:
228 --   It must return the record structure for the row with all system defaulted
229 --   values converted into its corresponding parameter value for update. When
230 --   we attempt to update a row through the Upd process , certain
231 --   parameters can be defaulted which enables flexibility in the calling of
232 --   the upd process (e.g. only attributes which need to be updated need to be
233 --   specified). For the upd process to determine which attributes
234 --   have NOT been specified we need to check if the parameter has a reserved
235 --   system default value. Therefore, for all parameters which have a
236 --   corresponding reserved system default mechanism specified we need to
237 --   check if a system default is being used. If a system default is being
238 --   used then we convert the defaulted value into its corresponding attribute
239 --   value held in the g_old_rec data structure.
240 --
241 -- Prerequisites:
242 --   This private function can only be called from the upd process.
243 --
244 -- In Parameters:
245 --   A Pl/Sql record structure.
246 --
247 -- Post Success:
248 --   The record structure will be returned with all system defaulted parameter
249 --   values converted into its current row attribute value.
250 --
251 -- Post Failure:
252 --   No direct error handling is required within this function. Any possible
253 --   errors within this procedure will be a PL/SQL value error due to
254 --   conversion of datatypes or data lengths.
255 --
256 -- Developer Implementation Notes:
257 --   None.
258 --
259 -- Access Status:
260 --   Internal Row Handler Use Only.
261 --
262 -- {End Of Comments}
263 -- ----------------------------------------------------------------------------
264 Procedure convert_defs
265   (p_rec in out nocopy pay_ptt_shd.g_rec_type
266   ) is
267 --
268 Begin
269   --
270   -- We must now examine each argument value in the
271   -- p_rec plsql record structure
272   -- to see if a system default is being used. If a system default
273   -- is being used then we must set to the 'current' argument value.
274   --
275   If (p_rec.source_lang = hr_api.g_varchar2) then
276     p_rec.source_lang :=
277     pay_ptt_shd.g_old_rec.source_lang;
278   End If;
279   If (p_rec.user_table_name = hr_api.g_varchar2) then
280     p_rec.user_table_name :=
281     pay_ptt_shd.g_old_rec.user_table_name;
282   End If;
283   If (p_rec.user_row_title = hr_api.g_varchar2) then
284     p_rec.user_row_title :=
285     pay_ptt_shd.g_old_rec.user_row_title;
286   End If;
287   --
288 End convert_defs;
289 --
290 -- ----------------------------------------------------------------------------
291 -- |---------------------------------< upd >----------------------------------|
292 -- ----------------------------------------------------------------------------
293 Procedure upd
294   (p_rec                          in out nocopy pay_ptt_shd.g_rec_type
295   ) is
296 --
297   l_proc  varchar2(72) := g_package||'upd';
298 --
299 Begin
300   hr_utility.set_location('Entering:'||l_proc, 5);
301   --
302   -- We must lock the row which we need to update.
303   --
304   pay_ptt_shd.lck
305     (p_rec.user_table_id
306     ,p_rec.language
307     );
308   --
309   -- 1. During an update system defaults are used to determine if
310   --    arguments have been defaulted or not. We must therefore
311   --    derive the full record structure values to be updated.
312   --
313   -- 2. Call the supporting update validate operations.
314   --
315   convert_defs(p_rec);
316   pay_ptt_bus.update_validate
317      (p_rec
318      );
319   --
320   -- Call to raise any errors on multi-message list
321   hr_multi_message.end_validation_set;
322   --
323   -- Call the supporting pre-update operation
324   --
325   pay_ptt_upd.pre_update(p_rec);
326   --
327   -- Update the row.
328   --
329   pay_ptt_upd.update_dml(p_rec);
330   --
331   -- Call the supporting post-update operation
332   --
333   --pay_ptt_upd.post_update(p_rec);
334   --
335   -- Call to raise any errors on multi-message list
336   hr_multi_message.end_validation_set;
337 End upd;
338 --
339 -- ----------------------------------------------------------------------------
340 -- |---------------------------------< upd >----------------------------------|
341 -- ----------------------------------------------------------------------------
342 Procedure upd
343   (p_user_table_id                in     number
344   ,p_language                     in     varchar2
345   ,p_source_lang                  in     varchar2  default hr_api.g_varchar2
346   ,p_user_table_name              in     varchar2  default hr_api.g_varchar2
347   ,p_user_row_title               in     varchar2  default hr_api.g_varchar2
348   ) is
349 --
350   l_rec   pay_ptt_shd.g_rec_type;
351   l_proc  varchar2(72) := g_package||'upd';
352 --
353 Begin
354   hr_utility.set_location('Entering:'||l_proc, 5);
355   --
356   -- Call conversion function to turn arguments into the
357   -- l_rec structure.
358   --
359   l_rec :=
360   pay_ptt_shd.convert_args
361   (p_user_table_id
362   ,p_language
363   ,p_source_lang
364   ,p_user_table_name
365   ,p_user_row_title
366   );
367   --
368   -- Having converted the arguments into the
369   -- plsql record structure we call the corresponding record
370   -- business process.
371   --
372   pay_ptt_upd.upd
373      (l_rec
374      );
375   --
376   --
377   hr_utility.set_location(' Leaving:'||l_proc, 10);
378 End upd;
379 --
380 -- ----------------------------------------------------------------------------
381 -- |------------------------------< upd_tl >----------------------------------|
382 -- ----------------------------------------------------------------------------
383 Procedure upd_tl
384   (p_language_code                 in varchar2
385   ,p_user_table_id                in number
386   ,p_user_table_name              in varchar2 default hr_api.g_varchar2
387   ,p_user_row_title               in varchar2 default hr_api.g_varchar2
388   ) is
389   --
390   -- Cursor to obtain the translation rows where the language or
391   -- source_lang match the specified language.
392   --
393   cursor csr_upd_langs is
394     select ptt.language
395       from pay_user_tables_tl ptt
396      where ptt.user_table_id = p_user_table_id
397        and p_language_code in (ptt.language
398                               ,ptt.source_lang);
399   --
400   l_proc  varchar2(72) := g_package||'upd_tl';
401   --
402 Begin
403   hr_utility.set_location('Entering:'||l_proc,10);
404   --
405   -- Update the translated values for every matching row
406   -- setting SOURCE_LANG to the specified language.
407   --
408   for l_lang in csr_upd_langs loop
409     pay_ptt_upd.upd
410       (p_user_table_id               => p_user_table_id
411       ,p_language                    => l_lang.language
412       ,p_source_lang                 => p_language_code
413       ,p_user_table_name             => p_user_table_name
414       ,p_user_row_title              => p_user_row_title
415       );
416   end loop;
417   --
418   hr_utility.set_location(' Leaving:'||l_proc,20);
419 End upd_tl;
420 --
421 end pay_ptt_upd;