1 Package PAY_ELEMENT_LINK_api as
2 /* $Header: pypelapi.pkh 120.3.12010000.1 2008/07/27 23:21:44 appldev ship $ */
3 /*#
4 * This package contains element link APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Element Link
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |---------------------------< create_element_link >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API will create an element link and element link input values.
17 *
18 * The main purpose of the element link is to describe what values are required
19 * to be eligible for an element type.
20 *
21 * <p><b>Licensing</b><br>
22 * This API is licensed for use with Human Resources.
23 *
24 * <p><b>Prerequisites</b><br>
25 * The element type should exist.
26 *
27 * <p><b>Post Success</b><br>
28 * The element link and element link input values will have been created.
29 *
30 * <p><b>Post Failure</b><br>
31 * The element link and element link input values will not have been created
32 * 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 Determines when the DateTrack operation comes into
37 * force.
38 * @param p_element_type_id {@rep:casecolumn
39 * PAY_ELEMENT_TYPES_F.ELEMENT_TYPE_ID}
40 * @param p_business_group_id The business group for which the element link
41 * will be created.
42 * @param p_costable_type The costable type for the link. Valid values are
43 * defined by 'COSTABLE_TYPE' lookup type.
44 * @param p_payroll_id Set this to a valid payroll identifier to include the
45 * payroll in the eligibility criteria.
46 * @param p_job_id Set this to a valid job identifier to include the job in the
47 * eligibility criteria.
48 * @param p_position_id Set this to a valid position identifier to include the
49 * position in the eligibility criteria.
50 * @param p_people_group_id Set this to a valid people group identifier to
51 * include the people group in the eligibility criteria.
52 * @param p_cost_allocation_keyflex_id Set this to a valid cost allocation key
53 * flexfield identifier to include the cost allocation key flexfield in the
54 * eligibility criteria.
55 * @param p_organization_id Set this to a valid organization identifier to
56 * include the organization in the eligibility criteria.
57 * @param p_location_id Set this to a valid location identifier to include the
58 * location in the eligibility criteria.
59 * @param p_grade_id Set this to a valid grade identifier to include the grade
60 * in the eligibility criteria.
61 * @param p_balancing_keyflex_id The balancing key flexfield identifier for the
62 * link.
63 * @param p_element_set_id {@rep:casecolumn PAY_ELEMENT_SETS.ELEMENT_SET_ID}
64 * @param p_pay_basis_id Set this to a valid pay basis identifier to include
65 * the salary basis in the eligibility criteria.
66 * @param p_link_to_all_payrolls_flag Specifies whether any payroll will be
67 * eligible for the element type. Valid values are defined by the 'YES_NO'
68 * lookup type.
69 * @param p_standard_link_flag Specifies whether the element link will be
70 * standard. Valid values are defined by the 'YES_NO' lookup type.
71 * @param p_transfer_to_gl_flag Specifies whether the costing information is to
72 * be transferred to GL. Valid values are defined by the 'YES_NO' lookup type.
73 * @param p_comments Element link comment text.
74 * @param p_employment_category Set this to a valid employment category to
75 * include the employment category in the eligibility criteria. Valid values
76 * are defined by the 'EMP_CAT' lookup type.
77 * @param p_qualifying_age Age required to qualify for the element link.
78 * @param p_qualifying_length_of_service Length of service required to qualify
79 * for the element link.
80 * @param p_qualifying_units The units associated with the qualifying criteria.
81 * Valid values are defined by 'QUALIFYING' lookup type.
82 * @param p_attribute_category This context value determines which flexfield
83 * structure to use with the descriptive flexfield segments.
84 * @param p_attribute1 Descriptive flexfield segment.
85 * @param p_attribute2 Descriptive flexfield segment.
86 * @param p_attribute3 Descriptive flexfield segment.
87 * @param p_attribute4 Descriptive flexfield segment.
88 * @param p_attribute5 Descriptive flexfield segment.
89 * @param p_attribute6 Descriptive flexfield segment.
90 * @param p_attribute7 Descriptive flexfield segment.
91 * @param p_attribute8 Descriptive flexfield segment.
92 * @param p_attribute9 Descriptive flexfield segment.
93 * @param p_attribute10 Descriptive flexfield segment.
94 * @param p_attribute11 Descriptive flexfield segment.
95 * @param p_attribute12 Descriptive flexfield segment.
96 * @param p_attribute13 Descriptive flexfield segment.
97 * @param p_attribute14 Descriptive flexfield segment.
98 * @param p_attribute15 Descriptive flexfield segment.
99 * @param p_attribute16 Descriptive flexfield segment.
100 * @param p_attribute17 Descriptive flexfield segment.
101 * @param p_attribute18 Descriptive flexfield segment.
102 * @param p_attribute19 Descriptive flexfield segment.
103 * @param p_attribute20 Descriptive flexfield segment.
104 * @param p_cost_segment1 Costing key flexfield segment.
105 * @param p_cost_segment2 Costing key flexfield segment.
106 * @param p_cost_segment3 Costing key flexfield segment.
107 * @param p_cost_segment4 Costing key flexfield segment.
108 * @param p_cost_segment5 Costing key flexfield segment.
109 * @param p_cost_segment6 Costing key flexfield segment.
110 * @param p_cost_segment7 Costing key flexfield segment.
111 * @param p_cost_segment8 Costing key flexfield segment.
112 * @param p_cost_segment9 Costing key flexfield segment.
113 * @param p_cost_segment10 Costing key flexfield segment.
114 * @param p_cost_segment11 Costing key flexfield segment.
115 * @param p_cost_segment12 Costing key flexfield segment.
116 * @param p_cost_segment13 Costing key flexfield segment.
117 * @param p_cost_segment14 Costing key flexfield segment.
118 * @param p_cost_segment15 Costing key flexfield segment.
119 * @param p_cost_segment16 Costing key flexfield segment.
120 * @param p_cost_segment17 Costing key flexfield segment.
121 * @param p_cost_segment18 Costing key flexfield segment.
122 * @param p_cost_segment19 Costing key flexfield segment.
123 * @param p_cost_segment20 Costing key flexfield segment.
124 * @param p_cost_segment21 Costing key flexfield segment.
125 * @param p_cost_segment22 Costing key flexfield segment.
126 * @param p_cost_segment23 Costing key flexfield segment.
127 * @param p_cost_segment24 Costing key flexfield segment.
128 * @param p_cost_segment25 Costing key flexfield segment.
129 * @param p_cost_segment26 Costing key flexfield segment.
130 * @param p_cost_segment27 Costing key flexfield segment.
131 * @param p_cost_segment28 Costing key flexfield segment.
132 * @param p_cost_segment29 Costing key flexfield segment.
133 * @param p_cost_segment30 Costing key flexfield segment.
134 * @param p_balance_segment1 Balancing key flexfield segment.
135 * @param p_balance_segment2 Balancing key flexfield segment.
136 * @param p_balance_segment3 Balancing key flexfield segment.
137 * @param p_balance_segment4 Balancing key flexfield segment.
138 * @param p_balance_segment5 Balancing key flexfield segment.
139 * @param p_balance_segment6 Balancing key flexfield segment.
140 * @param p_balance_segment7 Balancing key flexfield segment.
141 * @param p_balance_segment8 Balancing key flexfield segment.
142 * @param p_balance_segment9 Balancing key flexfield segment.
143 * @param p_balance_segment10 Balancing key flexfield segment.
144 * @param p_balance_segment11 Balancing key flexfield segment.
145 * @param p_balance_segment12 Balancing key flexfield segment.
146 * @param p_balance_segment13 Balancing key flexfield segment.
147 * @param p_balance_segment14 Balancing key flexfield segment.
148 * @param p_balance_segment15 Balancing key flexfield segment.
149 * @param p_balance_segment16 Balancing key flexfield segment.
150 * @param p_balance_segment17 Balancing key flexfield segment.
151 * @param p_balance_segment18 Balancing key flexfield segment.
152 * @param p_balance_segment19 Balancing key flexfield segment.
153 * @param p_balance_segment20 Balancing key flexfield segment.
154 * @param p_balance_segment21 Balancing key flexfield segment.
155 * @param p_balance_segment22 Balancing key flexfield segment.
156 * @param p_balance_segment23 Balancing key flexfield segment.
157 * @param p_balance_segment24 Balancing key flexfield segment.
158 * @param p_balance_segment25 Balancing key flexfield segment.
159 * @param p_balance_segment26 Balancing key flexfield segment.
160 * @param p_balance_segment27 Balancing key flexfield segment.
161 * @param p_balance_segment28 Balancing key flexfield segment.
162 * @param p_balance_segment29 Balancing key flexfield segment.
163 * @param p_balance_segment30 Balancing key flexfield segment.
164 * @param p_cost_concat_segments Concatenated costing flexfield values.
165 * @param p_balance_concat_segments Concatenated balancing flexfield values.
166 * @param p_element_link_id If p_validate is false, this uniquely identifies
167 * the element link created. If p_validate is true, then set to null.
168 * @param p_comment_id If p_validate is false and comment text was provided,
169 * then will be set to the identifier of the created element link comment
170 * record. If p_validate is true or no comment text was provided, then will be
171 * null.
172 * @param p_object_version_number If p_validate is false, then set to the
173 * version number of the created element link. If p_validate is true, then the
174 * value will be null.
175 * @param p_effective_start_date If p_validate is false, then set to the
176 * earliest effective start date for the created element link. If p_validate is
177 * true, then set to null.
178 * @param p_effective_end_date If p_validate is false, then set to the
179 * effective end date for the created element link. If p_validate is true, then
180 * set to null.
181 * @rep:displayname Create Element Link
182 * @rep:category BUSINESS_ENTITY PAY_ELEMENT_LINK
183 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
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 create_element_link
193 (p_validate in boolean default false
194 ,p_effective_date in date
195 ,p_element_type_id in number
196 ,p_business_group_id in number
197 ,p_costable_type in varchar2
198 ,p_payroll_id in number default null
199 ,p_job_id in number default null
200 ,p_position_id in number default null
201 ,p_people_group_id in number default null
202 ,p_cost_allocation_keyflex_id in number default null
203 ,p_organization_id in number default null
204 ,p_location_id in number default null
205 ,p_grade_id in number default null
206 ,p_balancing_keyflex_id in number default null
207 ,p_element_set_id in number default null
208 ,p_pay_basis_id in number default null
209 ,p_link_to_all_payrolls_flag in varchar2 default 'N'
210 ,p_standard_link_flag in varchar2 default null
211 ,p_transfer_to_gl_flag in varchar2 default 'N'
212 ,p_comments in varchar2 default null
213 ,p_employment_category in varchar2 default null
214 ,p_qualifying_age in number default null
215 ,p_qualifying_length_of_service in number default null
216 ,p_qualifying_units in varchar2 default null
217 ,p_attribute_category in varchar2 default null
218 ,p_attribute1 in varchar2 default null
219 ,p_attribute2 in varchar2 default null
220 ,p_attribute3 in varchar2 default null
221 ,p_attribute4 in varchar2 default null
222 ,p_attribute5 in varchar2 default null
223 ,p_attribute6 in varchar2 default null
224 ,p_attribute7 in varchar2 default null
225 ,p_attribute8 in varchar2 default null
226 ,p_attribute9 in varchar2 default null
227 ,p_attribute10 in varchar2 default null
228 ,p_attribute11 in varchar2 default null
229 ,p_attribute12 in varchar2 default null
230 ,p_attribute13 in varchar2 default null
231 ,p_attribute14 in varchar2 default null
232 ,p_attribute15 in varchar2 default null
233 ,p_attribute16 in varchar2 default null
234 ,p_attribute17 in varchar2 default null
235 ,p_attribute18 in varchar2 default null
236 ,p_attribute19 in varchar2 default null
237 ,p_attribute20 in varchar2 default null
238 ,p_cost_segment1 in varchar2 default null
239 ,p_cost_segment2 in varchar2 default null
240 ,p_cost_segment3 in varchar2 default null
241 ,p_cost_segment4 in varchar2 default null
242 ,p_cost_segment5 in varchar2 default null
243 ,p_cost_segment6 in varchar2 default null
244 ,p_cost_segment7 in varchar2 default null
245 ,p_cost_segment8 in varchar2 default null
246 ,p_cost_segment9 in varchar2 default null
247 ,p_cost_segment10 in varchar2 default null
248 ,p_cost_segment11 in varchar2 default null
249 ,p_cost_segment12 in varchar2 default null
250 ,p_cost_segment13 in varchar2 default null
251 ,p_cost_segment14 in varchar2 default null
252 ,p_cost_segment15 in varchar2 default null
253 ,p_cost_segment16 in varchar2 default null
254 ,p_cost_segment17 in varchar2 default null
255 ,p_cost_segment18 in varchar2 default null
256 ,p_cost_segment19 in varchar2 default null
257 ,p_cost_segment20 in varchar2 default null
258 ,p_cost_segment21 in varchar2 default null
259 ,p_cost_segment22 in varchar2 default null
260 ,p_cost_segment23 in varchar2 default null
261 ,p_cost_segment24 in varchar2 default null
262 ,p_cost_segment25 in varchar2 default null
263 ,p_cost_segment26 in varchar2 default null
264 ,p_cost_segment27 in varchar2 default null
265 ,p_cost_segment28 in varchar2 default null
266 ,p_cost_segment29 in varchar2 default null
267 ,p_cost_segment30 in varchar2 default null
268 ,p_balance_segment1 in varchar2 default null
269 ,p_balance_segment2 in varchar2 default null
270 ,p_balance_segment3 in varchar2 default null
274 ,p_balance_segment7 in varchar2 default null
271 ,p_balance_segment4 in varchar2 default null
272 ,p_balance_segment5 in varchar2 default null
273 ,p_balance_segment6 in varchar2 default null
275 ,p_balance_segment8 in varchar2 default null
276 ,p_balance_segment9 in varchar2 default null
277 ,p_balance_segment10 in varchar2 default null
278 ,p_balance_segment11 in varchar2 default null
279 ,p_balance_segment12 in varchar2 default null
280 ,p_balance_segment13 in varchar2 default null
281 ,p_balance_segment14 in varchar2 default null
282 ,p_balance_segment15 in varchar2 default null
283 ,p_balance_segment16 in varchar2 default null
284 ,p_balance_segment17 in varchar2 default null
285 ,p_balance_segment18 in varchar2 default null
286 ,p_balance_segment19 in varchar2 default null
287 ,p_balance_segment20 in varchar2 default null
288 ,p_balance_segment21 in varchar2 default null
289 ,p_balance_segment22 in varchar2 default null
290 ,p_balance_segment23 in varchar2 default null
291 ,p_balance_segment24 in varchar2 default null
292 ,p_balance_segment25 in varchar2 default null
293 ,p_balance_segment26 in varchar2 default null
294 ,p_balance_segment27 in varchar2 default null
295 ,p_balance_segment28 in varchar2 default null
296 ,p_balance_segment29 in varchar2 default null
297 ,p_balance_segment30 in varchar2 default null
298 ,p_cost_concat_segments in varchar2
299 ,p_balance_concat_segments in varchar2
300 ,p_element_link_id out nocopy number
301 ,p_comment_id out nocopy number
302 ,p_object_version_number out nocopy number
303 ,p_effective_start_date out nocopy date
304 ,p_effective_end_date out nocopy date
305 );
306 --
307 -- ----------------------------------------------------------------------------
308 -- |---------------------------< update_element_link >------------------------|
309 -- ----------------------------------------------------------------------------
310 --
311 -- {Start Of Comments}
312 /*#
313 * This API updates an element link.
314 *
315 * The main purpose of the element link is to describe what values are required
316 * to be eligible for an element type.
317 *
318 * <p><b>Licensing</b><br>
319 * This API is licensed for use with Human Resources.
320 *
321 * <p><b>Prerequisites</b><br>
322 * The element link must already exist.
323 *
324 * <p><b>Post Success</b><br>
325 * The element link will have been updated.
326 *
327 * <p><b>Post Failure</b><br>
328 * The element link will not have been updated and an error will be raised.
329 * @param p_validate If true, then validation alone will be performed and the
330 * database will remain unchanged. If false and all validation checks pass,
331 * then the database will be modified.
332 * @param p_effective_date Determines when the DateTrack operation comes into
333 * force.
334 * @param p_element_link_id The element link to be updated.
335 * @param p_datetrack_mode Indicates which DateTrack mode to use when updating
336 * the record. You must set to either UPDATE, CORRECTION, UPDATE_OVERRIDE or
337 * UPDATE_CHANGE_INSERT. Modes available for use with a particular record
338 * depend on the dates of previous record changes and the effective date of
339 * this change.
340 * @param p_costable_type The costable type for the link. Valid values are
341 * defined by 'COSTABLE_TYPE' lookup type.
342 * @param p_element_set_id {@rep:casecolumn PAY_ELEMENT_SETS.ELEMENT_SET_ID}
343 * @param p_multiply_value_flag Valid values are defined by 'YES_NO' lookup
344 * type.
345 * @param p_standard_link_flag Specifies whether the element link will be
346 * standard. Valid values are defined by the 'YES_NO' lookup type.
347 * @param p_transfer_to_gl_flag Specifies whether the costing information is to
348 * be transferred to GL. Valid values are defined by the 'YES_NO' lookup type.
349 * @param p_comments Comment
350 * @param p_comment_id {@rep:casecolumn HR_COMMENTS.COMMENT_ID}
351 * @param p_employment_category Obsolete parameter, do not use.
352 * @param p_qualifying_age Age required to qualify for the element link.
353 * @param p_qualifying_length_of_service Length of service required to qualify
354 * for the element link.
355 * @param p_qualifying_units The units associated with the qualifying criteria.
356 * Valid values are defined by 'QUALIFYING' lookup type.
357 * @param p_attribute_category This context value determines which flexfield
358 * structure to use with the descriptive flexfield segments.
359 * @param p_attribute1 Descriptive flexfield segment.
360 * @param p_attribute2 Descriptive flexfield segment.
361 * @param p_attribute3 Descriptive flexfield segment.
362 * @param p_attribute4 Descriptive flexfield segment.
363 * @param p_attribute5 Descriptive flexfield segment.
364 * @param p_attribute6 Descriptive flexfield segment.
365 * @param p_attribute7 Descriptive flexfield segment.
366 * @param p_attribute8 Descriptive flexfield segment.
367 * @param p_attribute9 Descriptive flexfield segment.
371 * @param p_attribute13 Descriptive flexfield segment.
368 * @param p_attribute10 Descriptive flexfield segment.
369 * @param p_attribute11 Descriptive flexfield segment.
370 * @param p_attribute12 Descriptive flexfield segment.
372 * @param p_attribute14 Descriptive flexfield segment.
373 * @param p_attribute15 Descriptive flexfield segment.
374 * @param p_attribute16 Descriptive flexfield segment.
375 * @param p_attribute17 Descriptive flexfield segment.
376 * @param p_attribute18 Descriptive flexfield segment.
377 * @param p_attribute19 Descriptive flexfield segment.
378 * @param p_attribute20 Descriptive flexfield segment.
379 * @param p_cost_segment1 Costing key flexfield segment.
380 * @param p_cost_segment2 Costing key flexfield segment.
381 * @param p_cost_segment3 Costing key flexfield segment.
382 * @param p_cost_segment4 Costing key flexfield segment.
383 * @param p_cost_segment5 Costing key flexfield segment.
384 * @param p_cost_segment6 Costing key flexfield segment.
385 * @param p_cost_segment7 Costing key flexfield segment.
386 * @param p_cost_segment8 Costing key flexfield segment.
387 * @param p_cost_segment9 Costing key flexfield segment.
388 * @param p_cost_segment10 Costing key flexfield segment.
389 * @param p_cost_segment11 Costing key flexfield segment.
390 * @param p_cost_segment12 Costing key flexfield segment.
391 * @param p_cost_segment13 Costing key flexfield segment.
392 * @param p_cost_segment14 Costing key flexfield segment.
393 * @param p_cost_segment15 Costing key flexfield segment.
394 * @param p_cost_segment16 Costing key flexfield segment.
395 * @param p_cost_segment17 Costing key flexfield segment.
396 * @param p_cost_segment18 Costing key flexfield segment.
397 * @param p_cost_segment19 Costing key flexfield segment.
398 * @param p_cost_segment20 Costing key flexfield segment.
399 * @param p_cost_segment21 Costing key flexfield segment.
400 * @param p_cost_segment22 Costing key flexfield segment.
401 * @param p_cost_segment23 Costing key flexfield segment.
402 * @param p_cost_segment24 Costing key flexfield segment.
403 * @param p_cost_segment25 Costing key flexfield segment.
404 * @param p_cost_segment26 Costing key flexfield segment.
405 * @param p_cost_segment27 Costing key flexfield segment.
406 * @param p_cost_segment28 Costing key flexfield segment.
407 * @param p_cost_segment29 Costing key flexfield segment.
408 * @param p_cost_segment30 Costing key flexfield segment.
409 * @param p_balance_segment1 Balancing key flexfield segment.
410 * @param p_balance_segment2 Balancing key flexfield segment.
411 * @param p_balance_segment3 Balancing key flexfield segment.
412 * @param p_balance_segment4 Balancing key flexfield segment.
413 * @param p_balance_segment5 Balancing key flexfield segment.
414 * @param p_balance_segment6 Balancing key flexfield segment.
415 * @param p_balance_segment7 Balancing key flexfield segment.
416 * @param p_balance_segment8 Balancing key flexfield segment.
417 * @param p_balance_segment9 Balancing key flexfield segment.
418 * @param p_balance_segment10 Balancing key flexfield segment.
419 * @param p_balance_segment11 Balancing key flexfield segment.
420 * @param p_balance_segment12 Balancing key flexfield segment.
421 * @param p_balance_segment13 Balancing key flexfield segment.
422 * @param p_balance_segment14 Balancing key flexfield segment.
423 * @param p_balance_segment15 Balancing key flexfield segment.
424 * @param p_balance_segment16 Balancing key flexfield segment.
428 * @param p_balance_segment20 Balancing key flexfield segment.
425 * @param p_balance_segment17 Balancing key flexfield segment.
426 * @param p_balance_segment18 Balancing key flexfield segment.
427 * @param p_balance_segment19 Balancing key flexfield segment.
429 * @param p_balance_segment21 Balancing key flexfield segment.
430 * @param p_balance_segment22 Balancing key flexfield segment.
431 * @param p_balance_segment23 Balancing key flexfield segment.
432 * @param p_balance_segment24 Balancing key flexfield segment.
433 * @param p_balance_segment25 Balancing key flexfield segment.
434 * @param p_balance_segment26 Balancing key flexfield segment.
435 * @param p_balance_segment27 Balancing key flexfield segment.
436 * @param p_balance_segment28 Balancing key flexfield segment.
437 * @param p_balance_segment29 Balancing key flexfield segment.
438 * @param p_balance_segment30 Balancing key flexfield segment.
439 * @param p_cost_concat_segments_in Concatenated costing flexfield values.
440 * @param p_balance_concat_segments_in Concatenated balancing flexfield values.
441 * @param p_object_version_number Pass in the current version number of the
442 * element link to be updated. When the API completes if p_validate is false,
443 * will be set to the new version number of the updated element link. If
444 * p_validate is true will be set to the same value which was passed in.
445 * @param p_cost_allocation_keyflex_id If p_validate is false, then this
446 * identifies the cost allocation key flexfield. If p_validate is true, then
447 * set to null.
448 * @param p_balancing_keyflex_id If p_validate is false, then this identifies
449 * the balancing key flexfield. If p_validate is true, then set to null.
450 * @param p_cost_concat_segments_out If p_validate is false, set to
451 * concatenated costing flexfield values. If p_validate is true, then set to
452 * null.
453 * @param p_balance_concat_segments_out If p_validate is false, set to
454 * concatenated balancing flexfield values. If p_validate is true, then set to
455 * null.
456 * @param p_effective_start_date If p_validate is false, then set to the
457 * effective start date on the updated element link row which now exists as of
458 * the effective date. If p_validate is true, then set to null.
459 * @param p_effective_end_date If p_validate is false, then set to the
460 * effective end date on the updated element link row which now exists as of
461 * the effective date. If p_validate is true, then set to null.
462 * @rep:displayname Update Element Link
463 * @rep:category BUSINESS_ENTITY PAY_ELEMENT_LINK
464 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
465 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
466 * @rep:scope public
467 * @rep:lifecycle active
468 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
469 */
470 --
471 -- {End Of Comments}
472 --
473 procedure update_element_link
474 (p_validate in boolean default false
475 ,p_effective_date in date
476 ,p_element_link_id in number
477 ,p_datetrack_mode in varchar2
478 ,p_costable_type in varchar2 default hr_api.g_varchar2
479 ,p_element_set_id in number default hr_api.g_number
480 ,p_multiply_value_flag in varchar2 default hr_api.g_varchar2
481 ,p_standard_link_flag in varchar2 default hr_api.g_varchar2
482 ,p_transfer_to_gl_flag in varchar2 default hr_api.g_varchar2
483 ,p_comments in varchar2 default hr_api.g_varchar2
484 ,p_comment_id in varchar2 default hr_api.g_varchar2
485 ,p_employment_category in varchar2 default hr_api.g_varchar2
486 ,p_qualifying_age in number default hr_api.g_number
487 ,p_qualifying_length_of_service in number default hr_api.g_number
488 ,p_qualifying_units in varchar2 default hr_api.g_varchar2
489 ,p_attribute_category in varchar2 default hr_api.g_varchar2
490 ,p_attribute1 in varchar2 default hr_api.g_varchar2
491 ,p_attribute2 in varchar2 default hr_api.g_varchar2
492 ,p_attribute3 in varchar2 default hr_api.g_varchar2
493 ,p_attribute4 in varchar2 default hr_api.g_varchar2
494 ,p_attribute5 in varchar2 default hr_api.g_varchar2
495 ,p_attribute6 in varchar2 default hr_api.g_varchar2
496 ,p_attribute7 in varchar2 default hr_api.g_varchar2
497 ,p_attribute8 in varchar2 default hr_api.g_varchar2
498 ,p_attribute9 in varchar2 default hr_api.g_varchar2
499 ,p_attribute10 in varchar2 default hr_api.g_varchar2
500 ,p_attribute11 in varchar2 default hr_api.g_varchar2
501 ,p_attribute12 in varchar2 default hr_api.g_varchar2
502 ,p_attribute13 in varchar2 default hr_api.g_varchar2
503 ,p_attribute14 in varchar2 default hr_api.g_varchar2
504 ,p_attribute15 in varchar2 default hr_api.g_varchar2
505 ,p_attribute16 in varchar2 default hr_api.g_varchar2
506 ,p_attribute17 in varchar2 default hr_api.g_varchar2
507 ,p_attribute18 in varchar2 default hr_api.g_varchar2
508 ,p_attribute19 in varchar2 default hr_api.g_varchar2
509 ,p_attribute20 in varchar2 default hr_api.g_varchar2
510 ,p_cost_segment1 in varchar2 default hr_api.g_varchar2
514 ,p_cost_segment5 in varchar2 default hr_api.g_varchar2
511 ,p_cost_segment2 in varchar2 default hr_api.g_varchar2
512 ,p_cost_segment3 in varchar2 default hr_api.g_varchar2
513 ,p_cost_segment4 in varchar2 default hr_api.g_varchar2
515 ,p_cost_segment6 in varchar2 default hr_api.g_varchar2
516 ,p_cost_segment7 in varchar2 default hr_api.g_varchar2
517 ,p_cost_segment8 in varchar2 default hr_api.g_varchar2
518 ,p_cost_segment9 in varchar2 default hr_api.g_varchar2
519 ,p_cost_segment10 in varchar2 default hr_api.g_varchar2
520 ,p_cost_segment11 in varchar2 default hr_api.g_varchar2
521 ,p_cost_segment12 in varchar2 default hr_api.g_varchar2
522 ,p_cost_segment13 in varchar2 default hr_api.g_varchar2
523 ,p_cost_segment14 in varchar2 default hr_api.g_varchar2
524 ,p_cost_segment15 in varchar2 default hr_api.g_varchar2
525 ,p_cost_segment16 in varchar2 default hr_api.g_varchar2
526 ,p_cost_segment17 in varchar2 default hr_api.g_varchar2
527 ,p_cost_segment18 in varchar2 default hr_api.g_varchar2
528 ,p_cost_segment19 in varchar2 default hr_api.g_varchar2
529 ,p_cost_segment20 in varchar2 default hr_api.g_varchar2
530 ,p_cost_segment21 in varchar2 default hr_api.g_varchar2
531 ,p_cost_segment22 in varchar2 default hr_api.g_varchar2
532 ,p_cost_segment23 in varchar2 default hr_api.g_varchar2
533 ,p_cost_segment24 in varchar2 default hr_api.g_varchar2
534 ,p_cost_segment25 in varchar2 default hr_api.g_varchar2
535 ,p_cost_segment26 in varchar2 default hr_api.g_varchar2
536 ,p_cost_segment27 in varchar2 default hr_api.g_varchar2
537 ,p_cost_segment28 in varchar2 default hr_api.g_varchar2
538 ,p_cost_segment29 in varchar2 default hr_api.g_varchar2
539 ,p_cost_segment30 in varchar2 default hr_api.g_varchar2
540 ,p_balance_segment1 in varchar2 default hr_api.g_varchar2
541 ,p_balance_segment2 in varchar2 default hr_api.g_varchar2
542 ,p_balance_segment3 in varchar2 default hr_api.g_varchar2
543 ,p_balance_segment4 in varchar2 default hr_api.g_varchar2
544 ,p_balance_segment5 in varchar2 default hr_api.g_varchar2
545 ,p_balance_segment6 in varchar2 default hr_api.g_varchar2
546 ,p_balance_segment7 in varchar2 default hr_api.g_varchar2
547 ,p_balance_segment8 in varchar2 default hr_api.g_varchar2
548 ,p_balance_segment9 in varchar2 default hr_api.g_varchar2
549 ,p_balance_segment10 in varchar2 default hr_api.g_varchar2
550 ,p_balance_segment11 in varchar2 default hr_api.g_varchar2
551 ,p_balance_segment12 in varchar2 default hr_api.g_varchar2
552 ,p_balance_segment13 in varchar2 default hr_api.g_varchar2
553 ,p_balance_segment14 in varchar2 default hr_api.g_varchar2
554 ,p_balance_segment15 in varchar2 default hr_api.g_varchar2
555 ,p_balance_segment16 in varchar2 default hr_api.g_varchar2
556 ,p_balance_segment17 in varchar2 default hr_api.g_varchar2
557 ,p_balance_segment18 in varchar2 default hr_api.g_varchar2
558 ,p_balance_segment19 in varchar2 default hr_api.g_varchar2
559 ,p_balance_segment20 in varchar2 default hr_api.g_varchar2
560 ,p_balance_segment21 in varchar2 default hr_api.g_varchar2
561 ,p_balance_segment22 in varchar2 default hr_api.g_varchar2
562 ,p_balance_segment23 in varchar2 default hr_api.g_varchar2
563 ,p_balance_segment24 in varchar2 default hr_api.g_varchar2
564 ,p_balance_segment25 in varchar2 default hr_api.g_varchar2
565 ,p_balance_segment26 in varchar2 default hr_api.g_varchar2
566 ,p_balance_segment27 in varchar2 default hr_api.g_varchar2
567 ,p_balance_segment28 in varchar2 default hr_api.g_varchar2
568 ,p_balance_segment29 in varchar2 default hr_api.g_varchar2
569 ,p_balance_segment30 in varchar2 default hr_api.g_varchar2
570 ,p_cost_concat_segments_in in varchar2 default hr_api.g_varchar2
571 ,p_balance_concat_segments_in in varchar2 default hr_api.g_varchar2
572 ,p_object_version_number in out nocopy number
573 ,p_cost_allocation_keyflex_id out nocopy number
574 ,p_balancing_keyflex_id out nocopy number
575 ,p_cost_concat_segments_out out nocopy varchar2
576 ,p_balance_concat_segments_out out nocopy varchar2
577 ,p_effective_start_date out nocopy date
578 ,p_effective_end_date out nocopy date
579 );
580 --
581 -- ----------------------------------------------------------------------------
582 -- |---------------------------< delete_element_link >------------------------|
583 -- ----------------------------------------------------------------------------
584 --
585 -- {Start Of Comments}
586 /*#
587 * This API deletes the element link.
588 *
589 * The role of this process is to perform a validated, date-effective delete of
590 * an existing row in the pay_element_links_f table of the HR schema.
591 *
592 * <p><b>Licensing</b><br>
593 * This API is licensed for use with Human Resources.
594 *
595 * <p><b>Prerequisites</b><br>
596 * The element link must already exist.
597 *
598 * <p><b>Post Success</b><br>
599 * The element link and associated element link input values will have been
600 * deleted.
601 *
602 * <p><b>Post Failure</b><br>
603 * The element link and associated element link input values will not have been
604 * deleted and an error will be raised.
605 * @param p_validate If true, then validation alone will be performed and the
606 * database will remain unchanged. If false and all validation checks pass,
607 * then the database will be modified.
608 * @param p_effective_date Determines when the DateTrack operation comes into
609 * force.
610 * @param p_element_link_id The Element Link to be deleted.
611 * @param p_datetrack_delete_mode Indicates which DateTrack mode to use when
612 * deleting the record. You must set to either ZAP, DELETE, FUTURE_CHANGE or
613 * DELETE_NEXT_CHANGE. Modes available for use with a particular record depend
614 * on the dates of previous record changes and the effective date of this
615 * change.
616 * @param p_object_version_number Pass in the current version number of the
617 * element link to be deleted. When the API completes if p_validate is false,
618 * will be set to the new version number of the deleted element link. If
619 * p_validate is true will be set to the same value which was passed in.
620 * @param p_effective_start_date If p_validate is false, then set to the
621 * effective start date for the deleted element link row which now exists as of
622 * the effective date. If p_validate is true or all row instances have been
623 * deleted then set to null.
624 * @param p_effective_end_date If p_validate is false, then set to the
625 * effective end date for the deleted element link row which now exists as of
626 * the effective date. If p_validate is true or all row instances have been
627 * deleted then set to null.
628 * @param p_entries_warning Set to true if a warning has occurred during
629 * delete.
630 * @rep:displayname Delete Element Link
631 * @rep:category BUSINESS_ENTITY PAY_ELEMENT_LINK
632 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
633 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
634 * @rep:scope public
635 * @rep:lifecycle active
636 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
637 */
638 --
639 -- {End Of Comments}
640 --
641 procedure delete_element_link
642 (p_validate in boolean default false
643 ,p_effective_date in date
644 ,p_element_link_id in number
645 ,p_datetrack_delete_mode in varchar2
646 ,p_object_version_number in out nocopy number
647 ,p_effective_start_date out nocopy date
648 ,p_effective_end_date out nocopy date
649 ,p_entries_warning out nocopy boolean
650 );
651
652 end pay_element_link_api;
[Home] [Help]