DBA Data[Home] [Help]

PACKAGE BODY: APPS.PQH_RAP_UPD

Source


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