DBA Data[Home] [Help]

PACKAGE BODY: APPS.HR_TCN_UPD

Source


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