1 Package Body pay_sba_upd as
2 /* $Header: pysbarhi.pkb 120.0 2005/05/29 08:33 appldev noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- | Private Global Definitions |
6 -- ----------------------------------------------------------------------------
7 --
8 g_package varchar2(33) := ' pay_sba_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 pay_sba_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 pay_shadow_bal_attributes Row
69 --
70 update pay_shadow_bal_attributes
71 set
72 balance_attribute_id = p_rec.balance_attribute_id
73 ,attribute_name = p_rec.attribute_name
74 ,defined_balance_id = p_rec.defined_balance_id
75 ,object_version_number = p_rec.object_version_number
76 ,exclusion_rule_id = p_rec.exclusion_rule_id
77 where balance_attribute_id = p_rec.balance_attribute_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 pay_sba_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 pay_sba_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 pay_sba_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 pay_sba_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 pay_sba_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 --
189 hr_utility.set_location(' Leaving:'||l_proc, 10);
190 End post_update;
191 --
192 -- ----------------------------------------------------------------------------
193 -- |-----------------------------< convert_defs >-----------------------------|
194 -- ----------------------------------------------------------------------------
195 -- {Start Of Comments}
196 --
197 -- Description:
198 -- The Convert_Defs procedure has one very important function:
199 -- It must return the record structure for the row with all system defaulted
200 -- values converted into its corresponding parameter value for update. When
201 -- we attempt to update a row through the Upd process , certain
202 -- parameters can be defaulted which enables flexibility in the calling of
203 -- the upd process (e.g. only attributes which need to be updated need to be
204 -- specified). For the upd process to determine which attributes
205 -- have NOT been specified we need to check if the parameter has a reserved
206 -- system default value. Therefore, for all parameters which have a
207 -- corresponding reserved system default mechanism specified we need to
208 -- check if a system default is being used. If a system default is being
209 -- used then we convert the defaulted value into its corresponding attribute
210 -- value held in the g_old_rec data structure.
211 --
212 -- Prerequisites:
213 -- This private function can only be called from the upd process.
214 --
215 -- In Parameters:
216 -- A Pl/Sql record structure.
217 --
218 -- Post Success:
219 -- The record structure will be returned with all system defaulted parameter
220 -- values converted into its current row attribute value.
221 --
222 -- Post Failure:
223 -- No direct error handling is required within this function. Any possible
224 -- errors within this procedure will be a PL/SQL value error due to
225 -- conversion of datatypes or data lengths.
226 --
227 -- Developer Implementation Notes:
228 -- None.
229 --
230 -- Access Status:
231 -- Internal Row Handler Use Only.
232 --
233 -- {End Of Comments}
234 -- ----------------------------------------------------------------------------
235 Procedure convert_defs
236 (p_rec in out nocopy pay_sba_shd.g_rec_type
237 ) is
238 --
239 Begin
240 --
241 -- We must now examine each argument value in the
242 -- p_rec plsql record structure
243 -- to see if a system default is being used. If a system default
244 -- is being used then we must set to the 'current' argument value.
245 --
246 If (p_rec.attribute_name = hr_api.g_varchar2) then
247 p_rec.attribute_name :=
248 pay_sba_shd.g_old_rec.attribute_name;
249 End If;
250 If (p_rec.defined_balance_id = hr_api.g_number) then
251 p_rec.defined_balance_id :=
252 pay_sba_shd.g_old_rec.defined_balance_id;
253 End If;
254 If (p_rec.exclusion_rule_id = hr_api.g_number) then
255 p_rec.exclusion_rule_id :=
256 pay_sba_shd.g_old_rec.exclusion_rule_id;
257 End If;
258 --
259 End convert_defs;
260 --
261 -- ----------------------------------------------------------------------------
262 -- |---------------------------------< upd >----------------------------------|
263 -- ----------------------------------------------------------------------------
264 Procedure upd
265 (p_rec in out nocopy pay_sba_shd.g_rec_type
266 ) is
267 --
268 l_proc varchar2(72) := g_package||'upd';
269 --
270 Begin
271 hr_utility.set_location('Entering:'||l_proc, 5);
272 --
273 -- We must lock the row which we need to update.
274 --
275 pay_sba_shd.lck
276 (p_rec.balance_attribute_id
277 ,p_rec.object_version_number
278 );
279 --
280 -- 1. During an update system defaults are used to determine if
281 -- arguments have been defaulted or not. We must therefore
282 -- derive the full record structure values to be updated.
283 --
284 -- 2. Call the supporting update validate operations.
285 --
286 convert_defs(p_rec);
287 pay_sba_bus.update_validate
288 (p_rec
289 );
290 --
291 -- Call to raise any errors on multi-message list
292 hr_multi_message.end_validation_set;
293 --
294 -- Call the supporting pre-update operation
295 --
296 pay_sba_upd.pre_update(p_rec);
297 --
298 -- Update the row.
299 --
300 pay_sba_upd.update_dml(p_rec);
301 --
302 -- Call the supporting post-update operation
303 --
304 pay_sba_upd.post_update
305 (p_rec
306 );
307 --
308 -- Call to raise any errors on multi-message list
309 hr_multi_message.end_validation_set;
310 End upd;
311 --
312 -- ----------------------------------------------------------------------------
313 -- |---------------------------------< upd >----------------------------------|
314 -- ----------------------------------------------------------------------------
315 Procedure upd
316 (p_balance_attribute_id in number
317 ,p_object_version_number in out nocopy number
318 ,p_attribute_name in varchar2 default hr_api.g_varchar2
319 ,p_defined_balance_id in number default hr_api.g_number
320 ,p_exclusion_rule_id in number default hr_api.g_number
321 ) is
322 --
323 l_rec pay_sba_shd.g_rec_type;
324 l_proc varchar2(72) := g_package||'upd';
325 --
326 Begin
327 hr_utility.set_location('Entering:'||l_proc, 5);
328 --
329 -- Call conversion function to turn arguments into the
330 -- l_rec structure.
331 --
332 l_rec :=
333 pay_sba_shd.convert_args
334 (p_balance_attribute_id
335 ,p_attribute_name
336 ,p_defined_balance_id
337 ,p_object_version_number
338 ,p_exclusion_rule_id
339 );
340 --
341 -- Having converted the arguments into the
342 -- plsql record structure we call the corresponding record
343 -- business process.
344 --
345 pay_sba_upd.upd
346 (l_rec
347 );
348 p_object_version_number := l_rec.object_version_number;
349 --
350 hr_utility.set_location(' Leaving:'||l_proc, 10);
351 End upd;
352 --
353 end pay_sba_upd;
[Home] [Help]