DBA Data[Home] [Help]

PACKAGE BODY: APPS.PER_PGT_UPD

Source


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