1 Package PER_BF_PROC_ASSIGNMENT_API AS
2 /* $Header: pebpaapi.pkh 120.1 2005/10/02 02:12:11 aroussel $ */
3 /*#
4 * This package contains APIs for maintaining backfeed processed assignments
5 * records.
6 * @rep:scope public
7 * @rep:product per
8 * @rep:displayname Backfeed Processed Assignment
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |-----------------------< create_processed_assignment >--------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates a processed assignment for a particular employee assignment
18 * relating to a third party payroll run.
19 *
20 * Creates a processed assignment for a particular third party payroll run and
21 * an employee assignment.
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 * A valid backfeed payroll run must exist.
28 *
29 * <p><b>Post Success</b><br>
30 * The backfeed processed assignment will be successfully inserted into the
31 * database.
32 *
33 * <p><b>Post Failure</b><br>
34 * The backfeed processed assignment will not be created and an error will be
35 * 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_assignment_id {@rep:casecolumn PER_ALL_ASSIGNMENTS_F.ASSIGNMENT_ID}
43 * @param p_payroll_run_id {@rep:casecolumn PER_BF_PAYROLL_RUNS.PAYROLL_RUN_ID}
44 * @param p_bpa_attribute_category This context value determines which
45 * flexfield structure to use with the descriptive flexfield segments.
46 * @param p_bpa_attribute1 Descriptive flexfield segment.
47 * @param p_bpa_attribute2 Descriptive flexfield segment.
48 * @param p_bpa_attribute3 Descriptive flexfield segment.
49 * @param p_bpa_attribute4 Descriptive flexfield segment.
50 * @param p_bpa_attribute5 Descriptive flexfield segment.
51 * @param p_bpa_attribute6 Descriptive flexfield segment.
52 * @param p_bpa_attribute7 Descriptive flexfield segment.
53 * @param p_bpa_attribute8 Descriptive flexfield segment.
54 * @param p_bpa_attribute9 Descriptive flexfield segment.
55 * @param p_bpa_attribute10 Descriptive flexfield segment.
56 * @param p_bpa_attribute11 Descriptive flexfield segment.
57 * @param p_bpa_attribute12 Descriptive flexfield segment.
58 * @param p_bpa_attribute13 Descriptive flexfield segment.
59 * @param p_bpa_attribute14 Descriptive flexfield segment.
60 * @param p_bpa_attribute15 Descriptive flexfield segment.
61 * @param p_bpa_attribute16 Descriptive flexfield segment.
62 * @param p_bpa_attribute17 Descriptive flexfield segment.
63 * @param p_bpa_attribute18 Descriptive flexfield segment.
64 * @param p_bpa_attribute19 Descriptive flexfield segment.
65 * @param p_bpa_attribute20 Descriptive flexfield segment.
66 * @param p_bpa_attribute21 Descriptive flexfield segment.
67 * @param p_bpa_attribute22 Descriptive flexfield segment.
68 * @param p_bpa_attribute23 Descriptive flexfield segment.
69 * @param p_bpa_attribute24 Descriptive flexfield segment.
70 * @param p_bpa_attribute25 Descriptive flexfield segment.
71 * @param p_bpa_attribute26 Descriptive flexfield segment.
72 * @param p_bpa_attribute27 Descriptive flexfield segment.
73 * @param p_bpa_attribute28 Descriptive flexfield segment.
74 * @param p_bpa_attribute29 Descriptive flexfield segment.
75 * @param p_bpa_attribute30 Descriptive flexfield segment.
76 * @param p_processed_assignment_id If p_validate is false, then this uniquely
77 * identifies the backfeed processed assignment created. If p_validate is true,
78 * then set to null.
79 * @param p_processed_assignment_ovn If p_validate is false, then set to the
80 * version number of the created backfeed payroll assignment record. If
81 * p_validate is true, then the value will be null.
82 * @rep:displayname Create Backfeed Processed Assignment
83 * @rep:category BUSINESS_ENTITY PER_BF_PAYROLL_RESULTS
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_processed_assignment
93 (p_validate in boolean default false
94 ,p_effective_date in date
95 ,p_assignment_id in number
96 ,p_payroll_run_id in number
97 ,p_bpa_attribute_category in varchar2 default null
98 ,p_bpa_attribute1 in varchar2 default null
99 ,p_bpa_attribute2 in varchar2 default null
100 ,p_bpa_attribute3 in varchar2 default null
101 ,p_bpa_attribute4 in varchar2 default null
102 ,p_bpa_attribute5 in varchar2 default null
103 ,p_bpa_attribute6 in varchar2 default null
104 ,p_bpa_attribute7 in varchar2 default null
105 ,p_bpa_attribute8 in varchar2 default null
106 ,p_bpa_attribute9 in varchar2 default null
107 ,p_bpa_attribute10 in varchar2 default null
108 ,p_bpa_attribute11 in varchar2 default null
109 ,p_bpa_attribute12 in varchar2 default null
110 ,p_bpa_attribute13 in varchar2 default null
111 ,p_bpa_attribute14 in varchar2 default null
112 ,p_bpa_attribute15 in varchar2 default null
113 ,p_bpa_attribute16 in varchar2 default null
114 ,p_bpa_attribute17 in varchar2 default null
115 ,p_bpa_attribute18 in varchar2 default null
116 ,p_bpa_attribute19 in varchar2 default null
117 ,p_bpa_attribute20 in varchar2 default null
118 ,p_bpa_attribute21 in varchar2 default null
119 ,p_bpa_attribute22 in varchar2 default null
120 ,p_bpa_attribute23 in varchar2 default null
121 ,p_bpa_attribute24 in varchar2 default null
122 ,p_bpa_attribute25 in varchar2 default null
123 ,p_bpa_attribute26 in varchar2 default null
124 ,p_bpa_attribute27 in varchar2 default null
125 ,p_bpa_attribute28 in varchar2 default null
126 ,p_bpa_attribute29 in varchar2 default null
127 ,p_bpa_attribute30 in varchar2 default null
128 ,p_processed_assignment_id out nocopy number
129 ,p_processed_assignment_ovn out nocopy number
130 );
131 --
132 -- ----------------------------------------------------------------------------
133 -- |-----------------------< update_processed_assignment >--------------------|
134 -- ----------------------------------------------------------------------------
135 --
136 -- {Start Of Comments}
137 /*#
138 * This API updates a processed assignment for a particular employee assignment
139 * relating to a third party payroll run.
140 *
141 * This API updates a processed assignment for a particular third party payroll
142 * run and an employee assignment.
143 *
144 * <p><b>Licensing</b><br>
145 * This API is licensed for use with Human Resources.
146 *
147 * <p><b>Prerequisites</b><br>
148 * A valid backfeed processed assignment must exist.
149 *
150 * <p><b>Post Success</b><br>
151 * The backfeed processed assignment will be successfully updated into the
152 * database.
153 *
154 * <p><b>Post Failure</b><br>
155 * The backfeed processed assignment will not be updated and an error will be
156 * raised.
157 * @param p_validate If true, then validation alone will be performed and the
158 * database will remain unchanged. If false and all validation checks pass,
159 * then the database will be modified.
160 * @param p_effective_date Reference date for validating lookup values are
161 * applicable during the start to end active date range. This date does not
162 * determine when the changes take effect.
163 * @param p_processed_assignment_id Uniquely identifies a backfeed processed
164 * assignment record.
165 * @param p_bpa_attribute_category This context value determines which
166 * flexfield structure to use with the descriptive flexfield segments.
167 * @param p_bpa_attribute1 Descriptive flexfield segment.
168 * @param p_bpa_attribute2 Descriptive flexfield segment.
169 * @param p_bpa_attribute3 Descriptive flexfield segment.
170 * @param p_bpa_attribute4 Descriptive flexfield segment.
171 * @param p_bpa_attribute5 Descriptive flexfield segment.
172 * @param p_bpa_attribute6 Descriptive flexfield segment.
173 * @param p_bpa_attribute7 Descriptive flexfield segment.
174 * @param p_bpa_attribute8 Descriptive flexfield segment.
175 * @param p_bpa_attribute9 Descriptive flexfield segment.
176 * @param p_bpa_attribute10 Descriptive flexfield segment.
177 * @param p_bpa_attribute11 Descriptive flexfield segment.
178 * @param p_bpa_attribute12 Descriptive flexfield segment.
179 * @param p_bpa_attribute13 Descriptive flexfield segment.
180 * @param p_bpa_attribute14 Descriptive flexfield segment.
181 * @param p_bpa_attribute15 Descriptive flexfield segment.
182 * @param p_bpa_attribute16 Descriptive flexfield segment.
183 * @param p_bpa_attribute17 Descriptive flexfield segment.
184 * @param p_bpa_attribute18 Descriptive flexfield segment.
185 * @param p_bpa_attribute19 Descriptive flexfield segment.
186 * @param p_bpa_attribute20 Descriptive flexfield segment.
187 * @param p_bpa_attribute21 Descriptive flexfield segment.
188 * @param p_bpa_attribute22 Descriptive flexfield segment.
189 * @param p_bpa_attribute23 Descriptive flexfield segment.
190 * @param p_bpa_attribute24 Descriptive flexfield segment.
191 * @param p_bpa_attribute25 Descriptive flexfield segment.
192 * @param p_bpa_attribute26 Descriptive flexfield segment.
193 * @param p_bpa_attribute27 Descriptive flexfield segment.
194 * @param p_bpa_attribute28 Descriptive flexfield segment.
195 * @param p_bpa_attribute29 Descriptive flexfield segment.
196 * @param p_bpa_attribute30 Descriptive flexfield segment.
197 * @param p_processed_assignment_ovn Pass in the current version number of the
198 * backfeed processed assignment to be updated. When the API completes if
199 * p_validate is false, will be set to the new version number of the updated
200 * backfeed payment detail. If p_validate is true will be set to the same value
201 * which was passed in.
202 * @rep:displayname Update Backfeed Processed Assignment
203 * @rep:category BUSINESS_ENTITY PER_BF_PAYROLL_RESULTS
204 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
205 * @rep:scope public
206 * @rep:lifecycle active
207 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
208 */
209 --
210 -- {End Of Comments}
211 --
212 procedure update_processed_assignment
213 (p_validate in boolean default false
214 ,p_effective_date in date
215 ,p_processed_assignment_id in number
216 ,p_bpa_attribute_category in varchar2 default hr_api.g_varchar2
217 ,p_bpa_attribute1 in varchar2 default hr_api.g_varchar2
218 ,p_bpa_attribute2 in varchar2 default hr_api.g_varchar2
219 ,p_bpa_attribute3 in varchar2 default hr_api.g_varchar2
220 ,p_bpa_attribute4 in varchar2 default hr_api.g_varchar2
221 ,p_bpa_attribute5 in varchar2 default hr_api.g_varchar2
222 ,p_bpa_attribute6 in varchar2 default hr_api.g_varchar2
223 ,p_bpa_attribute7 in varchar2 default hr_api.g_varchar2
224 ,p_bpa_attribute8 in varchar2 default hr_api.g_varchar2
225 ,p_bpa_attribute9 in varchar2 default hr_api.g_varchar2
226 ,p_bpa_attribute10 in varchar2 default hr_api.g_varchar2
227 ,p_bpa_attribute11 in varchar2 default hr_api.g_varchar2
228 ,p_bpa_attribute12 in varchar2 default hr_api.g_varchar2
229 ,p_bpa_attribute13 in varchar2 default hr_api.g_varchar2
230 ,p_bpa_attribute14 in varchar2 default hr_api.g_varchar2
231 ,p_bpa_attribute15 in varchar2 default hr_api.g_varchar2
232 ,p_bpa_attribute16 in varchar2 default hr_api.g_varchar2
233 ,p_bpa_attribute17 in varchar2 default hr_api.g_varchar2
234 ,p_bpa_attribute18 in varchar2 default hr_api.g_varchar2
235 ,p_bpa_attribute19 in varchar2 default hr_api.g_varchar2
236 ,p_bpa_attribute20 in varchar2 default hr_api.g_varchar2
237 ,p_bpa_attribute21 in varchar2 default hr_api.g_varchar2
238 ,p_bpa_attribute22 in varchar2 default hr_api.g_varchar2
239 ,p_bpa_attribute23 in varchar2 default hr_api.g_varchar2
240 ,p_bpa_attribute24 in varchar2 default hr_api.g_varchar2
241 ,p_bpa_attribute25 in varchar2 default hr_api.g_varchar2
242 ,p_bpa_attribute26 in varchar2 default hr_api.g_varchar2
243 ,p_bpa_attribute27 in varchar2 default hr_api.g_varchar2
244 ,p_bpa_attribute28 in varchar2 default hr_api.g_varchar2
245 ,p_bpa_attribute29 in varchar2 default hr_api.g_varchar2
246 ,p_bpa_attribute30 in varchar2 default hr_api.g_varchar2
247 ,p_processed_assignment_ovn in out nocopy number
248 );
249 --
250 -- ----------------------------------------------------------------------------
251 -- |-----------------------< delete_processed_assignment >--------------------|
252 -- ----------------------------------------------------------------------------
253 --
254 -- {Start Of Comments}
255 /*#
256 * This API deletes a processed assignment for a particular employee assignment
257 * relating to a third party payroll run.
258 *
259 * Deletes a processed assignment for a particular third party payroll run and
260 * an employee assignment.
261 *
262 * <p><b>Licensing</b><br>
263 * This API is licensed for use with Human Resources.
264 *
265 * <p><b>Prerequisites</b><br>
266 * A valid backfeed processed assignment must exist.
267 *
268 * <p><b>Post Success</b><br>
269 * The backfeed processed assignment will be successfully deleted from the
270 * database.
271 *
272 * <p><b>Post Failure</b><br>
273 * The backfeed processed assignment will not be deleted and an error will be
274 * raised.
275 * @param p_validate If true, then validation alone will be performed and the
276 * database will remain unchanged. If false and all validation checks pass,
277 * then the database will be modified.
278 * @param p_processed_assignment_id Uniquely identifies a backfeed processed
279 * assignment record.
280 * @param p_processed_assignment_ovn Current version number of the backfeed
281 * processed assignment to be deleted.
282 * @rep:displayname Delete Backfeed Processed Assignment
283 * @rep:category BUSINESS_ENTITY PER_BF_PAYROLL_RESULTS
284 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
285 * @rep:scope public
286 * @rep:lifecycle active
287 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
288 */
289 --
290 -- {End Of Comments}
291 --
292 procedure delete_processed_assignment
293 (p_validate in boolean default false
294 ,p_processed_assignment_id in number
295 ,p_processed_assignment_ovn in number
296 );
297 --
298 end PER_BF_PROC_ASSIGNMENT_API;
[Home] [Help]