1 Package Body irc_cmc_upd as
2 /* $Header: ircmcrhi.pkb 120.0 2007/11/19 11:04:15 sethanga noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- | Private Global Definitions |
6 -- ----------------------------------------------------------------------------
7 --
8 g_package varchar2(33) := ' irc_cmc_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_cmc_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 irc_communications Row
69 --
70 update irc_communications
71 set
72 communication_id = p_rec.communication_id
73 ,communication_property_id = p_rec.communication_property_id
74 ,object_type = p_rec.object_type
75 ,object_id = p_rec.object_id
76 ,status = p_rec.status
77 ,start_date = p_rec.start_date
78 ,end_date = p_rec.end_date
79 ,object_version_number = p_rec.object_version_number
80 where communication_id = p_rec.communication_id;
81 --
82 --
83 --
84 hr_utility.set_location(' Leaving:'||l_proc, 10);
85 --
86 Exception
87 When hr_api.check_integrity_violated Then
88 -- A check constraint has been violated
89 --
90 irc_cmc_shd.constraint_error
91 (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
92 When hr_api.parent_integrity_violated Then
93 -- Parent integrity has been violated
94 --
95 irc_cmc_shd.constraint_error
96 (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
97 When hr_api.unique_integrity_violated Then
98 -- Unique integrity has been violated
99 --
100 irc_cmc_shd.constraint_error
101 (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
102 When Others Then
103 --
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_cmc_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_cmc_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_cmc_rku.after_update
195 (p_effective_date => p_effective_date
196 ,p_communication_id
197 => p_rec.communication_id
198 ,p_communication_property_id
199 => p_rec.communication_property_id
200 ,p_object_type
201 => p_rec.object_type
202 ,p_object_id
203 => p_rec.object_id
204 ,p_status
205 => p_rec.status
206 ,p_start_date
207 => p_rec.start_date
208 ,p_end_date
209 => p_rec.end_date
210 ,p_object_version_number
211 => p_rec.object_version_number
212 ,p_communication_property_id_o
213 => irc_cmc_shd.g_old_rec.communication_property_id
214 ,p_object_type_o
215 => irc_cmc_shd.g_old_rec.object_type
216 ,p_object_id_o
217 => irc_cmc_shd.g_old_rec.object_id
218 ,p_status_o
219 => irc_cmc_shd.g_old_rec.status
220 ,p_start_date_o
221 => irc_cmc_shd.g_old_rec.start_date
222 ,p_end_date_o
223 => irc_cmc_shd.g_old_rec.end_date
224 ,p_object_version_number_o
225 => irc_cmc_shd.g_old_rec.object_version_number
226 );
227 --
228 exception
229 --
230 when hr_api.cannot_find_prog_unit then
231 --
232 hr_api.cannot_find_prog_unit_error
233 (p_module_name => 'IRC_COMMUNICATIONS'
234 ,p_hook_type => 'AU');
235 --
236 end;
237 --
238 hr_utility.set_location(' Leaving:'||l_proc, 10);
239 End post_update;
240 --
241 -- ----------------------------------------------------------------------------
242 -- |-----------------------------< convert_defs >-----------------------------|
243 -- ----------------------------------------------------------------------------
244 -- {Start Of Comments}
245 --
246 -- Description:
247 -- The Convert_Defs procedure has one very important function:
248 -- It must return the record structure for the row with all system defaulted
249 -- values converted into its corresponding parameter value for update. When
250 -- we attempt to update a row through the Upd process , certain
251 -- parameters can be defaulted which enables flexibility in the calling of
252 -- the upd process (e.g. only attributes which need to be updated need to be
253 -- specified). For the upd process to determine which attributes
254 -- have NOT been specified we need to check if the parameter has a reserved
255 -- system default value. Therefore, for all parameters which have a
256 -- corresponding reserved system default mechanism specified we need to
257 -- check if a system default is being used. If a system default is being
258 -- used then we convert the defaulted value into its corresponding attribute
259 -- value held in the g_old_rec data structure.
260 --
261 -- Prerequisites:
262 -- This private function can only be called from the upd process.
263 --
264 -- In Parameters:
265 -- A Pl/Sql record structure.
266 --
267 -- Post Success:
268 -- The record structure will be returned with all system defaulted parameter
269 -- values converted into its current row attribute value.
270 --
271 -- Post Failure:
272 -- No direct error handling is required within this function. Any possible
273 -- errors within this procedure will be a PL/SQL value error due to
274 -- conversion of datatypes or data lengths.
275 --
276 -- Developer Implementation Notes:
277 -- None.
278 --
279 -- Access Status:
280 -- Internal Row Handler Use Only.
281 --
282 -- {End Of Comments}
283 -- ----------------------------------------------------------------------------
284 Procedure convert_defs
285 (p_rec in out nocopy irc_cmc_shd.g_rec_type
286 ) is
287 --
288 Begin
289 --
290 -- We must now examine each argument value in the
291 -- p_rec plsql record structure
292 -- to see if a system default is being used. If a system default
293 -- is being used then we must set to the 'current' argument value.
294 --
295 If (p_rec.communication_property_id = hr_api.g_number) then
296 p_rec.communication_property_id :=
297 irc_cmc_shd.g_old_rec.communication_property_id;
298 End If;
299 If (p_rec.object_type = hr_api.g_varchar2) then
300 p_rec.object_type :=
301 irc_cmc_shd.g_old_rec.object_type;
302 End If;
303 If (p_rec.object_id = hr_api.g_number) then
304 p_rec.object_id :=
305 irc_cmc_shd.g_old_rec.object_id;
306 End If;
307 If (p_rec.status = hr_api.g_varchar2) then
308 p_rec.status :=
309 irc_cmc_shd.g_old_rec.status;
310 End If;
311 If (p_rec.start_date = hr_api.g_date) then
312 p_rec.start_date :=
313 irc_cmc_shd.g_old_rec.start_date;
314 End If;
315 If (p_rec.end_date = hr_api.g_date) then
316 p_rec.end_date :=
317 irc_cmc_shd.g_old_rec.end_date;
318 End If;
319 --
320 End convert_defs;
321 --
322 -- ----------------------------------------------------------------------------
323 -- |---------------------------------< upd >----------------------------------|
324 -- ----------------------------------------------------------------------------
325 Procedure upd
326 (p_effective_date in date
327 ,p_rec in out nocopy irc_cmc_shd.g_rec_type
328 ) is
329 --
330 l_proc varchar2(72) := g_package||'upd';
331 --
332 Begin
333 hr_utility.set_location('Entering:'||l_proc, 5);
334 --
335 -- We must lock the row which we need to update.
336 --
337 irc_cmc_shd.lck
338 (p_rec.communication_id
339 ,p_rec.object_version_number
340 );
341 --
342 -- 1. During an update system defaults are used to determine if
343 -- arguments have been defaulted or not. We must therefore
344 -- derive the full record structure values to be updated.
345 --
346 -- 2. Call the supporting update validate operations.
347 --
348 convert_defs(p_rec);
349 irc_cmc_bus.update_validate
350 (p_effective_date
351 ,p_rec
352 );
353 --
354 -- Call to raise any errors on multi-message list
355 hr_multi_message.end_validation_set;
356 --
357 -- Call the supporting pre-update operation
358 --
359 irc_cmc_upd.pre_update(p_rec);
360 --
361 -- Update the row.
362 --
363 irc_cmc_upd.update_dml(p_rec);
364 --
365 -- Call the supporting post-update operation
366 --
367 --irc_cmc_upd.post_update
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 End upd;
375 --
376 -- ----------------------------------------------------------------------------
377 -- |---------------------------------< upd >----------------------------------|
378 -- ----------------------------------------------------------------------------
379 Procedure upd
380 (p_effective_date in date
381 ,p_communication_id in number
382 ,p_object_version_number in out nocopy number
383 ,p_communication_property_id in number default hr_api.g_number
384 ,p_object_type in varchar2 default hr_api.g_varchar2
385 ,p_object_id in number default hr_api.g_number
386 ,p_status in varchar2 default hr_api.g_varchar2
387 ,p_start_date in date default hr_api.g_date
388 ,p_end_date in date default hr_api.g_date
389 ) is
390 --
391 l_rec irc_cmc_shd.g_rec_type;
392 l_proc varchar2(72) := g_package||'upd';
393 --
394 Begin
395 hr_utility.set_location('Entering:'||l_proc, 5);
396 --
397 -- Call conversion function to turn arguments into the
398 -- l_rec structure.
399 --
400 l_rec :=
401 irc_cmc_shd.convert_args
402 (p_communication_id
403 ,p_communication_property_id
404 ,p_object_type
405 ,p_object_id
406 ,p_status
407 ,p_start_date
408 ,p_end_date
409 ,p_object_version_number
410 );
411 --
412 -- Having converted the arguments into the
413 -- plsql record structure we call the corresponding record
414 -- business process.
415 --
416 irc_cmc_upd.upd
417 (p_effective_date
418 ,l_rec
419 );
420 p_object_version_number := l_rec.object_version_number;
421 --
422 hr_utility.set_location(' Leaving:'||l_proc, 10);
423 End upd;
424 --
425 end irc_cmc_upd;