DBA Data[Home] [Help]

PACKAGE BODY: APPS.HR_PAB_UPD

Source


1 Package Body hr_pab_upd as
2 /* $Header: hrpabrhi.pkb 115.1 99/07/17 05:36:11 porting ship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |                     Private Global Definitions                           |
6 -- ----------------------------------------------------------------------------
7 --
8 g_package  varchar2(33)	:= '  hr_pab_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 -- Pre Conditions:
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 Table Handler Use Only.
51 --
52 -- {End Of Comments}
53 -- ----------------------------------------------------------------------------
54 Procedure update_dml(p_rec in out hr_pab_shd.g_rec_type) is
55 --
56   l_proc  varchar2(72) := g_package||'update_dml';
57 --
58 Begin
59   hr_utility.set_location('Entering:'||l_proc, 5);
60   --
61   -- Increment the object version
62   --
63   p_rec.object_version_number := p_rec.object_version_number + 1;
64   --
65   hr_pab_shd.g_api_dml := true;  -- Set the api dml status
66   --
67   -- Update the hr_pattern_bits Row
68   --
69   update hr_pattern_bits
70   set
71   pattern_bit_id                    = p_rec.pattern_bit_id,
72   pattern_bit_code                  = p_rec.pattern_bit_code,
73   bit_meaning                       = p_rec.bit_meaning,
74   time_unit_multiplier              = p_rec.time_unit_multiplier,
75   base_time_unit                    = p_rec.base_time_unit,
76   object_version_number             = p_rec.object_version_number
77   where pattern_bit_id = p_rec.pattern_bit_id;
78   --
79   hr_pab_shd.g_api_dml := false;   -- Unset the api dml status
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     hr_pab_shd.g_api_dml := false;   -- Unset the api dml status
87     hr_pab_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     hr_pab_shd.g_api_dml := false;   -- Unset the api dml status
92     hr_pab_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     hr_pab_shd.g_api_dml := false;   -- Unset the api dml status
97     hr_pab_shd.constraint_error
98       (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
99   When Others Then
100     hr_pab_shd.g_api_dml := false;   -- Unset the api dml status
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 -- Pre Conditions:
114 --   This is an internal procedure which is called from the upd procedure.
115 --
116 -- In Parameters:
117 --   A Pl/Sql record structre.
118 --
119 -- Post Success:
120 --   Processing continues.
121 --
122 -- Post Failure:
123 --   If an error has occurred, an error message and exception will 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 Table Handler Use Only.
133 --
134 -- {End Of Comments}
135 -- ----------------------------------------------------------------------------
136 Procedure pre_update(p_rec in hr_pab_shd.g_rec_type) 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 the
153 --   update dml.
154 --
155 -- Pre Conditions:
156 --   This is an internal procedure which is called from the upd procedure.
157 --
158 -- In Parameters:
159 --   A Pl/Sql record structre.
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 Table Handler Use Only.
175 --
176 -- {End Of Comments}
177 -- ----------------------------------------------------------------------------
178 Procedure post_update(p_rec in hr_pab_shd.g_rec_type) is
179 --
180   l_proc  varchar2(72) := g_package||'post_update';
181 --
182 Begin
183   hr_utility.set_location('Entering:'||l_proc, 5);
184   --
185   hr_utility.set_location(' Leaving:'||l_proc, 10);
186 End post_update;
187 --
188 -- ----------------------------------------------------------------------------
189 -- |-----------------------------< convert_defs >-----------------------------|
190 -- ----------------------------------------------------------------------------
191 -- {Start Of Comments}
192 --
193 -- Description:
194 --   The Convert_Defs procedure has one very important function:
195 --   It must return the record structure for the row with all system defaulted
196 --   values converted into its corresponding parameter value for update. When
197 --   we attempt to update a row through the Upd process , certain
198 --   parameters can be defaulted which enables flexibility in the calling of
199 --   the upd process (e.g. only attributes which need to be updated need to be
200 --   specified). For the upd process to determine which attributes
201 --   have NOT been specified we need to check if the parameter has a reserved
202 --   system default value. Therefore, for all parameters which have a
203 --   corresponding reserved system default mechanism specified we need to
204 --   check if a system default is being used. If a system default is being
205 --   used then we convert the defaulted value into its corresponding attribute
206 --   value held in the g_old_rec data structure.
207 --
208 -- Pre Conditions:
209 --   This private function can only be called from the upd process.
210 --
211 -- In Parameters:
212 --   A Pl/Sql record structre.
213 --
214 -- Post Success:
215 --   The record structure will be returned with all system defaulted parameter
216 --   values converted into its current row attribute value.
217 --
218 -- Post Failure:
219 --   No direct error handling is required within this function. Any possible
220 --   errors within this procedure will be a PL/SQL value error due to conversion
221 
222 --   of datatypes or data lengths.
223 --
224 -- Developer Implementation Notes:
225 --   None.
226 --
227 -- Access Status:
228 --   Internal Table Handler Use Only.
229 --
230 -- {End Of Comments}
231 -- ----------------------------------------------------------------------------
232 Procedure convert_defs(p_rec in out hr_pab_shd.g_rec_type) is
233 --
234   l_proc  varchar2(72) := g_package||'convert_defs';
235 --
236 Begin
237   --
238   hr_utility.set_location('Entering:'||l_proc, 5);
239   --
240   -- We must now examine each argument value in the
241   -- p_rec plsql record structure
242   -- to see if a system default is being used. If a system default
243   -- is being used then we must set to the 'current' argument value.
244   --
245   If (p_rec.pattern_bit_code = hr_api.g_varchar2) then
246     p_rec.pattern_bit_code :=
247     hr_pab_shd.g_old_rec.pattern_bit_code;
248   End If;
249   If (p_rec.bit_meaning = hr_api.g_varchar2) then
250     p_rec.bit_meaning :=
251     hr_pab_shd.g_old_rec.bit_meaning;
252   End If;
253   If (p_rec.time_unit_multiplier = hr_api.g_number) then
254     p_rec.time_unit_multiplier :=
255     hr_pab_shd.g_old_rec.time_unit_multiplier;
256   End If;
257   If (p_rec.base_time_unit = hr_api.g_varchar2) then
258     p_rec.base_time_unit :=
259     hr_pab_shd.g_old_rec.base_time_unit;
260   End If;
261 
262   --
263   hr_utility.set_location(' Leaving:'||l_proc, 10);
264 --
265 End convert_defs;
266 --
267 -- ----------------------------------------------------------------------------
268 -- |---------------------------------< upd >----------------------------------|
269 -- ----------------------------------------------------------------------------
270 Procedure upd
271   (
272   p_rec        in out hr_pab_shd.g_rec_type,
273   p_validate   in     boolean default false
274   ) is
275 --
276   l_proc  varchar2(72) := g_package||'upd';
277 --
278 Begin
279   hr_utility.set_location('Entering:'||l_proc, 5);
280   --
281   -- Determine if the business process is to be validated.
282   --
283   If p_validate then
284     --
285     -- Issue the savepoint.
286     --
287     SAVEPOINT upd_hr_pab;
288   End If;
289   --
290   -- We must lock the row which we need to update.
291   --
292   hr_pab_shd.lck
293 	(
294 	p_rec.pattern_bit_id,
295 	p_rec.object_version_number
296 	);
297   --
298   -- 1. During an update system defaults are used to determine if
299   --    arguments have been defaulted or not. We must therefore
300   --    derive the full record structure values to be updated.
301   --
302   -- 2. Call the supporting update validate operations.
303   --
304   convert_defs(p_rec);
305   hr_pab_bus.update_validate(p_rec);
306   --
307   -- Call the supporting pre-update operation
308   --
309   pre_update(p_rec);
310   --
311   -- Update the row.
312   --
313   update_dml(p_rec);
314   --
315   -- Call the supporting post-update operation
316   --
317   post_update(p_rec);
318   --
319   -- If we are validating then raise the Validate_Enabled exception
320   --
321   If p_validate then
322     Raise HR_Api.Validate_Enabled;
323   End If;
324   --
325   hr_utility.set_location(' Leaving:'||l_proc, 10);
326 Exception
327   When HR_Api.Validate_Enabled Then
328     --
329     -- As the Validate_Enabled exception has been raised
330     -- we must rollback to the savepoint
331     --
332     ROLLBACK TO upd_hr_pab;
333 End upd;
334 --
335 -- ----------------------------------------------------------------------------
336 -- |---------------------------------< upd >----------------------------------|
337 -- ----------------------------------------------------------------------------
338 Procedure upd
339   (
340   p_pattern_bit_id               in number,
341   p_pattern_bit_code             in varchar2         default hr_api.g_varchar2,
342   p_bit_meaning                  in varchar2         default hr_api.g_varchar2,
343   p_time_unit_multiplier         in number           default hr_api.g_number,
344   p_base_time_unit               in varchar2         default hr_api.g_varchar2,
345   p_object_version_number        in out number,
346   p_validate                     in boolean      default false
347   ) is
348 --
349   l_rec	  hr_pab_shd.g_rec_type;
350   l_proc  varchar2(72) := g_package||'upd';
351 --
352 Begin
353   hr_utility.set_location('Entering:'||l_proc, 5);
354   --
355   -- Call conversion function to turn arguments into the
356   -- l_rec structure.
357   --
358   l_rec :=
359   hr_pab_shd.convert_args
360   (
361   p_pattern_bit_id,
362   p_pattern_bit_code,
363   p_bit_meaning,
364   p_time_unit_multiplier,
365   p_base_time_unit,
366   p_object_version_number
367   );
368   --
369   -- Having converted the arguments into the
370   -- plsql record structure we call the corresponding record
371   -- business process.
372   --
373   upd(l_rec, p_validate);
374   p_object_version_number := l_rec.object_version_number;
375   --
376   hr_utility.set_location(' Leaving:'||l_proc, 10);
377 End upd;
378 --
379 end hr_pab_upd;