1 Package BEN_CWB_PERSON_GROUPS_API AUTHID CURRENT_USER as
2 /* $Header: becpgapi.pkh 120.2.12000000.1 2007/01/19 02:23:44 appldev noship $ */
3 /*#
4 * This package contains Compensation Workbench Budget APIs.
5 * @rep:scope public
6 * @rep:product PER
7 * @rep:displayname Compensation Workbench Budget Detail
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |---------------------------< create_group_budget >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates budgeting details for compensation workbench processing.
17 *
18 * This API creates budgeting records (budget details) and refers to budget
19 * plan. Each record here refers to a budget plan. There will a plan record and
20 * multiple option records. Rate values stored here are in budget plan
21 * currency. Compensation Workbench self-service pages refer and update budget
22 * information using this API.
23 *
24 * <p><b>Licensing</b><br>
25 * This API is licensed for use with Human Resources.
26 *
27 * <p><b>Prerequisites</b><br>
28 * A budget rate should be defined for the Compensation Workbench Plan.
29 *
30 * <p><b>Post Success</b><br>
31 * The budget detail will be inserted into the database.
32 *
33 * <p><b>Post Failure</b><br>
34 * The budget detail will not be inserted 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 This parameter identifies the Life Event Reason
40 * ID of Compensation Workbench Person. Foreign key to BEN_PER_IN_LER..
41 * @param p_group_pl_id {@rep:casecolumn BEN_CWB_PL_DSGN.GROUP_PL_ID}
42 * @param p_group_oipl_id {@rep:casecolumn BEN_CWB_PL_DSGN.GROUP_OIPL_ID}
43 * @param p_lf_evt_ocrd_dt This parameter specifies the date on which the life
44 * event occurred.
45 * @param p_bdgt_pop_cd This parameter specifies the budget population code.
46 * Valid values are defined by the 'BEN_CWB_EMP_POP' lookup type.
47 * @param p_due_dt This parameter specifies the due date.
48 * @param p_access_cd This parameter specifies the access code for manager.
49 * Valid values are defined by 'BEN_CWB_TASK_ACCESS' lookup type.
50 * @param p_approval_cd This parameter specifies the approval code. Valid
51 * values are defined by 'BEN_APPR_STAT' lookup type.
52 * @param p_approval_date This parameter specifies the date of approval.
53 * @param p_approval_comments This parameter specifies the manager comments on
54 * approval.
55 * @param p_dist_bdgt_val This parameter specifies the value of budget to be
56 * distributed.
57 * @param p_ws_bdgt_val This parameter specifies the budget value on worksheet.
58 * @param p_rsrv_val This parameter specifies the budget reserve value.
59 * @param p_dist_bdgt_mn_val This parameter specifies the distribution budget
60 * minimum value.
61 * @param p_dist_bdgt_mx_val This parameter specifies the distribution budget
62 * maximum value.
63 * @param p_dist_bdgt_incr_val This parameter specifies the distribution budget
64 * increment value.
65 * @param p_ws_bdgt_mn_val This parameter specifies the worksheet budget
66 * minimum value.
67 * @param p_ws_bdgt_mx_val This parameter specifies the worksheet budget
68 * maximum value.
69 * @param p_ws_bdgt_incr_val This parameter specifies the worksheet budget
70 * increment value.
71 * @param p_rsrv_mn_val This parameter specifies the reserve minimum value.
72 * @param p_rsrv_mx_val This parameter specifies the reserve maximum value.
73 * @param p_rsrv_incr_val This parameter specifies the reserve increment value.
74 * @param p_dist_bdgt_iss_val {@rep:casecolumn
75 * BEN_CWB_PERSON_GROUPS.DIST_BDGT_ISS_VAL}
76 * @param p_ws_bdgt_iss_val {@rep:casecolumn
77 * BEN_CWB_PERSON_GROUPS.WS_BDGT_ISS_VAL}
78 * @param p_dist_bdgt_iss_date {@rep:casecolumn
79 * BEN_CWB_PERSON_GROUPS.DIST_BDGT_ISS_DATE}
80 * @param p_ws_bdgt_iss_date {@rep:casecolumn
81 * BEN_CWB_PERSON_GROUPS.WS_BDGT_ISS_DATE}
82 * @param p_ws_bdgt_val_last_upd_date {@rep:casecolumn
83 * BEN_CWB_PERSON_GROUPS.WS_BDGT_VAL_LAST_UPD_DATE}
84 * @param p_dist_bdgt_val_last_upd_date {@rep:casecolumn
85 * BEN_CWB_PERSON_GROUPS.DIST_BDGT_VAL_LAST_UPD_DATE}
86 * @param p_rsrv_val_last_upd_date {@rep:casecolumn
87 * BEN_CWB_PERSON_GROUPS.RSRV_VAL_LAST_UPD_DATE}
88 * @param p_ws_bdgt_val_last_upd_by {@rep:casecolumn
89 * BEN_CWB_PERSON_GROUPS.WS_BDGT_VAL_LAST_UPD_BY}
90 * @param p_dist_bdgt_val_last_upd_by {@rep:casecolumn
91 * BEN_CWB_PERSON_GROUPS.DIST_BDGT_VAL_LAST_UPD_BY}
92 * @param p_rsrv_val_last_upd_by {@rep:casecolumn
93 * BEN_CWB_PERSON_GROUPS.RSRV_VAL_LAST_UPD_BY}
94 * @param p_submit_cd This parameter specifies the allocation submission code
95 * to indicate if the manager has submitted work for approval. Valid values are
96 * defined from the 'BEN_SUBMIT_STAT' lookup type.
97 * @param p_submit_date This parameter specifies the allocation submission
98 * date.
99 * @param p_submit_comments This parameter specifies the submission comments.
100 * @param p_object_version_number If p_validate is false, then set to the
101 * version number of the created Compensation Workbench Budget. If p_validate
102 * is true, then the value will be null.
103 * @rep:displayname Create Group Budget
104 * @rep:category BUSINESS_ENTITY BEN_CWB_BUDGET
105 * @rep:lifecycle active
106 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
107 * @rep:scope public
108 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
109 */
110 --
111 -- {End Of Comments}
112 --
113 procedure create_group_budget
114 (p_validate in boolean default false
115 ,p_group_per_in_ler_id in number
116 ,p_group_pl_id in number
117 ,p_group_oipl_id in number
118 ,p_lf_evt_ocrd_dt in date
119 ,p_bdgt_pop_cd in varchar2 default null
120 ,p_due_dt in date default null
121 ,p_access_cd in varchar2 default null
122 ,p_approval_cd in varchar2 default null
123 ,p_approval_date in date default null
124 ,p_approval_comments in varchar2 default null
125 ,p_dist_bdgt_val in number default null
126 ,p_ws_bdgt_val in number default null
127 ,p_rsrv_val in number default null
128 ,p_dist_bdgt_mn_val in number default null
129 ,p_dist_bdgt_mx_val in number default null
130 ,p_dist_bdgt_incr_val in number default null
131 ,p_ws_bdgt_mn_val in number default null
132 ,p_ws_bdgt_mx_val in number default null
133 ,p_ws_bdgt_incr_val in number default null
134 ,p_rsrv_mn_val in number default null
135 ,p_rsrv_mx_val in number default null
136 ,p_rsrv_incr_val in number default null
137 ,p_dist_bdgt_iss_val in number default null
138 ,p_ws_bdgt_iss_val in number default null
139 ,p_dist_bdgt_iss_date in date default null
140 ,p_ws_bdgt_iss_date in date default null
141 ,p_ws_bdgt_val_last_upd_date in date default null
142 ,p_dist_bdgt_val_last_upd_date in date default null
143 ,p_rsrv_val_last_upd_date in date default null
144 ,p_ws_bdgt_val_last_upd_by in number default null
145 ,p_dist_bdgt_val_last_upd_by in number default null
146 ,p_rsrv_val_last_upd_by in number default null
147 ,p_submit_cd in varchar2 default null
148 ,p_submit_date in date default null
149 ,p_submit_comments in varchar2 default null
150 ,p_object_version_number out nocopy number
151 );
152 --
153 -- ----------------------------------------------------------------------------
154 -- |---------------------------< update_group_budget >------------------------|
155 -- ----------------------------------------------------------------------------
156 --
157 -- {Start Of Comments}
158 /*#
159 * This API updates budgeting details for compensation workbench processing.
160 *
161 * This API updates budgeting records (budget details) and refers to budget
162 * plan. Each record here refers to a budget plan. There will be a plan record
163 * and multiple option records. Rate values stored here are in budget plan
164 * currency. Compensation Workbench self-service pages refer and update budget
165 * information using this API.
166 *
167 * <p><b>Licensing</b><br>
168 * This API is licensed for use with Human Resources.
169 *
170 * <p><b>Prerequisites</b><br>
171 * A Compensation Workbench Budget to update in the database must exist.
172 *
173 * <p><b>Post Success</b><br>
174 * The budget detail will be updated into the database.
175 *
176 * <p><b>Post Failure</b><br>
177 * The budget detail will not be updated in the database.
178 *
179 * @param p_validate If true, then validation alone will be performed and the
180 * database will remain unchanged. If false and all validation checks pass,
181 * then the database will be modified.
182 * @param p_group_per_in_ler_id This parameter identifies the Life Event Reason
183 * ID of Compensation Workbench Person. Foreign key to BEN_PER_IN_LER.
184 * @param p_group_pl_id This parameter specifies the Compensation Workbench
185 * Group Plan ID.
186 * @param p_group_oipl_id This parameter specifies the Compensation Workbench
187 * Group Options ID.
188 * @param p_lf_evt_ocrd_dt This parameter specifies the date on which the life
189 * event occurred.
190 * @param p_bdgt_pop_cd This parameter specifies the Budget Population Code.
191 * Valid values are defined from 'BEN_CWB_EMP_POP' lookup.
192 * @param p_due_dt This parameter specifies the Due Date.
193 * @param p_access_cd This parameter specifies the access code for manager.
194 * Valid values are defined by 'BEN_CWB_TASK_ACCESS' lookup type.
195 * @param p_approval_cd This parameter specifies the approval code. Valid
196 * values are defined by 'BEN_APPR_STAT' lookup type.
197 * @param p_approval_date This parameter specifies the date of approval of
198 * allocations.
199 * @param p_approval_comments This parameter specifies the manager's comments
200 * on the approval.
201 * @param p_dist_bdgt_val This parameter specifies the value of budget to be
202 * distributed.
203 * @param p_ws_bdgt_val This parameter specifies the budget value on worksheet.
204 * @param p_rsrv_val This parameter specifies the budget reserve value.
205 * @param p_dist_bdgt_mn_val This parameter specifies the distribution budget
206 * minimum value.
207 * @param p_dist_bdgt_mx_val This parameter specifies the sistribution budget
208 * maximum value.
209 * @param p_dist_bdgt_incr_val This parameter specifies the distribution budget
210 * increment value.
211 * @param p_ws_bdgt_mn_val This parameter specifies the worksheet budget
212 * minimum value.
213 * @param p_ws_bdgt_mx_val This parameter specifies the worksheet budget
214 * maximum value.
215 * @param p_ws_bdgt_incr_val This parameter specifies the worksheet budget
216 * increment value.
217 * @param p_rsrv_mn_val This parameter specifies the reserve budget minimum
218 * value.
219 * @param p_rsrv_mx_val This parameter specifies the reserve budget maximum
220 * value.
224 * BEN_CWB_PERSON_GROUPS.DIST_BDGT_ISS_VAL}
221 * @param p_rsrv_incr_val This parameter specifies the reserve budget increment
222 * value.
223 * @param p_dist_bdgt_iss_val {@rep:casecolumn
225 * @param p_ws_bdgt_iss_val {@rep:casecolumn
226 * BEN_CWB_PERSON_GROUPS.WS_BDGT_ISS_VAL}
227 * @param p_dist_bdgt_iss_date {@rep:casecolumn
228 * BEN_CWB_PERSON_GROUPS.DIST_BDGT_ISS_DATE}
229 * @param p_ws_bdgt_iss_date {@rep:casecolumn
230 * BEN_CWB_PERSON_GROUPS.WS_BDGT_ISS_DATE}
231 * @param p_ws_bdgt_val_last_upd_date {@rep:casecolumn
232 * BEN_CWB_PERSON_GROUPS.WS_BDGT_VAL_LAST_UPD_DATE}
233 * @param p_dist_bdgt_val_last_upd_date {@rep:casecolumn
234 * BEN_CWB_PERSON_GROUPS.DIST_BDGT_VAL_LAST_UPD_DATE}
235 * @param p_rsrv_val_last_upd_date {@rep:casecolumn
236 * BEN_CWB_PERSON_GROUPS.RSRV_VAL_LAST_UPD_DATE}
237 * @param p_ws_bdgt_val_last_upd_by {@rep:casecolumn
238 * BEN_CWB_PERSON_GROUPS.WS_BDGT_VAL_LAST_UPD_BY}
239 * @param p_dist_bdgt_val_last_upd_by {@rep:casecolumn
240 * BEN_CWB_PERSON_GROUPS.DIST_BDGT_VAL_LAST_UPD_BY}
241 * @param p_rsrv_val_last_upd_by {@rep:casecolumn
242 * BEN_CWB_PERSON_GROUPS.RSRV_VAL_LAST_UPD_BY}
243 * @param p_submit_cd This parameter specifies the allocation submission code
244 * to indicate if the manager has submitted work for approval. Valid values are
245 * defined from 'BEN_SUBMIT_STAT' lookup type.
246 * @param p_submit_date This parameter specifies the allocation submission
247 * date.
248 * @param p_submit_comments This parameter specifies the submission comments.
249 * @param p_perf_min_max_edit This parameter specifies the flag to check edits
250 * for value between minimum and maximum.
251 * @param p_object_version_number Pass in the current version number of the
252 * Compensation Workbench Budget to be updated. When the API completes if
253 * p_validate is false, will be set to the new version number of the updated
254 * Compensation Workbench Budget. If p_validate is true will be set to the same
255 * value which was passed in.
256 * @rep:displayname Update Group Budget
257 * @rep:category BUSINESS_ENTITY BEN_CWB_BUDGET
258 * @rep:lifecycle active
259 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
260 * @rep:scope public
261 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
262 */
263 --
264 -- {End Of Comments}
265 --
266 procedure update_group_budget
267 (p_validate in boolean default false
268 ,p_group_per_in_ler_id in number
269 ,p_group_pl_id in number
270 ,p_group_oipl_id in number
271 ,p_lf_evt_ocrd_dt in date default hr_api.g_date
272 ,p_bdgt_pop_cd in varchar2 default hr_api.g_varchar2
273 ,p_due_dt in date default hr_api.g_date
274 ,p_access_cd in varchar2 default hr_api.g_varchar2
275 ,p_approval_cd in varchar2 default hr_api.g_varchar2
276 ,p_approval_date in date default hr_api.g_date
277 ,p_approval_comments in varchar2 default hr_api.g_varchar2
278 ,p_dist_bdgt_val in number default hr_api.g_number
279 ,p_ws_bdgt_val in number default hr_api.g_number
280 ,p_rsrv_val in number default hr_api.g_number
281 ,p_dist_bdgt_mn_val in number default hr_api.g_number
282 ,p_dist_bdgt_mx_val in number default hr_api.g_number
283 ,p_dist_bdgt_incr_val in number default hr_api.g_number
284 ,p_ws_bdgt_mn_val in number default hr_api.g_number
285 ,p_ws_bdgt_mx_val in number default hr_api.g_number
286 ,p_ws_bdgt_incr_val in number default hr_api.g_number
287 ,p_rsrv_mn_val in number default hr_api.g_number
288 ,p_rsrv_mx_val in number default hr_api.g_number
289 ,p_rsrv_incr_val in number default hr_api.g_number
290 ,p_dist_bdgt_iss_val in number default hr_api.g_number
291 ,p_ws_bdgt_iss_val in number default hr_api.g_number
292 ,p_dist_bdgt_iss_date in date default hr_api.g_date
293 ,p_ws_bdgt_iss_date in date default hr_api.g_date
294 ,p_ws_bdgt_val_last_upd_date in date default hr_api.g_date
295 ,p_dist_bdgt_val_last_upd_date in date default hr_api.g_date
296 ,p_rsrv_val_last_upd_date in date default hr_api.g_date
297 ,p_ws_bdgt_val_last_upd_by in number default hr_api.g_number
298 ,p_dist_bdgt_val_last_upd_by in number default hr_api.g_number
299 ,p_rsrv_val_last_upd_by in number default hr_api.g_number
300 ,p_submit_cd in varchar2 default hr_api.g_varchar2
301 ,p_submit_date in date default hr_api.g_date
302 ,p_submit_comments in varchar2 default hr_api.g_varchar2
303 ,p_perf_min_max_edit in varchar2 default 'Y'
304 ,p_object_version_number in out nocopy number
305 );
306 --
307 -- ----------------------------------------------------------------------------
308 -- |---------------------------< delete_group_budget >------------------------|
309 -- ----------------------------------------------------------------------------
310 --
311 -- {Start Of Comments}
312 /*#
313 * This API deletes budgeting details for compensation workbench processing.
314 *
315 * This API deletes budgeting records (budget details). Each record here refers
316 * to a budget plan. Compensation Workbench self-service pages refer and delete
317 * budget information using this API.
318 *
319 * <p><b>Licensing</b><br>
320 * This API is licensed for use with Human Resources.
321 *
322 * <p><b>Prerequisites</b><br>
326 * The budget detail will be deleted from the database.
323 * A Compensation Workbench Budget to delete exists in the database.
324 *
325 * <p><b>Post Success</b><br>
327 *
328 * <p><b>Post Failure</b><br>
329 * The budget detail will not be deleted from the database.
330 *
331 * @param p_validate If true, then validation alone will be performed and the
332 * database will remain unchanged. If false and all validation checks pass,
333 * then the database will be modified.
334 * @param p_group_per_in_ler_id This parameter identifies the Life Event Reason
335 * ID of Compensation Workbench Person. Foreign key to BEN_PER_IN_LER.
336 * @param p_group_pl_id {@rep:casecolumn BEN_CWB_PL_DSGN.GROUP_PL_ID}
337 * @param p_group_oipl_id {@rep:casecolumn BEN_CWB_PL_DSGN.GROUP_OIPL_ID}
338 * @param p_object_version_number Pass in the current version number of the
339 * @param p_update_summary Pass true to update summary reflecting the delete.
340 * Compensation Workbench Budget to be updated. When the API completes if
341 * p_validate is false, will be set to the new version number of the updated
342 * Compensation Workbench Budget. If p_validate is true will be set to the same
343 * value which was passed in.
344 * @rep:displayname Delete Group Budget
345 * @rep:category BUSINESS_ENTITY BEN_CWB_BUDGET
346 * @rep:lifecycle active
347 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
348 * @rep:scope public
349 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
350 */
351 --
352 -- {End Of Comments}
353 --
354 procedure delete_group_budget
355 (p_validate in boolean default false
356 ,p_group_per_in_ler_id in number
357 ,p_group_pl_id in number
358 ,p_group_oipl_id in number
359 ,p_object_version_number in out nocopy number
360 ,p_update_summary in boolean default false
361 );
362 end BEN_CWB_PERSON_GROUPS_API;
[Home] [Help]