DBA Data[Home] [Help]

PACKAGE BODY: APPS.BEN_BCM_UPD

Source


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