1 Package Body pqh_doc_del as
2 /* $Header: pqdocrhi.pkb 120.2 2005/09/19 14:55:19 rthiagar noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- | Private Global Definitions |
6 -- ----------------------------------------------------------------------------
7 --
8 g_package varchar2(33) := ' pqh_doc_del.'; -- Global package name
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------------< dt_delete_dml >-----------------------------|
12 -- ----------------------------------------------------------------------------
13 -- {Start Of Comments}
14 --
15 -- Description:
16 -- This procedure controls the actual dml delete logic for the datetrack
17 -- delete modes: ZAP, DELETE, FUTURE_CHANGE and DELETE_NEXT_CHANGE. The
18 -- execution is as follows:
22 -- effective start date is equal to the validation start date.
19 -- 1) To set and unset the g_api_dml status as required (as we are about to
20 -- perform dml).
21 -- 2) If the delete mode is DELETE_NEXT_CHANGE then delete where the
23 -- 3) If the delete mode is not DELETE_NEXT_CHANGE then delete
24 -- all rows for the entity where the effective start date is greater
25 -- than or equal to the validation start date.
26 -- 4) To raise any errors.
27 --
28 -- Prerequisites:
29 -- This is an internal private procedure which must be called from the
30 -- delete_dml procedure.
31 --
32 -- In Parameters:
33 -- A Pl/Sql record structure.
34 --
35 -- Post Success:
36 -- The specified row will be delete from the schema.
37 --
38 -- Post Failure:
39 -- On the delete dml failure it is important to note that we always reset the
40 -- g_api_dml status to false.
41 -- If any other error is reported, the error will be raised after the
42 -- g_api_dml status is reset.
43 --
44 -- Developer Implementation Notes:
45 -- This is an internal private procedure which must be called from the
46 -- delete_dml procedure.
47 --
48 -- Access Status:
49 -- Internal Row Handler Use Only.
50 --
51 -- {End Of Comments}
52 -- ----------------------------------------------------------------------------
53 Procedure dt_delete_dml
54 (p_rec in out NOCOPY pqh_doc_shd.g_rec_type
55 ,p_effective_date in date
56 ,p_datetrack_mode in varchar2
57 ,p_validation_start_date in date
58 ,p_validation_end_date in date
59 ) is
60 --
61 l_proc varchar2(72) := g_package||'dt_delete_dml';
62 --
63 Begin
64 hr_utility.set_location('Entering:'||l_proc, 5);
65 If (p_datetrack_mode = hr_api.g_delete_next_change) then
66 pqh_doc_shd.g_api_dml := true; -- Set the api dml status
67 --
68 -- Delete the where the effective start date is equal
69 -- to the validation end date.
70 --
71 delete from pqh_documents_f
72 where document_id = p_rec.document_id
73 and effective_start_date = p_validation_start_date;
74 --
75 pqh_doc_shd.g_api_dml := false; -- Unset the api dml status
76 Else
77 pqh_doc_shd.g_api_dml := true; -- Set the api dml status
78 --
79 -- Delete the row(s) where the effective start date is greater than
80 -- or equal to the validation start date.
81 --
82 delete from pqh_documents_f
83 where document_id = p_rec.document_id
84 and effective_start_date >= p_validation_start_date;
85 --
86 pqh_doc_shd.g_api_dml := false; -- Unset the api dml status
87 End If;
88 --
89 hr_utility.set_location(' Leaving:'||l_proc, 20);
90 --
91 Exception
92 When Others Then
93 pqh_doc_shd.g_api_dml := false; -- Unset the api dml status
94 Raise;
95 --
96 End dt_delete_dml;
97 --
98 -- ----------------------------------------------------------------------------
99 -- |------------------------------< delete_dml >------------------------------|
100 -- ----------------------------------------------------------------------------
101 Procedure delete_dml
102 (p_rec in out NOCOPY pqh_doc_shd.g_rec_type
103 ,p_effective_date in date
104 ,p_datetrack_mode in varchar2
105 ,p_validation_start_date in date
106 ,p_validation_end_date in date
107 ) is
108 --
109 l_proc varchar2(72) := g_package||'delete_dml';
110 --
111 Begin
112 hr_utility.set_location('Entering:'||l_proc, 5);
113 --
114 pqh_doc_del.dt_delete_dml
115 (p_rec => p_rec
116 ,p_effective_date => p_effective_date
117 ,p_datetrack_mode => p_datetrack_mode
118 ,p_validation_start_date => p_validation_start_date
119 ,p_validation_end_date => p_validation_end_date
120 );
121 --
122 hr_utility.set_location(' Leaving:'||l_proc, 10);
123 End delete_dml;
124 --
125 -- ----------------------------------------------------------------------------
126 -- |----------------------------< dt_pre_delete >-----------------------------|
127 -- ----------------------------------------------------------------------------
128 -- {Start Of Comments}
129 --
130 -- Description:
131 -- The dt_pre_delete process controls the execution of dml
132 -- for the datetrack modes: DELETE, FUTURE_CHANGE
133 -- and DELETE_NEXT_CHANGE only.
134 --
135 -- Prerequisites:
136 -- This is an internal procedure which is called from the pre_delete
137 -- procedure.
138 --
139 -- In Parameters:
140 -- A Pl/Sql record structure.
141 --
142 -- Post Success:
143 -- Processing continues.
144 --
145 -- Post Failure:
146 -- If an error has occurred, an error message and exception will be raised
147 -- but not handled.
148 --
149 -- Developer Implementation Notes:
150 -- This is an internal procedure which is required by Datetrack. Don't
151 -- remove or modify.
152 --
153 -- Access Status:
154 -- Internal Row Handler Use Only.
155 --
156 -- {End Of Comments}
157 -- ----------------------------------------------------------------------------
158 Procedure dt_pre_delete
159 (p_rec in out NOCOPY pqh_doc_shd.g_rec_type
160 ,p_effective_date in date
161 ,p_datetrack_mode in varchar2
165 --
162 ,p_validation_start_date in date
163 ,p_validation_end_date in date
164 ) is
166 l_proc varchar2(72) := g_package||'dt_pre_delete';
167 --
168 Begin
169 hr_utility.set_location('Entering:'||l_proc, 5);
170 --
171 If (p_datetrack_mode <> hr_api.g_zap) then
172 --
173 p_rec.effective_start_date
174 := pqh_doc_shd.g_old_rec.effective_start_date;
175 --
176 If (p_datetrack_mode = hr_api.g_delete) then
177 p_rec.effective_end_date := p_validation_start_date - 1;
178 Else
179 p_rec.effective_end_date := p_validation_end_date;
180 End If;
181 --
182 -- Update the current effective end date record
183 --
184 pqh_doc_shd.upd_effective_end_date
185 (p_effective_date => p_effective_date
186 ,p_base_key_value => p_rec.document_id
187 ,p_new_effective_end_date => p_rec.effective_end_date
188 ,p_validation_start_date => p_validation_start_date
189 ,p_validation_end_date => p_validation_end_date
190 ,p_object_version_number => p_rec.object_version_number
191 );
192 Else
193 p_rec.effective_start_date := null;
194 p_rec.effective_end_date := null;
195 End If;
196 hr_utility.set_location(' Leaving:'||l_proc, 10);
197 End dt_pre_delete;
198 --
199 -- ----------------------------------------------------------------------------
200 -- |------------------------------< pre_delete >------------------------------|
201 -- ----------------------------------------------------------------------------
202 -- {Start Of Comments}
203 --
204 -- Description:
205 -- This private procedure contains any processing which is required before
206 -- the delete dml.
207 --
208 -- Prerequisites:
209 -- This is an internal procedure which is called from the del procedure.
210 --
211 -- In Parameters:
212 -- A Pl/Sql record structure.
213 --
214 -- Post Success:
215 -- Processing continues.
216 --
217 -- Post Failure:
218 -- If an error has occurred, an error message and exception will be raised
219 -- but not handled.
220 --
221 -- Developer Implementation Notes:
222 -- Any pre-processing required before the delete dml is issued should be
223 -- coded within this procedure. It is important to note that any 3rd party
224 -- maintenance should be reviewed before placing in this procedure. The call
225 -- to the dt_delete_dml procedure should NOT be removed.
226 --
227 -- Access Status:
228 -- Internal Row Handler Use Only.
229 --
230 -- {End Of Comments}
231 -- ----------------------------------------------------------------------------
232 Procedure pre_delete
233 (p_rec in out NOCOPY pqh_doc_shd.g_rec_type
234 ,p_effective_date in date
235 ,p_datetrack_mode in varchar2
236 ,p_validation_start_date in date
237 ,p_validation_end_date in date
238 ) is
239 --
240 l_proc varchar2(72) := g_package||'pre_delete';
241 --
242 --
243 --
244 Begin
245 hr_utility.set_location('Entering:'||l_proc, 5);
246 --
247 --
248 --
249 pqh_doc_del.dt_pre_delete
250 (p_rec => p_rec
251 ,p_effective_date => p_effective_date
252 ,p_datetrack_mode => p_datetrack_mode
253 ,p_validation_start_date => p_validation_start_date
254 ,p_validation_end_date => p_validation_end_date
255 );
256 --
257 hr_utility.set_location(' Leaving:'||l_proc, 10);
258 End pre_delete;
259 --
260 -- ----------------------------------------------------------------------------
261 -- |----------------------------< post_delete >-------------------------------|
262 -- ----------------------------------------------------------------------------
263 -- {Start Of Comments}
264 --
265 -- Description:
266 -- This private procedure contains any processing which is required after
267 -- the delete dml.
268 --
269 -- Prerequisites:
270 -- This is an internal procedure which is called from the del procedure.
271 --
272 -- In Parameters:
273 -- A Pl/Sql record structure.
274 --
275 -- Post Success:
276 -- Processing continues.
277 --
278 -- Post Failure:
279 -- If an error has occurred, an error message and exception will be raised
280 -- but not handled.
281 --
282 -- Developer Implementation Notes:
283 -- Any post-processing required after the delete dml is issued should be
284 -- coded within this procedure. It is important to note that any 3rd party
285 -- maintenance should be reviewed before placing in this procedure.
286 --
287 -- Access Status:
288 -- Internal Row Handler Use Only.
289 --
290 -- {End Of Comments}
291 -- ----------------------------------------------------------------------------
292 Procedure post_delete
293 (p_rec in pqh_doc_shd.g_rec_type
294 ,p_effective_date in date
295 ,p_datetrack_mode in varchar2
296 ,p_validation_start_date in date
297 ,p_validation_end_date in date
298 ) is
299 --
300 l_proc varchar2(72) := g_package||'post_delete';
301 --
302 Begin
303 hr_utility.set_location('Entering:'||l_proc, 5);
304 begin
305 --
306 pqh_doc_rkd.after_delete
307 (p_effective_date
308 => p_effective_date
309 ,p_datetrack_mode
310 => p_datetrack_mode
311 ,p_validation_start_date
312 => p_validation_start_date
313 ,p_validation_end_date
314 => p_validation_end_date
318 => p_rec.effective_start_date
315 ,p_document_id
316 => p_rec.document_id
317 ,p_effective_start_date
319 ,p_effective_end_date
320 => p_rec.effective_end_date
321 ,p_effective_start_date_o
322 => pqh_doc_shd.g_old_rec.effective_start_date
323 ,p_effective_end_date_o
324 => pqh_doc_shd.g_old_rec.effective_end_date
325 ,p_short_name_o
326 => pqh_doc_shd.g_old_rec.short_name
327 ,p_document_name_o
328 => pqh_doc_shd.g_old_rec.document_name
329 ,p_file_id_o
330 => pqh_doc_shd.g_old_rec.file_id
331 ,p_enable_flag_o
332 => pqh_doc_shd.g_old_rec.enable_flag
333 ,p_last_update_by_o
334 => pqh_doc_shd.g_old_rec.last_update_by
335 ,p_object_version_number_o
336 => pqh_doc_shd.g_old_rec.object_version_number
337 ,p_formula_id_o
338 => pqh_doc_shd.g_old_rec.formula_id
339 , p_document_category_o
340 => pqh_doc_shd.g_old_rec.document_category
341 /* Added for XDO Changes */
342 ,p_lob_code_o
343 => pqh_doc_shd.g_old_rec.lob_code
344 ,p_language_o
345 => pqh_doc_shd.g_old_rec.language
346 ,p_territory_o
347 => pqh_doc_shd.g_old_rec.territory
348 );
349 --
350 exception
351 --
352 when hr_api.cannot_find_prog_unit then
353 --
354 hr_api.cannot_find_prog_unit_error
355 (p_module_name => 'PQH_DOCUMENTS_F'
356 ,p_hook_type => 'AD');
357 --
358 end;
359 --
360 hr_utility.set_location(' Leaving:'||l_proc, 10);
361 End post_delete;
362 --
363 -- ----------------------------------------------------------------------------
364 -- |---------------------------------< del >----------------------------------|
365 -- ----------------------------------------------------------------------------
366 Procedure del
367 (p_effective_date in date
368 ,p_datetrack_mode in varchar2
369 ,p_rec in out NOCOPY pqh_doc_shd.g_rec_type
370 ) is
371 --
372 l_proc varchar2(72) := g_package||'del';
373 l_validation_start_date date;
374 l_validation_end_date date;
375 --
376 Begin
377 hr_utility.set_location('Entering:'||l_proc, 5);
378 --
379 -- Ensure that the DateTrack delete mode is valid
380 --
381 dt_api.validate_dt_del_mode(p_datetrack_mode => p_datetrack_mode);
382 --
383 -- We must lock the row which we need to delete.
384 --
385 pqh_doc_shd.lck
386 (p_effective_date => p_effective_date
387 ,p_datetrack_mode => p_datetrack_mode
388 ,p_document_id => p_rec.document_id
389 ,p_object_version_number => p_rec.object_version_number
390 ,p_validation_start_date => l_validation_start_date
391 ,p_validation_end_date => l_validation_end_date
392 );
393 --
394 -- Call the supporting delete validate operation
395 --
396 pqh_doc_bus.delete_validate
397 (p_rec => p_rec
398 ,p_effective_date => p_effective_date
399 ,p_datetrack_mode => p_datetrack_mode
400 ,p_validation_start_date => l_validation_start_date
401 ,p_validation_end_date => l_validation_end_date
402 );
403 --
404 -- Call to raise any errors on multi-message list
405 hr_multi_message.end_validation_set;
406 --
407 -- Call the supporting pre-delete operation
408 --
409 pqh_doc_del.pre_delete
410 (p_rec => p_rec
411 ,p_effective_date => p_effective_date
412 ,p_datetrack_mode => p_datetrack_mode
413 ,p_validation_start_date => l_validation_start_date
414 ,p_validation_end_date => l_validation_end_date
415 );
416 --
417 -- Delete the row.
418 --
419 pqh_doc_del.delete_dml
420 (p_rec => p_rec
421 ,p_effective_date => p_effective_date
422 ,p_datetrack_mode => p_datetrack_mode
423 ,p_validation_start_date => l_validation_start_date
424 ,p_validation_end_date => l_validation_end_date
425 );
426 -- Call the supporting post-delete operation
427 --
428 pqh_doc_del.post_delete
429 (p_rec => p_rec
430 ,p_effective_date => p_effective_date
431 ,p_datetrack_mode => p_datetrack_mode
432 ,p_validation_start_date => l_validation_start_date
433 ,p_validation_end_date => l_validation_end_date
434 );
435 --
436 -- Call to raise any errors on multi-message list
437 hr_multi_message.end_validation_set;
438 --
439 hr_utility.set_location(' Leaving:'||l_proc, 5);
440 End del;
441 --
442 -- ----------------------------------------------------------------------------
443 -- |--------------------------------< del >-----------------------------------|
444 -- ----------------------------------------------------------------------------
445 Procedure del
446 (p_effective_date in date
447 ,p_datetrack_mode in varchar2
448 ,p_document_id in number
449 ,p_object_version_number in out NOCOPY number
450 ,p_effective_start_date out NOCOPY date
451 ,p_effective_end_date out NOCOPY date
452 ) is
453 --
454 l_rec pqh_doc_shd.g_rec_type;
455 l_proc varchar2(72) := g_package||'del';
456 --
457 Begin
458 hr_utility.set_location('Entering:'||l_proc, 5);
459 --
460 -- As the delete procedure accepts a plsql record structure we do need to
461 -- convert the arguments into the record structure.
462 -- We don't need to call the supplied conversion argument routine as we
463 -- only need a few attributes.
464 --
465 l_rec.document_id := p_document_id;
466 l_rec.object_version_number := p_object_version_number;
467 --
468 -- Having converted the arguments into the pqh_doc_rec
469 -- plsql record structure we must call the corresponding entity
470 -- business process
471 --
472 pqh_doc_del.del
473 (p_effective_date
474 ,p_datetrack_mode
475 ,l_rec
476 );
477 --
478 --
479 -- Set the out arguments
480 --
481 p_object_version_number := l_rec.object_version_number;
482 p_effective_start_date := l_rec.effective_start_date;
483 p_effective_end_date := l_rec.effective_end_date;
484 --
485 hr_utility.set_location(' Leaving:'||l_proc, 10);
486 End del;
487 --
488 end pqh_doc_del;