1 Package BEN_CWB_PERSON_RATES_API as
2 /* $Header: bertsapi.pkh 120.3.12000000.1 2007/01/19 23:09:27 appldev noship $ */
3 /*#
4 * This package contains Compensation Workbench Person Award APIs.
5 * @rep:scope public
6 * @rep:product PER
7 * @rep:displayname Compensation Workbench Person Award
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------------< create_person_rate >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates award details for eligible persons for compensation
17 * workbench processing.
18 *
19 * Award records are created for all eligible persons in a plan. Monetary
20 * amounts are stored in plan currency. All compensation workbench self-service
21 * pages, which refer to individual rates, use this API.
22 *
23 * <p><b>Licensing</b><br>
24 * This API is licensed for use with Human Resources.
25 *
26 * <p><b>Prerequisites</b><br>
27 * A person with a compensation life event reason in a Compensation Workbench
28 * Plan must exist.
29 *
30 * <p><b>Post Success</b><br>
31 * A Compensation Workbench Award for a person is created in the database.
32 *
33 * <p><b>Post Failure</b><br>
34 * A Compensation Workbench Award for a person is not created in the database.
35 *
36 * @param p_validate If true, then validation alone will be performed and the
37 * database will remain unchanged. If false and all validation checks pass,
38 * then the database will be modified.
39 * @param p_group_per_in_ler_id Identifies the Group Life Event Reason ID of
40 * Compensation Workbench Person. Foreign key to BEN_PER_IN_LER.
41 * @param p_pl_id Specifies the Compensation Workbench Plan.
42 * @param p_oipl_id Specifies options for Compensation Workbench Plan.
43 * @param p_group_pl_id Specifies Compensation Workbench Group Plan.
44 * @param p_group_oipl_id Specifies options for a Compensation Workbench Group
45 * Plan.
46 * @param p_lf_evt_ocrd_dt {@rep:casecolumn BEN_CWB_PL_DSGN.LF_EVT_OCRD_DT}
47 * @param p_person_id Identifies the person for whom you create the
48 * Compensation Workbench Award record.
49 * @param p_assignment_id Identifies the assignment for which is the
50 * Compensation Workbench Award
51 * @param p_elig_flag Eligibility flag for person. A person can be made
52 * ineligible for award from self-service pages.
53 * @param p_ws_val Compensation amount.
54 * @param p_ws_mn_val Worksheet minimum value for minimum maximum edits.
55 * @param p_ws_mx_val Worksheet maximum value for minimum maximum edits.
56 * @param p_ws_incr_val Worksheet increment value for compensation.
57 * @param p_elig_sal_val Eligible salary.
58 * @param p_stat_sal_val Stated salary.
59 * @param p_oth_comp_val Other compensation amount.
60 * @param p_tot_comp_val Total compensation.
61 * @param p_misc1_val Miscellaneous compensation 1 value.
62 * @param p_misc2_val Miscellaneous compensation 2 value.
63 * @param p_misc3_val Miscellaneous compensation 3 value.
64 * @param p_rec_val Recommended Value.
65 * @param p_rec_mn_val Recommended minimum value.
66 * @param p_rec_mx_val Recommended maximum value.
67 * @param p_rec_incr_val Recommended value increment.
68 * @param p_ws_val_last_upd_date Last update date of worksheet amount.
69 * @param p_ws_val_last_upd_by Specifies the person who made the last update of
70 * worksheet amount.
71 * @param p_pay_proposal_id Pay proposal. Foreign key to PER_PAY_PROPOSALS.
72 * @param p_element_entry_value_id Element entry value. Foreign key to
73 * PAY_ELEMENT_ENTRY_VALUES_F.
74 * @param p_inelig_rsn_cd Ineligibility reason code. Valid values are defined
75 * in 'BEN_INELG_RSN' lookup type.
76 * @param p_elig_ovrid_dt Eligibility override date.
77 * @param p_elig_ovrid_person_id Specifies person making eligibility override.
78 * @param p_copy_dist_bdgt_val Value of budget to be distributed.
79 * @param p_copy_ws_bdgt_val Budget value on worksheet.
80 * @param p_copy_rsrv_val Budget reserve value.
81 * @param p_copy_dist_bdgt_mn_val Distribution budget minimum value.
82 * @param p_copy_dist_bdgt_mx_val Distribution budget maximum value.
83 * @param p_copy_dist_bdgt_incr_val Distribution budget increment value.
84 * @param p_copy_ws_bdgt_mn_val Worksheet budget minimum value.
85 * @param p_copy_ws_bdgt_mx_val Worksheet budget maximum value.
86 * @param p_copy_ws_bdgt_incr_val Worksheet budget increment value.
87 * @param p_copy_rsrv_mn_val Reserve minimum value.
88 * @param p_copy_rsrv_mx_val Reserve maximum value.
89 * @param p_copy_rsrv_incr_val Reserve increment value.
90 * @param p_copy_dist_bdgt_iss_val {@rep:casecolumn
91 * BEN_CWB_PERSON_GROUPS.DIST_BDGT_ISS_VAL}
92 * @param p_copy_ws_bdgt_iss_val {@rep:casecolumn
93 * BEN_CWB_PERSON_GROUPS.WS_BDGT_ISS_VAL}
94 * @param p_copy_dist_bdgt_iss_date {@rep:casecolumn
95 * BEN_CWB_PERSON_GROUPS.DIST_BDGT_ISS_DATE}
96 * @param p_copy_ws_bdgt_iss_date {@rep:casecolumn
97 * BEN_CWB_PERSON_GROUPS.WS_BDGT_ISS_DATE}
98 * @param p_comp_posting_date Date when Compensation Workbench Award was
99 * posted.
100 * @param p_ws_rt_start_date Worksheet rate start date.
101 * @param p_currency Currency of monetary items.
102 * @param p_object_version_number If p_validate is false, then set to the
103 * version number of the created Compensation Workbench Award. If p_validate is
104 * true, then the value will be null.
105 * @param p_person_rate_id If p_validate is false, then this uniquely
106 * identifies the award created. If p_validate is true, then set to null.
107 * @rep:displayname Create Person Award
108 * @rep:category BUSINESS_ENTITY BEN_CWB_AWARD
109 * @rep:lifecycle active
110 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
111 * @rep:scope public
112 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
113 */
114 --
115 -- {End Of Comments}
116 --
117 procedure create_person_rate
118 (p_validate in boolean default false
119 ,p_group_per_in_ler_id in number
120 ,p_pl_id in number
121 ,p_oipl_id in number
122 ,p_group_pl_id in number
123 ,p_group_oipl_id in number
124 ,p_lf_evt_ocrd_dt in date
125 ,p_person_id in number default null
126 ,p_assignment_id in number default null
127 ,p_elig_flag in varchar2 default null
128 ,p_ws_val in number default null
129 ,p_ws_mn_val in number default null
130 ,p_ws_mx_val in number default null
131 ,p_ws_incr_val in number default null
132 ,p_elig_sal_val in number default null
133 ,p_stat_sal_val in number default null
134 ,p_oth_comp_val in number default null
135 ,p_tot_comp_val in number default null
136 ,p_misc1_val in number default null
137 ,p_misc2_val in number default null
138 ,p_misc3_val in number default null
139 ,p_rec_val in number default null
140 ,p_rec_mn_val in number default null
141 ,p_rec_mx_val in number default null
142 ,p_rec_incr_val in number default null
143 ,p_ws_val_last_upd_date in date default null
144 ,p_ws_val_last_upd_by in number default null
145 ,p_pay_proposal_id in number default null
146 ,p_element_entry_value_id in number default null
147 ,p_inelig_rsn_cd in varchar2 default null
148 ,p_elig_ovrid_dt in date default null
149 ,p_elig_ovrid_person_id in number default null
150 ,p_copy_dist_bdgt_val in number default null
151 ,p_copy_ws_bdgt_val in number default null
152 ,p_copy_rsrv_val in number default null
153 ,p_copy_dist_bdgt_mn_val in number default null
154 ,p_copy_dist_bdgt_mx_val in number default null
155 ,p_copy_dist_bdgt_incr_val in number default null
156 ,p_copy_ws_bdgt_mn_val in number default null
160 ,p_copy_rsrv_mx_val in number default null
157 ,p_copy_ws_bdgt_mx_val in number default null
158 ,p_copy_ws_bdgt_incr_val in number default null
159 ,p_copy_rsrv_mn_val in number default null
161 ,p_copy_rsrv_incr_val in number default null
162 ,p_copy_dist_bdgt_iss_val in number default null
163 ,p_copy_ws_bdgt_iss_val in number default null
164 ,p_copy_dist_bdgt_iss_date in date default null
165 ,p_copy_ws_bdgt_iss_date in date default null
166 ,p_comp_posting_date in date default null
167 ,p_ws_rt_start_date in date default null
168 ,p_currency in varchar2 default null
169 ,p_object_version_number out nocopy number
170 ,p_person_rate_id out nocopy number
171 );
172 --
173 -- ----------------------------------------------------------------------------
174 -- |----------------------------< update_person_rate >------------------------|
175 -- ----------------------------------------------------------------------------
176 --
177 -- {Start Of Comments}
178 /*#
179 * This API updates award details for eligible persons for compensation
180 * workbench processing.
181 *
182 * Award records is updated for all eligible persons in a plan. Monetary
183 * amounts are stored in plan currency. All compensation workbench self-service
184 * pages, which refer to individual rates, use this API.
185 *
186 * <p><b>Licensing</b><br>
187 * This API is licensed for use with Human Resources.
188 *
189 * <p><b>Prerequisites</b><br>
190 * A Compensation Workbench Award to update must exist in the database.
191 *
192 * <p><b>Post Success</b><br>
193 * The Compensation Workbench Award for a person will be updated in the
194 * database.
195 *
196 * <p><b>Post Failure</b><br>
197 * The Compensation Workbench Award for a person will not be updated in the
198 * database.
199 *
200 * @param p_validate If true, then validation alone will be performed and the
201 * database will remain unchanged. If false and all validation checks pass,
202 * then the database will be modified.
203 * @param p_group_per_in_ler_id Identifies the Group Life Event Reason ID of
204 * Compensation Workbench Person. Foreign key to BEN_PER_IN_LER.
205 * @param p_pl_id Specifies the Compensation Workbench Plan.
206 * @param p_oipl_id Specifies options for Compensation Workbench Plan.
207 * @param p_group_pl_id Specifies Compensation Workbench Group Plan.
208 * @param p_group_oipl_id Specifies options for a Compensation Workbench Group
209 * Plan.
210 * @param p_lf_evt_ocrd_dt {@rep:casecolumn BEN_CWB_PL_DSGN.LF_EVT_OCRD_DT}
211 * @param p_person_id Identifies the person for whom you create the
212 * Compensation Workbench Award record.
213 * @param p_assignment_id Identifies the assignment for which you create the
214 * Compensation Workbench Award.
215 * @param p_elig_flag Eligibility flag for person. A person can be made
216 * ineligible for award from self-service pages.
217 * @param p_ws_val Compensation amount.
218 * @param p_ws_mn_val Worksheet minimum value for minimum maximum edits.
219 * @param p_ws_mx_val Worksheet maximum value for minimum maximum edits.
220 * @param p_ws_incr_val Worksheet increment value for compensation.
221 * @param p_elig_sal_val Eligible salary.
222 * @param p_stat_sal_val Stated salary.
223 * @param p_oth_comp_val Other compensation amount.
224 * @param p_tot_comp_val Total compensation.
225 * @param p_misc1_val Miscellaneous compensation 1 value.
226 * @param p_misc2_val Miscellaneous compensation 2 value.
227 * @param p_misc3_val Miscellaneous compensation 3 value.
228 * @param p_rec_val Recommended Value.
229 * @param p_rec_mn_val Recommended minimum value.
230 * @param p_rec_mx_val Recommended maximum value.
231 * @param p_rec_incr_val Recommended value increment.
232 * @param p_ws_val_last_upd_date Last update date of worksheet amount.
233 * @param p_ws_val_last_upd_by Specifies the person who made last update of the
234 * worksheet amount.
235 * @param p_pay_proposal_id Pay proposal. Foreign key to PER_PAY_PROPOSALS.
236 * @param p_element_entry_value_id Element entry value. Foreign key to
237 * PAY_ELEMENT_ENTRY_VALUES_F.
238 * @param p_inelig_rsn_cd Ineligibility reason code. Valid values are defined
239 * in 'BEN_INELG_RSN' lookup type.
240 * @param p_elig_ovrid_dt Eligibility override date.
241 * @param p_elig_ovrid_person_id Specifies person making eligibility override.
242 * @param p_copy_dist_bdgt_val Value of budget to be distributed.
243 * @param p_copy_ws_bdgt_val Budget value on worksheet.
244 * @param p_copy_rsrv_val Budget reserve value.
245 * @param p_copy_dist_bdgt_mn_val Distribution budget minimum value.
246 * @param p_copy_dist_bdgt_mx_val Distribution budget maximum value.
247 * @param p_copy_dist_bdgt_incr_val Distribution budget increment value.
248 * @param p_copy_ws_bdgt_mn_val Worksheet budget minimum value.
249 * @param p_copy_ws_bdgt_mx_val Worksheet budget maximum value.
250 * @param p_copy_ws_bdgt_incr_val Worksheet budget increment value.
251 * @param p_copy_rsrv_mn_val Reserve minimum value.
252 * @param p_copy_rsrv_mx_val Reserve maximum value.
253 * @param p_copy_rsrv_incr_val Reserve increment value.
254 * @param p_copy_dist_bdgt_iss_val {@rep:casecolumn
255 * BEN_CWB_PERSON_GROUPS.DIST_BDGT_ISS_VAL}
256 * @param p_copy_ws_bdgt_iss_val {@rep:casecolumn
257 * BEN_CWB_PERSON_GROUPS.WS_BDGT_ISS_VAL}
258 * @param p_copy_dist_bdgt_iss_date {@rep:casecolumn
259 * BEN_CWB_PERSON_GROUPS.DIST_BDGT_ISS_DATE}
260 * @param p_copy_ws_bdgt_iss_date {@rep:casecolumn
261 * BEN_CWB_PERSON_GROUPS.WS_BDGT_ISS_DATE}
262 * @param p_comp_posting_date Date when Compensation Workbench Award posted.
263 * @param p_ws_rt_start_date Worksheet rate start date.
264 * @param p_currency Currency of monetary items.
268 * Compensation Workbench Award to be updated. When the API completes if
265 * @param p_perf_min_max_edit Flag to check edits for value between minimum and
266 * maximum.
267 * @param p_object_version_number Pass in the current version number of the
269 * p_validate is false, will be set to the new version number of the updated
270 * Compensation Workbench Award. If p_validate is true will be set to the same
271 * value which was passed in.
272 * @rep:displayname Update Person Award
273 * @rep:category BUSINESS_ENTITY BEN_CWB_AWARD
274 * @rep:lifecycle active
275 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
276 * @rep:scope public
277 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
278 */
279 --
280 -- {End Of Comments}
281 --
282 procedure update_person_rate
283 (p_validate in boolean default false
284 ,p_group_per_in_ler_id in number
285 ,p_pl_id in number
286 ,p_oipl_id in number
287 ,p_group_pl_id in number default hr_api.g_number
288 ,p_group_oipl_id in number default hr_api.g_number
289 ,p_lf_evt_ocrd_dt in date default hr_api.g_date
290 ,p_person_id in number default hr_api.g_number
291 ,p_assignment_id in number default hr_api.g_number
292 ,p_elig_flag in varchar2 default hr_api.g_varchar2
293 ,p_ws_val in number default hr_api.g_number
294 ,p_ws_mn_val in number default hr_api.g_number
295 ,p_ws_mx_val in number default hr_api.g_number
296 ,p_ws_incr_val in number default hr_api.g_number
297 ,p_elig_sal_val in number default hr_api.g_number
298 ,p_stat_sal_val in number default hr_api.g_number
299 ,p_oth_comp_val in number default hr_api.g_number
300 ,p_tot_comp_val in number default hr_api.g_number
301 ,p_misc1_val in number default hr_api.g_number
302 ,p_misc2_val in number default hr_api.g_number
303 ,p_misc3_val in number default hr_api.g_number
304 ,p_rec_val in number default hr_api.g_number
305 ,p_rec_mn_val in number default hr_api.g_number
306 ,p_rec_mx_val in number default hr_api.g_number
307 ,p_rec_incr_val in number default hr_api.g_number
308 ,p_ws_val_last_upd_date in date default hr_api.g_date
309 ,p_ws_val_last_upd_by in number default hr_api.g_number
310 ,p_pay_proposal_id in number default hr_api.g_number
311 ,p_element_entry_value_id in number default hr_api.g_number
312 ,p_inelig_rsn_cd in varchar2 default hr_api.g_varchar2
313 ,p_elig_ovrid_dt in date default hr_api.g_date
314 ,p_elig_ovrid_person_id in number default hr_api.g_number
315 ,p_copy_dist_bdgt_val in number default hr_api.g_number
316 ,p_copy_ws_bdgt_val in number default hr_api.g_number
317 ,p_copy_rsrv_val in number default hr_api.g_number
318 ,p_copy_dist_bdgt_mn_val in number default hr_api.g_number
319 ,p_copy_dist_bdgt_mx_val in number default hr_api.g_number
320 ,p_copy_dist_bdgt_incr_val in number default hr_api.g_number
321 ,p_copy_ws_bdgt_mn_val in number default hr_api.g_number
322 ,p_copy_ws_bdgt_mx_val in number default hr_api.g_number
323 ,p_copy_ws_bdgt_incr_val in number default hr_api.g_number
324 ,p_copy_rsrv_mn_val in number default hr_api.g_number
325 ,p_copy_rsrv_mx_val in number default hr_api.g_number
326 ,p_copy_rsrv_incr_val in number default hr_api.g_number
327 ,p_copy_dist_bdgt_iss_val in number default hr_api.g_number
328 ,p_copy_ws_bdgt_iss_val in number default hr_api.g_number
329 ,p_copy_dist_bdgt_iss_date in date default hr_api.g_date
330 ,p_copy_ws_bdgt_iss_date in date default hr_api.g_date
331 ,p_comp_posting_date in date default hr_api.g_date
332 ,p_ws_rt_start_date in date default hr_api.g_date
333 ,p_currency in varchar2 default hr_api.g_varchar2
334 ,p_perf_min_max_edit in varchar2 default 'Y'
335 ,p_object_version_number in out nocopy number
336 );
337 --
338 -- ----------------------------------------------------------------------------
339 -- |----------------------------< delete_person_rate >------------------------|
340 -- ----------------------------------------------------------------------------
341 --
342 -- {Start Of Comments}
343 /*#
344 * This API deletes award details for eligible persons for compensation
345 * workbench processing.
346 *
347 * Award records is deleted for all eligible persons in a plan. All
348 * compensation workbench self-service pages, which refer to individual rates
349 * use this API.
350 *
351 * <p><b>Licensing</b><br>
352 * This API is licensed for use with Human Resources.
353 *
354 * <p><b>Prerequisites</b><br>
355 * A Compensation Workbench Award to delete must exist in the database.
356 *
357 * <p><b>Post Success</b><br>
358 * The Compensation Workbench Award for a person will be deleted in the
359 * database.
360 *
361 * <p><b>Post Failure</b><br>
362 * The Compensation Workbench Award for a person will not be deleted in the
363 * database.
364 *
365 * @param p_validate If true, then validation alone will be performed and the
366 * database will remain unchanged. If false and all validation checks pass,
367 * then the database will be modified.
371 * @param p_oipl_id Specifies options for Compensation Workbench Plan.
368 * @param p_group_per_in_ler_id Identifies the Group Life Event Reason ID of
369 * Compensation Workbench Person. Foreign key to BEN_PER_IN_LER.
370 * @param p_pl_id Specifies the Compensation Workbench Plan.
372 * @param p_object_version_number Current version number of the Compensation
373 * @param p_update_summary Pass true to update summary reflecting the delete.
374 * Workbench Award to be deleted.
375 * @rep:displayname Delete Person Award
376 * @rep:category BUSINESS_ENTITY BEN_CWB_AWARD
377 * @rep:lifecycle active
378 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
379 * @rep:scope public
380 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
381 */
382 --
383 -- {End Of Comments}
384 --
385 procedure delete_person_rate
386 (p_validate in boolean default false
387 ,p_group_per_in_ler_id in number
388 ,p_pl_id in number
389 ,p_oipl_id in number
390 ,p_object_version_number in number
391 ,p_update_summary in boolean default false
392 );
393 --
394 end BEN_CWB_PERSON_RATES_API;
[Home] [Help]