DBA Data[Home] [Help]

PACKAGE BODY: APPS.HR_OTY_UPD

Source


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