DBA Data[Home] [Help]

PACKAGE BODY: APPS.AME_CVL_UPD

Source


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