4 * This package contains APIs that will maintain backfeed balance amounts.
1 Package PER_BF_BALANCE_AMOUNTS_API AUTHID CURRENT_USER AS
2 /* $Header: pebbaapi.pkh 120.1 2005/10/02 02:11:58 aroussel $ */
3 /*#
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Backfeed Balance Amount
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |--------------------------< create_balance_amount >-----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a set of balance amounts for a particular payroll run and
17 * assignment.
18 *
19 * Initially, a check is made to see if a row exists in the table
20 * PER_BF_PROCESSED_ASSIGNMENTS for the assignment and payroll run. If there
21 * isn't a row, one is created otherwise the ID of the existing row is used for
22 * the foreign key held in PER_BF_BALANCE_AMOUNTS.
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 * Backfeed balance type must be created.
29 *
30 * <p><b>Post Success</b><br>
31 * Information has successfully been inserted into the backfeed balance amount
32 * table. A row will be added, if one doesn't already exist, in the backfeed
33 * processed assignment.
34 *
35 * <p><b>Post Failure</b><br>
36 * The backfeed balance amount will not be updated and an error will be raised.
37 * @param p_validate If true, then validation alone will be performed and the
38 * database will remain unchanged. If false and all validation checks pass,
39 * then the database will be modified.
40 * @param p_effective_date Reference date for validating lookup values are
41 * applicable during the start to end active date range. This date does not
42 * determine when the changes take effect.
43 * @param p_business_group_id Business Group for this balance amount.
44 * @param p_balance_type_id {@rep:casecolumn
45 * PER_BF_BALANCE_TYPES.BALANCE_TYPE_ID}
46 * @param p_assignment_id {@rep:casecolumn PER_ALL_ASSIGNMENTS_F.ASSIGNMENT_ID}
47 * @param p_payroll_run_id {@rep:casecolumn PER_BF_PAYROLL_RUNS.PAYROLL_RUN_ID}
48 * @param p_ytd_amount Year to Date balance.
49 * @param p_fytd_amount Financial YTD balance.
50 * @param p_ptd_amount Period To Date Amount
51 * @param p_mtd_amount Month To Date Amount.
52 * @param p_qtd_amount Quarter to Date Amount
53 * @param p_run_amount Run Amount.
54 * @param p_currency_code Currency code of the amounts if the balance type is
55 * money.
56 * @param p_bba_attribute_category This context value determines which
57 * flexfield structure to use with the descriptive flexfield segments.
58 * @param p_bba_attribute1 Descriptive flexfield segment.
59 * @param p_bba_attribute2 Descriptive flexfield segment.
60 * @param p_bba_attribute3 Descriptive flexfield segment.
61 * @param p_bba_attribute4 Descriptive flexfield segment.
62 * @param p_bba_attribute5 Descriptive flexfield segment.
63 * @param p_bba_attribute6 Descriptive flexfield segment.
64 * @param p_bba_attribute7 Descriptive flexfield segment.
65 * @param p_bba_attribute8 Descriptive flexfield segment.
66 * @param p_bba_attribute9 Descriptive flexfield segment.
67 * @param p_bba_attribute10 Descriptive flexfield segment.
68 * @param p_bba_attribute11 Descriptive flexfield segment.
69 * @param p_bba_attribute12 Descriptive flexfield segment.
70 * @param p_bba_attribute13 Descriptive flexfield segment.
71 * @param p_bba_attribute14 Descriptive flexfield segment.
72 * @param p_bba_attribute15 Descriptive flexfield segment.
73 * @param p_bba_attribute16 Descriptive flexfield segment.
74 * @param p_bba_attribute17 Descriptive flexfield segment.
75 * @param p_bba_attribute18 Descriptive flexfield segment.
76 * @param p_bba_attribute19 Descriptive flexfield segment.
77 * @param p_bba_attribute20 Descriptive flexfield segment.
78 * @param p_bba_attribute21 Descriptive flexfield segment.
79 * @param p_bba_attribute22 Descriptive flexfield segment.
80 * @param p_bba_attribute23 Descriptive flexfield segment.
81 * @param p_bba_attribute24 Descriptive flexfield segment.
82 * @param p_bba_attribute25 Descriptive flexfield segment.
83 * @param p_bba_attribute26 Descriptive flexfield segment.
84 * @param p_bba_attribute27 Descriptive flexfield segment.
85 * @param p_bba_attribute28 Descriptive flexfield segment.
86 * @param p_bba_attribute29 Descriptive flexfield segment.
87 * @param p_bba_attribute30 Descriptive flexfield segment.
88 * @param p_processed_assignment_id {@rep:casecolumn
89 * PER_BF_PROCESSED_ASSIGNMENTS.PROCESSED_ASSIGNMENT_ID}
90 * @param p_processed_assignment_ovn {@rep:casecolumn
91 * PER_BF_PROCESSED_ASSIGNMENTS.OBJECT_VERSION_NUMBER}
92 * @param p_balance_amount_id If p_validate is false, then this uniquely
93 * identifies the backfeed balance amount created. If p_validate is true, then
94 * set to null.
95 * @param p_balance_amount_ovn If p_validate is false, then set to the version
96 * number of the backfeed balance amount. If p_validate is true, then the value
97 * will be null.
98 * @rep:displayname Create Backfeed Balance Amount
102 * @rep:lifecycle active
99 * @rep:category BUSINESS_ENTITY PER_BF_PAYROLL_RESULTS
100 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
101 * @rep:scope public
103 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
104 */
105 --
106 -- {End Of Comments}
107 --
108 procedure create_balance_amount
109 (p_validate in boolean default false
110 ,p_effective_date in date
111 ,p_business_group_id in number
112 ,p_balance_type_id in number
113 ,p_assignment_id in number
114 ,p_payroll_run_id in number
115 ,p_ytd_amount in number default null
116 ,p_fytd_amount in number default null
117 ,p_ptd_amount in number default null
118 ,p_mtd_amount in number default null
119 ,p_qtd_amount in number default null
120 ,p_run_amount in number default null
121 ,p_currency_code in varchar2 default null
122 ,p_bba_attribute_category in varchar2 default null
123 ,p_bba_attribute1 in varchar2 default null
124 ,p_bba_attribute2 in varchar2 default null
125 ,p_bba_attribute3 in varchar2 default null
126 ,p_bba_attribute4 in varchar2 default null
127 ,p_bba_attribute5 in varchar2 default null
128 ,p_bba_attribute6 in varchar2 default null
129 ,p_bba_attribute7 in varchar2 default null
130 ,p_bba_attribute8 in varchar2 default null
131 ,p_bba_attribute9 in varchar2 default null
132 ,p_bba_attribute10 in varchar2 default null
133 ,p_bba_attribute11 in varchar2 default null
134 ,p_bba_attribute12 in varchar2 default null
135 ,p_bba_attribute13 in varchar2 default null
136 ,p_bba_attribute14 in varchar2 default null
137 ,p_bba_attribute15 in varchar2 default null
138 ,p_bba_attribute16 in varchar2 default null
139 ,p_bba_attribute17 in varchar2 default null
140 ,p_bba_attribute18 in varchar2 default null
141 ,p_bba_attribute19 in varchar2 default null
142 ,p_bba_attribute20 in varchar2 default null
143 ,p_bba_attribute21 in varchar2 default null
144 ,p_bba_attribute22 in varchar2 default null
145 ,p_bba_attribute23 in varchar2 default null
146 ,p_bba_attribute24 in varchar2 default null
147 ,p_bba_attribute25 in varchar2 default null
148 ,p_bba_attribute26 in varchar2 default null
149 ,p_bba_attribute27 in varchar2 default null
150 ,p_bba_attribute28 in varchar2 default null
151 ,p_bba_attribute29 in varchar2 default null
152 ,p_bba_attribute30 in varchar2 default null
153 ,p_processed_assignment_id out nocopy number
154 ,p_processed_assignment_ovn out nocopy number
155 ,p_balance_amount_id out nocopy number
156 ,p_balance_amount_ovn out nocopy number
157 );
158 --
159 -- ----------------------------------------------------------------------------
160 -- |--------------------------< update_balance_amount >-----------------------|
161 -- ----------------------------------------------------------------------------
162 --
163 -- {Start Of Comments}
164 /*#
165 * This API updates a set of balance amounts for a particular payroll run and
166 * assignment.
167 *
168 * This API updates balance amounts which have been processed in a third party
169 * payroll application within the backfeed tables.
170 *
171 * <p><b>Licensing</b><br>
172 * This API is licensed for use with Human Resources.
173 *
174 * <p><b>Prerequisites</b><br>
175 * Balance amount been updated must exist.
176 *
177 * <p><b>Post Success</b><br>
178 * The backfeed balance amount will be successfully updated into the database.
179 *
180 * <p><b>Post Failure</b><br>
181 * The backfeed balance amount will not be updated and an error will be raised.
182 * @param p_validate If true, then validation alone will be performed and the
183 * database will remain unchanged. If false and all validation checks pass,
184 * then the database will be modified.
185 * @param p_effective_date Reference date for validating lookup values are
186 * applicable during the start to end active date range. This date does not
187 * determine when the changes take effect.
188 * @param p_ytd_amount Year to Date balance.
189 * @param p_fytd_amount Financial YTD balance.
190 * @param p_ptd_amount Period To Date Amount
191 * @param p_mtd_amount Month To Date Amount.
192 * @param p_qtd_amount Quarter to Date Amount
193 * @param p_run_amount Run Amount.
194 * @param p_currency_code Currency code of the amounts if the balance type is
195 * money.
196 * @param p_bba_attribute_category This context value determines which
197 * flexfield structure to use with the descriptive flexfield segments.
198 * @param p_bba_attribute1 Descriptive flexfield segment.
199 * @param p_bba_attribute2 Descriptive flexfield segment.
200 * @param p_bba_attribute3 Descriptive flexfield segment.
201 * @param p_bba_attribute4 Descriptive flexfield segment.
202 * @param p_bba_attribute5 Descriptive flexfield segment.
203 * @param p_bba_attribute6 Descriptive flexfield segment.
204 * @param p_bba_attribute7 Descriptive flexfield segment.
205 * @param p_bba_attribute8 Descriptive flexfield segment.
206 * @param p_bba_attribute9 Descriptive flexfield segment.
207 * @param p_bba_attribute10 Descriptive flexfield segment.
208 * @param p_bba_attribute11 Descriptive flexfield segment.
212 * @param p_bba_attribute15 Descriptive flexfield segment.
209 * @param p_bba_attribute12 Descriptive flexfield segment.
210 * @param p_bba_attribute13 Descriptive flexfield segment.
211 * @param p_bba_attribute14 Descriptive flexfield segment.
213 * @param p_bba_attribute16 Descriptive flexfield segment.
214 * @param p_bba_attribute17 Descriptive flexfield segment.
215 * @param p_bba_attribute18 Descriptive flexfield segment.
216 * @param p_bba_attribute19 Descriptive flexfield segment.
217 * @param p_bba_attribute20 Descriptive flexfield segment.
218 * @param p_bba_attribute21 Descriptive flexfield segment.
219 * @param p_bba_attribute22 Descriptive flexfield segment.
220 * @param p_bba_attribute23 Descriptive flexfield segment.
221 * @param p_bba_attribute24 Descriptive flexfield segment.
222 * @param p_bba_attribute25 Descriptive flexfield segment.
223 * @param p_bba_attribute26 Descriptive flexfield segment.
224 * @param p_bba_attribute27 Descriptive flexfield segment.
225 * @param p_bba_attribute28 Descriptive flexfield segment.
226 * @param p_bba_attribute29 Descriptive flexfield segment.
227 * @param p_bba_attribute30 Descriptive flexfield segment.
228 * @param p_balance_amount_id Uniquely identifies the backfeed balance amount
229 * to update.
230 * @param p_balance_amount_ovn Pass in the current version number of the
231 * backfeed balance amount to be updated. When the API completes if p_validate
232 * is false, will be set to the new version number of the updated backfeed
233 * balance amount. If p_validate is true will be set to the same value which
234 * was passed in.
235 * @rep:displayname Update Backfeed Balance Amount
236 * @rep:category BUSINESS_ENTITY PER_BF_PAYROLL_RESULTS
237 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
238 * @rep:scope public
239 * @rep:lifecycle active
240 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
241 */
242 --
243 -- {End Of Comments}
244 --
245 procedure update_balance_amount
246 (p_validate in boolean default false
247 ,p_effective_date in date
248 ,p_ytd_amount in number default hr_api.g_number
249 ,p_fytd_amount in number default hr_api.g_number
250 ,p_ptd_amount in number default hr_api.g_number
251 ,p_mtd_amount in number default hr_api.g_number
252 ,p_qtd_amount in number default hr_api.g_number
256 ,p_bba_attribute1 in varchar2 default hr_api.g_varchar2
253 ,p_run_amount in number default hr_api.g_number
254 ,p_currency_code in varchar2 default hr_api.g_varchar2
255 ,p_bba_attribute_category in varchar2 default hr_api.g_varchar2
257 ,p_bba_attribute2 in varchar2 default hr_api.g_varchar2
258 ,p_bba_attribute3 in varchar2 default hr_api.g_varchar2
259 ,p_bba_attribute4 in varchar2 default hr_api.g_varchar2
260 ,p_bba_attribute5 in varchar2 default hr_api.g_varchar2
261 ,p_bba_attribute6 in varchar2 default hr_api.g_varchar2
262 ,p_bba_attribute7 in varchar2 default hr_api.g_varchar2
263 ,p_bba_attribute8 in varchar2 default hr_api.g_varchar2
264 ,p_bba_attribute9 in varchar2 default hr_api.g_varchar2
265 ,p_bba_attribute10 in varchar2 default hr_api.g_varchar2
266 ,p_bba_attribute11 in varchar2 default hr_api.g_varchar2
267 ,p_bba_attribute12 in varchar2 default hr_api.g_varchar2
268 ,p_bba_attribute13 in varchar2 default hr_api.g_varchar2
269 ,p_bba_attribute14 in varchar2 default hr_api.g_varchar2
270 ,p_bba_attribute15 in varchar2 default hr_api.g_varchar2
271 ,p_bba_attribute16 in varchar2 default hr_api.g_varchar2
272 ,p_bba_attribute17 in varchar2 default hr_api.g_varchar2
273 ,p_bba_attribute18 in varchar2 default hr_api.g_varchar2
274 ,p_bba_attribute19 in varchar2 default hr_api.g_varchar2
275 ,p_bba_attribute20 in varchar2 default hr_api.g_varchar2
279 ,p_bba_attribute24 in varchar2 default hr_api.g_varchar2
276 ,p_bba_attribute21 in varchar2 default hr_api.g_varchar2
277 ,p_bba_attribute22 in varchar2 default hr_api.g_varchar2
278 ,p_bba_attribute23 in varchar2 default hr_api.g_varchar2
280 ,p_bba_attribute25 in varchar2 default hr_api.g_varchar2
281 ,p_bba_attribute26 in varchar2 default hr_api.g_varchar2
282 ,p_bba_attribute27 in varchar2 default hr_api.g_varchar2
283 ,p_bba_attribute28 in varchar2 default hr_api.g_varchar2
284 ,p_bba_attribute29 in varchar2 default hr_api.g_varchar2
285 ,p_bba_attribute30 in varchar2 default hr_api.g_varchar2
286 ,p_balance_amount_id in number
287 ,p_balance_amount_ovn in out nocopy number
288 );
289 --
290 -- ----------------------------------------------------------------------------
291 -- |--------------------------< delete_balance_amount >-----------------------|
292 -- ----------------------------------------------------------------------------
293 --
294 -- {Start Of Comments}
295 /*#
296 * This API deletes a set of balance amounts for a particular payroll run and
297 * assignment.
298 *
299 *
300 * <p><b>Licensing</b><br>
301 * This API is licensed for use with Human Resources.
302 *
303 * <p><b>Prerequisites</b><br>
304 * Balance amount been deleted must exist.
305 *
306 * <p><b>Post Success</b><br>
307 * The backfeed balance amount will be successfully deleted from the database.
308 *
309 * <p><b>Post Failure</b><br>
310 * The backfeed balance amount will not be deleted and an error will be raised.
311 * @param p_validate If true, then validation alone will be performed and the
312 * database will remain unchanged. If false and all validation checks pass,
313 * then the database will be modified.
314 * @param p_balance_amount_id Uniquely identifies the backfeed balance amount
315 * to delete.
316 * @param p_balance_amount_ovn Current version number of the backfeed balance
317 * amount to be deleted.
318 * @rep:displayname Delete Backfeed Balance Amount
319 * @rep:category BUSINESS_ENTITY PER_BF_PAYROLL_RESULTS
320 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
321 * @rep:scope public
322 * @rep:lifecycle active
323 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
324 */
325 --
326 -- {End Of Comments}
327 --
328 procedure delete_balance_amount
329 (p_validate in boolean default false
330 ,p_balance_amount_id in number
331 ,p_balance_amount_ovn in number
332 );
333 --
334 end PER_BF_BALANCE_AMOUNTS_API;
[Home] [Help]