DBA Data[Home] [Help]

PACKAGE: APPS.BEN_PRTT_RT_VAL_API

Source


1 Package ben_prtt_rt_val_api as
2 /* $Header: beprvapi.pkh 120.0.12000000.1 2007/01/19 22:14:35 appldev noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |------------------------< create_prtt_rt_val >------------------------|
6 -- ----------------------------------------------------------------------------
7 -- {Start Of Comments}
8 --
9 -- Description:
10 --
11 -- Prerequisites:
12 --
13 --
14 -- In Parameters:
15 --   Name                           Reqd Type     Description
16 --   p_validate                     Yes  boolean  Commit or Rollback.
17 --   p_rt_strt_dt                   Yes  date
18 --   p_rt_end_dt                    Yes  date
19 --   p_rt_typ_cd                    No   varchar2
20 --   p_tx_typ_cd                    No   varchar2
21 --   p_acty_typ_cd                  No   varchar2
22 --   p_ordr_num                     Yes  number
23 --   p_mlt_cd                       No   varchar2
24 --   p_acty_ref_perd_cd             No   varchar2
25 --   p_rt_val                       No   number
26 --   p_ann_rt_val                   No   number
27 --   p_cmcd_rt_val                  No   number
28 --   p_cmcd_ref_perd_cd             No   varchar2
29 --   p_bnft_rt_typ_cd               No   varchar2
30 --   p_dsply_on_enrt_flag           Yes  varchar2
31 --   p_rt_ovridn_flag               Yes  varchar2
32 --   p_rt_ovridn_thru_dt            No   date
33 --   p_elctns_made_dt               No   date
34 --   p_prtt_rt_val_stat_cd          No   varchar2
35 --   p_prtt_enrt_rslt_id            Yes  number
36 --   p_cvg_amt_calc_mthd_id         No   number
37 --   p_actl_prem_id                 No   number
38 --   p_comp_lvl_fctr_id             No   number
39 --   p_element_entry_value_id       No   number
40 --   p_per_in_ler_id                No   number
41 --   p_ended_per_in_ler_id          No   number
42 --   p_acty_base_rt_id              No   number
43 --   p_prtt_reimbmt_rqst_id         No   number
44 --   p_prtt_rmt_aprvd_fr_pymt_id    No   number
45 --   p_business_group_id            Yes  number    Business Group of Record
46 --   p_prv_attribute_category       No   varchar2  Descriptive Flexfield
47 --   p_prv_attribute1               No   varchar2  Descriptive Flexfield
48 --   p_prv_attribute2               No   varchar2  Descriptive Flexfield
49 --   p_prv_attribute3               No   varchar2  Descriptive Flexfield
50 --   p_prv_attribute4               No   varchar2  Descriptive Flexfield
51 --   p_prv_attribute5               No   varchar2  Descriptive Flexfield
52 --   p_prv_attribute6               No   varchar2  Descriptive Flexfield
53 --   p_prv_attribute7               No   varchar2  Descriptive Flexfield
54 --   p_prv_attribute8               No   varchar2  Descriptive Flexfield
55 --   p_prv_attribute9               No   varchar2  Descriptive Flexfield
56 --   p_prv_attribute10              No   varchar2  Descriptive Flexfield
57 --   p_prv_attribute11              No   varchar2  Descriptive Flexfield
58 --   p_prv_attribute12              No   varchar2  Descriptive Flexfield
59 --   p_prv_attribute13              No   varchar2  Descriptive Flexfield
60 --   p_prv_attribute14              No   varchar2  Descriptive Flexfield
61 --   p_prv_attribute15              No   varchar2  Descriptive Flexfield
62 --   p_prv_attribute16              No   varchar2  Descriptive Flexfield
63 --   p_prv_attribute17              No   varchar2  Descriptive Flexfield
64 --   p_prv_attribute18              No   varchar2  Descriptive Flexfield
65 --   p_prv_attribute19              No   varchar2  Descriptive Flexfield
66 --   p_prv_attribute20              No   varchar2  Descriptive Flexfield
67 --   p_prv_attribute21              No   varchar2  Descriptive Flexfield
68 --   p_prv_attribute22              No   varchar2  Descriptive Flexfield
69 --   p_prv_attribute23              No   varchar2  Descriptive Flexfield
70 --   p_prv_attribute24              No   varchar2  Descriptive Flexfield
71 --   p_prv_attribute25              No   varchar2  Descriptive Flexfield
72 --   p_prv_attribute26              No   varchar2  Descriptive Flexfield
73 --   p_prv_attribute27              No   varchar2  Descriptive Flexfield
74 --   p_prv_attribute28              No   varchar2  Descriptive Flexfield
75 --   p_prv_attribute29              No   varchar2  Descriptive Flexfield
76 --   p_prv_attribute30              No   varchar2  Descriptive Flexfield
77 --   p_pk_id_table_name             No   varchar2
78 --   p_pk_id                        No   number
79 --   p_effective_date           Yes  date      Session Date.
80 --
81 -- Post Success:
82 --
83 -- Out Parameters:
84 --   Name                                Type     Description
85 --   p_prtt_rt_val_id               Yes  number    PK of record
86 --   p_object_version_number        No   number    OVN of record
87 --
88 -- Post Failure:
89 --
90 -- Access Status:
91 --   Public.
92 --
93 -- {End Of Comments}
94 --
95 procedure create_prtt_rt_val
96 (
97    p_validate                       in boolean    default false
98   ,p_prtt_rt_val_id                 out nocopy number
99   ,p_enrt_rt_id			    in number default null
100   ,p_person_id                      in  number
101   ,p_input_value_id                 in  number
102   ,p_element_type_id                in  number
103   ,p_rt_strt_dt                     in  date      default null
104   ,p_rt_end_dt                      in  date      default null
105   ,p_rt_typ_cd                      in  varchar2  default null
106   ,p_tx_typ_cd                      in  varchar2  default null
107   ,p_ordr_num			    in  number    default null
108   ,p_acty_typ_cd                    in  varchar2  default null
109   ,p_mlt_cd                         in  varchar2  default null
110   ,p_acty_ref_perd_cd               in  varchar2  default null
111   ,p_rt_val                         in  number    default null
112   ,p_ann_rt_val                     in  number    default null
113   ,p_cmcd_rt_val                    in  number    default null
114   ,p_cmcd_ref_perd_cd               in  varchar2  default null
115   ,p_bnft_rt_typ_cd                 in  varchar2  default null
116   ,p_dsply_on_enrt_flag             in  varchar2  default 'N'
117   ,p_rt_ovridn_flag                 in  varchar2  default 'N'
118   ,p_rt_ovridn_thru_dt              in  date      default null
119   ,p_elctns_made_dt                 in  date      default null
120   ,p_prtt_rt_val_stat_cd            in  varchar2  default null
121   ,p_prtt_enrt_rslt_id              in  number    default null
122   ,p_cvg_amt_calc_mthd_id           in  number    default null
123   ,p_actl_prem_id                   in  number    default null
124   ,p_comp_lvl_fctr_id               in  number    default null
125   ,p_element_entry_value_id         in  number    default null
126   ,p_per_in_ler_id                  in  number    default null
127   ,p_ended_per_in_ler_id            in  number    default null
128   ,p_acty_base_rt_id                in  number    default null
129   ,p_prtt_reimbmt_rqst_id           in  number    default null
130   ,p_prtt_rmt_aprvd_fr_pymt_id      in  number    default null
131   ,p_pp_in_yr_used_num              in  number    default null
132   ,p_business_group_id              in  number    default null
133   ,p_prv_attribute_category         in  varchar2  default null
134   ,p_prv_attribute1                 in  varchar2  default null
135   ,p_prv_attribute2                 in  varchar2  default null
136   ,p_prv_attribute3                 in  varchar2  default null
137   ,p_prv_attribute4                 in  varchar2  default null
138   ,p_prv_attribute5                 in  varchar2  default null
139   ,p_prv_attribute6                 in  varchar2  default null
140   ,p_prv_attribute7                 in  varchar2  default null
141   ,p_prv_attribute8                 in  varchar2  default null
142   ,p_prv_attribute9                 in  varchar2  default null
143   ,p_prv_attribute10                in  varchar2  default null
144   ,p_prv_attribute11                in  varchar2  default null
145   ,p_prv_attribute12                in  varchar2  default null
146   ,p_prv_attribute13                in  varchar2  default null
147   ,p_prv_attribute14                in  varchar2  default null
148   ,p_prv_attribute15                in  varchar2  default null
149   ,p_prv_attribute16                in  varchar2  default null
150   ,p_prv_attribute17                in  varchar2  default null
151   ,p_prv_attribute18                in  varchar2  default null
152   ,p_prv_attribute19                in  varchar2  default null
153   ,p_prv_attribute20                in  varchar2  default null
154   ,p_prv_attribute21                in  varchar2  default null
155   ,p_prv_attribute22                in  varchar2  default null
156   ,p_prv_attribute23                in  varchar2  default null
157   ,p_prv_attribute24                in  varchar2  default null
158   ,p_prv_attribute25                in  varchar2  default null
159   ,p_prv_attribute26                in  varchar2  default null
160   ,p_prv_attribute27                in  varchar2  default null
161   ,p_prv_attribute28                in  varchar2  default null
162   ,p_prv_attribute29                in  varchar2  default null
163   ,p_prv_attribute30                in  varchar2  default null
164   ,p_pk_id_table_name               in  varchar2  default null
165   ,p_pk_id                          in  number    default null
166   ,p_object_version_number          out nocopy number
167   ,p_effective_date            in  date
168  );
169 -- ----------------------------------------------------------------------------
170 -- |------------------------< update_prtt_rt_val >------------------------|
171 -- ----------------------------------------------------------------------------
172 -- {Start Of Comments}
173 --
174 -- Description:
175 --
176 -- Prerequisites:
177 --
178 --
179 -- In Parameters:
180 --   Name                           Reqd Type     Description
181 --   p_validate                     Yes  boolean  Commit or Rollback.
182 --   p_prtt_rt_val_id               Yes  number    PK of record
183 --   p_rt_strt_dt                   Yes  date
184 --   p_rt_end_dt                    Yes  date
185 --   p_rt_typ_cd                    No   varchar2
186 --   p_tx_typ_cd                    No   varchar2
187 --   p_ordr_num                     Yes  number
188 --   p_acty_typ_cd                  No   varchar2
189 --   p_mlt_cd                       No   varchar2
190 --   p_acty_ref_perd_cd             No   varchar2
191 --   p_rt_val                       No   number
192 --   p_ann_rt_val                   No   number
193 --   p_cmcd_rt_val                  No   number
194 --   p_cmcd_ref_perd_cd             No   varchar2
195 --   p_bnft_rt_typ_cd               No   varchar2
196 --   p_dsply_on_enrt_flag           Yes  varchar2
197 --   p_rt_ovridn_flag               Yes  varchar2
198 --   p_rt_ovridn_thru_dt            No   date
199 --   p_elctns_made_dt               No   date
200 --   p_prtt_rt_val_stat_cd          No   varchar2
201 --   p_prtt_enrt_rslt_id            Yes  number
202 --   p_cvg_amt_calc_mthd_id         No   number
203 --   p_actl_prem_id                 No   number
204 --   p_comp_lvl_fctr_id             No   number
205 --   p_element_entry_value_id       No   number
206 --   p_per_in_ler_id                No   number
207 --   p_ended_per_in_ler_id          No   number
208 --   p_acty_base_rt_id              No   number
209 --   p_prtt_reimbmt_rqst_id         No   number
210 --   p_prtt_rmt_aprvd_fr_pymt_id    No   number
211 --   p_business_group_id            Yes  number    Business Group of Record
212 --   p_prv_attribute_category       No   varchar2  Descriptive Flexfield
213 --   p_prv_attribute1               No   varchar2  Descriptive Flexfield
214 --   p_prv_attribute2               No   varchar2  Descriptive Flexfield
215 --   p_prv_attribute3               No   varchar2  Descriptive Flexfield
216 --   p_prv_attribute4               No   varchar2  Descriptive Flexfield
217 --   p_prv_attribute5               No   varchar2  Descriptive Flexfield
218 --   p_prv_attribute6               No   varchar2  Descriptive Flexfield
219 --   p_prv_attribute7               No   varchar2  Descriptive Flexfield
220 --   p_prv_attribute8               No   varchar2  Descriptive Flexfield
221 --   p_prv_attribute9               No   varchar2  Descriptive Flexfield
222 --   p_prv_attribute10              No   varchar2  Descriptive Flexfield
223 --   p_prv_attribute11              No   varchar2  Descriptive Flexfield
224 --   p_prv_attribute12              No   varchar2  Descriptive Flexfield
225 --   p_prv_attribute13              No   varchar2  Descriptive Flexfield
226 --   p_prv_attribute14              No   varchar2  Descriptive Flexfield
227 --   p_prv_attribute15              No   varchar2  Descriptive Flexfield
228 --   p_prv_attribute16              No   varchar2  Descriptive Flexfield
229 --   p_prv_attribute17              No   varchar2  Descriptive Flexfield
230 --   p_prv_attribute18              No   varchar2  Descriptive Flexfield
231 --   p_prv_attribute19              No   varchar2  Descriptive Flexfield
232 --   p_prv_attribute20              No   varchar2  Descriptive Flexfield
233 --   p_prv_attribute21              No   varchar2  Descriptive Flexfield
234 --   p_prv_attribute22              No   varchar2  Descriptive Flexfield
235 --   p_prv_attribute23              No   varchar2  Descriptive Flexfield
236 --   p_prv_attribute24              No   varchar2  Descriptive Flexfield
237 --   p_prv_attribute25              No   varchar2  Descriptive Flexfield
238 --   p_prv_attribute26              No   varchar2  Descriptive Flexfield
239 --   p_prv_attribute27              No   varchar2  Descriptive Flexfield
240 --   p_prv_attribute28              No   varchar2  Descriptive Flexfield
241 --   p_prv_attribute29              No   varchar2  Descriptive Flexfield
242 --   p_prv_attribute30              No   varchar2  Descriptive Flexfield
243 --   p_pk_id_table_name             No   varchar2
244 --   p_pk_id                        No   number
245 --   p_effective_date          Yes  date       Session Date.
246 --
247 -- Post Success:
248 --
249 --   Name                           Type     Description
250 --   p_object_version_number        No   number    OVN of record
251 --
252 -- Post Failure:
253 --
254 -- Access Status:
255 --   Public.
256 --
257 -- {End Of Comments}
258 --
259 procedure update_prtt_rt_val
260   (
261    p_validate                       in boolean    default false
262   ,p_prtt_rt_val_id                 in  number
263   ,p_person_id                      in  number    default hr_api.g_number
264   ,p_input_value_id                 in  number    default hr_api.g_number
265   ,p_element_type_id                in  number    default hr_api.g_number
266   ,p_enrt_rt_id                     in  number    default hr_api.g_number
267   ,p_rt_strt_dt                     in  date      default hr_api.g_date
268   ,p_rt_end_dt                      in  date      default hr_api.g_date
269   ,p_rt_typ_cd                      in  varchar2  default hr_api.g_varchar2
270   ,p_tx_typ_cd                      in  varchar2  default hr_api.g_varchar2
271   ,p_ordr_num			    in number     default hr_api.g_number
272   ,p_acty_typ_cd                    in  varchar2  default hr_api.g_varchar2
273   ,p_mlt_cd                         in  varchar2  default hr_api.g_varchar2
274   ,p_acty_ref_perd_cd               in  varchar2  default hr_api.g_varchar2
275   ,p_rt_val                         in  number    default hr_api.g_number
276   ,p_ann_rt_val                     in  number    default hr_api.g_number
277   ,p_cmcd_rt_val                    in  number    default hr_api.g_number
278   ,p_cmcd_ref_perd_cd               in  varchar2  default hr_api.g_varchar2
279   ,p_bnft_rt_typ_cd                 in  varchar2  default hr_api.g_varchar2
280   ,p_dsply_on_enrt_flag             in  varchar2  default hr_api.g_varchar2
281   ,p_rt_ovridn_flag                 in  varchar2  default hr_api.g_varchar2
282   ,p_rt_ovridn_thru_dt              in  date      default hr_api.g_date
283   ,p_elctns_made_dt                 in  date      default hr_api.g_date
284   ,p_prtt_rt_val_stat_cd            in  varchar2  default hr_api.g_varchar2
285   ,p_prtt_enrt_rslt_id              in  number    default hr_api.g_number
286   ,p_cvg_amt_calc_mthd_id           in  number    default hr_api.g_number
287   ,p_actl_prem_id                   in  number    default hr_api.g_number
288   ,p_comp_lvl_fctr_id               in  number    default hr_api.g_number
289   ,p_element_entry_value_id         in  number    default hr_api.g_number
290   ,p_per_in_ler_id                  in  number    default hr_api.g_number
291   ,p_ended_per_in_ler_id            in  number    default hr_api.g_number
292   ,p_acty_base_rt_id                in  number    default hr_api.g_number
293   ,p_prtt_reimbmt_rqst_id           in  number    default hr_api.g_number
294   ,p_prtt_rmt_aprvd_fr_pymt_id      in  number    default hr_api.g_number
298   ,p_prv_attribute1                 in  varchar2  default hr_api.g_varchar2
295   ,p_pp_in_yr_used_num              in  number    default hr_api.g_number
296   ,p_business_group_id              in  number    default hr_api.g_number
297   ,p_prv_attribute_category         in  varchar2  default hr_api.g_varchar2
299   ,p_prv_attribute2                 in  varchar2  default hr_api.g_varchar2
300   ,p_prv_attribute3                 in  varchar2  default hr_api.g_varchar2
301   ,p_prv_attribute4                 in  varchar2  default hr_api.g_varchar2
302   ,p_prv_attribute5                 in  varchar2  default hr_api.g_varchar2
303   ,p_prv_attribute6                 in  varchar2  default hr_api.g_varchar2
304   ,p_prv_attribute7                 in  varchar2  default hr_api.g_varchar2
305   ,p_prv_attribute8                 in  varchar2  default hr_api.g_varchar2
306   ,p_prv_attribute9                 in  varchar2  default hr_api.g_varchar2
307   ,p_prv_attribute10                in  varchar2  default hr_api.g_varchar2
308   ,p_prv_attribute11                in  varchar2  default hr_api.g_varchar2
309   ,p_prv_attribute12                in  varchar2  default hr_api.g_varchar2
310   ,p_prv_attribute13                in  varchar2  default hr_api.g_varchar2
311   ,p_prv_attribute14                in  varchar2  default hr_api.g_varchar2
312   ,p_prv_attribute15                in  varchar2  default hr_api.g_varchar2
313   ,p_prv_attribute16                in  varchar2  default hr_api.g_varchar2
314   ,p_prv_attribute17                in  varchar2  default hr_api.g_varchar2
315   ,p_prv_attribute18                in  varchar2  default hr_api.g_varchar2
316   ,p_prv_attribute19                in  varchar2  default hr_api.g_varchar2
317   ,p_prv_attribute20                in  varchar2  default hr_api.g_varchar2
318   ,p_prv_attribute21                in  varchar2  default hr_api.g_varchar2
319   ,p_prv_attribute22                in  varchar2  default hr_api.g_varchar2
320   ,p_prv_attribute23                in  varchar2  default hr_api.g_varchar2
321   ,p_prv_attribute24                in  varchar2  default hr_api.g_varchar2
322   ,p_prv_attribute25                in  varchar2  default hr_api.g_varchar2
323   ,p_prv_attribute26                in  varchar2  default hr_api.g_varchar2
324   ,p_prv_attribute27                in  varchar2  default hr_api.g_varchar2
325   ,p_prv_attribute28                in  varchar2  default hr_api.g_varchar2
326   ,p_prv_attribute29                in  varchar2  default hr_api.g_varchar2
327   ,p_prv_attribute30                in  varchar2  default hr_api.g_varchar2
328   ,p_pk_id_table_name               in  varchar2  default hr_api.g_varchar2
329   ,p_pk_id                          in  number    default hr_api.g_number
330   ,p_no_end_element                 in  boolean   default false
331   ,p_object_version_number          in out nocopy number
332   ,p_effective_date            in  date
333   );
334 --
335 -- ----------------------------------------------------------------------------
336 -- |------------------------< delete_prtt_rt_val >------------------------|
337 -- ----------------------------------------------------------------------------
338 -- {Start Of Comments}
339 --
340 -- Description:
341 --
342 -- Prerequisites:
343 --
344 --
345 -- In Parameters:
346 --   Name                           Reqd Type     Description
347 --   p_validate                     Yes  boolean  Commit or Rollback.
348 --   p_prtt_rt_val_id               Yes  number    PK of record
349 --   p_effective_date          Yes  date     Session Date.
350 --
351 -- Post Success:
352 --
353 --   Name                           Type     Description
354 --   p_object_version_number        No   number    OVN of record
355 --
356 -- Post Failure:
357 --
358 -- Access Status:
359 --   Public.
360 --
361 -- {End Of Comments}
362 --
363 procedure delete_prtt_rt_val
364   (
365    p_validate                       in boolean        default false
366   ,p_prtt_rt_val_id                 in  number
367   ,p_enrt_rt_id			      in  number default null
368   ,p_person_id                      in  number
369   ,p_business_group_id              in  number
370   ,p_object_version_number          in out nocopy number
371   ,p_effective_date            in date
372   );
373 --
374 -- ----------------------------------------------------------------------------
375 -- |----------------------------------< lck >---------------------------------|
376 -- ----------------------------------------------------------------------------
377 -- {Start Of Comments}
378 --
379 -- Description:
380 --
381 -- Prerequisites:
382 --
383 --
384 -- In Parameters:
385 --   Name                           Reqd Type     Description
386 --   p_prtt_rt_val_id                 Yes  number   PK of record
387 --   p_object_version_number        Yes  number   OVN of record
388 --
389 -- Post Success:
390 --
391 --   Name                           Type     Description
392 --
393 -- Post Failure:
394 --
395 -- Access Status:
396 --   Public.
397 --
398 -- {End Of Comments}
399 --
400 procedure lck
401   (
402     p_prtt_rt_val_id                 in number
403    ,p_object_version_number        in number
404   );
405 --
406 --
407 -- ---------------------------------------------------------------------------
408 -- |------------------------< chk_overlapping_dates  >---------------------|
409 -- ---------------------------------------------------------------------------
410 --
411 procedure chk_overlapping_dates
412   (p_acty_base_rt_id                in  number
413   ,p_prtt_rt_val_id                 in  number
414   ,p_prtt_enrt_rslt_id              in  number
415   ,p_new_rt_strt_dt                 in  date
416   ,p_new_rt_end_dt                  in  date
417   );
418 --
419 -- ---------------------------------------------------------------------------
420 -- |------------------------< get_non_recurring_end_dt >---------------------|
421 -- ---------------------------------------------------------------------------
422 --
423 procedure get_non_recurring_end_dt
424 (  p_rt_strt_dt              date
425   ,p_acty_base_rt_id         number
426   ,p_business_group_id       number
427   ,p_rt_end_dt               in out nocopy date
428   ,p_recurring_rt            out nocopy boolean
429   ,p_effective_date          date
430  ) ;
431 --
432 function result_is_suspended
433 (  p_prtt_enrt_rslt_id              number
434   ,p_person_id                      number
435   ,p_business_group_id              number
436   ,p_effective_date                 date
437  ) return varchar2 ;
438 --
439 end ben_prtt_rt_val_api;