DBA Data[Home] [Help]

PACKAGE BODY: APPS.PQH_DEF_UPD

Source


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