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