1 Package Body ff_ffp_upd as
2 /* $Header: ffffprhi.pkb 120.1 2005/10/05 01:51 adkumar noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- | Private Global Definitions |
6 -- ----------------------------------------------------------------------------
7 --
8 g_package varchar2(33) := ' ff_ffp_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 ff_ffp_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);
65 --
62 --
63 -- Increment the object version
64 p_rec.object_version_number := p_rec.object_version_number + 1;
66 ff_ffp_shd.g_api_dml := true; -- Set the api dml status
67 --
68 -- Update the ff_function_parameters Row
69 --
70 update ff_function_parameters
71 set
72 function_id = p_rec.function_id
73 ,sequence_number = p_rec.sequence_number
74 ,class = p_rec.class
75 ,continuing_parameter = p_rec.continuing_parameter
76 ,data_type = p_rec.data_type
77 ,name = p_rec.name
78 ,optional = p_rec.optional
79 ,object_version_number = p_rec.object_version_number
80 where function_id = p_rec.function_id
81 and sequence_number = p_rec.sequence_number;
82 --
83 ff_ffp_shd.g_api_dml := false; -- Unset the api dml status
84 --
85 hr_utility.set_location(' Leaving:'||l_proc, 10);
86 --
87 Exception
88 When hr_api.check_integrity_violated Then
89 -- A check constraint has been violated
90 ff_ffp_shd.g_api_dml := false; -- Unset the api dml status
91 ff_ffp_shd.constraint_error
92 (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
93 When hr_api.parent_integrity_violated Then
94 -- Parent integrity has been violated
95 ff_ffp_shd.g_api_dml := false; -- Unset the api dml status
96 ff_ffp_shd.constraint_error
97 (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
98 When hr_api.unique_integrity_violated Then
99 -- Unique integrity has been violated
100 ff_ffp_shd.g_api_dml := false; -- Unset the api dml status
101 ff_ffp_shd.constraint_error
102 (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
103 When Others Then
104 ff_ffp_shd.g_api_dml := false; -- Unset the api dml status
105 Raise;
106 End update_dml;
107 --
108 -- ----------------------------------------------------------------------------
109 -- |------------------------------< pre_update >------------------------------|
110 -- ----------------------------------------------------------------------------
111 -- {Start Of Comments}
112 --
113 -- Description:
114 -- This private procedure contains any processing which is required before
115 -- the update dml.
116 --
117 -- Prerequisites:
118 -- This is an internal procedure which is called from the upd procedure.
119 --
120 -- In Parameters:
121 -- A Pl/Sql record structure.
122 --
123 -- Post Success:
124 -- Processing continues.
125 --
126 -- Post Failure:
127 -- If an error has occurred, an error message and exception wil be raised
128 -- but not handled.
129 --
130 -- Developer Implementation Notes:
131 -- Any pre-processing required before the update dml is issued should be
132 -- coded within this procedure. It is important to note that any 3rd party
133 -- maintenance should be reviewed before placing in this procedure.
134 --
135 -- Access Status:
136 -- Internal Row Handler Use Only.
137 --
138 -- {End Of Comments}
139 -- ----------------------------------------------------------------------------
140 Procedure pre_update
141 (p_rec in ff_ffp_shd.g_rec_type
142 ) is
143 --
144 l_proc varchar2(72) := g_package||'pre_update';
145 --
146 Begin
147 hr_utility.set_location('Entering:'||l_proc, 5);
148 --
149 hr_utility.set_location(' Leaving:'||l_proc, 10);
150 End pre_update;
151 --
152 -- ----------------------------------------------------------------------------
153 -- |-----------------------------< post_update >------------------------------|
154 -- ----------------------------------------------------------------------------
155 -- {Start Of Comments}
156 --
157 -- Description:
158 -- This private procedure contains any processing which is required after
159 -- the update dml.
160 --
161 -- Prerequisites:
162 -- This is an internal procedure which is called from the upd procedure.
163 --
164 -- In Parameters:
165 -- A Pl/Sql record structure.
166 --
167 -- Post Success:
168 -- Processing continues.
169 --
170 -- Post Failure:
171 -- If an error has occurred, an error message and exception will be raised
172 -- but not handled.
173 --
174 -- Developer Implementation Notes:
175 -- Any post-processing required after the update dml is issued should be
176 -- coded within this procedure. It is important to note that any 3rd party
177 -- maintenance should be reviewed before placing in this procedure.
178 --
179 -- Access Status:
180 -- Internal Row Handler Use Only.
181 --
182 -- {End Of Comments}
183 -- ----------------------------------------------------------------------------
184 Procedure post_update
185 (p_effective_date in date
186 ,p_rec in ff_ffp_shd.g_rec_type
187 ) is
188 --
189 l_proc varchar2(72) := g_package||'post_update';
190 --
191 Begin
192 hr_utility.set_location('Entering:'||l_proc, 5);
193 begin
194 --
195 ff_ffp_rku.after_update
196 (p_effective_date => p_effective_date
197 ,p_function_id
198 => p_rec.function_id
199 ,p_sequence_number
200 => p_rec.sequence_number
201 ,p_class
202 => p_rec.class
203 ,p_continuing_parameter
204 => p_rec.continuing_parameter
205 ,p_data_type
206 => p_rec.data_type
207 ,p_name
208 => p_rec.name
209 ,p_optional
210 => p_rec.optional
214 => ff_ffp_shd.g_old_rec.class
211 ,p_object_version_number
212 => p_rec.object_version_number
213 ,p_class_o
215 ,p_continuing_parameter_o
216 => ff_ffp_shd.g_old_rec.continuing_parameter
217 ,p_data_type_o
218 => ff_ffp_shd.g_old_rec.data_type
219 ,p_name_o
220 => ff_ffp_shd.g_old_rec.name
221 ,p_optional_o
222 => ff_ffp_shd.g_old_rec.optional
223 ,p_object_version_number_o
224 => ff_ffp_shd.g_old_rec.object_version_number
225 );
226 --
227 exception
228 --
229 when hr_api.cannot_find_prog_unit then
230 --
231 hr_api.cannot_find_prog_unit_error
232 (p_module_name => 'FF_FUNCTION_PARAMETERS'
233 ,p_hook_type => 'AU');
234 --
235 end;
236 --
237 hr_utility.set_location(' Leaving:'||l_proc, 10);
238 End post_update;
239 --
240 -- ----------------------------------------------------------------------------
241 -- |-----------------------------< convert_defs >-----------------------------|
242 -- ----------------------------------------------------------------------------
243 -- {Start Of Comments}
244 --
245 -- Description:
246 -- The Convert_Defs procedure has one very important function:
247 -- It must return the record structure for the row with all system defaulted
248 -- values converted into its corresponding parameter value for update. When
249 -- we attempt to update a row through the Upd process , certain
250 -- parameters can be defaulted which enables flexibility in the calling of
251 -- the upd process (e.g. only attributes which need to be updated need to be
252 -- specified). For the upd process to determine which attributes
253 -- have NOT been specified we need to check if the parameter has a reserved
254 -- system default value. Therefore, for all parameters which have a
255 -- corresponding reserved system default mechanism specified we need to
256 -- check if a system default is being used. If a system default is being
257 -- used then we convert the defaulted value into its corresponding attribute
258 -- value held in the g_old_rec data structure.
259 --
260 -- Prerequisites:
261 -- This private function can only be called from the upd process.
262 --
263 -- In Parameters:
264 -- A Pl/Sql record structure.
265 --
266 -- Post Success:
267 -- The record structure will be returned with all system defaulted parameter
268 -- values converted into its current row attribute value.
269 --
270 -- Post Failure:
271 -- No direct error handling is required within this function. Any possible
272 -- errors within this procedure will be a PL/SQL value error due to
273 -- conversion of datatypes or data lengths.
274 --
275 -- Developer Implementation Notes:
276 -- None.
277 --
278 -- Access Status:
279 -- Internal Row Handler Use Only.
280 --
281 -- {End Of Comments}
282 -- ----------------------------------------------------------------------------
283 Procedure convert_defs
284 (p_rec in out nocopy ff_ffp_shd.g_rec_type
285 ) is
286 --
287 Begin
288 --
289 -- We must now examine each argument value in the
290 -- p_rec plsql record structure
291 -- to see if a system default is being used. If a system default
292 -- is being used then we must set to the 'current' argument value.
293 --
294 If (p_rec.class = hr_api.g_varchar2) then
295 p_rec.class :=
296 ff_ffp_shd.g_old_rec.class;
297 End If;
298 If (p_rec.continuing_parameter = hr_api.g_varchar2) then
299 p_rec.continuing_parameter :=
300 ff_ffp_shd.g_old_rec.continuing_parameter;
301 End If;
302 If (p_rec.data_type = hr_api.g_varchar2) then
303 p_rec.data_type :=
304 ff_ffp_shd.g_old_rec.data_type;
305 End If;
306 If (p_rec.name = hr_api.g_varchar2) then
307 p_rec.name :=
308 ff_ffp_shd.g_old_rec.name;
309 End If;
310 If (p_rec.optional = hr_api.g_varchar2) then
311 p_rec.optional :=
312 ff_ffp_shd.g_old_rec.optional;
313 End If;
314 --
315 End convert_defs;
316 --
317 -- ----------------------------------------------------------------------------
318 -- |---------------------------------< upd >----------------------------------|
319 -- ----------------------------------------------------------------------------
320 Procedure upd
321 (p_effective_date in date
322 ,p_rec in out nocopy ff_ffp_shd.g_rec_type
323 ) is
324 --
325 l_proc varchar2(72) := g_package||'upd';
326 --
327 Begin
328 hr_utility.set_location('Entering:'||l_proc, 5);
329 --
330 -- We must lock the row which we need to update.
331 --
332 ff_ffp_shd.lck
333 (p_rec.function_id
334 ,p_rec.sequence_number
335 ,p_rec.object_version_number
336 );
337 --
338 -- 1. During an update system defaults are used to determine if
339 -- arguments have been defaulted or not. We must therefore
340 -- derive the full record structure values to be updated.
341 --
342 -- 2. Call the supporting update validate operations.
343 --
344 convert_defs(p_rec);
345 ff_ffp_bus.update_validate
346 (p_effective_date
347 ,p_rec
348 );
349 --
350 -- Call to raise any errors on multi-message list
351 hr_multi_message.end_validation_set;
352 --
353 -- Call the supporting pre-update operation
354 --
355 ff_ffp_upd.pre_update(p_rec);
356 --
357 -- Update the row.
358 --
359 ff_ffp_upd.update_dml(p_rec);
360 --
361 -- Call the supporting post-update operation
362 --
366 );
363 ff_ffp_upd.post_update
364 (p_effective_date
365 ,p_rec
367 --
368 -- Call to raise any errors on multi-message list
369 hr_multi_message.end_validation_set;
370 End upd;
371 --
372 -- ----------------------------------------------------------------------------
373 -- |---------------------------------< upd >----------------------------------|
374 -- ----------------------------------------------------------------------------
375 Procedure upd
376 (p_effective_date in date
377 ,p_function_id in number
378 ,p_sequence_number in number
379 ,p_object_version_number in out nocopy number
380 ,p_class in varchar2 default hr_api.g_varchar2
381 ,p_continuing_parameter in varchar2 default hr_api.g_varchar2
382 ,p_data_type in varchar2 default hr_api.g_varchar2
383 ,p_name in varchar2 default hr_api.g_varchar2
384 ,p_optional in varchar2 default hr_api.g_varchar2
385 ) is
386 --
387 l_rec ff_ffp_shd.g_rec_type;
388 l_proc varchar2(72) := g_package||'upd';
389 --
390 Begin
391 hr_utility.set_location('Entering:'||l_proc, 5);
392 --
393 -- Call conversion function to turn arguments into the
394 -- l_rec structure.
395 --
396 l_rec :=
397 ff_ffp_shd.convert_args
398 (p_function_id
399 ,p_sequence_number
400 ,p_class
401 ,p_continuing_parameter
402 ,p_data_type
403 ,p_name
404 ,p_optional
405 ,p_object_version_number
406 );
407 --
408 -- Having converted the arguments into the
409 -- plsql record structure we call the corresponding record
410 -- business process.
411 --
412 ff_ffp_upd.upd
413 (p_effective_date
414 ,l_rec
415 );
416 p_object_version_number := l_rec.object_version_number;
417 --
418 hr_utility.set_location(' Leaving:'||l_proc, 10);
419 End upd;
420 --
421 end ff_ffp_upd;
[Home] [Help]