1 Package Body pay_sgb_upd as
2 /* $Header: pysgbrhi.pkb 115.3 2003/02/05 17:11:07 arashid noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- | Private Global Definitions |
6 -- ----------------------------------------------------------------------------
7 --
8 g_package varchar2(33) := ' pay_sgb_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_sgb_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_gu_bal_exclusions Row
69 --
70 update pay_shadow_gu_bal_exclusions
71 set
72 grossup_balances_id = p_rec.grossup_balances_id
73 ,source_id = p_rec.source_id
74 ,source_type = p_rec.source_type
75 ,balance_type_name = p_rec.balance_type_name
76 ,balance_type_id = p_rec.balance_type_id
77 ,exclusion_rule_id = p_rec.exclusion_rule_id
78 ,object_version_number = p_rec.object_version_number
79 where grossup_balances_id = p_rec.grossup_balances_id;
80 --
81 --
82 --
83 hr_utility.set_location(' Leaving:'||l_proc, 10);
84 --
85 Exception
86 When hr_api.check_integrity_violated Then
87 -- A check constraint has been violated
88 --
89 pay_sgb_shd.constraint_error
90 (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
91 When hr_api.parent_integrity_violated Then
92 -- Parent integrity has been violated
93 --
94 pay_sgb_shd.constraint_error
95 (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
96 When hr_api.unique_integrity_violated Then
97 -- Unique integrity has been violated
98 --
99 pay_sgb_shd.constraint_error
100 (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
101 When Others Then
102 --
103 Raise;
104 End update_dml;
105 --
106 -- ----------------------------------------------------------------------------
107 -- |------------------------------< pre_update >------------------------------|
108 -- ----------------------------------------------------------------------------
109 -- {Start Of Comments}
110 --
111 -- Description:
112 -- This private procedure contains any processing which is required before
113 -- the update dml.
114 --
115 -- Prerequisites:
116 -- This is an internal procedure which is called from the upd procedure.
117 --
118 -- In Parameters:
119 -- A Pl/Sql record structure.
120 --
121 -- Post Success:
122 -- Processing continues.
123 --
124 -- Post Failure:
125 -- If an error has occurred, an error message and exception wil be raised
126 -- but not handled.
127 --
128 -- Developer Implementation Notes:
129 -- Any pre-processing required before the update dml is issued should be
130 -- coded within this procedure. It is important to note that any 3rd party
131 -- maintenance should be reviewed before placing in this procedure.
132 --
133 -- Access Status:
134 -- Internal Row Handler Use Only.
135 --
136 -- {End Of Comments}
137 -- ----------------------------------------------------------------------------
138 Procedure pre_update
139 (p_rec in pay_sgb_shd.g_rec_type
140 ) is
141 --
142 l_proc varchar2(72) := g_package||'pre_update';
143 --
144 Begin
145 hr_utility.set_location('Entering:'||l_proc, 5);
146 --
147 hr_utility.set_location(' Leaving:'||l_proc, 10);
148 End pre_update;
149 --
150 -- ----------------------------------------------------------------------------
151 -- |-----------------------------< post_update >------------------------------|
152 -- ----------------------------------------------------------------------------
153 -- {Start Of Comments}
154 --
155 -- Description:
156 -- This private procedure contains any processing which is required after the
157 -- update dml.
158 --
159 -- Prerequisites:
160 -- This is an internal procedure which is called from the upd procedure.
161 --
162 -- In Parameters:
163 -- A Pl/Sql record structure.
164 --
165 -- Post Success:
166 -- Processing continues.
167 --
168 -- Post Failure:
169 -- If an error has occurred, an error message and exception will be raised
170 -- but not handled.
171 --
172 -- Developer Implementation Notes:
173 -- Any post-processing required after the update dml is issued should be
174 -- coded within this procedure. It is important to note that any 3rd party
175 -- maintenance should be reviewed before placing in this procedure.
176 --
177 -- Access Status:
178 -- Internal Row Handler Use Only.
179 --
180 -- {End Of Comments}
181 -- ----------------------------------------------------------------------------
182 Procedure post_update (p_rec in pay_sgb_shd.g_rec_type ) 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
203 -- the upd process (e.g. only attributes which need to be updated need to be
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
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_sgb_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.source_id = hr_api.g_number) then
247 p_rec.source_id :=
248 pay_sgb_shd.g_old_rec.source_id;
249 End If;
250 If (p_rec.source_type = hr_api.g_varchar2) then
251 p_rec.source_type :=
252 pay_sgb_shd.g_old_rec.source_type;
253 End If;
254 If (p_rec.balance_type_name = hr_api.g_varchar2) then
255 p_rec.balance_type_name :=
256 pay_sgb_shd.g_old_rec.balance_type_name;
257 End If;
258 If (p_rec.balance_type_id = hr_api.g_number) then
259 p_rec.balance_type_id :=
260 pay_sgb_shd.g_old_rec.balance_type_id;
261 End If;
262 If (p_rec.exclusion_rule_id = hr_api.g_number) then
263 p_rec.exclusion_rule_id :=
264 pay_sgb_shd.g_old_rec.exclusion_rule_id;
265 End If;
266 --
267 End convert_defs;
268 --
269 -- ----------------------------------------------------------------------------
270 -- |---------------------------------< upd >----------------------------------|
271 -- ----------------------------------------------------------------------------
272 Procedure upd
273 (p_effective_date in date
274 ,p_rec in out nocopy pay_sgb_shd.g_rec_type
275 ) is
276 --
277 l_proc varchar2(72) := g_package||'upd';
278 --
279 Begin
280 hr_utility.set_location('Entering:'||l_proc, 5);
281 --
282 -- We must lock the row which we need to update.
283 --
284 pay_sgb_shd.lck
285 (p_rec.grossup_balances_id
286 ,p_rec.object_version_number
287 );
288 --
289 -- 1. During an update system defaults are used to determine if
290 -- arguments have been defaulted or not. We must therefore
291 -- derive the full record structure values to be updated.
292 --
293 -- 2. Call the supporting update validate operations.
294 --
295 convert_defs(p_rec);
296 pay_sgb_bus.update_validate
297 (p_effective_date
298 ,p_rec
299 );
300 --
301 -- Call the supporting pre-update operation
302 --
303 pay_sgb_upd.pre_update(p_rec);
304 --
305 -- Update the row.
306 --
307 pay_sgb_upd.update_dml(p_rec);
308 --
309 -- Call the supporting post-update operation
310 --
311 pay_sgb_upd.post_update
312 (p_rec);
313 End upd;
314 --
315 -- ----------------------------------------------------------------------------
316 -- |---------------------------------< upd >----------------------------------|
317 -- ----------------------------------------------------------------------------
318 Procedure upd
319 (p_effective_date in date
320 ,p_grossup_balances_id in number
321 ,p_object_version_number in out nocopy number
322 ,p_source_id in number default hr_api.g_number
323 ,p_source_type in varchar2 default hr_api.g_varchar2
324 ,p_balance_type_name in varchar2 default hr_api.g_varchar2
325 ,p_balance_type_id in number default hr_api.g_number
326 ,p_exclusion_rule_id in number default hr_api.g_number
327 ) is
328 --
329 l_rec pay_sgb_shd.g_rec_type;
330 l_proc varchar2(72) := g_package||'upd';
331 --
332 Begin
333 hr_utility.set_location('Entering:'||l_proc, 5);
334 --
335 -- Call conversion function to turn arguments into the
336 -- l_rec structure.
337 --
338 l_rec :=
339 pay_sgb_shd.convert_args
340 (p_grossup_balances_id
341 ,p_source_id
342 ,p_source_type
343 ,p_balance_type_name
344 ,p_balance_type_id
345 ,p_exclusion_rule_id
346 ,p_object_version_number
347 );
348 --
349 -- Having converted the arguments into the
350 -- plsql record structure we call the corresponding record
351 -- business process.
352 --
353 pay_sgb_upd.upd
354 (p_effective_date
355 ,l_rec
356 );
357 p_object_version_number := l_rec.object_version_number;
358 --
359 hr_utility.set_location(' Leaving:'||l_proc, 10);
360 End upd;
361 --
362 end pay_sgb_upd;
[Home] [Help]