DBA Data[Home] [Help]

PACKAGE BODY: APPS.OTA_FRM_UPD

Source


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