DBA Data[Home] [Help]

PACKAGE BODY: APPS.PER_CAI_UPD

Source


1 Package Body per_cai_upd as
2 /* $Header: pecairhi.pkb 115.1 2002/12/04 05:50:07 raranjan noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |                     Private Global Definitions                           |
6 -- ----------------------------------------------------------------------------
7 --
8 g_package  varchar2(33)    := '  per_cai_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 per_cai_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 per_cagr_apis Row
69   --
70   update per_cagr_apis
71     set
72      cagr_api_id                     = p_rec.cagr_api_id
73     ,api_name                        = p_rec.api_name
74     ,category_name                   = p_rec.category_name
75     ,object_version_number           = p_rec.object_version_number
76     where cagr_api_id = p_rec.cagr_api_id;
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     per_cai_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     per_cai_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     per_cai_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 per_cai_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 the
154 --   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_effective_date               in date
181   ,p_rec                          in per_cai_shd.g_rec_type
182   ) is
183 --
184   l_proc  varchar2(72) := g_package||'post_update';
185 --
186 Begin
187   hr_utility.set_location('Entering:'||l_proc, 5);
188   /*
189   begin
190     --
191     per_cai_rku.after_update
192       (p_effective_date              => p_effective_date
193       ,p_cagr_api_id
194       => p_rec.cagr_api_id
195       ,p_api_name
196       => p_rec.api_name
197       ,p_category_name
198       => p_rec.category_name
199       ,p_object_version_number
200       => p_rec.object_version_number
201       ,p_api_name_o
202       => per_cai_shd.g_old_rec.api_name
203       ,p_category_name_o
204       => per_cai_shd.g_old_rec.category_name
205       ,p_object_version_number_o
206       => per_cai_shd.g_old_rec.object_version_number
207       );
208     --
209   exception
210     --
211     when hr_api.cannot_find_prog_unit then
212       --
213       hr_api.cannot_find_prog_unit_error
214         (p_module_name => 'PER_CAGR_APIS'
215         ,p_hook_type   => 'AU');
216       --
217   end;
218   */
219   --
220   hr_utility.set_location(' Leaving:'||l_proc, 10);
221 End post_update;
222 --
223 -- ----------------------------------------------------------------------------
224 -- |-----------------------------< convert_defs >-----------------------------|
225 -- ----------------------------------------------------------------------------
226 -- {Start Of Comments}
227 --
228 -- Description:
229 --   The Convert_Defs procedure has one very important function:
230 --   It must return the record structure for the row with all system defaulted
231 --   values converted into its corresponding parameter value for update. When
232 --   we attempt to update a row through the Upd process , certain
233 --   parameters can be defaulted which enables flexibility in the calling of
234 --   the upd process (e.g. only attributes which need to be updated need to be
235 --   specified). For the upd process to determine which attributes
236 --   have NOT been specified we need to check if the parameter has a reserved
237 --   system default value. Therefore, for all parameters which have a
238 --   corresponding reserved system default mechanism specified we need to
239 --   check if a system default is being used. If a system default is being
240 --   used then we convert the defaulted value into its corresponding attribute
241 --   value held in the g_old_rec data structure.
242 --
243 -- Prerequisites:
244 --   This private function can only be called from the upd process.
245 --
246 -- In Parameters:
247 --   A Pl/Sql record structure.
248 --
249 -- Post Success:
250 --   The record structure will be returned with all system defaulted parameter
251 --   values converted into its current row attribute value.
252 --
253 -- Post Failure:
254 --   No direct error handling is required within this function. Any possible
255 --   errors within this procedure will be a PL/SQL value error due to
256 --   conversion of datatypes or data lengths.
257 --
258 -- Developer Implementation Notes:
259 --   None.
260 --
261 -- Access Status:
262 --   Internal Row Handler Use Only.
263 --
264 -- {End Of Comments}
265 -- ----------------------------------------------------------------------------
266 Procedure convert_defs
267   (p_rec in out nocopy per_cai_shd.g_rec_type
268   ) is
269 --
270 Begin
271   --
272   -- We must now examine each argument value in the
273   -- p_rec plsql record structure
274   -- to see if a system default is being used. If a system default
275   -- is being used then we must set to the 'current' argument value.
276   --
277   If (p_rec.api_name = hr_api.g_varchar2) then
278     p_rec.api_name :=
279     per_cai_shd.g_old_rec.api_name;
280   End If;
281   If (p_rec.category_name = hr_api.g_varchar2) then
282     p_rec.category_name :=
283     per_cai_shd.g_old_rec.category_name;
284   End If;
285   --
286 End convert_defs;
287 --
288 -- ----------------------------------------------------------------------------
289 -- |---------------------------------< upd >----------------------------------|
290 -- ----------------------------------------------------------------------------
291 Procedure upd
292   (p_effective_date               in date
293   ,p_rec                          in out nocopy per_cai_shd.g_rec_type
294   ) is
295 --
296   l_proc  varchar2(72) := g_package||'upd';
297 --
298 Begin
299   hr_utility.set_location('Entering:'||l_proc, 5);
300   --
301   -- We must lock the row which we need to update.
302   --
303   per_cai_shd.lck
304     (p_rec.cagr_api_id
305     ,p_rec.object_version_number
306     );
307   --
308   -- 1. During an update system defaults are used to determine if
309   --    arguments have been defaulted or not. We must therefore
310   --    derive the full record structure values to be updated.
311   --
312   -- 2. Call the supporting update validate operations.
313   --
314   convert_defs(p_rec);
315   per_cai_bus.update_validate
316      (p_effective_date
317      ,p_rec
318      );
319   --
320   -- Call the supporting pre-update operation
321   --
322   per_cai_upd.pre_update(p_rec);
323   --
324   -- Update the row.
325   --
326   per_cai_upd.update_dml(p_rec);
327   --
328   -- Call the supporting post-update operation
329   --
330   per_cai_upd.post_update
331      (p_effective_date
332      ,p_rec
333      );
334 End upd;
335 --
336 -- ----------------------------------------------------------------------------
337 -- |---------------------------------< upd >----------------------------------|
338 -- ----------------------------------------------------------------------------
339 Procedure upd
340   (p_effective_date               in     date
341   ,p_cagr_api_id                  in     number
342   ,p_object_version_number        in out nocopy number
343   ,p_api_name                     in     varchar2  default hr_api.g_varchar2
344   ,p_category_name                in     varchar2  default hr_api.g_varchar2
345   ) is
346 --
347   l_rec      per_cai_shd.g_rec_type;
348   l_proc  varchar2(72) := g_package||'upd';
349 --
350 Begin
351   hr_utility.set_location('Entering:'||l_proc, 5);
352   --
353   -- Call conversion function to turn arguments into the
354   -- l_rec structure.
355   --
356   l_rec :=
357   per_cai_shd.convert_args
358   (p_cagr_api_id
359   ,p_api_name
360   ,p_category_name
361   ,p_object_version_number
362   );
363   --
364   -- Having converted the arguments into the
365   -- plsql record structure we call the corresponding record
366   -- business process.
367   --
368   per_cai_upd.upd
369      (p_effective_date
370      ,l_rec
371      );
372   p_object_version_number := l_rec.object_version_number;
373   --
374   hr_utility.set_location(' Leaving:'||l_proc, 10);
375 End upd;
376 --
377 end per_cai_upd;