DBA Data[Home] [Help]

PACKAGE BODY: APPS.IRC_VCE_UPD

Source


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