1 Package pqh_BUDGET_POOLS_api AUTHID CURRENT_USER as
5 * and reallocation transactions.
2 /* $Header: pqbplapi.pkh 120.1 2005/10/02 02:25:59 aroussel $ */
3 /*#
4 * This package contains APIs to create, update or delete reallocation folders
6 * @rep:scope public
7 * @rep:product per
8 * @rep:displayname Budget Pool
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |------------------------< create_reallocation_folder >--------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates the reallocation folder.
18 *
19 * Reallocation pool for a budget version and for a specific budget measurement
20 * unit is created.
21 *
22 * <p><b>Licensing</b><br>
23 * This API is licensed for use with Human Resources.
24 *
25 * <p><b>Prerequisites</b><br>
26 * Budget unit and budget version should already exist.
27 *
28 * <p><b>Post Success</b><br>
29 * Reallocation folder will be inserted in the database.
30 *
31 * <p><b>Post Failure</b><br>
32 * Reallocation folder will not be created and an error will be raised.
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_effective_date Reference date for validating lookup values are
37 * applicable during the start to end active date range. This date does not
38 * determine when the changes take effect.
39 * @param p_folder_id If p_validate is false, then this uniquely identifies the
40 * reallocation folder created. If p_validate is true, then set to null.
41 * @param p_name Identifies folder/transaction name.
42 * @param p_budget_version_id Identifies Parent folder.
43 * @param p_budget_unit_id Measurement unit of the budget version for which the
44 * pool is created.
45 * @param p_entity_type Identifies the budgeted entity. Valid values are
46 * defined by 'PQH_BUDGET_ENTITY' lookup type.
47 * @param p_approval_status Indicates the approval status. Valid values are
48 * defined by 'PQH_REALLOC_TXN_STATUS' lookup type.
49 * @param p_object_version_number If p_validate is false, then set to the
50 * version number of the created reallocation folder. If p_validate is true,
51 * then the value will be null.
52 * @param p_business_group_id Identifies business group.
53 * @param p_wf_transaction_category_id Workflow transaction category
54 * identifier.
55 * @rep:displayname Create Reallocation Folder
56 * @rep:category BUSINESS_ENTITY HR_BUDGET
57 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
58 * @rep:scope public
59 * @rep:lifecycle active
60 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
61 */
62 --
63 -- {End Of Comments}
64 --
65 procedure create_reallocation_folder
66 (
67 p_validate in boolean default false
68 ,p_effective_date in date
69 ,p_folder_id out nocopy number
70 ,p_name in varchar2
71 ,p_budget_version_id in number
72 ,p_budget_unit_id in number
73 ,p_entity_type in varchar2
74 ,p_approval_status in varchar2
75 ,p_object_version_number out nocopy number
76 ,p_business_group_id in number
77 ,p_wf_transaction_category_id in number
78 );
79 --
80 -- ----------------------------------------------------------------------------
81 -- |------------------------< update_reallocation_folder >--------------------|
82 -- ----------------------------------------------------------------------------
83 --
84 -- {Start Of Comments}
85 /*#
86 * This API updates the reallocation folder.
87 *
88 * Reallocation pool for a budget version and for a specific budget measurement
89 * unit is updated.
90 *
91 * <p><b>Licensing</b><br>
92 * This API is licensed for use with Human Resources.
93 *
94 * <p><b>Prerequisites</b><br>
95 * Reallocation folder to be updated should already exist. Budget version and
96 * budget unit should already exist.
97 *
98 * <p><b>Post Success</b><br>
99 * Reallocation folder will be updated in the database.
100 *
101 * <p><b>Post Failure</b><br>
102 * Reallocation folder will not be updated and an error will be raised.
103 * @param p_validate If true, then validation alone will be performed and the
104 * database will remain unchanged. If false and all validation checks pass,
105 * then the database will be modified.
106 * @param p_effective_date Reference date for validating lookup values are
107 * applicable during the start to end active date range. This date does not
108 * determine when the changes take effect.
109 * @param p_folder_id Identifies the reallocation folder.
110 * @param p_name Identifies folder/transaction name.
111 * @param p_budget_version_id Identifies Parent folder.
112 * @param p_budget_unit_id Measurement unit of the budget version for which the
113 * pool is created.
114 * @param p_entity_type Identifies the budgeted entity. Valid values are
115 * defined by 'PQH_BUDGET_ENTITY' lookup type.
116 * @param p_approval_status Indicates the approval status. Valid values are
117 * defined by 'PQH_REALLOC_TXN_STATUS' lookup type.
118 * @param p_object_version_number Pass in the current version number of the
119 * reallocation folder to be updated. When the API completes if p_validate is
120 * false, will be set to the new version number of the updated reallocation
121 * folder. If p_validate is true will be set to the same value which was passed
122 * in
123 * @param p_business_group_id Identifies business group.
124 * @param p_wf_transaction_category_id Workflow transaction category
128 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
125 * identifier.
126 * @rep:displayname Update Reallocation Folder
127 * @rep:category BUSINESS_ENTITY HR_BUDGET
129 * @rep:scope public
130 * @rep:lifecycle active
131 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
132 */
133 --
134 -- {End Of Comments}
135 --
136 procedure update_reallocation_folder
137 (
138 p_validate in boolean default false
139 ,p_effective_date in date
140 ,p_folder_id in number
141 ,p_name in varchar2 default hr_api.g_varchar2
142 ,p_budget_version_id in number default hr_api.g_number
143 ,p_budget_unit_id in number default hr_api.g_number
144 ,p_entity_type in varchar2 default hr_api.g_varchar2
145 ,p_approval_status in varchar2 default hr_api.g_varchar2
146 ,p_object_version_number in out nocopy number
147 ,p_business_group_id in number
148 ,p_wf_transaction_category_id in number
149 );
150 --
151 -- ----------------------------------------------------------------------------
152 -- |------------------------< delete_reallocation_folder >--------------------|
153 -- ----------------------------------------------------------------------------
154 --
155 -- {Start Of Comments}
156 /*#
157 * This API deletes the reallocation folder.
158 *
159 * Reallocation pool for a budget version and for a specific budget measurement
160 * unit is deleted.
161 *
162 * <p><b>Licensing</b><br>
163 * This API is licensed for use with Human Resources.
164 *
165 * <p><b>Prerequisites</b><br>
166 * The reallocation folder to be deleted should already exist.
167 *
168 * <p><b>Post Success</b><br>
169 * Reallocation folder will be deleted from the database.
170 *
171 * <p><b>Post Failure</b><br>
172 * Reallocation folder will not be deleted and an error will be raised.
173 * @param p_validate If true, then validation alone will be performed and the
174 * database will remain unchanged. If false and all validation checks pass,
175 * then the database will be modified.
176 * @param p_folder_id This uniquely identifies the reallocation folder.
177 * @param p_object_version_number Current version number of the reallocation
178 * folder to be deleted.
179 * @param p_effective_date Reference date for validating lookup values are
180 * applicable during the start to end active date range. This date does not
181 * determine when the changes take effect.
182 * @rep:displayname Delete Reallocation Folder
183 * @rep:category BUSINESS_ENTITY HR_BUDGET
184 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
185 * @rep:scope public
186 * @rep:lifecycle active
187 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
188 */
189 --
190 -- {End Of Comments}
191 --
192 procedure delete_reallocation_folder
193 (
194 p_validate in boolean default false
195 ,p_folder_id in number
196 ,p_object_version_number in number
197 ,p_effective_date in date
198 );
199 --
200 -- ----------------------------------------------------------------------------
201 -- |-------------------------< create_reallocation_txn >----------------------|
202 -- ----------------------------------------------------------------------------
203 --
204 -- {Start Of Comments}
205 /*#
206 * This API creates the reallocation transaction.
207 *
208 * Reallocation transaction is a placeholder for linking the reallocation
209 * folder and the reallocation transaction detail. Reallocation transaction has
210 * to be created before creating reallocation transaction details. A
211 * reallocation transaction must be balanced for it to be approved.
212 *
213 * <p><b>Licensing</b><br>
214 * This API is licensed for use with Human Resources.
215 *
216 * <p><b>Prerequisites</b><br>
217 * Reallocation folder should already exist.
218 *
219 * <p><b>Post Success</b><br>
220 * Reallocation transaction will be inserted in the database.
221 *
222 * <p><b>Post Failure</b><br>
223 * Reallocation transaction will not be created and an error will be raised.
224 * @param p_validate If true, then validation alone will be performed and the
225 * database will remain unchanged. If false and all validation checks pass,
226 * then the database will be modified.
227 * @param p_effective_date Reference date for validating lookup values are
228 * applicable during the start to end active date range. This date does not
229 * determine when the changes take effect.
230 * @param p_transaction_id If p_validate is false, then this uniquely
231 * identifies the reallocation transaction created. If p_validate is true, then
232 * set to null.
233 * @param p_name {@rep:casecolumn PQH_BUDGET_POOLS.NAME}
234 * @param p_parent_folder_id Identifies Parent folder.
235 * @param p_object_version_number If p_validate is false, then set to the
236 * version number of the created reallocation transaction. If p_validate is
237 * true, then the value will be null.
238 * @param p_business_group_id Identifies business group.
239 * @rep:displayname Create Reallocation Transaction
240 * @rep:category BUSINESS_ENTITY HR_BUDGET
241 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
242 * @rep:scope public
243 * @rep:lifecycle active
244 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
245 */
246 --
247 -- {End Of Comments}
248 --
249 procedure create_reallocation_txn
250 (
251 p_validate in boolean default false
252 ,p_effective_date in date
256 ,p_object_version_number out nocopy number
253 ,p_transaction_id out nocopy number
254 ,p_name in varchar2
255 ,p_parent_folder_id in number
257 ,p_business_group_id in number
258
259 );
260 --
261 -- ----------------------------------------------------------------------------
262 -- |-------------------------< update_reallocation_txn >----------------------|
263 -- ----------------------------------------------------------------------------
264 --
265 -- {Start Of Comments}
266 /*#
267 * This API updates the reallocation transaction.
268 *
269 * Reallocation transaction is a placeholder for linking the reallocation
270 * folder and the reallocation transaction detail. A reallocation transaction
271 * must be balanced for it to be approved.
272 *
273 * <p><b>Licensing</b><br>
274 * This API is licensed for use with Human Resources.
275 *
276 * <p><b>Prerequisites</b><br>
277 * The reallocation transaction to be updated should already exist.
278 * Reallocation folder should already exist.
279 *
280 * <p><b>Post Success</b><br>
281 * Reallocation transaction will be updated in the database.
282 *
283 * <p><b>Post Failure</b><br>
284 * Reallocation transaction will not be updated and an error will be raised.
285 * @param p_validate If true, then validation alone will be performed and the
286 * database will remain unchanged. If false and all validation checks pass,
287 * then the database will be modified.
288 * @param p_effective_date Reference date for validating lookup values are
289 * applicable during the start to end active date range. This date does not
290 * determine when the changes take effect.
291 * @param p_transaction_id Identifies the reallocation transaction.
292 * @param p_name Identifies folder/transaction name.
293 * @param p_parent_folder_id Identifies parent folder.
294 * @param p_object_version_number Pass in the current version number of the
295 * reallocation transaction to be updated. When the API completes if p_validate
296 * is false, will be set to the new version number of the updated reallocation
297 * transaction. If p_validate is true will be set to the same value which was
298 * passed in.
299 * @param p_business_group_id Identifies business group.
300 * @rep:displayname Update Reallocation Transaction
301 * @rep:category BUSINESS_ENTITY HR_BUDGET
302 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
303 * @rep:scope public
304 * @rep:lifecycle active
305 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
306 */
307 --
308 -- {End Of Comments}
309 --
310 procedure update_reallocation_txn
311 (
312 p_validate in boolean default false
313 ,p_effective_date in date
314 ,p_transaction_id in number
315 ,p_name in varchar2 default hr_api.g_varchar2
316 ,p_parent_folder_id in number default hr_api.g_number
317 ,p_object_version_number in out nocopy number
318 ,p_business_group_id in number default hr_api.g_number
319
320 );
321 --
322 -- ----------------------------------------------------------------------------
323 -- |-------------------------< delete_reallocation_txn >----------------------|
324 -- ----------------------------------------------------------------------------
325 --
326 -- {Start Of Comments}
327 /*#
328 * This API deletes the reallocation transaction.
329 *
330 *
331 * <p><b>Licensing</b><br>
332 * This API is licensed for use with Human Resources.
333 *
334 * <p><b>Prerequisites</b><br>
335 * The reallocation transaction to be deleted should already exist.
336 *
337 * <p><b>Post Success</b><br>
338 * Reallocation transaction will be deleted from the database.
339 *
340 * <p><b>Post Failure</b><br>
341 * Reallocation transaction will not be deleted and an error will be raised.
342 * @param p_validate If true, then validation alone will be performed and the
343 * database will remain unchanged. If false and all validation checks pass,
344 * then the database will be modified.
345 * @param p_transaction_id This uniquely identifies the reallocation
346 * transaction
347 * @param p_object_version_number Current version number of the reallocation
348 * transaction to be deleted.
349 * @param p_effective_date Reference date for validating lookup values are
350 * applicable during the start to end active date range. This date does not
351 * determine when the changes take effect.
352 * @rep:displayname Delete Reallocation Transaction
353 * @rep:category BUSINESS_ENTITY HR_BUDGET
354 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
355 * @rep:scope public
356 * @rep:lifecycle active
357 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
358 */
359 --
360 -- {End Of Comments}
361 --
362 procedure delete_reallocation_txn
363 (
364 p_validate in boolean default false
365 ,p_transaction_id in number
366 ,p_object_version_number in number
367 ,p_effective_date in date
368 );
369 --
370 end pqh_budget_pools_api;
[Home] [Help]