DBA Data[Home] [Help]

PACKAGE BODY: APPS.PER_ENV_UPD

Source


1 Package Body per_env_upd as
2 /* $Header: peenvrhi.pkb 120.1 2005/08/04 03:23:12 vegopala noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |                     Private Global Definitions                           |
6 -- ----------------------------------------------------------------------------
7 --
8 g_package  varchar2(33) := '  per_env_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 per_env_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 per_cal_entry_values Row
69   update per_cal_entry_values
70    set
71      cal_entry_value_id              = p_rec.cal_entry_value_id
72     ,override_name                   = p_rec.override_name
73     ,override_type                   = p_rec.override_type
74     ,parent_entry_value_id           = p_rec.parent_entry_value_id
75     ,usage_flag                      = p_rec.usage_flag
76     ,object_version_number           = p_rec.object_version_number
77     where cal_entry_value_id = p_rec.cal_entry_value_id;
78   --
79   --
80   hr_utility.set_location(' Leaving:'||l_proc, 10);
81 --
82 Exception
83   When hr_api.check_integrity_violated Then
84     -- A check constraint has been violated
85     --
86     per_env_shd.constraint_error
87       (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
88   When hr_api.parent_integrity_violated Then
89     -- Parent integrity has been violated
90     --
91     per_env_shd.constraint_error
92       (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
93   When hr_api.unique_integrity_violated Then
94     -- Unique integrity has been violated
95     --
96     per_env_shd.constraint_error
97       (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
98   When Others Then
99     --
100     Raise;
101 End update_dml;
102 --
103 -- ----------------------------------------------------------------------------
104 -- |------------------------------< pre_update >------------------------------|
105 -- ----------------------------------------------------------------------------
106 -- {Start Of Comments}
107 --
108 -- Description:
109 --   This private procedure contains any processing which is required before
110 --   the update dml.
111 --
112 -- Prerequisites:
113 --   This is an internal procedure which is called from the upd procedure.
114 --
115 -- In Parameters:
116 --   A Pl/Sql record structure.
117 --
118 -- Post Success:
119 --   Processing continues.
120 --
121 -- Post Failure:
122 --   If an error has occurred, an error message and exception wil be raised
123 --   but not handled.
124 --
125 -- Developer Implementation Notes:
126 --   Any pre-processing required before the update dml is issued should be
127 --   coded within this procedure. It is important to note that any 3rd party
128 --   maintenance should be reviewed before placing in this procedure.
129 --
130 -- Access Status:
131 --   Internal Row Handler Use Only.
132 --
133 -- {End Of Comments}
134 -- ----------------------------------------------------------------------------
135 Procedure pre_update
136   (p_rec in per_env_shd.g_rec_type
137   ) is
138 --
139   l_proc  varchar2(72) := g_package||'pre_update';
140 --
141 Begin
142   hr_utility.set_location('Entering:'||l_proc, 5);
143   --
144   hr_utility.set_location(' Leaving:'||l_proc, 10);
145 End pre_update;
146 --
147 -- ----------------------------------------------------------------------------
148 -- |-----------------------------< post_update >------------------------------|
149 -- ----------------------------------------------------------------------------
150 -- {Start Of Comments}
151 --
152 -- Description:
153 --   This private procedure contains any processing which is required after
154 --   the update dml.
155 --
156 -- Prerequisites:
157 --   This is an internal procedure which is called from the upd procedure.
158 --
159 -- In Parameters:
160 --   A Pl/Sql record structure.
161 --
162 -- Post Success:
163 --   Processing continues.
164 --
165 -- Post Failure:
166 --   If an error has occurred, an error message and exception will be raised
167 --   but not handled.
168 --
169 -- Developer Implementation Notes:
170 --   Any post-processing required after the update dml is issued should be
171 --   coded within this procedure. It is important to note that any 3rd party
172 --   maintenance should be reviewed before placing in this procedure.
173 --
174 -- Access Status:
175 --   Internal Row Handler Use Only.
176 --
177 -- {End Of Comments}
178 -- ----------------------------------------------------------------------------
179 Procedure post_update
180   (p_effective_date               in date
181   ,p_rec                          in per_env_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     per_env_rku.after_update
191       (p_effective_date              => p_effective_date
192       ,p_cal_entry_value_id          => p_rec.cal_entry_value_id
193       ,p_override_name               => p_rec.override_name
194       ,p_override_type               => p_rec.override_type
195       ,p_parent_entry_value_id       => p_rec.parent_entry_value_id
196       ,p_usage_flag                  => p_rec.usage_flag
197       ,p_object_version_number       => p_rec.object_version_number
198       ,p_calendar_entry_id_o         => per_env_shd.g_old_rec.calendar_entry_id
199       ,p_hierarchy_node_id_o         => per_env_shd.g_old_rec.hierarchy_node_id
200       ,p_value_o                     => per_env_shd.g_old_rec.value
201       ,p_org_structure_element_id_o  => per_env_shd.g_old_rec.org_structure_element_id
202       ,p_organization_id_o           => per_env_shd.g_old_rec.organization_id
203       ,p_override_name_o             => per_env_shd.g_old_rec.override_name
204       ,p_override_type_o             => per_env_shd.g_old_rec.override_type
205       ,p_parent_entry_value_id_o     => per_env_shd.g_old_rec.parent_entry_value_id
206       ,p_usage_flag_o                => per_env_shd.g_old_rec.usage_flag
207       ,p_object_version_number_o     => per_env_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 => 'PER_CAL_ENTRY_VALUES'
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 per_env_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.calendar_entry_id = hr_api.g_number) then
278     p_rec.calendar_entry_id :=
279     per_env_shd.g_old_rec.calendar_entry_id;
280   End If;
281   If (p_rec.hierarchy_node_id = hr_api.g_number) then
282     p_rec.hierarchy_node_id :=
283     per_env_shd.g_old_rec.hierarchy_node_id;
284   End If;
285   If (p_rec.value = hr_api.g_varchar2) then
286     p_rec.value :=
287     per_env_shd.g_old_rec.value;
288   End If;
289   If (p_rec.org_structure_element_id = hr_api.g_number) then
290     p_rec.org_structure_element_id :=
291     per_env_shd.g_old_rec.org_structure_element_id;
292   End If;
293   If (p_rec.organization_id = hr_api.g_number) then
294     p_rec.organization_id :=
295     per_env_shd.g_old_rec.organization_id;
296   End If;
297   If (p_rec.override_name = hr_api.g_varchar2) then
298     p_rec.override_name :=
299     per_env_shd.g_old_rec.override_name;
300   End If;
301   If (p_rec.override_type = hr_api.g_varchar2) then
302     p_rec.override_type :=
303     per_env_shd.g_old_rec.override_type;
304   End If;
305   If (p_rec.parent_entry_value_id = hr_api.g_number) then
306     p_rec.parent_entry_value_id :=
307     per_env_shd.g_old_rec.parent_entry_value_id;
308   End If;
309   If (p_rec.usage_flag = hr_api.g_varchar2) then
310     p_rec.usage_flag :=
311     per_env_shd.g_old_rec.usage_flag;
312   End If;
313   --
314 End convert_defs;
315 --
316 -- ----------------------------------------------------------------------------
317 -- |---------------------------------< upd >----------------------------------|
318 -- ----------------------------------------------------------------------------
319 Procedure upd
320   (p_effective_date               in date
321   ,p_rec                          in out nocopy per_env_shd.g_rec_type
322   ) is
323 --
324   l_proc  varchar2(72) := g_package||'upd';
325 --
326 Begin
327   hr_utility.set_location('Entering:'||l_proc, 5);
328   --
329   -- We must lock the row which we need to update.
330   --
331   per_env_shd.lck
332     (p_rec.cal_entry_value_id
333     ,p_rec.object_version_number
334     );
335   --
336   -- 1. During an update system defaults are used to determine if
337   --    arguments have been defaulted or not. We must therefore
338   --    derive the full record structure values to be updated.
339   --
340   -- 2. Call the supporting update validate operations.
341   --
342   convert_defs(p_rec);
343   per_env_bus.update_validate
344      (p_effective_date
345      ,p_rec
346      );
347   --
348   -- Call to raise any errors on multi-message list
349   hr_multi_message.end_validation_set;
350   --
351   -- Call the supporting pre-update operation
352   --
353   per_env_upd.pre_update(p_rec);
354   --
355   -- Update the row.
356   --
357   per_env_upd.update_dml(p_rec);
358   --
359   -- Call the supporting post-update operation
360   --
361   per_env_upd.post_update
362      (p_effective_date
363      ,p_rec
364      );
365   --
366   -- Call to raise any errors on multi-message list
367   hr_multi_message.end_validation_set;
368 End upd;
369 --
370 -- ----------------------------------------------------------------------------
371 -- |---------------------------------< upd >----------------------------------|
372 -- ----------------------------------------------------------------------------
373 Procedure upd
374   (p_effective_date               in     date
375   ,p_cal_entry_value_id           in     number
376   ,p_object_version_number        in out nocopy number
377   ,p_override_name                in     varchar2  default hr_api.g_varchar2
378   ,p_override_type                in     varchar2  default hr_api.g_varchar2
379   ,p_parent_entry_value_id        in     number    default hr_api.g_number
380   ,p_usage_flag                   in     varchar2  default hr_api.g_varchar2
381   ) is
382 --
383   l_rec   per_env_shd.g_rec_type;
384   l_proc  varchar2(72) := g_package||'upd';
385 --
386 Begin
387   hr_utility.set_location('Entering:'||l_proc, 5);
388   --
389   -- Call conversion function to turn arguments into the
390   -- l_rec structure.
391   --
392   l_rec :=
393   per_env_shd.convert_args
394   (p_cal_entry_value_id
395   ,hr_api.g_number
396   ,hr_api.g_number
397   ,hr_api.g_varchar2
398   ,hr_api.g_number
399   ,hr_api.g_number
400   ,p_override_name
401   ,p_override_type
402   ,p_parent_entry_value_id
403   ,hr_api.g_varchar2
404   ,p_object_version_number
405   ,p_usage_flag
406   );
407   --
408   -- Having converted the arguments into the
409   -- plsql record structure we call the corresponding record
410   -- business process.
411   --
412   per_env_upd.upd
413      (p_effective_date
414      ,l_rec
415      );
416   p_object_version_number := l_rec.object_version_number;
417   --
418   hr_utility.set_location(' Leaving:'||l_proc, 10);
419 End upd;
420 --
421 end per_env_upd;