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