1 Package PAY_ELEMENT_TYPES_api AUTHID CURRENT_USER as
2 /* $Header: pyetpapi.pkh 120.3 2007/02/01 10:44:54 mshingan noship $ */
3 /*#
4 * This package contains element type APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Element Type
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |---------------------------< create_element_type >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API is used to create a new element type as of the effective date.
17 *
18 * The role of this process is to insert a fully validated row into the
19 * pay_element_types_f table of the HR schema along with any default input
20 * values required by the element type.
21 *
22 * <p><b>Licensing</b><br>
23 * This API is licensed for use with Human Resources.
24 *
25 * <p><b>Prerequisites</b><br>
26 * The element classification must already exist.
27 *
28 * <p><b>Post Success</b><br>
29 * The element type will be successfully inserted into the database.
30 *
31 * <p><b>Post Failure</b><br>
32 * The element type will not be created 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_classification_id {@rep:casecolumn
39 * PAY_ELEMENT_CLASSIFICATIONS.CLASSIFICATION_ID}
40 * @param p_element_name {@rep:casecolumn PAY_ELEMENT_TYPES_F.ELEMENT_NAME}
41 * @param p_input_currency_code {@rep:casecolumn
42 * PAY_ELEMENT_TYPES_F.INPUT_CURRENCY_CODE}
43 * @param p_output_currency_code {@rep:casecolumn
44 * PAY_ELEMENT_TYPES_F.OUTPUT_CURRENCY_CODE}
45 * @param p_multiple_entries_allowed_fla {@rep:casecolumn
46 * PAY_ELEMENT_TYPES_F.MULTIPLE_ENTRIES_ALLOWED_FLAG}
47 * @param p_processing_type {@rep:casecolumn
48 * PAY_ELEMENT_TYPES_F.PROCESSING_TYPE}
49 * @param p_business_group_id {@rep:casecolumn
50 * PAY_ELEMENT_TYPES_F.BUSINESS_GROUP_ID}
51 * @param p_legislation_code {@rep:casecolumn
52 * PAY_ELEMENT_TYPES_F.LEGISLATION_CODE}
53 * @param p_formula_id {@rep:casecolumn PAY_ELEMENT_TYPES_F.FORMULA_ID}
54 * @param p_benefit_classification_id {@rep:casecolumn
55 * PAY_ELEMENT_TYPES_F.BENEFIT_CLASSIFICATION_ID}
56 * @param p_additional_entry_allowed_fla {@rep:casecolumn
57 * PAY_ELEMENT_TYPES_F.ADDITIONAL_ENTRY_ALLOWED_FLAG}
58 * @param p_adjustment_only_flag {@rep:casecolumn
59 * PAY_ELEMENT_TYPES_F.ADJUSTMENT_ONLY_FLAG}
60 * @param p_closed_for_entry_flag {@rep:casecolumn
61 * PAY_ELEMENT_TYPES_F.CLOSED_FOR_ENTRY_FLAG}
62 * @param p_reporting_name {@rep:casecolumn PAY_ELEMENT_TYPES_F.REPORTING_NAME}
63 * @param p_description {@rep:casecolumn PAY_ELEMENT_TYPES_F.DESCRIPTION}
64 * @param p_indirect_only_flag {@rep:casecolumn
65 * PAY_ELEMENT_TYPES_F.INDIRECT_ONLY_FLAG}
66 * @param p_multiply_value_flag {@rep:casecolumn
67 * PAY_ELEMENT_TYPES_F.MULTIPLY_VALUE_FLAG}
68 * @param p_post_termination_rule {@rep:casecolumn
69 * PAY_ELEMENT_TYPES_F.POST_TERMINATION_RULE}
70 * @param p_process_in_run_flag {@rep:casecolumn
71 * PAY_ELEMENT_TYPES_F.PROCESS_IN_RUN_FLAG}
72 * @param p_processing_priority {@rep:casecolumn
76 * @param p_comments Element type comment text.
73 * PAY_ELEMENT_TYPES_F.PROCESSING_PRIORITY}
74 * @param p_standard_link_flag {@rep:casecolumn
75 * PAY_ELEMENT_TYPES_F.STANDARD_LINK_FLAG}
77 * @param p_third_party_pay_only_flag {@rep:casecolumn
78 * PAY_ELEMENT_TYPES_F.THIRD_PARTY_PAY_ONLY_FLAG}
79 * @param p_iterative_flag {@rep:casecolumn PAY_ELEMENT_TYPES_F.ITERATIVE_FLAG}
80 * @param p_iterative_formula_id {@rep:casecolumn
81 * PAY_ELEMENT_TYPES_F.ITERATIVE_FORMULA_ID}
82 * @param p_iterative_priority {@rep:casecolumn
83 * PAY_ELEMENT_TYPES_F.ITERATIVE_PRIORITY}
84 * @param p_creator_type {@rep:casecolumn PAY_ELEMENT_TYPES_F.CREATOR_TYPE}
85 * @param p_retro_summ_ele_id {@rep:casecolumn
86 * PAY_ELEMENT_TYPES_F.RETRO_SUMM_ELE_ID}
87 * @param p_grossup_flag {@rep:casecolumn PAY_ELEMENT_TYPES_F.GROSSUP_FLAG}
88 * @param p_process_mode {@rep:casecolumn PAY_ELEMENT_TYPES_F.PROCESS_MODE}
89 * @param p_advance_indicator {@rep:casecolumn
90 * PAY_ELEMENT_TYPES_F.ADVANCE_INDICATOR}
91 * @param p_advance_payable {@rep:casecolumn
92 * PAY_ELEMENT_TYPES_F.ADVANCE_PAYABLE}
93 * @param p_advance_deduction {@rep:casecolumn
94 * PAY_ELEMENT_TYPES_F.ADVANCE_DEDUCTION}
95 * @param p_process_advance_entry {@rep:casecolumn
96 * PAY_ELEMENT_TYPES_F.PROCESS_ADVANCE_ENTRY}
97 * @param p_proration_group_id {@rep:casecolumn
98 * PAY_ELEMENT_TYPES_F.PRORATION_GROUP_ID}
99 * @param p_proration_formula_id {@rep:casecolumn
100 * PAY_ELEMENT_TYPES_F.PRORATION_FORMULA_ID}
101 * @param p_recalc_event_group_id {@rep:casecolumn
102 * PAY_ELEMENT_TYPES_F.RECALC_EVENT_GROUP_ID}
103 * @param p_legislation_subgroup {@rep:casecolumn
104 * PAY_ELEMENT_TYPES_F.LEGISLATION_SUBGROUP}
105 * @param p_qualifying_age {@rep:casecolumn PAY_ELEMENT_TYPES_F.QUALIFYING_AGE}
106 * @param p_qualifying_length_of_service {@rep:casecolumn
107 * PAY_ELEMENT_TYPES_F.QUALIFYING_LENGTH_OF_SERVICE}
108 * @param p_qualifying_units {@rep:casecolumn
109 * PAY_ELEMENT_TYPES_F.QUALIFYING_UNITS}
110 * @param p_attribute_category This context value determines which flexfield
111 * structure to use with the descriptive flexfield segments.
112 * @param p_attribute1 Descriptive flexfield segment.
113 * @param p_attribute2 Descriptive flexfield segment.
114 * @param p_attribute3 Descriptive flexfield segment.
115 * @param p_attribute4 Descriptive flexfield segment.
116 * @param p_attribute5 Descriptive flexfield segment.
117 * @param p_attribute6 Descriptive flexfield segment.
118 * @param p_attribute7 Descriptive flexfield segment.
119 * @param p_attribute8 Descriptive flexfield segment.
120 * @param p_attribute9 Descriptive flexfield segment.
121 * @param p_attribute10 Descriptive flexfield segment.
122 * @param p_attribute11 Descriptive flexfield segment.
123 * @param p_attribute12 Descriptive flexfield segment.
124 * @param p_attribute13 Descriptive flexfield segment.
125 * @param p_attribute14 Descriptive flexfield segment.
126 * @param p_attribute15 Descriptive flexfield segment.
127 * @param p_attribute16 Descriptive flexfield segment.
128 * @param p_attribute17 Descriptive flexfield segment.
129 * @param p_attribute18 Descriptive flexfield segment.
130 * @param p_attribute19 Descriptive flexfield segment.
131 * @param p_attribute20 Descriptive flexfield segment.
132 * @param p_element_information_category This context value determines which
133 * Flexfield Structure to use with the Developer Descriptive flexfield
134 * segments.
135 * @param p_element_information1 Developer Descriptive flexfield segment.
136 * @param p_element_information2 Developer Descriptive flexfield segment.
137 * @param p_element_information3 Developer Descriptive flexfield segment.
138 * @param p_element_information4 Developer Descriptive flexfield segment.
139 * @param p_element_information5 Developer Descriptive flexfield segment.
140 * @param p_element_information6 Developer Descriptive flexfield segment.
141 * @param p_element_information7 Developer Descriptive flexfield segment.
142 * @param p_element_information8 Developer Descriptive flexfield segment.
143 * @param p_element_information9 Developer Descriptive flexfield segment.
144 * @param p_element_information10 Developer Descriptive flexfield segment.
145 * @param p_element_information11 Developer Descriptive flexfield segment.
146 * @param p_element_information12 Developer Descriptive flexfield segment.
147 * @param p_element_information13 Developer Descriptive flexfield segment.
148 * @param p_element_information14 Developer Descriptive flexfield segment.
149 * @param p_element_information15 Developer Descriptive flexfield segment.
150 * @param p_element_information16 Developer Descriptive flexfield segment.
151 * @param p_element_information17 Developer Descriptive flexfield segment.
152 * @param p_element_information18 Developer Descriptive flexfield segment.
153 * @param p_element_information19 Developer Descriptive flexfield segment.
154 * @param p_element_information20 Developer Descriptive flexfield segment.
155 * @param p_default_uom Unit of measure to be used for all default input
156 * values.
157 * @param p_once_each_period_flag {@rep:casecolumn
158 * PAY_ELEMENT_TYPES_F.ONCE_EACH_PERIOD_FLAG}
159 * @param p_language_code Specifies to which language the translation values
160 * apply. You can set to the base or any installed language. The default value
161 * of hr_api.userenv_lang is equivalent to the RDBMS userenv('LANG') function
162 * value.
163 * @param p_time_definition_type Specifies the time definition type.
164 * @param p_time_definition_id Specifies the time definition.
165 * @param p_element_type_id If p_validate is false, uniquely identifies the
166 * element type created. If p_validate is true, set to null.
167 * @param p_effective_start_date If p_validate is false, then set to the
168 * earliest effective start date for the created element type. If p_validate is
169 * true, then set to null.
170 * @param p_effective_end_date If p_validate is false, then set to the
171 * effective end date for the created element type. If p_validate is true, then
172 * set to null.
173 * @param p_object_version_number If p_validate is false, then set to the
174 * version number of the created element type. If p_validate is true, then the
175 * value will be null.
176 * @param p_comment_id If p_validate is false and comment text was provided,
177 * then will be set to the identifier of the created element type comment
178 * record. If p_validate is true or no comment text was provided, then will be
179 * null.
180 * @param p_processing_priority_warning If set to true, then the processing
181 * priority is not in range for the element classification.
182 * @rep:displayname Create Element Type
183 * @rep:category BUSINESS_ENTITY PAY_ELEMENT
184 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
185 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
186 * @rep:scope public
187 * @rep:lifecycle active
188 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
189 */
190 --
191 -- {End Of Comments}
192 --
193 procedure CREATE_ELEMENT_TYPE
194 (p_validate in boolean default false
195 ,p_effective_date in date
196 ,p_classification_id in number
197 ,p_element_name in varchar2
198 ,p_input_currency_code in varchar2
199 ,p_output_currency_code in varchar2
200 ,p_multiple_entries_allowed_fla in varchar2
201 ,p_processing_type in varchar2
202 ,p_business_group_id in number default null
203 ,p_legislation_code in varchar2 default null
204 ,p_formula_id in number default null
205 ,p_benefit_classification_id in number default null
206 ,p_additional_entry_allowed_fla in varchar2 default 'N'
207 ,p_adjustment_only_flag in varchar2 default 'N'
208 ,p_closed_for_entry_flag in varchar2 default 'N'
209 ,p_reporting_name in varchar2 default null
210 ,p_description in varchar2 default null
211 ,p_indirect_only_flag in varchar2 default 'N'
212 ,p_multiply_value_flag in varchar2 default 'N'
213 ,p_post_termination_rule in varchar2 default 'L'
214 ,p_process_in_run_flag in varchar2 default 'Y'
215 ,p_processing_priority in number default null
216 ,p_standard_link_flag in varchar2 default 'N'
217 ,p_comments in varchar2 default null
218 ,p_third_party_pay_only_flag in varchar2 default null
219 ,p_iterative_flag in varchar2 default null
220 ,p_iterative_formula_id in number default null
221 ,p_iterative_priority in number default null
222 ,p_creator_type in varchar2 default null
223 ,p_retro_summ_ele_id in number default null
224 ,p_grossup_flag in varchar2 default null
225 ,p_process_mode in varchar2 default null
226 ,p_advance_indicator in varchar2 default null
227 ,p_advance_payable in varchar2 default null
228 ,p_advance_deduction in varchar2 default null
229 ,p_process_advance_entry in varchar2 default null
230 ,p_proration_group_id in number default null
231 ,p_proration_formula_id in number default null
232 ,p_recalc_event_group_id in number default null
233 ,p_legislation_subgroup in varchar2 default null
234 ,p_qualifying_age in number default null
235 ,p_qualifying_length_of_service in number default null
236 ,p_qualifying_units in varchar2 default null
237 ,p_attribute_category in varchar2 default null
238 ,p_attribute1 in varchar2 default null
239 ,p_attribute2 in varchar2 default null
240 ,p_attribute3 in varchar2 default null
241 ,p_attribute4 in varchar2 default null
242 ,p_attribute5 in varchar2 default null
243 ,p_attribute6 in varchar2 default null
244 ,p_attribute7 in varchar2 default null
245 ,p_attribute8 in varchar2 default null
246 ,p_attribute9 in varchar2 default null
247 ,p_attribute10 in varchar2 default null
248 ,p_attribute11 in varchar2 default null
249 ,p_attribute12 in varchar2 default null
250 ,p_attribute13 in varchar2 default null
251 ,p_attribute14 in varchar2 default null
252 ,p_attribute15 in varchar2 default null
253 ,p_attribute16 in varchar2 default null
254 ,p_attribute17 in varchar2 default null
255 ,p_attribute18 in varchar2 default null
256 ,p_attribute19 in varchar2 default null
257 ,p_attribute20 in varchar2 default null
258 ,p_element_information_category in varchar2 default null
259 ,p_element_information1 in varchar2 default null
260 ,p_element_information2 in varchar2 default null
261 ,p_element_information3 in varchar2 default null
262 ,p_element_information4 in varchar2 default null
263 ,p_element_information5 in varchar2 default null
264 ,p_element_information6 in varchar2 default null
265 ,p_element_information7 in varchar2 default null
266 ,p_element_information8 in varchar2 default null
267 ,p_element_information9 in varchar2 default null
268 ,p_element_information10 in varchar2 default null
269 ,p_element_information11 in varchar2 default null
270 ,p_element_information12 in varchar2 default null
271 ,p_element_information13 in varchar2 default null
272 ,p_element_information14 in varchar2 default null
273 ,p_element_information15 in varchar2 default null
274 ,p_element_information16 in varchar2 default null
275 ,p_element_information17 in varchar2 default null
276 ,p_element_information18 in varchar2 default null
277 ,p_element_information19 in varchar2 default null
278 ,p_element_information20 in varchar2 default null
279 ,p_default_uom in varchar2 default null
280 ,p_once_each_period_flag in varchar2 default 'N'
281 ,p_language_code in varchar2 default hr_api.userenv_lang
282 ,p_time_definition_type in varchar2 default null
283 ,p_time_definition_id in number default null
284 ,p_advance_element_type_id in number default null
285 ,p_deduction_element_type_id in number default null
286 ,p_element_type_id out nocopy number
287 ,p_effective_start_date out nocopy date
288 ,p_effective_end_date out nocopy date
289 ,p_object_version_number out nocopy number
290 ,p_comment_id out nocopy number
291 ,p_processing_priority_warning out nocopy boolean
292 );
293 --
294 -- ----------------------------------------------------------------------------
295 -- |---------------------------< update_element_type >------------------------|
296 -- ----------------------------------------------------------------------------
297 --
298 -- {Start Of Comments}
299 /*#
300 * This API is used to update an element type as of the effective date.
301 *
302 * The role of this process is to perform a validated, date-effective update of
303 * an existing row in the pay_element_types_f table of the HR schema.
304 *
305 * <p><b>Licensing</b><br>
306 * This API is licensed for use with Human Resources.
307 *
308 * <p><b>Prerequisites</b><br>
309 * The element type specified by the in parameter p_element_type_id and the in
310 * out parameter p_object_version_number must already exist.
311 *
312 * <p><b>Post Success</b><br>
313 * The element type will have been successfully updated in the database.
314 *
315 * <p><b>Post Failure</b><br>
316 * The element type will not be updated and an error will be raised.
317 * @param p_validate If true, then validation alone will be performed and the
318 * database will remain unchanged. If false and all validation checks pass,
319 * then the database will be modified.
320 * @param p_effective_date Determines when the DateTrack operation comes into
321 * force.
322 * @param p_datetrack_update_mode Indicates which DateTrack mode to use when
323 * updating the record. You must set to either UPDATE, CORRECTION,
324 * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
325 * particular record depend on the dates of previous record changes and the
326 * effective date of this change.
327 * @param p_element_type_id {@rep:casecolumn
328 * PAY_ELEMENT_TYPES_F.ELEMENT_TYPE_ID}
329 * @param p_object_version_number Pass in the current version number of the
330 * element type to be updated. When the API completes if p_validate is false,
331 * will be set to the new version number of the updated element type. If
332 * p_validate is true will be set to the same value which was passed in.
333 * @param p_formula_id {@rep:casecolumn PAY_ELEMENT_TYPES_F.FORMULA_ID}
334 * @param p_benefit_classification_id {@rep:casecolumn
335 * PAY_ELEMENT_TYPES_F.BENEFIT_CLASSIFICATION_ID}
336 * @param p_additional_entry_allowed_fla {@rep:casecolumn
337 * PAY_ELEMENT_TYPES_F.ADDITIONAL_ENTRY_ALLOWED_FLAG}
338 * @param p_adjustment_only_flag {@rep:casecolumn
339 * PAY_ELEMENT_TYPES_F.ADJUSTMENT_ONLY_FLAG}
340 * @param p_closed_for_entry_flag {@rep:casecolumn
341 * PAY_ELEMENT_TYPES_F.CLOSED_FOR_ENTRY_FLAG}
342 * @param p_element_name {@rep:casecolumn PAY_ELEMENT_TYPES_F.ELEMENT_NAME}
343 * @param p_reporting_name {@rep:casecolumn PAY_ELEMENT_TYPES_F.REPORTING_NAME}
344 * @param p_description {@rep:casecolumn PAY_ELEMENT_TYPES_F.DESCRIPTION}
345 * @param p_indirect_only_flag {@rep:casecolumn
346 * PAY_ELEMENT_TYPES_F.INDIRECT_ONLY_FLAG}
347 * @param p_multiple_entries_allowed_fla {@rep:casecolumn
348 * PAY_ELEMENT_TYPES_F.MULTIPLE_ENTRIES_ALLOWED_FLAG}
349 * @param p_multiply_value_flag {@rep:casecolumn
350 * PAY_ELEMENT_TYPES_F.MULTIPLY_VALUE_FLAG}
351 * @param p_post_termination_rule {@rep:casecolumn
352 * PAY_ELEMENT_TYPES_F.POST_TERMINATION_RULE}
353 * @param p_process_in_run_flag {@rep:casecolumn
354 * PAY_ELEMENT_TYPES_F.PROCESS_IN_RUN_FLAG}
355 * @param p_processing_priority {@rep:casecolumn
356 * PAY_ELEMENT_TYPES_F.PROCESSING_PRIORITY}
357 * @param p_standard_link_flag {@rep:casecolumn
358 * PAY_ELEMENT_TYPES_F.STANDARD_LINK_FLAG}
359 * @param p_comments Element type comment text.
360 * @param p_third_party_pay_only_flag {@rep:casecolumn
361 * PAY_ELEMENT_TYPES_F.THIRD_PARTY_PAY_ONLY_FLAG}
362 * @param p_iterative_flag {@rep:casecolumn PAY_ELEMENT_TYPES_F.ITERATIVE_FLAG}
363 * @param p_iterative_formula_id {@rep:casecolumn
364 * PAY_ELEMENT_TYPES_F.ITERATIVE_FORMULA_ID}
365 * @param p_iterative_priority {@rep:casecolumn
366 * PAY_ELEMENT_TYPES_F.ITERATIVE_PRIORITY}
367 * @param p_creator_type {@rep:casecolumn PAY_ELEMENT_TYPES_F.CREATOR_TYPE}
368 * @param p_retro_summ_ele_id {@rep:casecolumn
369 * PAY_ELEMENT_TYPES_F.RETRO_SUMM_ELE_ID}
370 * @param p_grossup_flag {@rep:casecolumn PAY_ELEMENT_TYPES_F.GROSSUP_FLAG}
371 * @param p_process_mode {@rep:casecolumn PAY_ELEMENT_TYPES_F.PROCESS_MODE}
372 * @param p_advance_indicator {@rep:casecolumn
373 * PAY_ELEMENT_TYPES_F.ADVANCE_INDICATOR}
374 * @param p_advance_payable {@rep:casecolumn
375 * PAY_ELEMENT_TYPES_F.ADVANCE_PAYABLE}
376 * @param p_advance_deduction {@rep:casecolumn
377 * PAY_ELEMENT_TYPES_F.ADVANCE_DEDUCTION}
378 * @param p_process_advance_entry {@rep:casecolumn
382 * @param p_proration_formula_id {@rep:casecolumn
379 * PAY_ELEMENT_TYPES_F.PROCESS_ADVANCE_ENTRY}
380 * @param p_proration_group_id {@rep:casecolumn
381 * PAY_ELEMENT_TYPES_F.PRORATION_GROUP_ID}
383 * PAY_ELEMENT_TYPES_F.PRORATION_FORMULA_ID}
384 * @param p_recalc_event_group_id {@rep:casecolumn
385 * PAY_ELEMENT_TYPES_F.RECALC_EVENT_GROUP_ID}
386 * @param p_qualifying_age {@rep:casecolumn PAY_ELEMENT_TYPES_F.QUALIFYING_AGE}
387 * @param p_qualifying_length_of_service {@rep:casecolumn
388 * PAY_ELEMENT_TYPES_F.QUALIFYING_LENGTH_OF_SERVICE}
389 * @param p_qualifying_units {@rep:casecolumn
390 * PAY_ELEMENT_TYPES_F.QUALIFYING_UNITS}
391 * @param p_attribute_category This context value determines which flexfield
392 * structure to use with the descriptive flexfield segments.
393 * @param p_attribute1 Descriptive flexfield segment.
394 * @param p_attribute2 Descriptive flexfield segment.
395 * @param p_attribute3 Descriptive flexfield segment.
396 * @param p_attribute4 Descriptive flexfield segment.
397 * @param p_attribute5 Descriptive flexfield segment.
398 * @param p_attribute6 Descriptive flexfield segment.
399 * @param p_attribute7 Descriptive flexfield segment.
400 * @param p_attribute8 Descriptive flexfield segment.
401 * @param p_attribute9 Descriptive flexfield segment.
402 * @param p_attribute10 Descriptive flexfield segment.
403 * @param p_attribute11 Descriptive flexfield segment.
404 * @param p_attribute12 Descriptive flexfield segment.
405 * @param p_attribute13 Descriptive flexfield segment.
406 * @param p_attribute14 Descriptive flexfield segment.
407 * @param p_attribute15 Descriptive flexfield segment.
408 * @param p_attribute16 Descriptive flexfield segment.
409 * @param p_attribute17 Descriptive flexfield segment.
410 * @param p_attribute18 Descriptive flexfield segment.
411 * @param p_attribute19 Descriptive flexfield segment.
412 * @param p_attribute20 Descriptive flexfield segment.
413 * @param p_element_information_category This context value determines which
414 * Flexfield Structure to use with the Developer Descriptive flexfield
415 * segments.
416 * @param p_element_information1 Developer Descriptive flexfield segment.
417 * @param p_element_information2 Developer Descriptive flexfield segment.
418 * @param p_element_information3 Developer Descriptive flexfield segment.
419 * @param p_element_information4 Developer Descriptive flexfield segment.
420 * @param p_element_information5 Developer Descriptive flexfield segment.
421 * @param p_element_information6 Developer Descriptive flexfield segment.
422 * @param p_element_information7 Developer Descriptive flexfield segment.
423 * @param p_element_information8 Developer Descriptive flexfield segment.
424 * @param p_element_information9 Developer Descriptive flexfield segment.
425 * @param p_element_information10 Developer Descriptive flexfield segment.
426 * @param p_element_information11 Developer Descriptive flexfield segment.
427 * @param p_element_information12 Developer Descriptive flexfield segment.
428 * @param p_element_information13 Developer Descriptive flexfield segment.
429 * @param p_element_information14 Developer Descriptive flexfield segment.
430 * @param p_element_information15 Developer Descriptive flexfield segment.
431 * @param p_element_information16 Developer Descriptive flexfield segment.
432 * @param p_element_information17 Developer Descriptive flexfield segment.
433 * @param p_element_information18 Developer Descriptive flexfield segment.
434 * @param p_element_information19 Developer Descriptive flexfield segment.
435 * @param p_element_information20 Developer Descriptive flexfield segment.
436 * @param p_once_each_period_flag {@rep:casecolumn
437 * PAY_ELEMENT_TYPES_F.ONCE_EACH_PERIOD_FLAG}
438 * @param p_language_code Specifies to which language the translation values
439 * apply. You can set to the base or any installed language. The default value
440 * of hr_api.userenv_lang is equivalent to the RDBMS userenv('LANG') function
441 * value.
442 * @param p_time_definition_type Specifies the time definition type.
443 * @param p_time_definition_id Specifies the time definition.
444 * @param p_effective_start_date If p_validate is false, then set to the
445 * effective start date on the updated element type row which now exists as of
446 * the effective date. If p_validate is true, then set to null.
447 * @param p_effective_end_date If p_validate is false, then set to the
448 * effective end date on the updated element type row which now exists as of
449 * the effective date. If p_validate is true, then set to null.
450 * @param p_comment_id If p_validate is false and new or existing comment text
451 * exists, then will be set to the identifier of the element type comment
452 * record. If p_validate is true or no comment text exists, then will be null.
453 * @param p_processing_priority_warning If set to true, then the processing
454 * priority is not in range for the element classification.
455 * @param p_element_name_warning If set to true, then the source language for
456 * the translated element record is different from p_language_code when the
457 * element name is changed.
458 * @param p_element_name_change_warning If set to true, then the element name
459 * has changed.
460 * @rep:displayname Update Element Type
461 * @rep:category BUSINESS_ENTITY PAY_ELEMENT
462 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
463 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
464 * @rep:scope public
465 * @rep:lifecycle active
466 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
467 */
468 --
469 -- {End Of Comments}
470 --
471 procedure UPDATE_ELEMENT_TYPE
472 (p_validate in boolean default false
473 ,p_effective_date in date
474 ,p_datetrack_update_mode in varchar2
475 ,p_element_type_id in number
476 ,p_object_version_number in out nocopy number
477 ,p_formula_id in number default hr_api.g_number
478 ,p_benefit_classification_id in number default hr_api.g_number
479 ,p_additional_entry_allowed_fla in varchar2 default hr_api.g_varchar2
480 ,p_adjustment_only_flag in varchar2 default hr_api.g_varchar2
481 ,p_closed_for_entry_flag in varchar2 default hr_api.g_varchar2
482 ,p_element_name in varchar2 default hr_api.g_varchar2
483 ,p_reporting_name in varchar2 default hr_api.g_varchar2
484 ,p_description in varchar2 default hr_api.g_varchar2
485 ,p_indirect_only_flag in varchar2 default hr_api.g_varchar2
486 ,p_multiple_entries_allowed_fla in varchar2 default hr_api.g_varchar2
487 ,p_multiply_value_flag in varchar2 default hr_api.g_varchar2
488 ,p_post_termination_rule in varchar2 default hr_api.g_varchar2
489 ,p_process_in_run_flag in varchar2 default hr_api.g_varchar2
490 ,p_processing_priority in number default hr_api.g_number
491 ,p_standard_link_flag in varchar2 default hr_api.g_varchar2
492 ,p_comments in varchar2 default hr_api.g_varchar2
493 ,p_third_party_pay_only_flag in varchar2 default hr_api.g_varchar2
494 ,p_iterative_flag in varchar2 default hr_api.g_varchar2
495 ,p_iterative_formula_id in number default hr_api.g_number
496 ,p_iterative_priority in number default hr_api.g_number
497 ,p_creator_type in varchar2 default hr_api.g_varchar2
498 ,p_retro_summ_ele_id in number default hr_api.g_number
499 ,p_grossup_flag in varchar2 default hr_api.g_varchar2
500 ,p_process_mode in varchar2 default hr_api.g_varchar2
501 ,p_advance_indicator in varchar2 default hr_api.g_varchar2
502 ,p_advance_payable in varchar2 default hr_api.g_varchar2
503 ,p_advance_deduction in varchar2 default hr_api.g_varchar2
504 ,p_process_advance_entry in varchar2 default hr_api.g_varchar2
505 ,p_proration_group_id in number default hr_api.g_number
506 ,p_proration_formula_id in number default hr_api.g_number
507 ,p_recalc_event_group_id in number default hr_api.g_number
508 ,p_qualifying_age in number default hr_api.g_number
509 ,p_qualifying_length_of_service in number default hr_api.g_number
510 ,p_qualifying_units in varchar2 default hr_api.g_varchar2
511 ,p_attribute_category in varchar2 default hr_api.g_varchar2
512 ,p_attribute1 in varchar2 default hr_api.g_varchar2
513 ,p_attribute2 in varchar2 default hr_api.g_varchar2
514 ,p_attribute3 in varchar2 default hr_api.g_varchar2
515 ,p_attribute4 in varchar2 default hr_api.g_varchar2
516 ,p_attribute5 in varchar2 default hr_api.g_varchar2
517 ,p_attribute6 in varchar2 default hr_api.g_varchar2
518 ,p_attribute7 in varchar2 default hr_api.g_varchar2
519 ,p_attribute8 in varchar2 default hr_api.g_varchar2
520 ,p_attribute9 in varchar2 default hr_api.g_varchar2
521 ,p_attribute10 in varchar2 default hr_api.g_varchar2
522 ,p_attribute11 in varchar2 default hr_api.g_varchar2
523 ,p_attribute12 in varchar2 default hr_api.g_varchar2
524 ,p_attribute13 in varchar2 default hr_api.g_varchar2
525 ,p_attribute14 in varchar2 default hr_api.g_varchar2
526 ,p_attribute15 in varchar2 default hr_api.g_varchar2
527 ,p_attribute16 in varchar2 default hr_api.g_varchar2
528 ,p_attribute17 in varchar2 default hr_api.g_varchar2
529 ,p_attribute18 in varchar2 default hr_api.g_varchar2
530 ,p_attribute19 in varchar2 default hr_api.g_varchar2
531 ,p_attribute20 in varchar2 default hr_api.g_varchar2
532 ,p_element_information_category in varchar2 default hr_api.g_varchar2
533 ,p_element_information1 in varchar2 default hr_api.g_varchar2
534 ,p_element_information2 in varchar2 default hr_api.g_varchar2
535 ,p_element_information3 in varchar2 default hr_api.g_varchar2
536 ,p_element_information4 in varchar2 default hr_api.g_varchar2
537 ,p_element_information5 in varchar2 default hr_api.g_varchar2
538 ,p_element_information6 in varchar2 default hr_api.g_varchar2
539 ,p_element_information7 in varchar2 default hr_api.g_varchar2
540 ,p_element_information8 in varchar2 default hr_api.g_varchar2
541 ,p_element_information9 in varchar2 default hr_api.g_varchar2
542 ,p_element_information10 in varchar2 default hr_api.g_varchar2
543 ,p_element_information11 in varchar2 default hr_api.g_varchar2
544 ,p_element_information12 in varchar2 default hr_api.g_varchar2
545 ,p_element_information13 in varchar2 default hr_api.g_varchar2
546 ,p_element_information14 in varchar2 default hr_api.g_varchar2
547 ,p_element_information15 in varchar2 default hr_api.g_varchar2
548 ,p_element_information16 in varchar2 default hr_api.g_varchar2
549 ,p_element_information17 in varchar2 default hr_api.g_varchar2
550 ,p_element_information18 in varchar2 default hr_api.g_varchar2
551 ,p_element_information19 in varchar2 default hr_api.g_varchar2
552 ,p_element_information20 in varchar2 default hr_api.g_varchar2
553 ,p_once_each_period_flag in varchar2 default hr_api.g_varchar2
554 ,p_language_code in varchar2 default hr_api.userenv_lang
555 ,p_time_definition_type in varchar2 default hr_api.g_varchar2
556 ,p_time_definition_id in number default hr_api.g_number
557 ,p_advance_element_type_id in number default hr_api.g_number
558 ,p_deduction_element_type_id in number default hr_api.g_number
559 ,p_effective_start_date out nocopy date
560 ,p_effective_end_date out nocopy date
561 ,p_comment_id out nocopy number
562 ,p_processing_priority_warning out nocopy boolean
563 ,p_element_name_warning out nocopy boolean
564 ,p_element_name_change_warning out nocopy boolean
565 );
566 --
567 -- ----------------------------------------------------------------------------
568 -- |---------------------------< delete_element_type >------------------------|
569 -- ----------------------------------------------------------------------------
570 --
571 -- {Start Of Comments}
572 /*#
573 * This API is used to delete a new element type as of the effective date.
574 *
575 * The role of this process is to perform a validated, date-effective delete of
576 * an existing row in the pay_element_type_usages_f table of the HR schema.
577 *
578 * <p><b>Licensing</b><br>
579 * This API is licensed for use with Human Resources.
580 *
581 * <p><b>Prerequisites</b><br>
582 * The element type specified by the in parameter p_element_type_id and the in
583 * out parameter p_object_version_number must already exist.
584 *
585 * <p><b>Post Success</b><br>
586 * The element type will have been successfully removed from the database.
587 *
588 * <p><b>Post Failure</b><br>
589 * The element type will not be deleted and an error will be raised.
590 * @param p_validate If true, then validation alone will be performed and the
591 * database will remain unchanged. If false and all validation checks pass,
592 * then the database will be modified.
593 * @param p_effective_date Determines when the DateTrack operation comes into
594 * force.
595 * @param p_datetrack_delete_mode Indicates which DateTrack mode to use when
596 * deleting the record. You must set to either ZAP, DELETE, FUTURE_CHANGE or
597 * DELETE_NEXT_CHANGE. Modes available for use with a particular record depend
598 * on the dates of previous record changes and the effective date of this
599 * change.
600 * @param p_element_type_id {@rep:casecolumn
601 * PAY_ELEMENT_TYPES_F.ELEMENT_TYPE_ID}
602 * @param p_object_version_number Pass in the current version number of the
603 * element type to be deleted. When the API completes if p_validate is false,
604 * will be set to the new version number of the deleted element type. If
605 * p_validate is true will be set to the same value which was passed in.
606 * @param p_effective_start_date If p_validate is false, then set to the
607 * effective start date for the deleted element type row which now exists as of
608 * the effective date. If p_validate is true or all row instances have been
609 * deleted then set to null.
610 * @param p_effective_end_date If p_validate is false, then set to the
611 * effective end date for the deleted element name row which now exists as of
612 * the effective date. If p_validate is true or all row instances have been
613 * deleted then set to null.
614 * @param p_balance_feeds_warning If set to true, then balance feeds have been
615 * deleted.
616 * @param p_processing_rules_warning If set to true, then processing rules have
617 * not been affected for delete_next_change operations.
618 * @rep:displayname Delete Element Type
619 * @rep:category BUSINESS_ENTITY PAY_ELEMENT
620 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
621 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
622 * @rep:scope public
623 * @rep:lifecycle active
624 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
625 */
626 --
627 -- {End Of Comments}
628 --
629 procedure DELETE_ELEMENT_TYPE
630 (p_validate in boolean default false
631 ,p_effective_date in date
632 ,p_datetrack_delete_mode in varchar2
633 ,p_element_type_id in number
634 ,p_object_version_number in out nocopy number
635 ,p_effective_start_date out nocopy date
636 ,p_effective_end_date out nocopy date
637 ,p_balance_feeds_warning out nocopy boolean
638 ,p_processing_rules_warning out nocopy boolean
639 );
640
641 end PAY_ELEMENT_TYPES_api;
[Home] [Help]