1 Package ben_cpp_shd AUTHID CURRENT_USER as
2 /* $Header: becpprhi.pkh 120.0.12020000.2 2012/07/03 12:05:05 amnaraya ship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- | Global Record Type Specification |
6 -- ----------------------------------------------------------------------------
7 --
8 Type g_rec_type Is Record
9 (
10 plip_id number(15),
11 effective_start_date date,
12 effective_end_date date,
13 business_group_id number(15),
14 pgm_id number(15),
15 pl_id number(15),
16 cmbn_plip_id number(15),
17 dflt_flag varchar2(30),
18 plip_stat_cd varchar2(30),
19 dflt_enrt_cd varchar2(30),
20 dflt_enrt_det_rl number(15),
21 ordr_num number(15),
22 alws_unrstrctd_enrt_flag varchar2(30),
23 auto_enrt_mthd_rl number(15),
24 enrt_cd varchar2(30),
25 enrt_mthd_cd varchar2(30),
26 enrt_rl number(15),
27 ivr_ident varchar2(90), -- UTF8 Change Bug 2254683
28 url_ref_name varchar2(240),
29 enrt_cvg_strt_dt_cd varchar2(30),
30 enrt_cvg_strt_dt_rl number(15),
31 enrt_cvg_end_dt_cd varchar2(30),
32 enrt_cvg_end_dt_rl number(15),
33 rt_strt_dt_cd varchar2(30),
34 rt_strt_dt_rl number(15),
35 rt_end_dt_cd varchar2(30),
36 rt_end_dt_rl number(15),
37 drvbl_fctr_apls_rts_flag varchar2(30),
38 drvbl_fctr_prtn_elig_flag varchar2(30),
39 elig_apls_flag varchar2(30),
40 prtn_elig_ovrid_alwd_flag varchar2(30),
41 trk_inelig_per_flag varchar2(30),
42 postelcn_edit_rl number(15),
43 dflt_to_asn_pndg_ctfn_cd varchar2(30),
44 dflt_to_asn_pndg_ctfn_rl number(15),
45 mn_cvg_amt number,
46 mn_cvg_rl number(15),
47 mx_cvg_alwd_amt number,
48 mx_cvg_incr_alwd_amt number,
49 mx_cvg_incr_wcf_alwd_amt number,
50 mx_cvg_mlt_incr_num number(15),
51 mx_cvg_mlt_incr_wcf_num number(15),
52 mx_cvg_rl number(15),
53 mx_cvg_wcfn_amt number,
54 mx_cvg_wcfn_mlt_num number(15),
55 no_mn_cvg_amt_apls_flag varchar2(30),
56 no_mn_cvg_incr_apls_flag varchar2(30),
57 no_mx_cvg_amt_apls_flag varchar2(30),
58 no_mx_cvg_incr_apls_flag varchar2(30),
59 unsspnd_enrt_cd varchar2(30),
60 prort_prtl_yr_cvg_rstrn_cd varchar2(30),
61 prort_prtl_yr_cvg_rstrn_rl number(15),
62 cvg_incr_r_decr_only_cd varchar2(30),
63 bnft_or_option_rstrctn_cd varchar2(30),
64 per_cvrd_cd varchar2(30),
65 short_name varchar2(30),
66 short_code varchar2(30),
67 legislation_code varchar2(30),
68 legislation_subgroup varchar2(30),
69 vrfy_fmly_mmbr_rl number(15),
70 vrfy_fmly_mmbr_cd varchar2(30),
71 use_csd_rsd_prccng_cd varchar2(30),
72 cpp_attribute_category varchar2(30),
73 cpp_attribute1 varchar2(150),
74 cpp_attribute2 varchar2(150),
75 cpp_attribute3 varchar2(150),
76 cpp_attribute4 varchar2(150),
77 cpp_attribute5 varchar2(150),
78 cpp_attribute6 varchar2(150),
79 cpp_attribute7 varchar2(150),
80 cpp_attribute8 varchar2(150),
81 cpp_attribute9 varchar2(150),
82 cpp_attribute10 varchar2(150),
83 cpp_attribute11 varchar2(150),
84 cpp_attribute12 varchar2(150),
85 cpp_attribute13 varchar2(150),
86 cpp_attribute14 varchar2(150),
87 cpp_attribute15 varchar2(150),
88 cpp_attribute16 varchar2(150),
89 cpp_attribute17 varchar2(150),
90 cpp_attribute18 varchar2(150),
91 cpp_attribute19 varchar2(150),
92 cpp_attribute20 varchar2(150),
93 cpp_attribute21 varchar2(150),
94 cpp_attribute22 varchar2(150),
95 cpp_attribute23 varchar2(150),
96 cpp_attribute24 varchar2(150),
97 cpp_attribute25 varchar2(150),
98 cpp_attribute26 varchar2(150),
99 cpp_attribute27 varchar2(150),
100 cpp_attribute28 varchar2(150),
101 cpp_attribute29 varchar2(150),
102 cpp_attribute30 varchar2(150),
103 all_inelig varchar2(30),
104 object_version_number number(9)
105 );
106 --
107 -- ----------------------------------------------------------------------------
108 -- | Global Definitions - Internal Development Use Only |
109 -- ----------------------------------------------------------------------------
110 --
111 g_old_rec g_rec_type; -- Global record definition
112 g_api_dml boolean; -- Global api dml status
113 --
114 -- ----------------------------------------------------------------------------
115 -- |------------------------< return_api_dml_status >-------------------------|
116 -- ----------------------------------------------------------------------------
117 -- {Start Of Comments}
118 --
119 -- Description:
120 -- This function will return the current g_api_dml private global
121 -- boolean status.
122 -- The g_api_dml status determines if at the time of the function
123 -- being executed if a dml statement (i.e. INSERT, UPDATE or DELETE)
124 -- is being issued from within an api.
125 -- If the status is TRUE then a dml statement is being issued from
126 -- within this entity api.
127 -- This function is primarily to support database triggers which
128 -- need to maintain the object_version_number for non-supported
129 -- dml statements (i.e. dml statement issued outside of the api layer).
130 --
131 -- Prerequisites:
132 -- None.
133 --
134 -- In Parameters:
135 -- None.
136 --
137 -- Post Success:
138 -- Processing continues.
139 -- If the function returns a TRUE value then, dml is being executed from
140 -- within this api.
141 --
142 -- Post Failure:
143 -- None.
144 --
145 -- Access Status:
146 -- Internal Row Handler Use Only.
147 --
148 -- {End Of Comments}
149 -- ----------------------------------------------------------------------------
150 Function return_api_dml_status Return Boolean;
151 --
152 -- ----------------------------------------------------------------------------
153 -- |---------------------------< constraint_error >---------------------------|
154 -- ----------------------------------------------------------------------------
155 -- {Start Of Comments}
156 --
157 -- Description:
158 -- This procedure is called when a constraint has been violated (i.e.
159 -- The exception hr_api.check_integrity_violated,
160 -- hr_api.parent_integrity_violated, hr_api.child_integrity_violated or
161 -- hr_api.unique_integrity_violated has been raised).
162 -- The exceptions can only be raised as follows:
163 -- 1) A check constraint can only be violated during an INSERT or UPDATE
164 -- dml operation.
165 -- 2) A parent integrity constraint can only be violated during an
166 -- INSERT or UPDATE dml operation.
167 -- 3) A child integrity constraint can only be violated during an
168 -- DELETE dml operation.
169 -- 4) A unique integrity constraint can only be violated during INSERT or
170 -- UPDATE dml operation.
171 --
172 -- Prerequisites:
173 -- 1) Either hr_api.check_integrity_violated,
174 -- hr_api.parent_integrity_violated, hr_api.child_integrity_violated or
175 -- hr_api.unique_integrity_violated has been raised with the subsequent
176 -- stripping of the constraint name from the generated error message
177 -- text.
178 -- 2) Standalone validation test which corresponds with a constraint error.
179 --
180 -- In Parameter:
181 -- p_constraint_name is in upper format and is just the constraint name
182 -- (e.g. not prefixed by brackets, schema owner etc).
183 --
184 -- Post Success:
185 -- Development dependant.
186 --
187 -- Post Failure:
188 -- Developement dependant.
189 --
190 -- Developer Implementation Notes:
191 -- For each constraint being checked the hr system package failure message
192 -- has been generated as a template only. These system error messages should
193 -- be modified as required (i.e. change the system failure message to a user
194 -- friendly defined error message).
195 --
196 -- Access Status:
197 -- Internal Development Use Only.
198 --
199 -- {End Of Comments}
200 -- ----------------------------------------------------------------------------
201 Procedure constraint_error
202 (p_constraint_name in all_constraints.constraint_name%TYPE);
203 --
204 -- ----------------------------------------------------------------------------
205 -- |-----------------------------< api_updating >-----------------------------|
206 -- ----------------------------------------------------------------------------
207 -- {Start Of Comments}
208 --
209 -- Description:
210 -- This function is used to populate the g_old_rec record with the current
211 -- row from the database for the specified primary key provided that the
212 -- primary key exists, and is valid, and does not already match the current
213 -- g_old_rec.
214 -- The function will always return a TRUE value if the g_old_rec is
215 -- populated with the current row. A FALSE value will be returned if all of
216 -- the primary key arguments are null.
217 --
218 -- Prerequisites:
219 -- None.
220 --
221 -- In Parameters:
222 --
223 -- Post Success:
224 -- A value of TRUE will be returned indiciating that the g_old_rec is
225 -- current.
226 -- A value of FALSE will be returned if all of the primary key arguments
227 -- have a null value (this indicates that the row has not be inserted into
228 -- the Schema), and therefore could never have a corresponding row.
229 --
230 -- Post Failure:
231 -- A failure can only occur under two circumstances:
232 -- 1) The primary key is invalid (i.e. a row does not exist for the
233 -- specified primary key values).
234 -- 2) If an object_version_number exists but is NOT the same as the current
235 -- g_old_rec value.
236 --
237 -- Developer Implementation Notes:
238 -- None.
239 --
240 -- Access Status:
241 -- Internal Development Use Only.
242 --
243 -- {End Of Comments}
244 -- ----------------------------------------------------------------------------
245 Function api_updating
246 (p_effective_date in date,
247 p_plip_id in number,
248 p_object_version_number in number
249 ) Return Boolean;
250 --
251 -- ----------------------------------------------------------------------------
252 -- |--------------------------< find_dt_del_modes >---------------------------|
253 -- ----------------------------------------------------------------------------
254 -- {Start Of Comments}
255 --
256 -- Description:
257 -- This procedure is used to determine what datetrack delete modes are
258 -- allowed as of the effective date for this entity. The procedure will
259 -- return a corresponding Boolean value for each of the delete modes
260 -- available where TRUE indicates that the corresponding delete mode is
261 -- available.
262 --
263 -- Prerequisites:
264 -- None.
265 --
266 -- In Parameters:
267 -- p_effective_date
268 -- Specifies the date at which the datetrack modes will be operated on.
269 -- p_base_key_value
270 -- Specifies the primary key value for this datetrack entity.
271 -- (E.g. For this entity the assignment of the argument would be:
272 -- p_base_key_value = :plip_id).
273 --
274 -- Post Success:
275 -- Processing continues.
276 --
277 -- Post Failure:
278 -- Failure might occur if for the specified effective date and primary key
279 -- value a row doesn't exist.
280 --
281 -- Developer Implementation Notes:
282 -- This procedure could require changes if this entity has any sepcific
283 -- delete restrictions.
284 -- For example, this entity might disallow the datetrack delete mode of
288 -- Access Status:
285 -- ZAP. To implement this you would have to set and return a Boolean value
286 -- of FALSE after the call to the dt_api.find_dt_del_modes procedure.
287 --
289 -- Internal Development Use Only.
290 --
291 -- {End Of Comments}
292 -- ----------------------------------------------------------------------------
293 Procedure find_dt_del_modes
294 (p_effective_date in date,
295 p_base_key_value in number,
296 p_zap out nocopy boolean,
297 p_delete out nocopy boolean,
298 p_future_change out nocopy boolean,
299 p_delete_next_change out nocopy boolean);
300 --
301 -- ----------------------------------------------------------------------------
302 -- |--------------------------< find_dt_upd_modes >---------------------------|
303 -- ----------------------------------------------------------------------------
304 -- {Start Of Comments}
305 --
306 -- Description:
307 -- This procedure is used to determine what datetrack update modes are
308 -- allowed as of the effective date for this entity. The procedure will
309 -- return a corresponding Boolean value for each of the update modes
310 -- available where TRUE indicates that the corresponding update mode
311 -- is available.
312 --
313 -- Prerequisites:
314 -- None.
315 --
316 -- In Parameters:
317 -- p_effective_date
318 -- Specifies the date at which the datetrack modes will be operated on.
319 -- p_base_key_value
320 -- Specifies the primary key value for this datetrack entity.
321 -- (E.g. For this entity the assignment of the argument would be:
322 -- p_base_key_value = :plip_id).
323 --
324 -- Post Success:
325 -- Processing continues.
326 --
327 -- Post Failure:
328 -- Failure might occur if for the specified effective date and primary key
329 -- value a row doesn't exist.
330 --
331 -- Developer Implementation Notes:
332 -- This procedure could require changes if this entity has any sepcific
333 -- delete restrictions.
334 -- For example, this entity might disallow the datetrack update mode of
335 -- UPDATE. To implement this you would have to set and return a Boolean
336 -- value of FALSE after the call to the dt_api.find_dt_upd_modes procedure.
337 --
338 -- Access Status:
339 -- Internal Development Use Only.
340 --
341 -- {End Of Comments}
342 -- ----------------------------------------------------------------------------
343 Procedure find_dt_upd_modes
344 (p_effective_date in date,
345 p_base_key_value in number,
346 p_correction out nocopy boolean,
347 p_update out nocopy boolean,
348 p_update_override out nocopy boolean,
349 p_update_change_insert out nocopy boolean);
350 --
351 -- ----------------------------------------------------------------------------
352 -- |------------------------< upd_effective_end_date >------------------------|
353 -- ----------------------------------------------------------------------------
354 -- {Start Of Comments}
355 --
356 -- Description:
357 -- This procedure will update the specified datetrack row with the
358 -- specified new effective end date. The object version number is also
359 -- set to the next object version number. DateTrack modes which call
360 -- this procedure are: UPDATE, UPDATE_CHANGE_INSERT,
361 -- UPDATE_OVERRIDE, DELETE, FUTURE_CHANGE and DELETE_NEXT_CHANGE.
362 -- This is an internal datetrack maintenance procedure which should
363 -- not be modified in anyway.
364 --
365 -- Prerequisites:
366 -- None.
367 --
368 -- In Parameters:
369 -- p_new_effective_end_date
370 -- Specifies the new effective end date which will be set for the
371 -- row as of the effective date.
372 -- p_base_key_value
373 -- Specifies the primary key value for this datetrack entity.
374 -- (E.g. For this entity the assignment of the argument would be:
375 -- p_base_key_value = :plip_id).
376 --
377 -- Post Success:
378 -- The specified row will be updated with the new effective end date and
379 -- object_version_number.
380 --
381 -- Post Failure:
382 -- Failure might occur if for the specified effective date and primary key
383 -- value a row doesn't exist.
384 --
385 -- Developer Implementation Notes:
386 -- This is an internal datetrack maintenance procedure which should
387 -- not be modified in anyway.
388 --
389 -- Access Status:
390 -- Internal Row Handler Use Only.
391 --
392 -- {End Of Comments}
393 -- ----------------------------------------------------------------------------
394 Procedure upd_effective_end_date
395 (p_effective_date in date,
396 p_base_key_value in number,
397 p_new_effective_end_date in date,
398 p_validation_start_date in date,
399 p_validation_end_date in date,
400 p_object_version_number out nocopy number);
401 --
402 -- ----------------------------------------------------------------------------
403 -- |---------------------------------< lck >----------------------------------|
404 -- ----------------------------------------------------------------------------
405 -- {Start Of Comments}
406 --
407 -- Description:
408 -- The Lck process for datetrack is complicated and comprises of the
409 -- following processing
410 -- The processing steps are as follows:
411 -- 1) The row to be updated or deleted must be locked.
412 -- By locking this row, the g_old_rec record data type is populated.
413 -- 2) If a comment exists the text is selected from hr_comments.
414 -- 3) The datetrack mode is then validated to ensure the operation is
415 -- valid. If the mode is valid the validation start and end dates for
416 -- the mode will be derived and returned. Any required locking is
417 -- completed when the datetrack mode is validated.
418 --
422 --
419 -- Prerequisites:
420 -- When attempting to call the lck procedure the object version number,
421 -- primary key, effective date and datetrack mode must be specified.
423 -- In Parameters:
424 -- p_effective_date
425 -- Specifies the date of the datetrack update operation.
426 -- p_datetrack_mode
427 -- Determines the datetrack update or delete mode.
428 --
429 -- Post Success:
430 -- On successful completion of the Lck process the row to be updated or
431 -- deleted will be locked and selected into the global data structure
432 -- g_old_rec.
433 --
434 -- Post Failure:
435 -- The Lck process can fail for three reasons:
436 -- 1) When attempting to lock the row the row could already be locked by
437 -- another user. This will raise the HR_Api.Object_Locked exception.
438 -- 2) The row which is required to be locked doesn't exist in the HR Schema.
439 -- This error is trapped and reported using the message name
440 -- 'HR_7220_INVALID_PRIMARY_KEY'.
441 -- 3) The row although existing in the HR Schema has a different object
442 -- version number than the object version number specified.
443 -- This error is trapped and reported using the message name
444 -- 'HR_7155_OBJECT_INVALID'.
445 --
446 -- Developer Implementation Notes:
447 -- None.
448 --
449 -- Access Status:
450 -- Internal Development Use Only.
451 --
452 -- {End Of Comments}
453 -- ----------------------------------------------------------------------------
454 Procedure lck
455 (p_effective_date in date,
456 p_datetrack_mode in varchar2,
457 p_plip_id in number,
458 p_object_version_number in number,
459 p_validation_start_date out nocopy date,
460 p_validation_end_date out nocopy date);
461 --
462 -- ----------------------------------------------------------------------------
463 -- |-----------------------------< convert_args >-----------------------------|
464 -- ----------------------------------------------------------------------------
465 -- {Start Of Comments}
466 --
467 -- Description:
468 -- This function is used to turn attribute parameters into the record
469 -- structure parameter g_rec_type.
470 --
471 -- Prerequisites:
472 -- This is a private function and can only be called from the ins or upd
473 -- attribute processes.
474 --
475 -- In Parameters:
476 --
477 -- Post Success:
478 -- A returning record structure will be returned.
479 --
480 -- Post Failure:
481 -- No direct error handling is required within this function. Any possible
482 -- errors within this function will be a PL/SQL value error due to conversion
483 -- of datatypes or data lengths.
484 --
485 -- Developer Implementation Notes:
486 -- None.
487 --
488 -- Access Status:
489 -- Internal Row Handler Use Only.
490 --
491 -- {End Of Comments}
492 -- ----------------------------------------------------------------------------
493 Function convert_args
494 (
495 p_plip_id in number,
496 p_effective_start_date in date,
497 p_effective_end_date in date,
498 p_business_group_id in number,
499 p_pgm_id in number,
500 p_pl_id in number,
501 p_cmbn_plip_id in number,
502 p_dflt_flag in varchar2,
503 p_plip_stat_cd in varchar2,
504 p_dflt_enrt_cd in varchar2,
505 p_dflt_enrt_det_rl in number,
506 p_ordr_num in number,
507 p_alws_unrstrctd_enrt_flag in varchar2,
508 p_auto_enrt_mthd_rl in number,
509 p_enrt_cd in varchar2,
510 p_enrt_mthd_cd in varchar2,
511 p_enrt_rl in number,
512 p_ivr_ident in varchar2,
513 p_url_ref_name in varchar2,
514 p_enrt_cvg_strt_dt_cd in varchar2,
515 p_enrt_cvg_strt_dt_rl in number,
516 p_enrt_cvg_end_dt_cd in varchar2,
517 p_enrt_cvg_end_dt_rl in number,
518 p_rt_strt_dt_cd in varchar2,
519 p_rt_strt_dt_rl in number,
520 p_rt_end_dt_cd in varchar2,
521 p_rt_end_dt_rl in number,
522 p_drvbl_fctr_apls_rts_flag in varchar2,
523 p_drvbl_fctr_prtn_elig_flag in varchar2,
524 p_elig_apls_flag in varchar2,
525 p_prtn_elig_ovrid_alwd_flag in varchar2,
526 p_trk_inelig_per_flag in varchar2,
527 p_postelcn_edit_rl in number,
528 p_dflt_to_asn_pndg_ctfn_cd in varchar2,
529 p_dflt_to_asn_pndg_ctfn_rl in number,
530 p_mn_cvg_amt in number,
531 p_mn_cvg_rl in number,
532 p_mx_cvg_alwd_amt in number,
533 p_mx_cvg_incr_alwd_amt in number,
534 p_mx_cvg_incr_wcf_alwd_amt in number,
535 p_mx_cvg_mlt_incr_num in number,
536 p_mx_cvg_mlt_incr_wcf_num in number,
537 p_mx_cvg_rl in number,
538 p_mx_cvg_wcfn_amt in number,
539 p_mx_cvg_wcfn_mlt_num in number,
540 p_no_mn_cvg_amt_apls_flag in varchar2,
541 p_no_mn_cvg_incr_apls_flag in varchar2,
542 p_no_mx_cvg_amt_apls_flag in varchar2,
543 p_no_mx_cvg_incr_apls_flag in varchar2,
544 p_unsspnd_enrt_cd in varchar2,
545 p_prort_prtl_yr_cvg_rstrn_cd in varchar2,
546 p_prort_prtl_yr_cvg_rstrn_rl in number,
547 p_cvg_incr_r_decr_only_cd in varchar2,
548 p_bnft_or_option_rstrctn_cd in varchar2,
549 p_per_cvrd_cd in varchar2,
550 p_short_name in varchar2,
551 p_short_code in varchar2,
552 p_legislation_code in varchar2,
553 p_legislation_subgroup in varchar2,
554 P_vrfy_fmly_mmbr_rl in number,
555 P_vrfy_fmly_mmbr_cd in varchar2,
556 P_use_csd_rsd_prccng_cd in varchar2,
557 p_cpp_attribute_category in varchar2,
558 p_cpp_attribute1 in varchar2,
559 p_cpp_attribute2 in varchar2,
560 p_cpp_attribute3 in varchar2,
561 p_cpp_attribute4 in varchar2,
562 p_cpp_attribute5 in varchar2,
563 p_cpp_attribute6 in varchar2,
564 p_cpp_attribute7 in varchar2,
565 p_cpp_attribute8 in varchar2,
566 p_cpp_attribute9 in varchar2,
567 p_cpp_attribute10 in varchar2,
568 p_cpp_attribute11 in varchar2,
569 p_cpp_attribute12 in varchar2,
570 p_cpp_attribute13 in varchar2,
571 p_cpp_attribute14 in varchar2,
572 p_cpp_attribute15 in varchar2,
573 p_cpp_attribute16 in varchar2,
574 p_cpp_attribute17 in varchar2,
575 p_cpp_attribute18 in varchar2,
576 p_cpp_attribute19 in varchar2,
577 p_cpp_attribute20 in varchar2,
578 p_cpp_attribute21 in varchar2,
579 p_cpp_attribute22 in varchar2,
580 p_cpp_attribute23 in varchar2,
581 p_cpp_attribute24 in varchar2,
582 p_cpp_attribute25 in varchar2,
583 p_cpp_attribute26 in varchar2,
584 p_cpp_attribute27 in varchar2,
585 p_cpp_attribute28 in varchar2,
586 p_cpp_attribute29 in varchar2,
587 p_cpp_attribute30 in varchar2,
588 p_all_inelig in varchar2,
589 p_object_version_number in number
590 )
591 Return g_rec_type;
592 --
593 end ben_cpp_shd;
[Home] [Help]