1 Package Body hr_fcn_upd as
2 /* $Header: hrfcnrhi.pkb 115.3 2002/12/03 10:18:31 hjonnala noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- | Private Global Definitions |
6 -- ----------------------------------------------------------------------------
7 --
8 g_package varchar2(33) := ' hr_fcn_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_fcn_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_form_canvases_b Row
69 --
70 update hr_form_canvases_b
71 set
72 form_canvas_id = p_rec.form_canvas_id
73 ,object_version_number = p_rec.object_version_number
74 ,form_window_id = p_rec.form_window_id
75 ,canvas_name = p_rec.canvas_name
76 ,canvas_type = p_rec.canvas_type
77 where form_canvas_id = p_rec.form_canvas_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_fcn_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_fcn_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_fcn_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_fcn_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 the
155 -- 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 hr_fcn_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 hr_fcn_rku.after_update
192 (p_effective_date => p_effective_date
193 ,p_form_canvas_id
194 => p_rec.form_canvas_id
195 ,p_object_version_number
196 => p_rec.object_version_number
197 ,p_form_window_id
198 => p_rec.form_window_id
199 ,p_canvas_name
200 => p_rec.canvas_name
201 ,p_canvas_type
202 => p_rec.canvas_type
203 ,p_object_version_number_o
204 => hr_fcn_shd.g_old_rec.object_version_number
205 ,p_form_window_id_o
206 => hr_fcn_shd.g_old_rec.form_window_id
207 ,p_canvas_name_o
208 => hr_fcn_shd.g_old_rec.canvas_name
209 ,p_canvas_type_o
210 => hr_fcn_shd.g_old_rec.canvas_type
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 => 'HR_FORM_CANVASES_B'
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 hr_fcn_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.form_window_id = hr_api.g_number) then
281 p_rec.form_window_id :=
282 hr_fcn_shd.g_old_rec.form_window_id;
283 End If;
284 If (p_rec.canvas_name = hr_api.g_varchar2) then
285 p_rec.canvas_name :=
286 hr_fcn_shd.g_old_rec.canvas_name;
287 End If;
288 If (p_rec.canvas_type = hr_api.g_varchar2) then
289 p_rec.canvas_type :=
290 hr_fcn_shd.g_old_rec.canvas_type;
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 hr_fcn_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 hr_fcn_shd.lck
311 (p_rec.form_canvas_id
312 ,p_rec.object_version_number
313 );
314 --
315 -- 1. During an update system defaults are used to determine if
316 -- arguments have been defaulted or not. We must therefore
317 -- derive the full record structure values to be updated.
318 --
319 -- 2. Call the supporting update validate operations.
320 --
321 convert_defs(p_rec);
322 hr_fcn_bus.update_validate
323 (p_effective_date
324 ,p_rec
325 );
326 --
327 -- Call the supporting pre-update operation
328 --
329 hr_fcn_upd.pre_update(p_rec);
330 --
331 -- Update the row.
332 --
333 hr_fcn_upd.update_dml(p_rec);
334 --
335 -- Call the supporting post-update operation
336 --
337 hr_fcn_upd.post_update
338 (p_effective_date
339 ,p_rec
340 );
341 End upd;
342 --
343 -- ----------------------------------------------------------------------------
344 -- |---------------------------------< upd >----------------------------------|
345 -- ----------------------------------------------------------------------------
346 Procedure upd
347 (p_effective_date in date
348 ,p_form_canvas_id in number
349 ,p_object_version_number in out nocopy number
350 ,p_form_window_id in number default hr_api.g_number
351 ,p_canvas_name in varchar2 default hr_api.g_varchar2
352 ,p_canvas_type in varchar2 default hr_api.g_varchar2
353 ) is
354 --
355 l_rec hr_fcn_shd.g_rec_type;
356 l_proc varchar2(72) := g_package||'upd';
357 --
358 Begin
359 hr_utility.set_location('Entering:'||l_proc, 5);
360 --
361 -- Call conversion function to turn arguments into the
362 -- l_rec structure.
363 --
364 l_rec :=
365 hr_fcn_shd.convert_args
366 (p_form_canvas_id
367 ,p_object_version_number
368 ,p_form_window_id
369 ,p_canvas_name
370 ,p_canvas_type
371 );
372 --
373 -- Having converted the arguments into the
374 -- plsql record structure we call the corresponding record
375 -- business process.
376 --
377 hr_fcn_upd.upd
378 (p_effective_date
379 ,l_rec
380 );
381 p_object_version_number := l_rec.object_version_number;
382 --
383 hr_utility.set_location(' Leaving:'||l_proc, 10);
384 End upd;
385 --
386 end hr_fcn_upd;