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