DBA Data[Home] [Help]

PACKAGE BODY: APPS.PSP_RTD_UPD

Source


1 Package Body psp_rtd_upd as
2 /* $Header: PSPRDRHB.pls 120.0 2005/06/02 15:51 appldev noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |                     Private Global Definitions                           |
6 -- ----------------------------------------------------------------------------
7 --
8 g_package  varchar2(33) := '  psp_rtd_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 psp_rtd_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   psp_rtd_shd.g_api_dml := true;  -- Set the api dml status
67   --
68   -- Update the psp_report_template_details Row
69   --
70   update psp_report_template_details
71     set
72      template_detail_id              = p_rec.template_detail_id
73     ,template_id                     = p_rec.template_id
74     ,object_version_number           = p_rec.object_version_number
75     ,criteria_lookup_type            = p_rec.criteria_lookup_type
76     ,criteria_lookup_code            = p_rec.criteria_lookup_code
77     ,include_exclude_flag            = p_rec.include_exclude_flag
78     ,criteria_value1                 = p_rec.criteria_value1
79     ,criteria_value2                 = p_rec.criteria_value2
80     ,criteria_value3                 = p_rec.criteria_value3
81     where template_detail_id = p_rec.template_detail_id;
82   --
83   psp_rtd_shd.g_api_dml := false;   -- Unset the api dml status
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     psp_rtd_shd.g_api_dml := false;   -- Unset the api dml status
91     psp_rtd_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     psp_rtd_shd.g_api_dml := false;   -- Unset the api dml status
96     psp_rtd_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     psp_rtd_shd.g_api_dml := false;   -- Unset the api dml status
101     psp_rtd_shd.constraint_error
102       (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
103   When Others Then
104     psp_rtd_shd.g_api_dml := false;   -- Unset the api dml status
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 psp_rtd_shd.g_rec_type
142   ) is
143 --
144   l_proc  varchar2(72) := g_package||'pre_update';
145 --
146 Begin
147   hr_utility.set_location('Entering:'||l_proc, 5);
148   --
149   hr_utility.set_location(' Leaving:'||l_proc, 10);
150 End pre_update;
151 --
152 -- ----------------------------------------------------------------------------
153 -- |-----------------------------< post_update >------------------------------|
154 -- ----------------------------------------------------------------------------
155 -- {Start Of Comments}
156 --
157 -- Description:
158 --   This private procedure contains any processing which is required after
159 --   the update dml.
160 --
161 -- Prerequisites:
162 --   This is an internal procedure which is called from the upd procedure.
163 --
164 -- In Parameters:
165 --   A Pl/Sql record structure.
166 --
167 -- Post Success:
168 --   Processing continues.
169 --
170 -- Post Failure:
171 --   If an error has occurred, an error message and exception will be raised
172 --   but not handled.
173 --
174 -- Developer Implementation Notes:
175 --   Any post-processing required after the update dml is issued should be
176 --   coded within this procedure. It is important to note that any 3rd party
177 --   maintenance should be reviewed before placing in this procedure.
178 --
179 -- Access Status:
180 --   Internal Row Handler Use Only.
181 --
182 -- {End Of Comments}
183 -- ----------------------------------------------------------------------------
184 Procedure post_update
185   (p_rec                          in psp_rtd_shd.g_rec_type
186   ) is
187 --
188   l_proc  varchar2(72) := g_package||'post_update';
189 --
190 Begin
191   hr_utility.set_location('Entering:'||l_proc, 5);
192   begin
193     --
194     psp_rtd_rku.after_update
195       (p_template_detail_id
196       => p_rec.template_detail_id
197       ,p_template_id
198       => p_rec.template_id
199       ,p_object_version_number
200       => p_rec.object_version_number
201       ,p_criteria_lookup_type
202       => p_rec.criteria_lookup_type
203       ,p_criteria_lookup_code
204       => p_rec.criteria_lookup_code
205       ,p_include_exclude_flag
206       => p_rec.include_exclude_flag
207       ,p_criteria_value1
208       => p_rec.criteria_value1
209       ,p_criteria_value2
210       => p_rec.criteria_value2
211       ,p_criteria_value3
212       => p_rec.criteria_value3
213       ,p_template_id_o
214       => psp_rtd_shd.g_old_rec.template_id
215       ,p_object_version_number_o
216       => psp_rtd_shd.g_old_rec.object_version_number
217       ,p_criteria_lookup_type_o
218       => psp_rtd_shd.g_old_rec.criteria_lookup_type
219       ,p_criteria_lookup_code_o
220       => psp_rtd_shd.g_old_rec.criteria_lookup_code
221       ,p_include_exclude_flag_o
222       => psp_rtd_shd.g_old_rec.include_exclude_flag
223       ,p_criteria_value1_o
224       => psp_rtd_shd.g_old_rec.criteria_value1
225       ,p_criteria_value2_o
226       => psp_rtd_shd.g_old_rec.criteria_value2
227       ,p_criteria_value3_o
228       => psp_rtd_shd.g_old_rec.criteria_value3
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 => 'PSP_REPORT_TEMPLATE_DETAILS'
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 psp_rtd_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.template_id = hr_api.g_number) then
299     p_rec.template_id :=
300     psp_rtd_shd.g_old_rec.template_id;
301   End If;
302   If (p_rec.criteria_lookup_type = hr_api.g_varchar2) then
303     p_rec.criteria_lookup_type :=
304     psp_rtd_shd.g_old_rec.criteria_lookup_type;
305   End If;
306   If (p_rec.criteria_lookup_code = hr_api.g_varchar2) then
307     p_rec.criteria_lookup_code :=
308     psp_rtd_shd.g_old_rec.criteria_lookup_code;
309   End If;
310   If (p_rec.include_exclude_flag = hr_api.g_varchar2) then
311     p_rec.include_exclude_flag :=
312     psp_rtd_shd.g_old_rec.include_exclude_flag;
313   End If;
314   If (p_rec.criteria_value1 = hr_api.g_varchar2) then
315     p_rec.criteria_value1 :=
316     psp_rtd_shd.g_old_rec.criteria_value1;
317   End If;
318   If (p_rec.criteria_value2 = hr_api.g_varchar2) then
319     p_rec.criteria_value2 :=
320     psp_rtd_shd.g_old_rec.criteria_value2;
321   End If;
322   If (p_rec.criteria_value3 = hr_api.g_varchar2) then
323     p_rec.criteria_value3 :=
324     psp_rtd_shd.g_old_rec.criteria_value3;
325   End If;
326   --
327 End convert_defs;
328 --
329 -- ----------------------------------------------------------------------------
330 -- |---------------------------------< upd >----------------------------------|
331 -- ----------------------------------------------------------------------------
332 Procedure upd
333   (p_rec                          in out nocopy psp_rtd_shd.g_rec_type
334   ) is
335 --
336   l_proc  varchar2(72) := g_package||'upd';
337 --
338 Begin
339   hr_utility.set_location('Entering:'||l_proc, 5);
340   --
341   -- We must lock the row which we need to update.
342   --
343   psp_rtd_shd.lck
344     (p_rec.template_detail_id
345     ,p_rec.object_version_number
346     );
347   --
348   -- 1. During an update system defaults are used to determine if
349   --    arguments have been defaulted or not. We must therefore
350   --    derive the full record structure values to be updated.
351   --
352   -- 2. Call the supporting update validate operations.
353   --
354   convert_defs(p_rec);
355   psp_rtd_bus.update_validate
356      (p_rec
357      );
358   --
359   -- Call to raise any errors on multi-message list
360   hr_multi_message.end_validation_set;
361   --
362   -- Call the supporting pre-update operation
363   --
364   psp_rtd_upd.pre_update(p_rec);
365   --
366   -- Update the row.
367   --
368   psp_rtd_upd.update_dml(p_rec);
369   --
370   -- Call the supporting post-update operation
371   --
372   psp_rtd_upd.post_update
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_template_detail_id           in     number
385   ,p_object_version_number        in out nocopy number
386   ,p_template_id                  in     number    default hr_api.g_number
387   ,p_include_exclude_flag         in     varchar2  default hr_api.g_varchar2
388   ,p_criteria_lookup_type         in     varchar2  default hr_api.g_varchar2
389   ,p_criteria_lookup_code         in     varchar2  default hr_api.g_varchar2
390   ,p_criteria_value1              in     varchar2  default hr_api.g_varchar2
391   ,p_criteria_value2              in     varchar2  default hr_api.g_varchar2
392   ,p_criteria_value3              in     varchar2  default hr_api.g_varchar2
393   ) is
394 --
395   l_rec   psp_rtd_shd.g_rec_type;
396   l_proc  varchar2(72) := g_package||'upd';
397 --
398 Begin
399   hr_utility.set_location('Entering:'||l_proc, 5);
400   --
401   -- Call conversion function to turn arguments into the
402   -- l_rec structure.
403   --
404   l_rec :=
405   psp_rtd_shd.convert_args
406   (p_template_detail_id
407   ,p_template_id
408   ,p_object_version_number
409   ,p_criteria_lookup_type
410   ,p_criteria_lookup_code
411   ,p_include_exclude_flag
412   ,p_criteria_value1
413   ,p_criteria_value2
414   ,p_criteria_value3
415   );
416   --
417   -- Having converted the arguments into the
418   -- plsql record structure we call the corresponding record
419   -- business process.
420   --
421   psp_rtd_upd.upd
422      (l_rec
423      );
424   p_object_version_number := l_rec.object_version_number;
425   --
426   hr_utility.set_location(' Leaving:'||l_proc, 10);
427 End upd;
428 --
429 end psp_rtd_upd;