DBA Data[Home] [Help]

PACKAGE BODY: APPS.PQH_OPG_UPD

Source


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