DBA Data[Home] [Help]

PACKAGE BODY: APPS.HR_HRC_UPD

Source


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