DBA Data[Home] [Help]

PACKAGE BODY: APPS.OTA_FNS_UPD

Source


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