1 Package BEN_CWB_PL_DSGN_API as
2 /* $Header: becpdapi.pkh 120.3 2006/08/16 08:27:13 steotia noship $ */
3 /*#
4 * This package contains Compensation Workbench Plan Design APIs.
5 * @rep:scope public
6 * @rep:product PER
7 * @rep:displayname Compensation Workbench Plan Design
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |--------------------------< create_plan_or_option >-----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates compensation workbench plan and option information.
17 *
18 * This API information is used by all self-service pages that create plan
19 * design data.
20 *
21 * <p><b>Licensing</b><br>
22 * This API is licensed for use with Human Resources.
23 *
24 * <p><b>Prerequisites</b><br>
25 * A valid plan/option for Compensation Workbench must exist.
26 *
27 * <p><b>Post Success</b><br>
28 * A Compensation Workbench Plan will have been created in the database.
29 *
30 * <p><b>Post Failure</b><br>
31 * A Compensation Workbench Plan will not be created in the database.
32 *
33 * @param p_validate If true, then validation alone will be performed and the
34 * database will remain unchanged. If false and all validation checks pass,
35 * then the database will be modified.
36 * @param p_pl_id Specifies the Compensation Workbench Plan.
37 * @param p_oipl_id Specifies options for Compensation Workbench Plan.
38 * @param p_lf_evt_ocrd_dt {@rep:casecolumn BEN_CWB_PL_DSGN.LF_EVT_OCRD_DT}
39 * @param p_effective_date Determines when the DateTrack operation comes into
40 * force.
41 * @param p_name This parameter specifies the Compensation Workbench Plan name.
42 * @param p_group_pl_id This parameter specifies Compensation Workbench Group
43 * Plan.
44 * @param p_group_oipl_id Specifies options for a Compensation Workbench Group
45 * Plan.
46 * @param p_opt_hidden_flag This parameter specifies if the Compensation
47 * Workbench Plan options will be displayed in the SS pages.
48 * @param p_opt_id This parameter specifies the option and is foreign Key to
49 * BEN_OPT_F.
50 * @param p_pl_uom This parameter specifies the Compensation Workbench Plan
51 * currency.
52 * @param p_pl_ordr_num This parameter specifiesthe Compensation Workbench Plan
53 * order number.
54 * @param p_oipl_ordr_num This parameter specifiesthe Compensation Workbench
55 * Plan options order number.
56 * @param p_pl_xchg_rate This parameter specifies the exchange rate for
57 * Compensation Workbench Plan currency.
58 * @param p_opt_count This parameter keeps count of plan options.
59 * @param p_uses_bdgt_flag This parameter specifies if budgeting is used or
60 * not.
61 * @param p_prsrv_bdgt_cd This parameter specifies if budget is stored as
62 * amount or percentage of eligible salaries.
63 * @param p_upd_start_dt Self Service update start date
64 * @param p_upd_end_dt Self Service update end date
65 * @param p_approval_mode This parameter specifies approval mode for
66 * allocations submission. Valid values are defined in 'BEN_CWB_APPROVAL_MODE'
67 * lookup type.
68 * @param p_enrt_perd_start_dt {@rep:casecolumn
69 * BEN_CWB_PL_DSGN.ENRT_PERD_START_DT}
70 * @param p_enrt_perd_end_dt {@rep:casecolumn BEN_CWB_PL_DSGN.ENRT_PERD_END_DT}
71 * @param p_yr_perd_start_dt {@rep:casecolumn BEN_CWB_PL_DSGN.YR_PERD_START_DT}
72 * @param p_yr_perd_end_dt {@rep:casecolumn BEN_CWB_PL_DSGN.YR_PERD_END_DT}
73 * @param p_wthn_yr_start_dt {@rep:casecolumn BEN_CWB_PL_DSGN.WTHN_YR_START_DT}
74 * @param p_wthn_yr_end_dt {@rep:casecolumn BEN_CWB_PL_DSGN.WTHN_YR_END_DT}
75 * @param p_enrt_perd_id {@rep:casecolumn BEN_CWB_PL_DSGN.ENRT_PERD_ID}
76 * @param p_yr_perd_id {@rep:casecolumn BEN_CWB_PL_DSGN.YR_PERD_ID}
77 * @param p_business_group_id {@rep:casecolumn
78 * PER_ALL_ASSIGNMENTS_F.BUSINESS_GROUP_ID}
79 * @param p_perf_revw_strt_dt {@rep:casecolumn BEN_ENRT_PERD.PERF_REVW_STRT_DT}
80 * @param p_asg_updt_eff_date {@rep:casecolumn BEN_ENRT_PERD.ASG_UPDT_EFF_DATE}
81 * @param p_emp_interview_typ_cd This parameter specifies performance rating
82 * type. It specifies the valid values defined in 'EMP_INTERVIEW_TYPE' lookup
83 * type.
84 * @param p_salary_change_reason {@rep:casecolumn
85 * BEN_CWB_PL_DSGN.SALARY_CHANGE_REASON}
86 * @param p_ws_abr_id This parameter specifies worksheet rate. It is null if no
87 * worksheet rate is defined.
88 * @param p_ws_nnmntry_uom This parameter specifies the non-monetory units of
89 * measure such as stocks.
90 * @param p_ws_rndg_cd This parameter specifies the numeric rounding parameter.
91 * Valid values are defined in 'BEN_RNDG' lookup type.
92 * @param p_ws_sub_acty_typ_cd This parameter specifies worksheet rate sub
93 * activity type code. Valid values are defined in 'BEN_SUB_ACTY_TYP' lookup
94 * type.
95 * @param p_dist_bdgt_abr_id This parameter specifies distribution budget rate.
96 * @param p_dist_bdgt_nnmntry_uom This parameter specifies the non-monetory
97 * units of measure such as stocks.
98 * @param p_dist_bdgt_rndg_cd This parameter specifies the numeric rounding
99 * parameter. Valid values defined are in 'BEN_RNDG' lookup type.
100 * @param p_ws_bdgt_abr_id This parameter specifies worksheet budget rate.
101 * @param p_ws_bdgt_nnmntry_uom This parameter specifies the non-monetory units
102 * of measure such as stocks.
103 * @param p_ws_bdgt_rndg_cd This parameter specifies the numeric rounding
104 * parameter. Valid values are defined in 'BEN_RNDG' lookup type.
105 * @param p_rsrv_abr_id This parameter specifies reserve budget rate.
106 * @param p_rsrv_nnmntry_uom This parameter specifies the non-monetory units of
107 * measure such as stocks.
108 * @param p_rsrv_rndg_cd This parameter specifies the numeric rounding
109 * parameter. Valid values defined are in 'BEN_RNDG' lookup type.
110 * @param p_elig_sal_abr_id This parameter specifies eligible salary rate.
111 * @param p_elig_sal_nnmntry_uom This parameter specifies the non-monetory
112 * units of measure such as stocks.
113 * @param p_elig_sal_rndg_cd This parameter specifies the non-monetory units of
114 * measure such as stocks.
115 * @param p_misc1_abr_id This parameter specifies miscellaneous 1 rate.
116 * @param p_misc1_nnmntry_uom This parameter specifies the non-monetory units
117 * of measure such as stocks.
118 * @param p_misc1_rndg_cd This parameter specifies the numeric rounding
119 * parameter. Valid values are defined in 'BEN_RNDG' lookup type.
120 * @param p_misc2_abr_id This parameter specifies miscellaneous 2 rate.
121 * @param p_misc2_nnmntry_uom This parameter specifies the non-monetory units
122 * of measure such as stocks.
123 * @param p_misc2_rndg_cd This parameter specifies the numeric rounding
124 * parameter. Valid values are defined in 'BEN_RNDG' lookup type.
125 * @param p_misc3_abr_id This parameter specifies miscellaneous 3 rate.
126 * @param p_misc3_nnmntry_uom This parameter specifies the non-monetory units
127 * of measure such as stocks.
128 * @param p_misc3_rndg_cd This parameter specifies the numeric rounding
129 * parameter. Valid values defined in 'BEN_RNDG' lookup type.
130 * @param p_stat_sal_abr_id This parameter specifies the stated salary rate.
131 * @param p_stat_sal_nnmntry_uom This parameter specifies the non-monetory
132 * units of measure such as stocks.
133 * @param p_stat_sal_rndg_cd This parameter specifies the numeric rounding
134 * parameter. Valid values defined in 'BEN_RNDG' lookup type.
135 * @param p_rec_abr_id This parameter specifies the recommended rate.
136 * @param p_rec_nnmntry_uom This parameter specifies the non-monetory units of
137 * measure such as stocks.
138 * @param p_rec_rndg_cd This parameter specifies the numeric rounding
139 * parameter. Valid values are defined in 'BEN_RNDG' lookup type.
140 * @param p_tot_comp_abr_id This parameter specifies the total compensation.
141 * @param p_tot_comp_nnmntry_uom This parameter specifies the non-monetory
142 * units of measure such as stocks.
143 * @param p_tot_comp_rndg_cd This parameter specifies the numeric rounding
144 * parameter. Valid values are defined in 'BEN_RNDG' lookup type.
145 * @param p_oth_comp_abr_id This parameter specifies the other compensation.
146 * @param p_oth_comp_nnmntry_uom This parameter specifies the non-monetory
147 * units of measure such as stocks.
148 * @param p_oth_comp_rndg_cd This parameter specifies the numeric rounding
149 * parameter. Valid values are defined in 'BEN_RNDG' lookup type.
150 * @param p_actual_flag This parameter specifies if balance type is actual or
151 * not.
152 * @param p_acty_ref_perd_cd This parameter specifies the activity reference
153 * period. Valid values are defined in 'BEN_ACTY_REF_PERD' lookup type.
154 * @param p_legislation_code This parameter specifies the legislation to which
155 * the information type applies. Foreign key to FND_TERRITORIES.
156 * @param p_pl_annulization_factor {@rep:casecolumn
157 * BEN_CWB_PL_DSGN.PL_ANNULIZATION_FACTOR}
158 * @param p_pl_stat_cd This parameter specifies the plan status code. Valid
159 * values are defined in 'BEN_STAT' lookup type.
160 * @param p_uom_precision {@rep:casecolumn BEN_CWB_PL_DSGN.UOM_PRECISION}
161 * @param p_ws_element_type_id {@rep:casecolumn
162 * BEN_CWB_PL_DSGN.WS_ELEMENT_TYPE_ID}
163 * @param p_ws_input_value_id {@rep:casecolumn
164 * BEN_CWB_PL_DSGN.WS_INPUT_VALUE_ID}
165 * @param p_data_freeze_date This parameter specifies the freeze date on which
166 * snapshot for Compensation Workbench Person is performed.
167 * @param p_ws_amt_edit_cd This parameter specifies the allocations amount edit
168 * code.
169 * @param p_ws_amt_edit_enf_cd_for_nul This parameter specifies allocations
170 * amount edit code for nulls.
171 * @param p_ws_over_budget_edit_cd This parameter specifies allocations over
172 * budget edit code.
173 * @param p_ws_over_budget_tol_pct This parameter specifies allocations over
174 * budget tolerance percentage.
175 * @param p_bdgt_over_budget_edit_cd This parameter specifies budgets over
176 * budget edit code.
177 * @param p_bdgt_over_budget_tol_pct This parameter specifies distribution
178 * budget over budget tolerance percentage.
179 * @param p_auto_distr_flag This parameter specifies a flag for automatic
180 * distribution.
181 * @param p_pqh_document_short_name This parameter is a short name for PQH
182 * (Public sector HR) document.
183 * @param p_ovrid_rt_strt_dt This parameter allows the user to override the
184 * effective date when post process is run to post data.
185 * @param p_do_not_process_flag If yes, then post process skips processing
186 * the particular local plan for which it is set.
187 * @param p_ovr_perf_revw_strt_dt This parameter overrides the effective date
188 * for performance related changes.
189 * @param p_object_version_number If p_validate is false, then set to the
190 * version number of the created Compensation Workbench Plan. If p_validate is
191 * true, then the value will be null.
192 * @rep:displayname Create Compensation Workbench Plan
193 * @rep:category BUSINESS_ENTITY BEN_CWB_PLAN
194 * @rep:lifecycle active
195 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
196 * @rep:scope public
197 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
198 */
199 --
200 -- {End Of Comments}
201 --
202 procedure create_plan_or_option
203 (p_validate in boolean default false
204 ,p_pl_id in number
205 ,p_oipl_id in number
206 ,p_lf_evt_ocrd_dt in date
207 ,p_effective_date in date default null
208 ,p_name in varchar2 default null
209 ,p_group_pl_id in number default null
210 ,p_group_oipl_id in number default null
211 ,p_opt_hidden_flag in varchar2 default null
212 ,p_opt_id in number default null
213 ,p_pl_uom in varchar2 default null
214 ,p_pl_ordr_num in number default null
215 ,p_oipl_ordr_num in number default null
216 ,p_pl_xchg_rate in number default null
217 ,p_opt_count in number default null
218 ,p_uses_bdgt_flag in varchar2 default null
219 ,p_prsrv_bdgt_cd in varchar2 default null
220 ,p_upd_start_dt in date default null
221 ,p_upd_end_dt in date default null
222 ,p_approval_mode in varchar2 default null
223 ,p_enrt_perd_start_dt in date default null
224 ,p_enrt_perd_end_dt in date default null
225 ,p_yr_perd_start_dt in date default null
226 ,p_yr_perd_end_dt in date default null
227 ,p_wthn_yr_start_dt in date default null
228 ,p_wthn_yr_end_dt in date default null
229 ,p_enrt_perd_id in number default null
230 ,p_yr_perd_id in number default null
231 ,p_business_group_id in number default null
232 ,p_perf_revw_strt_dt in date default null
233 ,p_asg_updt_eff_date in date default null
234 ,p_emp_interview_typ_cd in varchar2 default null
235 ,p_salary_change_reason in varchar2 default null
236 ,p_ws_abr_id in number default null
237 ,p_ws_nnmntry_uom in varchar2 default null
238 ,p_ws_rndg_cd in varchar2 default null
239 ,p_ws_sub_acty_typ_cd in varchar2 default null
240 ,p_dist_bdgt_abr_id in number default null
241 ,p_dist_bdgt_nnmntry_uom in varchar2 default null
242 ,p_dist_bdgt_rndg_cd in varchar2 default null
243 ,p_ws_bdgt_abr_id in number default null
244 ,p_ws_bdgt_nnmntry_uom in varchar2 default null
245 ,p_ws_bdgt_rndg_cd in varchar2 default null
246 ,p_rsrv_abr_id in number default null
247 ,p_rsrv_nnmntry_uom in varchar2 default null
248 ,p_rsrv_rndg_cd in varchar2 default null
249 ,p_elig_sal_abr_id in number default null
250 ,p_elig_sal_nnmntry_uom in varchar2 default null
251 ,p_elig_sal_rndg_cd in varchar2 default null
252 ,p_misc1_abr_id in number default null
253 ,p_misc1_nnmntry_uom in varchar2 default null
254 ,p_misc1_rndg_cd in varchar2 default null
255 ,p_misc2_abr_id in number default null
256 ,p_misc2_nnmntry_uom in varchar2 default null
257 ,p_misc2_rndg_cd in varchar2 default null
258 ,p_misc3_abr_id in number default null
259 ,p_misc3_nnmntry_uom in varchar2 default null
260 ,p_misc3_rndg_cd in varchar2 default null
261 ,p_stat_sal_abr_id in number default null
262 ,p_stat_sal_nnmntry_uom in varchar2 default null
263 ,p_stat_sal_rndg_cd in varchar2 default null
264 ,p_rec_abr_id in number default null
268 ,p_tot_comp_nnmntry_uom in varchar2 default null
265 ,p_rec_nnmntry_uom in varchar2 default null
266 ,p_rec_rndg_cd in varchar2 default null
267 ,p_tot_comp_abr_id in number default null
269 ,p_tot_comp_rndg_cd in varchar2 default null
270 ,p_oth_comp_abr_id in number default null
271 ,p_oth_comp_nnmntry_uom in varchar2 default null
272 ,p_oth_comp_rndg_cd in varchar2 default null
273 ,p_actual_flag in varchar2 default null
274 ,p_acty_ref_perd_cd in varchar2 default null
275 ,p_legislation_code in varchar2 default null
276 ,p_pl_annulization_factor in number default null
277 ,p_pl_stat_cd in varchar2 default null
278 ,p_uom_precision in number default null
279 ,p_ws_element_type_id in number default null
280 ,p_ws_input_value_id in number default null
281 ,p_data_freeze_date in date default null
282 ,p_ws_amt_edit_cd in varchar2 default null
283 ,p_ws_amt_edit_enf_cd_for_nul in varchar2 default null
284 ,p_ws_over_budget_edit_cd in varchar2 default null
285 ,p_ws_over_budget_tol_pct in number default null
286 ,p_bdgt_over_budget_edit_cd in varchar2 default null
287 ,p_bdgt_over_budget_tol_pct in number default null
288 ,p_auto_distr_flag in varchar2 default null
289 ,p_pqh_document_short_name in varchar2 default null
290 ,p_ovrid_rt_strt_dt in date default null
291 ,p_do_not_process_flag in varchar2 default null
292 ,p_ovr_perf_revw_strt_dt in date default null
293 ,p_object_version_number out nocopy number
294 );
295 --
296 -- ----------------------------------------------------------------------------
297 -- |--------------------------< update_plan_or_option >-----------------------|
298 -- ----------------------------------------------------------------------------
299 --
300 -- {Start Of Comments}
301 /*#
302 * This API updates compensation workbench plan and option information.
303 *
304 * This information is used by all self-service pages that update plan design
305 * data.
306 *
307 * <p><b>Licensing</b><br>
308 * This API is licensed for use with Human Resources.
309 *
310 * <p><b>Prerequisites</b><br>
311 * A Compensation Workbench Plan to update in the database exists.
312 *
313 * <p><b>Post Success</b><br>
314 * The Compensation Workbench Plan will be updated in the database.
315 *
316 * <p><b>Post Failure</b><br>
317 * The Compensation Workbench Plan will be not updated in the database.
318 *
319 * @param p_validate If true, then validation alone will be performed and the
320 * database will remain unchanged. If false and all validation checks pass,
321 * then the database will be modified.
322 * @param p_pl_id This parameter specifies the Compensation Workbench Plan.
323 * @param p_oipl_id This parameter specifies options for Compensation Workbench
324 * Plan.
325 * @param p_lf_evt_ocrd_dt {@rep:casecolumn BEN_CWB_PL_DSGN.LF_EVT_OCRD_DT}
326 * @param p_effective_date Determines when the DateTrack operation comes into
327 * force.
328 * @param p_name This parameter specifies the Compensation Workbench Plan name.
329 * @param p_group_pl_id This parameter specifies Compensation Workbench Group
330 * Plan.
331 * @param p_group_oipl_id This parameter specifies options for a Compensation
332 * Workbench Group Plan.
333 * @param p_opt_hidden_flag This parameter specifies if the Compensation
334 * Workbench Plan options will be displayed in the SS pages.
338 * currency.
335 * @param p_opt_id This parameter specifies the option and is foreign Key to
336 * BEN_OPT_F.
337 * @param p_pl_uom This parameter specifies the Compensation Workbench Plan
339 * @param p_pl_ordr_num This parameter specifies the Compensation Workbench
340 * Plan order number.
341 * @param p_oipl_ordr_num This parameter specifies the Compensation Workbench
342 * Plan options order number.
343 * @param p_pl_xchg_rate This parameter specifies the exchange rate for
344 * Compensation Workbench Plan currency.
345 * @param p_opt_count This parameter keeps count of plan options.
346 * @param p_uses_bdgt_flag This parameter specifies if budgeting is used or
347 * not.
348 * @param p_prsrv_bdgt_cd This parameter specifies if budget is stored as
349 * amount or percentage of eligible salaries.
350 * @param p_upd_start_dt Self Service update start date
351 * @param p_upd_end_dt Self Service update end date
352 * @param p_approval_mode This parameter specifies the approval mode for
353 * allocations submission. Valid values are defined in 'BEN_CWB_APPROVAL_MODE'
354 * lookup type.
355 * @param p_enrt_perd_start_dt {@rep:casecolumn
356 * BEN_CWB_PL_DSGN.ENRT_PERD_START_DT}
357 * @param p_enrt_perd_end_dt {@rep:casecolumn BEN_CWB_PL_DSGN.ENRT_PERD_END_DT}
358 * @param p_yr_perd_start_dt {@rep:casecolumn BEN_CWB_PL_DSGN.YR_PERD_START_DT}
359 * @param p_yr_perd_end_dt {@rep:casecolumn BEN_CWB_PL_DSGN.YR_PERD_END_DT}
360 * @param p_wthn_yr_start_dt {@rep:casecolumn BEN_CWB_PL_DSGN.WTHN_YR_START_DT}
361 * @param p_wthn_yr_end_dt {@rep:casecolumn BEN_CWB_PL_DSGN.WTHN_YR_END_DT}
362 * @param p_enrt_perd_id {@rep:casecolumn BEN_CWB_PL_DSGN.ENRT_PERD_ID}
363 * @param p_yr_perd_id {@rep:casecolumn BEN_CWB_PL_DSGN.YR_PERD_ID}
364 * @param p_business_group_id {@rep:casecolumn
365 * PER_ALL_ASSIGNMENTS_F.BUSINESS_GROUP_ID}
366 * @param p_perf_revw_strt_dt {@rep:casecolumn BEN_ENRT_PERD.PERF_REVW_STRT_DT}
367 * @param p_asg_updt_eff_date {@rep:casecolumn BEN_ENRT_PERD.ASG_UPDT_EFF_DATE}
368 * @param p_emp_interview_typ_cd This parameter specifies the performance
369 * rating type. Valid values are defined in 'EMP_INTERVIEW_TYPE' lookup type.
370 * @param p_salary_change_reason {@rep:casecolumn
371 * BEN_CWB_PL_DSGN.SALARY_CHANGE_REASON}
372 * @param p_ws_abr_id This parameter specifies worksheet rate. It is null if no
373 * worksheet rate is defined.
374 * @param p_ws_nnmntry_uom This parameter specifies the non-monetory units of
375 * measure such as stocks.
376 * @param p_ws_rndg_cd This parameter specifies the numeric rounding parameter.
377 * Valid values are defined in 'BEN_RNDG' lookup type.
378 * @param p_ws_sub_acty_typ_cd This parameter specifies worksheet rate sub
379 * activity type code. Valid values are defined in 'BEN_SUB_ACTY_TYP' lookup
380 * type.
381 * @param p_dist_bdgt_abr_id This parameter specifies the distribution budget
382 * rate.
383 * @param p_dist_bdgt_nnmntry_uom This parameter specifies the non-monetory
384 * units of measure such as stocks.
385 * @param p_dist_bdgt_rndg_cd This parameter specifies the numeric rounding
386 * parameter. Valid values are defined in 'BEN_RNDG' lookup type.
387 * @param p_ws_bdgt_abr_id This parameter specifies worksheet budget rate.
391 * parameter. Valid values are defined in 'BEN_RNDG' lookup type.
388 * @param p_ws_bdgt_nnmntry_uom This parameter specifies the non-monetory units
389 * of measure such as stocks.
390 * @param p_ws_bdgt_rndg_cd This parameter specifies the numeric rounding
392 * @param p_rsrv_abr_id This parameter specifies the reserve budget rate.
393 * @param p_rsrv_nnmntry_uom This parameter specifies the non-monetory units of
394 * measure such as stocks.
395 * @param p_rsrv_rndg_cd This parameter specifies the numeric rounding
396 * parameter. Valid values are defined in 'BEN_RNDG' lookup type.
397 * @param p_elig_sal_abr_id This parameter specifies the eligible salary rate.
398 * @param p_elig_sal_nnmntry_uom This parameter specifies the non-monetory
399 * units of measure such as stocks.
400 * @param p_elig_sal_rndg_cd This parameter specifies the non-monetory units of
401 * measure such as stocks.
402 * @param p_misc1_abr_id This parameter specifies miscellaneous 1 rate.
403 * @param p_misc1_nnmntry_uom This parameter specifies the non-monetory units
404 * of measure such as stocks.
405 * @param p_misc1_rndg_cd This parameter specifies the numeric rounding
406 * parameter. Valid values are defined in 'BEN_RNDG' lookup type.
407 * @param p_misc2_abr_id This parameter specifies miscellaneous 2 rate.
408 * @param p_misc2_nnmntry_uom This parameter specifies the non-monetory units
409 * of measure such as stocks.
413 * @param p_misc3_nnmntry_uom This parameter specifies the non-monetory units
410 * @param p_misc2_rndg_cd This parameter specifies the numeric rounding
411 * parameter. Valid values are defined in 'BEN_RNDG' lookup type.
412 * @param p_misc3_abr_id This parameter specifies miscellaneous 3 rate.
414 * of measure such as stocks.
415 * @param p_misc3_rndg_cd This parameter specifies the numeric rounding
416 * parameter. Valid values are defined in 'BEN_RNDG' lookup type.
417 * @param p_stat_sal_abr_id This parameter specifies the stated salary rate.
418 * @param p_stat_sal_nnmntry_uom This parameter specifies the non-monetory
419 * units of measure such as stocks.
420 * @param p_stat_sal_rndg_cd This parameter specifies the numeric rounding
421 * parameter. Valid values are defined in 'BEN_RNDG' lookup type.
422 * @param p_rec_abr_id This parameter specifies the recommended rate.
423 * @param p_rec_nnmntry_uom This parameter specifies the non-monetory units of
424 * measure such as stocks.
425 * @param p_rec_rndg_cd This parameter specifies the numeric rounding
426 * parameter. Valid values are defined in 'BEN_RNDG' lookup type.
430 * @param p_tot_comp_rndg_cd This parameter specifies the numeric rounding
427 * @param p_tot_comp_abr_id This parameter specifies the total compensation.
428 * @param p_tot_comp_nnmntry_uom This parameter specifies the non-monetory
429 * units of measure such as stocks.
431 * parameter. Valid values are defined in 'BEN_RNDG' lookup type.
432 * @param p_oth_comp_abr_id This parameter specifies the other compensation.
433 * @param p_oth_comp_nnmntry_uom This parameter specifies the non-monetory
434 * units of measure such as stocks.
435 * @param p_oth_comp_rndg_cd This parameter specifies the numeric rounding
436 * parameter. Valid values are defined in 'BEN_RNDG' lookup type.
437 * @param p_actual_flag This parameter specifies if balance type is actual or
438 * not.
439 * @param p_acty_ref_perd_cd This parameter specifies the activity reference
440 * period. Valid values are defined in 'BEN_ACTY_REF_PERD' lookup type.
441 * @param p_legislation_code This parameter specifies the legislation to which
442 * the information type applies. Foreign key is to FND_TERRITORIES.
443 * @param p_pl_annulization_factor {@rep:casecolumn
444 * BEN_CWB_PL_DSGN.PL_ANNULIZATION_FACTOR}
445 * @param p_pl_stat_cd This parameter specifies the plan status code. Valid
446 * values are defined in 'BEN_STAT' lookup type.
447 * @param p_uom_precision {@rep:casecolumn BEN_CWB_PL_DSGN.UOM_PRECISION}
448 * @param p_ws_element_type_id {@rep:casecolumn
449 * BEN_CWB_PL_DSGN.WS_ELEMENT_TYPE_ID}
450 * @param p_ws_input_value_id {@rep:casecolumn
451 * BEN_CWB_PL_DSGN.WS_INPUT_VALUE_ID}
452 * @param p_data_freeze_date This parameter specifies the freeze date on which
453 * snapshot for Compensation Workbench Person is performed.
454 * @param p_ws_amt_edit_cd This parameter specifies the allocations amount edit
455 * code.
456 * @param p_ws_amt_edit_enf_cd_for_nul This parameter specifies the allocations
457 * amount edit code for nulls.
458 * @param p_ws_over_budget_edit_cd This parameter specifies allocations over
459 * budget edit code.
460 * @param p_ws_over_budget_tol_pct This parameter specifies the allocations
461 * over budget tolerance percentage.
462 * @param p_bdgt_over_budget_edit_cd This parameter specifies the budgets over
463 * budget edit code.
464 * @param p_bdgt_over_budget_tol_pct This parameter specifies the distribution
465 * budget over budget tolerance percentage.
466 * @param p_auto_distr_flag This parameter specifies the flag for automatic
467 * distribution.
468 * @param p_pqh_document_short_name This parameter specifies the short name for
469 * PQH (Public sector HR) document.
470 * @param p_call_data_syncopation This parameter specifies if the internal
471 * procedure, which makes sure that all the child rows, get correct data from
472 * parent HR tables.
473 * @param p_ovrid_rt_strt_dt This parameter allows the user to override the
474 * effective date when post process is run to post data.
475 * @param p_do_not_process_flag If yes, then post process skips processing
476 * the particular local plan for which it is set.
477 * @param p_ovr_perf_revw_strt_dt This parameter overrides the effective date
478 * for performance related changes.
479 * @param p_object_version_number Pass in the current version number of the
480 * Compensation Workbench Plan to be updated. When the API completes if
481 * p_validate is false, will be set to the new version number of the updated
482 * Compensation Workbench Plan. If p_validate is true will be set to the same
483 * value which was passed in.
484 * @rep:displayname Update Compensation Workbench Plan
485 * @rep:category BUSINESS_ENTITY BEN_CWB_PLAN
486 * @rep:lifecycle active
487 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
488 * @rep:scope public
489 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
490 */
491 --
492 -- {End Of Comments}
493 --
494 procedure update_plan_or_option
495 (p_validate in boolean default false
496 ,p_pl_id in number
497 ,p_oipl_id in number
498 ,p_lf_evt_ocrd_dt in date
499 ,p_effective_date in date default hr_api.g_date
500 ,p_name in varchar2 default hr_api.g_varchar2
501 ,p_group_pl_id in number default hr_api.g_number
502 ,p_group_oipl_id in number default hr_api.g_number
503 ,p_opt_hidden_flag in varchar2 default hr_api.g_varchar2
504 ,p_opt_id in number default hr_api.g_number
505 ,p_pl_uom in varchar2 default hr_api.g_varchar2
506 ,p_pl_ordr_num in number default hr_api.g_number
507 ,p_oipl_ordr_num in number default hr_api.g_number
508 ,p_pl_xchg_rate in number default hr_api.g_number
509 ,p_opt_count in number default hr_api.g_number
510 ,p_uses_bdgt_flag in varchar2 default hr_api.g_varchar2
511 ,p_prsrv_bdgt_cd in varchar2 default hr_api.g_varchar2
512 ,p_upd_start_dt in date default hr_api.g_date
513 ,p_upd_end_dt in date default hr_api.g_date
514 ,p_approval_mode in varchar2 default hr_api.g_varchar2
515 ,p_enrt_perd_start_dt in date default hr_api.g_date
516 ,p_enrt_perd_end_dt in date default hr_api.g_date
517 ,p_yr_perd_start_dt in date default hr_api.g_date
518 ,p_yr_perd_end_dt in date default hr_api.g_date
519 ,p_wthn_yr_start_dt in date default hr_api.g_date
520 ,p_wthn_yr_end_dt in date default hr_api.g_date
521 ,p_enrt_perd_id in number default hr_api.g_number
522 ,p_yr_perd_id in number default hr_api.g_number
523 ,p_business_group_id in number default hr_api.g_number
524 ,p_perf_revw_strt_dt in date default hr_api.g_date
525 ,p_asg_updt_eff_date in date default hr_api.g_date
526 ,p_emp_interview_typ_cd in varchar2 default hr_api.g_varchar2
527 ,p_salary_change_reason in varchar2 default hr_api.g_varchar2
528 ,p_ws_abr_id in number default hr_api.g_number
529 ,p_ws_nnmntry_uom in varchar2 default hr_api.g_varchar2
530 ,p_ws_rndg_cd in varchar2 default hr_api.g_varchar2
531 ,p_ws_sub_acty_typ_cd in varchar2 default hr_api.g_varchar2
532 ,p_dist_bdgt_abr_id in number default hr_api.g_number
533 ,p_dist_bdgt_nnmntry_uom in varchar2 default hr_api.g_varchar2
534 ,p_dist_bdgt_rndg_cd in varchar2 default hr_api.g_varchar2
535 ,p_ws_bdgt_abr_id in number default hr_api.g_number
536 ,p_ws_bdgt_nnmntry_uom in varchar2 default hr_api.g_varchar2
537 ,p_ws_bdgt_rndg_cd in varchar2 default hr_api.g_varchar2
538 ,p_rsrv_abr_id in number default hr_api.g_number
539 ,p_rsrv_nnmntry_uom in varchar2 default hr_api.g_varchar2
540 ,p_rsrv_rndg_cd in varchar2 default hr_api.g_varchar2
541 ,p_elig_sal_abr_id in number default hr_api.g_number
542 ,p_elig_sal_nnmntry_uom in varchar2 default hr_api.g_varchar2
543 ,p_elig_sal_rndg_cd in varchar2 default hr_api.g_varchar2
544 ,p_misc1_abr_id in number default hr_api.g_number
545 ,p_misc1_nnmntry_uom in varchar2 default hr_api.g_varchar2
546 ,p_misc1_rndg_cd in varchar2 default hr_api.g_varchar2
547 ,p_misc2_abr_id in number default hr_api.g_number
548 ,p_misc2_nnmntry_uom in varchar2 default hr_api.g_varchar2
549 ,p_misc2_rndg_cd in varchar2 default hr_api.g_varchar2
550 ,p_misc3_abr_id in number default hr_api.g_number
551 ,p_misc3_nnmntry_uom in varchar2 default hr_api.g_varchar2
552 ,p_misc3_rndg_cd in varchar2 default hr_api.g_varchar2
553 ,p_stat_sal_abr_id in number default hr_api.g_number
554 ,p_stat_sal_nnmntry_uom in varchar2 default hr_api.g_varchar2
555 ,p_stat_sal_rndg_cd in varchar2 default hr_api.g_varchar2
556 ,p_rec_abr_id in number default hr_api.g_number
557 ,p_rec_nnmntry_uom in varchar2 default hr_api.g_varchar2
558 ,p_rec_rndg_cd in varchar2 default hr_api.g_varchar2
559 ,p_tot_comp_abr_id in number default hr_api.g_number
560 ,p_tot_comp_nnmntry_uom in varchar2 default hr_api.g_varchar2
561 ,p_tot_comp_rndg_cd in varchar2 default hr_api.g_varchar2
562 ,p_oth_comp_abr_id in number default hr_api.g_number
563 ,p_oth_comp_nnmntry_uom in varchar2 default hr_api.g_varchar2
564 ,p_oth_comp_rndg_cd in varchar2 default hr_api.g_varchar2
565 ,p_actual_flag in varchar2 default hr_api.g_varchar2
566 ,p_acty_ref_perd_cd in varchar2 default hr_api.g_varchar2
567 ,p_legislation_code in varchar2 default hr_api.g_varchar2
571 ,p_ws_element_type_id in number default hr_api.g_number
568 ,p_pl_annulization_factor in number default hr_api.g_number
569 ,p_pl_stat_cd in varchar2 default hr_api.g_varchar2
570 ,p_uom_precision in number default hr_api.g_number
572 ,p_ws_input_value_id in number default hr_api.g_number
573 ,p_data_freeze_date in date default hr_api.g_date
574 ,p_ws_amt_edit_cd in varchar2 default hr_api.g_varchar2
575 ,p_ws_amt_edit_enf_cd_for_nul in varchar2 default hr_api.g_varchar2
576 ,p_ws_over_budget_edit_cd in varchar2 default hr_api.g_varchar2
577 ,p_ws_over_budget_tol_pct in number default hr_api.g_number
578 ,p_bdgt_over_budget_edit_cd in varchar2 default hr_api.g_varchar2
579 ,p_bdgt_over_budget_tol_pct in number default hr_api.g_number
580 ,p_auto_distr_flag in varchar2 default hr_api.g_varchar2
581 ,p_pqh_document_short_name in varchar2 default hr_api.g_varchar2
582 ,p_call_data_syncopation in varchar2 default 'Y'
583 ,p_ovrid_rt_strt_dt in date default hr_api.g_date
584 ,p_do_not_process_flag in varchar2 default 'N'
585 ,p_ovr_perf_revw_strt_dt in date default hr_api.g_date
586 ,p_object_version_number in out nocopy number
587 );
588 --
589 -- ----------------------------------------------------------------------------
590 -- |--------------------------< delete_plan_or_option >-----------------------|
591 -- ----------------------------------------------------------------------------
592 --
593 -- {Start Of Comments}
594 /*#
595 * This API deletes compensation workbench plan and option information.
596 *
597 * Any self-service page which deletes plan design data uses this API.
598 *
599 * <p><b>Licensing</b><br>
600 * This API is licensed for use with Human Resources.
601 *
602 * <p><b>Prerequisites</b><br>
603 * A Compensation Workbench Plan to delete exists in the database.
604 *
605 * <p><b>Post Success</b><br>
606 * The Compensation Workbench Plan will be deleted in the database.
607 *
608 * <p><b>Post Failure</b><br>
609 * The Compensation Workbench Plan will be not deleted from the database.
610 *
611 * @param p_validate If true, then validation alone will be performed and the
612 * database will remain unchanged. If false and all validation checks pass,
613 * then the database will be modified.
614 * @param p_pl_id This parameter specifies the Compensation Workbench Plan.
615 * @param p_oipl_id This Parameter specifies the options for Compensation
616 * Workbench Plan.
617 * @param p_lf_evt_ocrd_dt {@rep:casecolumn BEN_CWB_PL_DSGN.LF_EVT_OCRD_DT}
618 * @param p_object_version_number Current version number of the Compensation
619 * Workbench Plan to be deleted.
620 * @rep:displayname Delete Compensation Workbench Plan
621 * @rep:category BUSINESS_ENTITY BEN_CWB_PLAN
622 * @rep:lifecycle active
623 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
624 * @rep:scope public
625 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
626 */
627 --
628 -- {End Of Comments}
629 --
630 procedure delete_plan_or_option
631 (p_validate in boolean default false
632 ,p_pl_id in number
633 ,p_oipl_id in number
634 ,p_lf_evt_ocrd_dt in date
635 ,p_object_version_number in number
636 );
637 end BEN_CWB_PL_DSGN_API;
[Home] [Help]