DBA Data[Home] [Help]

PACKAGE BODY: APPS.GHR_CIN_UPD

Source


1 Package Body ghr_cin_upd as
2 /* $Header: ghcinrhi.pkb 115.1 2003/01/30 19:25:18 asubrahm noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |                     Private Global Definitions                           |
6 -- ----------------------------------------------------------------------------
7 --
8 g_package  varchar2(33) := '  ghr_cin_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 ghr_cin_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 ghr_compl_incidents Row
69   --
70   update ghr_compl_incidents
71     set
72      compl_incident_id               = p_rec.compl_incident_id
73     ,compl_claim_id                  = p_rec.compl_claim_id
74     ,incident_date                   = p_rec.incident_date
75     ,description                     = p_rec.description
76     ,date_amended                    = p_rec.date_amended
77     ,date_acknowledged               = p_rec.date_acknowledged
78     ,object_version_number           = p_rec.object_version_number
79     where compl_incident_id = p_rec.compl_incident_id;
80   --
81   --
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     --
89     ghr_cin_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     --
94     ghr_cin_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     --
99     ghr_cin_shd.constraint_error
100       (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
101   When Others Then
102     --
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 ghr_cin_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 ghr_cin_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     ghr_cin_rku.after_update
194       (p_effective_date              => p_effective_date
195       ,p_compl_incident_id           => p_rec.compl_incident_id
196       ,p_compl_claim_id              => p_rec.compl_claim_id
197       ,p_incident_date               => p_rec.incident_date
198       ,p_description                 => p_rec.description
199       ,p_date_amended                => p_rec.date_amended
200       ,p_date_acknowledged           => p_rec.date_acknowledged
201       ,p_object_version_number       => p_rec.object_version_number
202       ,p_compl_claim_id_o            => ghr_cin_shd.g_old_rec.compl_claim_id
203       ,p_incident_date_o             => ghr_cin_shd.g_old_rec.incident_date
204       ,p_description_o               => ghr_cin_shd.g_old_rec.description
205       ,p_date_amended_o              => ghr_cin_shd.g_old_rec.date_amended
206       ,p_date_acknowledged_o         => ghr_cin_shd.g_old_rec.date_acknowledged
207       ,p_object_version_number_o     => ghr_cin_shd.g_old_rec.object_version_number
208       );
209     --
210   exception
211     --
212     when hr_api.cannot_find_prog_unit then
213       --
214       hr_api.cannot_find_prog_unit_error
215         (p_module_name => 'GHR_COMPL_INCIDENTS'
216         ,p_hook_type   => 'AU');
217       --
218   end;
219   --
220   hr_utility.set_location(' Leaving:'||l_proc, 10);
221 End post_update;
222 --
223 -- ----------------------------------------------------------------------------
224 -- |-----------------------------< convert_defs >-----------------------------|
225 -- ----------------------------------------------------------------------------
226 -- {Start Of Comments}
227 --
228 -- Description:
229 --   The Convert_Defs procedure has one very important function:
230 --   It must return the record structure for the row with all system defaulted
231 --   values converted into its corresponding parameter value for update. When
232 --   we attempt to update a row through the Upd process , certain
233 --   parameters can be defaulted which enables flexibility in the calling of
234 --   the upd process (e.g. only attributes which need to be updated need to be
235 --   specified). For the upd process to determine which attributes
236 --   have NOT been specified we need to check if the parameter has a reserved
237 --   system default value. Therefore, for all parameters which have a
238 --   corresponding reserved system default mechanism specified we need to
239 --   check if a system default is being used. If a system default is being
240 --   used then we convert the defaulted value into its corresponding attribute
241 --   value held in the g_old_rec data structure.
242 --
243 -- Prerequisites:
244 --   This private function can only be called from the upd process.
245 --
246 -- In Parameters:
247 --   A Pl/Sql record structure.
248 --
249 -- Post Success:
250 --   The record structure will be returned with all system defaulted parameter
251 --   values converted into its current row attribute value.
252 --
253 -- Post Failure:
254 --   No direct error handling is required within this function. Any possible
255 --   errors within this procedure will be a PL/SQL value error due to
256 --   conversion of datatypes or data lengths.
257 --
258 -- Developer Implementation Notes:
259 --   None.
260 --
261 -- Access Status:
262 --   Internal Row Handler Use Only.
263 --
264 -- {End Of Comments}
265 -- ----------------------------------------------------------------------------
266 Procedure convert_defs
267   (p_rec in out nocopy ghr_cin_shd.g_rec_type
268   ) is
269 --
270 Begin
271   --
272   -- We must now examine each argument value in the
273   -- p_rec plsql record structure
274   -- to see if a system default is being used. If a system default
275   -- is being used then we must set to the 'current' argument value.
276   --
277   If (p_rec.compl_claim_id = hr_api.g_number) then
278     p_rec.compl_claim_id :=
279     ghr_cin_shd.g_old_rec.compl_claim_id;
280   End If;
281   If (p_rec.incident_date = hr_api.g_date) then
282     p_rec.incident_date :=
283     ghr_cin_shd.g_old_rec.incident_date;
284   End If;
285   If (p_rec.description = hr_api.g_varchar2) then
286     p_rec.description :=
287     ghr_cin_shd.g_old_rec.description;
288   End If;
289   If (p_rec.date_amended = hr_api.g_date) then
290     p_rec.date_amended :=
291     ghr_cin_shd.g_old_rec.date_amended;
292   End If;
293   If (p_rec.date_acknowledged = hr_api.g_date) then
294     p_rec.date_acknowledged :=
295     ghr_cin_shd.g_old_rec.date_acknowledged;
296   End If;
297   --
298 End convert_defs;
299 --
300 -- ----------------------------------------------------------------------------
301 -- |---------------------------------< upd >----------------------------------|
302 -- ----------------------------------------------------------------------------
303 Procedure upd
304   (p_effective_date               in date
305   ,p_rec                          in out nocopy ghr_cin_shd.g_rec_type
306   ) is
307 --
308   l_proc  varchar2(72) := g_package||'upd';
309 --
310 Begin
311   hr_utility.set_location('Entering:'||l_proc, 5);
312   --
313   -- We must lock the row which we need to update.
314   --
315   ghr_cin_shd.lck
316     (p_rec.compl_incident_id
317     ,p_rec.object_version_number
318     );
319   --
320   -- 1. During an update system defaults are used to determine if
321   --    arguments have been defaulted or not. We must therefore
322   --    derive the full record structure values to be updated.
323   --
324   -- 2. Call the supporting update validate operations.
325   --
326   convert_defs(p_rec);
327   ghr_cin_bus.update_validate
328      (p_effective_date
329      ,p_rec
330      );
331   --
332   -- Call the supporting pre-update operation
333   --
334   ghr_cin_upd.pre_update(p_rec);
335   --
336   -- Update the row.
337   --
338   ghr_cin_upd.update_dml(p_rec);
339   --
340   -- Call the supporting post-update operation
341   --
342   ghr_cin_upd.post_update
343      (p_effective_date
344      ,p_rec
345      );
346 End upd;
347 --
348 -- ----------------------------------------------------------------------------
349 -- |---------------------------------< upd >----------------------------------|
350 -- ----------------------------------------------------------------------------
351 Procedure upd
352   (p_effective_date               in     date
353   ,p_compl_incident_id            in     number
354   ,p_object_version_number        in out nocopy number
355   ,p_compl_claim_id               in     number    default hr_api.g_number
356   ,p_incident_date                in     date      default hr_api.g_date
357   ,p_description                  in     varchar2  default hr_api.g_varchar2
358   ,p_date_amended                 in     date      default hr_api.g_date
359   ,p_date_acknowledged            in     date      default hr_api.g_date
360   ) is
361 --
362   l_rec   ghr_cin_shd.g_rec_type;
363   l_proc  varchar2(72) := g_package||'upd';
364 --
365 Begin
366   hr_utility.set_location('Entering:'||l_proc, 5);
367   --
368   -- Call conversion function to turn arguments into the
369   -- l_rec structure.
370   --
371   l_rec :=
372   ghr_cin_shd.convert_args
373   (p_compl_incident_id
374   ,p_compl_claim_id
375   ,p_incident_date
376   ,p_description
377   ,p_date_amended
378   ,p_date_acknowledged
379   ,p_object_version_number
380   );
381   --
382   -- Having converted the arguments into the
383   -- plsql record structure we call the corresponding record
384   -- business process.
385   --
386   ghr_cin_upd.upd
387      (p_effective_date
388      ,l_rec
389      );
390   p_object_version_number := l_rec.object_version_number;
391   --
392   hr_utility.set_location(' Leaving:'||l_proc, 10);
393 End upd;
394 --
395 end ghr_cin_upd;