DBA Data[Home] [Help]

PACKAGE BODY: APPS.PQH_BPL_UPD

Source


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