DBA Data[Home] [Help]

PACKAGE BODY: APPS.PAY_GBE_UPD

Source


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