DBA Data[Home] [Help]

PACKAGE BODY: APPS.HR_SNP_UPD

Source


1 Package Body hr_snp_upd as
2 /* $Header: hrsnprhi.pkb 120.0 2005/05/31 02:52:28 appldev noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |                     Private Global Definitions                           |
6 -- ----------------------------------------------------------------------------
7 --
8 g_package  varchar2(33) := '  hr_snp_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_snp_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_transaction_snapshot Row
69   --
70   update hr_transaction_snapshot
71     set
72      object_version_number           = p_rec.object_version_number
73     ,document                        = p_rec.document
74     ,object_name                     = p_rec.object_name
75     ,object_identifier               = p_rec.object_identifier
76 
77     where snapshot_id = p_rec.snapshot_id;
78   --
79   --
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     --
87     hr_snp_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     --
92     hr_snp_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     --
97     hr_snp_shd.constraint_error
98       (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
99   When Others Then
100     --
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 hr_snp_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 hr_snp_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     /*hr_snp_rku.after_update
191       (p_snapshot_id
192       => p_rec.snapshot_id
193       ,p_object_version_number
194       => p_rec.object_version_number
195       ,p_access_key
196       => p_rec.access_key
197       ,p_document
198       => p_rec.document
199       ,p_object_version_number_o
200       => hr_snp_shd.g_old_rec.object_version_number
201       ,p_access_key_o
202       => hr_snp_shd.g_old_rec.access_key
203       ,p_document_o
204       => hr_snp_shd.g_old_rec.document
205       );*/
206       null;
207     --
208   exception
209     --
210     when hr_api.cannot_find_prog_unit then
211       --
212       hr_api.cannot_find_prog_unit_error
213         (p_module_name => 'HR_TRANSACTION_SNAPSHOT'
214         ,p_hook_type   => 'AU');
215       --
216   end;
217   --
218   hr_utility.set_location(' Leaving:'||l_proc, 10);
219 End post_update;
220 
221 --
222 -- ----------------------------------------------------------------------------
223 -- |-----------------------------< convert_defs >-----------------------------|
224 -- ----------------------------------------------------------------------------
225 -- {Start Of Comments}
226 --
227 -- Description:
228 --   The Convert_Defs procedure has one very important function:
229 --   It must return the record structure for the row with all system defaulted
230 --   values converted into its corresponding parameter value for update. When
231 --   we attempt to update a row through the Upd process , certain
232 --   parameters can be defaulted which enables flexibility in the calling of
233 --   the upd process (e.g. only attributes which need to be updated need to be
234 --   specified). For the upd process to determine which attributes
235 --   have NOT been specified we need to check if the parameter has a reserved
236 --   system default value. Therefore, for all parameters which have a
237 --   corresponding reserved system default mechanism specified we need to
238 --   check if a system default is being used. If a system default is being
239 --   used then we convert the defaulted value into its corresponding attribute
240 --   value held in the g_old_rec data structure.
241 --
242 -- Prerequisites:
243 --   This private function can only be called from the upd process.
244 --
245 -- In Parameters:
246 --   A Pl/Sql record structure.
247 --
248 -- Post Success:
249 --   The record structure will be returned with all system defaulted parameter
250 --   values converted into its current row attribute value.
251 --
252 -- Post Failure:
253 --   No direct error handling is required within this function. Any possible
254 --   errors within this procedure will be a PL/SQL value error due to
255 --   conversion of datatypes or data lengths.
256 --
257 -- Developer Implementation Notes:
258 --   None.
259 --
260 -- Access Status:
261 --   Internal Row Handler Use Only.
262 --
263 -- {End Of Comments}
264 -- ----------------------------------------------------------------------------
265 Procedure convert_defs
266   (p_rec in out nocopy hr_snp_shd.g_rec_type
267   ) is
268 --
269 Begin
270   --
271   -- We must now examine each argument value in the
272   -- p_rec plsql record structure
273   -- to see if a system default is being used. If a system default
274   -- is being used then we must set to the 'current' argument value.
275   --
276   NULL;
277   /* If (p_rec.document = empty_clob()) then
278     p_rec.document :=
279     hr_snp_shd.g_old_rec.document;
280   End If; */
281   --
282 End convert_defs;
283 --
284 -- ----------------------------------------------------------------------------
285 -- |---------------------------------< upd >----------------------------------|
286 -- ----------------------------------------------------------------------------
287 Procedure upd
288   (p_rec                          in out nocopy hr_snp_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_snp_shd.lck
299     (p_rec.snapshot_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_snp_bus.update_validate
311      (p_rec
312      );
313   --
314   -- Call to raise any errors on multi-message list
315   hr_multi_message.end_validation_set;
316   --
317   -- Call the supporting pre-update operation
318   --
319   hr_snp_upd.pre_update(p_rec);
320   --
321   -- Update the row.
322   --
323   hr_snp_upd.update_dml(p_rec);
324   --
325   -- Call the supporting post-update operation
326   --
327   hr_snp_upd.post_update
328      (p_rec
329      );
330   --
331   -- Call to raise any errors on multi-message list
332   hr_multi_message.end_validation_set;
333 End upd;
334 --
335 -- ----------------------------------------------------------------------------
336 -- |---------------------------------< upd >----------------------------------|
337 -- ----------------------------------------------------------------------------
338 Procedure upd
339   (p_snapshot_id                  in     number
340   ,p_object_version_number        in out nocopy number
341   ,p_document                     in     clob default NULL
342   ,p_object_name                  in     varchar2
343   ,p_object_identifier            in     varchar2
344 
345 
346   ) is
347 --
348   l_rec   hr_snp_shd.g_rec_type;
349   l_proc  varchar2(72) := g_package||'upd';
350 --
351 Begin
352   hr_utility.set_location('Entering:'||l_proc, 5);
353   --
354   -- Call conversion function to turn arguments into the
355   -- l_rec structure.
356   --
357   l_rec :=
358   hr_snp_shd.convert_args
359   (p_snapshot_id
360   ,p_object_version_number
361   ,p_document
362   ,p_object_name
363   ,p_object_identifier
364   );
365   --
366   -- Having converted the arguments into the
367   -- plsql record structure we call the corresponding record
368   -- business process.
369   --
370   hr_snp_upd.upd
371      (l_rec
372      );
373   p_object_version_number := l_rec.object_version_number;
374   --
375   hr_utility.set_location(' Leaving:'||l_proc, 10);
376 End upd;
377 --
378 end hr_snp_upd;