DBA Data[Home] [Help]

PACKAGE BODY: APPS.PQP_ERS_UPD

Source


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