1 Package PER_BF_PAYROLL_RUNS_API as
2 /* $Header: pebprapi.pkh 120.1 2005/10/02 02:12:27 aroussel $ */
3 /*#
4 * This package contains APIs that maintain backfeed payroll runs details.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Backfeed Payroll Run
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------------< create_payroll_run >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates payroll run information from a third party payroll
17 * application.
18 *
19 *
20 * <p><b>Licensing</b><br>
21 * This API is licensed for use with Human Resources.
22 *
23 * <p><b>Prerequisites</b><br>
24 * A valid payroll definition must exist.
25 *
26 * <p><b>Post Success</b><br>
27 * The backfeed payroll run will be successfully inserted into the database.
28 *
29 * <p><b>Post Failure</b><br>
30 * The backfeed payroll run will not be created and an error will be raised.
31 * @param p_validate If true, then validation alone will be performed and the
32 * database will remain unchanged. If false and all validation checks pass,
33 * then the database will be modified.
34 * @param p_effective_date Reference date for validating lookup values are
35 * applicable during the start to end active date range. This date does not
36 * determine when the changes take effect.
37 * @param p_business_group_id Business Group for the backfeed payroll run.
38 * @param p_payroll_id The payroll id of the payroll run.
39 * @param p_payroll_identifier Unique identifier of a payroll run.
40 * @param p_period_start_date Start date of the payroll period.
41 * @param p_period_end_date End date of the payroll period.
42 * @param p_processing_date Date the payroll run took place.
43 * @param p_bpr_attribute_category This context value determines which
44 * flexfield structure to use with the descriptive flexfield segments.
45 * @param p_bpr_attribute1 Descriptive flexfield segment.
46 * @param p_bpr_attribute2 Descriptive flexfield segment.
47 * @param p_bpr_attribute3 Descriptive flexfield segment.
48 * @param p_bpr_attribute4 Descriptive flexfield segment.
49 * @param p_bpr_attribute5 Descriptive flexfield segment.
50 * @param p_bpr_attribute6 Descriptive flexfield segment.
51 * @param p_bpr_attribute7 Descriptive flexfield segment.
52 * @param p_bpr_attribute8 Descriptive flexfield segment.
53 * @param p_bpr_attribute9 Descriptive flexfield segment.
54 * @param p_bpr_attribute10 Descriptive flexfield segment.
55 * @param p_bpr_attribute11 Descriptive flexfield segment.
56 * @param p_bpr_attribute12 Descriptive flexfield segment.
57 * @param p_bpr_attribute13 Descriptive flexfield segment.
58 * @param p_bpr_attribute14 Descriptive flexfield segment.
59 * @param p_bpr_attribute15 Descriptive flexfield segment.
60 * @param p_bpr_attribute16 Descriptive flexfield segment.
61 * @param p_bpr_attribute17 Descriptive flexfield segment.
62 * @param p_bpr_attribute18 Descriptive flexfield segment.
63 * @param p_bpr_attribute19 Descriptive flexfield segment.
64 * @param p_bpr_attribute20 Descriptive flexfield segment.
65 * @param p_bpr_attribute21 Descriptive flexfield segment.
66 * @param p_bpr_attribute22 Descriptive flexfield segment.
67 * @param p_bpr_attribute23 Descriptive flexfield segment.
68 * @param p_bpr_attribute24 Descriptive flexfield segment.
69 * @param p_bpr_attribute25 Descriptive flexfield segment.
70 * @param p_bpr_attribute26 Descriptive flexfield segment.
71 * @param p_bpr_attribute27 Descriptive flexfield segment.
72 * @param p_bpr_attribute28 Descriptive flexfield segment.
73 * @param p_bpr_attribute29 Descriptive flexfield segment.
74 * @param p_bpr_attribute30 Descriptive flexfield segment.
75 * @param p_payroll_run_id If p_validate is false, then this uniquely
76 * identifies the backfeed payroll run created. If p_validate is true, then set
77 * to null.
78 * @param p_object_version_number If p_validate is false, then set to the
79 * version number of the created backfeed payroll run record. If p_validate is
80 * true, then the value will be null.
81 * @rep:displayname Create Backfeed Payroll Run
82 * @rep:category BUSINESS_ENTITY PER_BF_PAYROLL_RESULTS
83 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
84 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
85 * @rep:scope public
86 * @rep:lifecycle active
87 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
88 */
89 --
90 -- {End Of Comments}
91 --
92 procedure create_payroll_run
93 (p_validate in boolean default false
94 ,p_effective_date in date
95 ,p_business_group_id in number
96 ,p_payroll_id in number
97 ,p_payroll_identifier in varchar2
98 ,p_period_start_date in date default null
99 ,p_period_end_date in date default null
100 ,p_processing_date in date default null
101 ,p_bpr_attribute_category in varchar2 default null
102 ,p_bpr_attribute1 in varchar2 default null
103 ,p_bpr_attribute2 in varchar2 default null
104 ,p_bpr_attribute3 in varchar2 default null
105 ,p_bpr_attribute4 in varchar2 default null
106 ,p_bpr_attribute5 in varchar2 default null
107 ,p_bpr_attribute6 in varchar2 default null
108 ,p_bpr_attribute7 in varchar2 default null
109 ,p_bpr_attribute8 in varchar2 default null
110 ,p_bpr_attribute9 in varchar2 default null
111 ,p_bpr_attribute10 in varchar2 default null
112 ,p_bpr_attribute11 in varchar2 default null
113 ,p_bpr_attribute12 in varchar2 default null
114 ,p_bpr_attribute13 in varchar2 default null
115 ,p_bpr_attribute14 in varchar2 default null
116 ,p_bpr_attribute15 in varchar2 default null
117 ,p_bpr_attribute16 in varchar2 default null
118 ,p_bpr_attribute17 in varchar2 default null
119 ,p_bpr_attribute18 in varchar2 default null
120 ,p_bpr_attribute19 in varchar2 default null
121 ,p_bpr_attribute20 in varchar2 default null
122 ,p_bpr_attribute21 in varchar2 default null
123 ,p_bpr_attribute22 in varchar2 default null
124 ,p_bpr_attribute23 in varchar2 default null
125 ,p_bpr_attribute24 in varchar2 default null
126 ,p_bpr_attribute25 in varchar2 default null
127 ,p_bpr_attribute26 in varchar2 default null
128 ,p_bpr_attribute27 in varchar2 default null
129 ,p_bpr_attribute28 in varchar2 default null
130 ,p_bpr_attribute29 in varchar2 default null
131 ,p_bpr_attribute30 in varchar2 default null
132 --
133 ,p_payroll_run_id out nocopy number
134 ,p_object_version_number out nocopy number
135 );
136 --
137 -- ----------------------------------------------------------------------------
138 -- |----------------------------< update_payroll_run >------------------------|
139 -- ----------------------------------------------------------------------------
140 --
141 -- {Start Of Comments}
142 /*#
143 * This API updates payroll run information from a third party payroll
144 * application.
145 *
146 *
147 * <p><b>Licensing</b><br>
148 * This API is licensed for use with Human Resources.
149 *
150 * <p><b>Prerequisites</b><br>
151 * A valid backfeed payroll run must exist.
152 *
153 * <p><b>Post Success</b><br>
154 * The backfeed payroll run will be successfully updated into the database.
155 *
156 * <p><b>Post Failure</b><br>
157 * The backfeed payroll run will not be updated and an error will be raised.
158 * @param p_payroll_run_id Uniquely identifies the backfeed payroll run.
159 * @param p_payroll_identifier Unique identifier of a payroll run.
160 * @param p_period_start_date Start date of the payroll period.
161 * @param p_period_end_date End date of the payroll period.
162 * @param p_processing_date Date the payroll run took place.
163 * @param p_bpr_attribute_category This context value determines which
164 * flexfield structure to use with the descriptive flexfield segments.
165 * @param p_bpr_attribute1 Descriptive flexfield segment.
166 * @param p_bpr_attribute2 Descriptive flexfield segment.
167 * @param p_bpr_attribute3 Descriptive flexfield segment.
168 * @param p_bpr_attribute4 Descriptive flexfield segment.
169 * @param p_bpr_attribute5 Descriptive flexfield segment.
170 * @param p_bpr_attribute6 Descriptive flexfield segment.
171 * @param p_bpr_attribute7 Descriptive flexfield segment.
172 * @param p_bpr_attribute8 Descriptive flexfield segment.
173 * @param p_bpr_attribute9 Descriptive flexfield segment.
174 * @param p_bpr_attribute10 Descriptive flexfield segment.
175 * @param p_bpr_attribute11 Descriptive flexfield segment.
176 * @param p_bpr_attribute12 Descriptive flexfield segment.
177 * @param p_bpr_attribute13 Descriptive flexfield segment.
178 * @param p_bpr_attribute14 Descriptive flexfield segment.
179 * @param p_bpr_attribute15 Descriptive flexfield segment.
180 * @param p_bpr_attribute16 Descriptive flexfield segment.
181 * @param p_bpr_attribute17 Descriptive flexfield segment.
182 * @param p_bpr_attribute18 Descriptive flexfield segment.
183 * @param p_bpr_attribute19 Descriptive flexfield segment.
184 * @param p_bpr_attribute20 Descriptive flexfield segment.
185 * @param p_bpr_attribute21 Descriptive flexfield segment.
186 * @param p_bpr_attribute22 Descriptive flexfield segment.
187 * @param p_bpr_attribute23 Descriptive flexfield segment.
188 * @param p_bpr_attribute24 Descriptive flexfield segment.
189 * @param p_bpr_attribute25 Descriptive flexfield segment.
190 * @param p_bpr_attribute26 Descriptive flexfield segment.
191 * @param p_bpr_attribute27 Descriptive flexfield segment.
192 * @param p_bpr_attribute28 Descriptive flexfield segment.
193 * @param p_bpr_attribute29 Descriptive flexfield segment.
194 * @param p_bpr_attribute30 Descriptive flexfield segment.
195 * @param p_validate If true, then validation alone will be performed and the
196 * database will remain unchanged. If false and all validation checks pass,
197 * then the database will be modified.
198 * @param p_effective_date Reference date for validating lookup values are
199 * applicable during the start to end active date range. This date does not
200 * determine when the changes take effect.
201 * @param p_object_version_number Pass in the current version number of the
202 * backfeed payroll run to be updated. When the API completes if p_validate is
203 * false, will be set to the new version number of the updated backfeed payment
204 * detail. If p_validate is true will be set to the same value which was passed
205 * in.
206 * @rep:displayname Update Backfeed Payroll Run
207 * @rep:category BUSINESS_ENTITY PER_BF_PAYROLL_RESULTS
208 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
209 * @rep:scope public
210 * @rep:lifecycle active
211 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
212 */
213 --
214 -- {End Of Comments}
215 --
216 procedure update_payroll_run
217 (p_payroll_run_id in number
218 ,p_payroll_identifier in varchar2 default hr_api.g_varchar2
219 ,p_period_start_date in date default hr_api.g_date
220 ,p_period_end_date in date default hr_api.g_date
221 ,p_processing_date in date default hr_api.g_date
222 ,p_bpr_attribute_category in varchar2 default hr_api.g_varchar2
223 ,p_bpr_attribute1 in varchar2 default hr_api.g_varchar2
224 ,p_bpr_attribute2 in varchar2 default hr_api.g_varchar2
225 ,p_bpr_attribute3 in varchar2 default hr_api.g_varchar2
226 ,p_bpr_attribute4 in varchar2 default hr_api.g_varchar2
227 ,p_bpr_attribute5 in varchar2 default hr_api.g_varchar2
228 ,p_bpr_attribute6 in varchar2 default hr_api.g_varchar2
229 ,p_bpr_attribute7 in varchar2 default hr_api.g_varchar2
230 ,p_bpr_attribute8 in varchar2 default hr_api.g_varchar2
231 ,p_bpr_attribute9 in varchar2 default hr_api.g_varchar2
232 ,p_bpr_attribute10 in varchar2 default hr_api.g_varchar2
233 ,p_bpr_attribute11 in varchar2 default hr_api.g_varchar2
234 ,p_bpr_attribute12 in varchar2 default hr_api.g_varchar2
235 ,p_bpr_attribute13 in varchar2 default hr_api.g_varchar2
236 ,p_bpr_attribute14 in varchar2 default hr_api.g_varchar2
237 ,p_bpr_attribute15 in varchar2 default hr_api.g_varchar2
238 ,p_bpr_attribute16 in varchar2 default hr_api.g_varchar2
239 ,p_bpr_attribute17 in varchar2 default hr_api.g_varchar2
240 ,p_bpr_attribute18 in varchar2 default hr_api.g_varchar2
241 ,p_bpr_attribute19 in varchar2 default hr_api.g_varchar2
242 ,p_bpr_attribute20 in varchar2 default hr_api.g_varchar2
243 ,p_bpr_attribute21 in varchar2 default hr_api.g_varchar2
244 ,p_bpr_attribute22 in varchar2 default hr_api.g_varchar2
245 ,p_bpr_attribute23 in varchar2 default hr_api.g_varchar2
246 ,p_bpr_attribute24 in varchar2 default hr_api.g_varchar2
247 ,p_bpr_attribute25 in varchar2 default hr_api.g_varchar2
248 ,p_bpr_attribute26 in varchar2 default hr_api.g_varchar2
249 ,p_bpr_attribute27 in varchar2 default hr_api.g_varchar2
250 ,p_bpr_attribute28 in varchar2 default hr_api.g_varchar2
251 ,p_bpr_attribute29 in varchar2 default hr_api.g_varchar2
252 ,p_bpr_attribute30 in varchar2 default hr_api.g_varchar2
253 ,p_validate in boolean default false
254 ,p_effective_date in date
255 ,p_object_version_number in out nocopy number
256 );
257 --
258 -- ----------------------------------------------------------------------------
259 -- |----------------------------< delete_payroll_run >------------------------|
260 -- ----------------------------------------------------------------------------
261 --
262 -- {Start Of Comments}
263 /*#
264 * This API deletes payroll run information from a third party payroll
265 * application.
266 *
267 *
268 * <p><b>Licensing</b><br>
269 * This API is licensed for use with Human Resources.
270 *
271 * <p><b>Prerequisites</b><br>
272 * A valid backfeed payroll run amount must exist.
273 *
274 * <p><b>Post Success</b><br>
275 * The backfeed payroll run amount will be successfully deleted from the
276 * database.
277 *
278 * <p><b>Post Failure</b><br>
279 * The backfeed payroll run amount will not be deleted and an error will be
280 * raised.
281 * @param p_payroll_run_id Uniquely identifies the backfeed payroll run.
282 * @param p_validate If true, then validation alone will be performed and the
283 * database will remain unchanged. If false and all validation checks pass,
284 * then the database will be modified.
285 * @param p_object_version_number Current version number of the backfeed
286 * payroll run to be deleted.
287 * @rep:displayname Delete Backfeed Payroll Run
288 * @rep:category BUSINESS_ENTITY PER_BF_PAYROLL_RESULTS
289 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
290 * @rep:scope public
291 * @rep:lifecycle active
292 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
293 */
294 --
295 -- {End Of Comments}
296 --
297 procedure delete_payroll_run
298 (p_payroll_run_id in number
299 ,p_validate in boolean default false
300 ,p_object_version_number in number
301 );
302 end PER_BF_PAYROLL_RUNS_API;
[Home] [Help]