DBA Data[Home] [Help]

PACKAGE BODY: APPS.FF_FCU_UPD

Source


1 Package Body ff_fcu_upd as
2 /* $Header: fffcurhi.pkb 120.1 2005/10/05 01:51 adkumar noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |                     Private Global Definitions                           |
6 -- ----------------------------------------------------------------------------
7 --
8 g_package  varchar2(33) := '  ff_fcu_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_fcu_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   ff_fcu_shd.g_api_dml := true;  -- Set the api dml status
67   --
68   -- Update the ff_function_context_usages Row
69   --
70   update ff_function_context_usages
71     set
72      function_id                     = p_rec.function_id
73     ,sequence_number                 = p_rec.sequence_number
74     ,context_id                      = p_rec.context_id
75     ,object_version_number           = p_rec.object_version_number
76     where function_id = p_rec.function_id
77     and sequence_number = p_rec.sequence_number;
78   --
79   ff_fcu_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     ff_fcu_shd.g_api_dml := false;   -- Unset the api dml status
87     ff_fcu_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     ff_fcu_shd.g_api_dml := false;   -- Unset the api dml status
92     ff_fcu_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     ff_fcu_shd.g_api_dml := false;   -- Unset the api dml status
97     ff_fcu_shd.constraint_error
98       (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
99   When Others Then
100     ff_fcu_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 -- 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 ff_fcu_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
155 --   the 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_rec                          in ff_fcu_shd.g_rec_type
182   ) is
183 --
184   l_proc  varchar2(72) := g_package||'post_update';
185 --
186 Begin
187   hr_utility.set_location('Entering:'||l_proc, 5);
188   begin
189     --
190     ff_fcu_rku.after_update
191       (p_function_id
192       => p_rec.function_id
193       ,p_sequence_number
194       => p_rec.sequence_number
195       ,p_context_id
196       => p_rec.context_id
197       ,p_object_version_number
198       => p_rec.object_version_number
199       ,p_context_id_o
200       => ff_fcu_shd.g_old_rec.context_id
201       ,p_object_version_number_o
202       => ff_fcu_shd.g_old_rec.object_version_number
203       );
204     --
205   exception
206     --
207     when hr_api.cannot_find_prog_unit then
208       --
209       hr_api.cannot_find_prog_unit_error
210         (p_module_name => 'FF_FUNCTION_CONTEXT_USAGES'
211         ,p_hook_type   => 'AU');
212       --
213   end;
214   --
215   hr_utility.set_location(' Leaving:'||l_proc, 10);
216 End post_update;
217 --
218 -- ----------------------------------------------------------------------------
219 -- |-----------------------------< convert_defs >-----------------------------|
220 -- ----------------------------------------------------------------------------
221 -- {Start Of Comments}
222 --
223 -- Description:
224 --   The Convert_Defs procedure has one very important function:
225 --   It must return the record structure for the row with all system defaulted
226 --   values converted into its corresponding parameter value for update. When
227 --   we attempt to update a row through the Upd process , certain
228 --   parameters can be defaulted which enables flexibility in the calling of
229 --   the upd process (e.g. only attributes which need to be updated need to be
230 --   specified). For the upd process to determine which attributes
231 --   have NOT been specified we need to check if the parameter has a reserved
232 --   system default value. Therefore, for all parameters which have a
233 --   corresponding reserved system default mechanism specified we need to
234 --   check if a system default is being used. If a system default is being
235 --   used then we convert the defaulted value into its corresponding attribute
236 --   value held in the g_old_rec data structure.
237 --
238 -- Prerequisites:
239 --   This private function can only be called from the upd process.
240 --
241 -- In Parameters:
242 --   A Pl/Sql record structure.
243 --
244 -- Post Success:
245 --   The record structure will be returned with all system defaulted parameter
246 --   values converted into its current row attribute value.
247 --
248 -- Post Failure:
249 --   No direct error handling is required within this function. Any possible
250 --   errors within this procedure will be a PL/SQL value error due to
251 --   conversion of datatypes or data lengths.
252 --
253 -- Developer Implementation Notes:
254 --   None.
255 --
256 -- Access Status:
257 --   Internal Row Handler Use Only.
258 --
259 -- {End Of Comments}
260 -- ----------------------------------------------------------------------------
261 Procedure convert_defs
262   (p_rec in out nocopy ff_fcu_shd.g_rec_type
263   ) is
264 --
265 Begin
266   --
267   -- We must now examine each argument value in the
268   -- p_rec plsql record structure
269   -- to see if a system default is being used. If a system default
270   -- is being used then we must set to the 'current' argument value.
271   --
272   If (p_rec.context_id = hr_api.g_number) then
273     p_rec.context_id :=
274     ff_fcu_shd.g_old_rec.context_id;
275   End If;
276   --
277 End convert_defs;
278 --
279 -- ----------------------------------------------------------------------------
280 -- |---------------------------------< upd >----------------------------------|
281 -- ----------------------------------------------------------------------------
282 Procedure upd
283   (p_rec                          in out nocopy ff_fcu_shd.g_rec_type
284   ) is
285 --
286   l_proc  varchar2(72) := g_package||'upd';
287 --
288 Begin
289   hr_utility.set_location('Entering:'||l_proc, 5);
290   --
291   -- We must lock the row which we need to update.
292   --
293   ff_fcu_shd.lck
294     (p_rec.function_id
295     ,p_rec.sequence_number
296     ,p_rec.object_version_number
297     );
298   --
299   -- 1. During an update system defaults are used to determine if
300   --    arguments have been defaulted or not. We must therefore
301   --    derive the full record structure values to be updated.
302   --
303   -- 2. Call the supporting update validate operations.
304   --
305   convert_defs(p_rec);
306   ff_fcu_bus.update_validate
307      (p_rec
308      );
309   --
310   -- Call to raise any errors on multi-message list
311   hr_multi_message.end_validation_set;
312   --
313   -- Call the supporting pre-update operation
314   --
315   ff_fcu_upd.pre_update(p_rec);
316   --
317   -- Update the row.
318   --
319   ff_fcu_upd.update_dml(p_rec);
320   --
321   -- Call the supporting post-update operation
322   --
323   ff_fcu_upd.post_update
324      (p_rec
325      );
326   --
327   -- Call to raise any errors on multi-message list
328   hr_multi_message.end_validation_set;
329 End upd;
330 --
331 -- ----------------------------------------------------------------------------
332 -- |---------------------------------< upd >----------------------------------|
333 -- ----------------------------------------------------------------------------
334 Procedure upd
335   (p_function_id                  in     number
336   ,p_sequence_number              in     number
337   ,p_object_version_number        in out nocopy number
338   ,p_context_id                   in     number    default hr_api.g_number
339   ) is
340 --
341   l_rec   ff_fcu_shd.g_rec_type;
342   l_proc  varchar2(72) := g_package||'upd';
343 --
344 Begin
345   hr_utility.set_location('Entering:'||l_proc, 5);
346 
347   -- Call conversion function to turn arguments into the
348   -- l_rec structure.
349   --
350   l_rec :=
351   ff_fcu_shd.convert_args
352   (p_function_id
353   ,p_sequence_number
354   ,p_context_id
355   ,p_object_version_number
356   );
357   --
358   -- Having converted the arguments into the
359   -- plsql record structure we call the corresponding record
360   -- business process.
361   --
362   ff_fcu_upd.upd
363      (l_rec
364      );
365   p_object_version_number := l_rec.object_version_number;
366   --
367   hr_utility.set_location(' Leaving:'||l_proc, 10);
368 End upd;
369 --
370 end ff_fcu_upd;