1 Package pay_element_extra_info_api as
2 /* $Header: pyeeiapi.pkh 120.1 2005/10/02 02:30:38 aroussel $ */
3 /*#
4 * This package contains element extra information APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Element Extra Information
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |------------------------< create_element_extra_info >---------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates extra information for a given element.
17 *
18 * The role of this process is to insert a fully validated row into the
19 * pay_element_type_extra_info table of the HR schema
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 must already exist. Element information types must already
26 * exist.
27 *
28 * <p><b>Post Success</b><br>
29 * The element extra information will be successfully inserted into the
30 * database.
31 *
32 * <p><b>Post Failure</b><br>
33 * The element extra information will not be created and an error will be
34 * raised.
35 * @param p_validate If true, then validation alone will be performed and the
36 * database will remain unchanged. If false and all validation checks pass,
37 * then the database will be modified.
38 * @param p_element_type_id {@rep:casecolumn
39 * PAY_ELEMENT_TYPES_F.ELEMENT_TYPE_ID}
40 * @param p_information_type {@rep:casecolumn
41 * PAY_ELEMENT_TYPE_EXTRA_INFO.INFORMATION_TYPE}
42 * @param p_eei_attribute_category This context value determines which
43 * Flexfield Structure to use with the Descriptive flexfield segments.
44 * @param p_eei_attribute1 Descriptive flexfield segment.
45 * @param p_eei_attribute2 Descriptive flexfield segment.
46 * @param p_eei_attribute3 Descriptive flexfield segment.
47 * @param p_eei_attribute4 Descriptive flexfield segment.
48 * @param p_eei_attribute5 Descriptive flexfield segment.
49 * @param p_eei_attribute6 Descriptive flexfield segment.
50 * @param p_eei_attribute7 Descriptive flexfield segment.
51 * @param p_eei_attribute8 Descriptive flexfield segment.
52 * @param p_eei_attribute9 Descriptive flexfield segment.
53 * @param p_eei_attribute10 Descriptive flexfield segment.
54 * @param p_eei_attribute11 Descriptive flexfield segment.
55 * @param p_eei_attribute12 Descriptive flexfield segment.
56 * @param p_eei_attribute13 Descriptive flexfield segment.
57 * @param p_eei_attribute14 Descriptive flexfield segment.
58 * @param p_eei_attribute15 Descriptive flexfield segment.
59 * @param p_eei_attribute16 Descriptive flexfield segment.
60 * @param p_eei_attribute17 Descriptive flexfield segment.
61 * @param p_eei_attribute18 Descriptive flexfield segment.
62 * @param p_eei_attribute19 Descriptive flexfield segment.
63 * @param p_eei_attribute20 Descriptive flexfield segment.
64 * @param p_eei_information_category This context value determines which
65 * Flexfield Structure to use with the Developer Descriptive flexfield
66 * segments.
67 * @param p_eei_information1 Developer Descriptive flexfield segment.
68 * @param p_eei_information2 Developer Descriptive flexfield segment.
69 * @param p_eei_information3 Developer Descriptive flexfield segment.
70 * @param p_eei_information4 Developer Descriptive flexfield segment.
71 * @param p_eei_information5 Developer Descriptive flexfield segment.
72 * @param p_eei_information6 Developer Descriptive flexfield segment.
73 * @param p_eei_information7 Developer Descriptive flexfield segment.
74 * @param p_eei_information8 Developer Descriptive flexfield segment.
75 * @param p_eei_information9 Developer Descriptive flexfield segment.
76 * @param p_eei_information10 Developer Descriptive flexfield segment.
77 * @param p_eei_information11 Developer Descriptive flexfield segment.
78 * @param p_eei_information12 Developer Descriptive flexfield segment.
79 * @param p_eei_information13 Developer Descriptive flexfield segment.
80 * @param p_eei_information14 Developer Descriptive flexfield segment.
81 * @param p_eei_information15 Developer Descriptive flexfield segment.
82 * @param p_eei_information16 Developer Descriptive flexfield segment.
83 * @param p_eei_information17 Developer Descriptive flexfield segment.
84 * @param p_eei_information18 Developer Descriptive flexfield segment.
85 * @param p_eei_information19 Developer Descriptive flexfield segment.
86 * @param p_eei_information20 Developer Descriptive flexfield segment.
87 * @param p_eei_information21 Developer Descriptive flexfield segment.
88 * @param p_eei_information22 Developer Descriptive flexfield segment.
89 * @param p_eei_information23 Developer Descriptive flexfield segment.
90 * @param p_eei_information24 Developer Descriptive flexfield segment.
91 * @param p_eei_information25 Developer Descriptive flexfield segment.
92 * @param p_eei_information26 Developer Descriptive flexfield segment.
93 * @param p_eei_information27 Developer Descriptive flexfield segment.
94 * @param p_eei_information28 Developer Descriptive flexfield segment.
95 * @param p_eei_information29 Developer Descriptive flexfield segment.
96 * @param p_eei_information30 Developer Descriptive flexfield segment.
97 * @param p_element_type_extra_info_id If p_validate is false, uniquely
98 * identifies the element extra info created. If p_validate is true, set to
99 * null.
100 * @param p_object_version_number If p_validate is false, then set to the
101 * version number of the created element type extra information. If p_validate
102 * is true, then the value will be null.
103 * @rep:displayname Create Extra Information for an Element
104 * @rep:category BUSINESS_ENTITY PAY_ELEMENT
105 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
106 * @rep:scope public
107 * @rep:lifecycle active
108 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
109 */
110 --
111 -- {End Of Comments}
112 --
113 procedure create_element_extra_info
114 (p_validate in boolean default false
115 ,p_element_type_id in number
116 ,p_information_type in varchar2
117 ,p_eei_attribute_category in varchar2 default null
118 ,p_eei_attribute1 in varchar2 default null
119 ,p_eei_attribute2 in varchar2 default null
120 ,p_eei_attribute3 in varchar2 default null
121 ,p_eei_attribute4 in varchar2 default null
122 ,p_eei_attribute5 in varchar2 default null
123 ,p_eei_attribute6 in varchar2 default null
124 ,p_eei_attribute7 in varchar2 default null
125 ,p_eei_attribute8 in varchar2 default null
126 ,p_eei_attribute9 in varchar2 default null
127 ,p_eei_attribute10 in varchar2 default null
128 ,p_eei_attribute11 in varchar2 default null
129 ,p_eei_attribute12 in varchar2 default null
130 ,p_eei_attribute13 in varchar2 default null
131 ,p_eei_attribute14 in varchar2 default null
132 ,p_eei_attribute15 in varchar2 default null
133 ,p_eei_attribute16 in varchar2 default null
134 ,p_eei_attribute17 in varchar2 default null
135 ,p_eei_attribute18 in varchar2 default null
136 ,p_eei_attribute19 in varchar2 default null
137 ,p_eei_attribute20 in varchar2 default null
138 ,p_eei_information_category in varchar2 default null
139 ,p_eei_information1 in varchar2 default null
140 ,p_eei_information2 in varchar2 default null
141 ,p_eei_information3 in varchar2 default null
142 ,p_eei_information4 in varchar2 default null
143 ,p_eei_information5 in varchar2 default null
144 ,p_eei_information6 in varchar2 default null
145 ,p_eei_information7 in varchar2 default null
146 ,p_eei_information8 in varchar2 default null
147 ,p_eei_information9 in varchar2 default null
148 ,p_eei_information10 in varchar2 default null
149 ,p_eei_information11 in varchar2 default null
150 ,p_eei_information12 in varchar2 default null
151 ,p_eei_information13 in varchar2 default null
152 ,p_eei_information14 in varchar2 default null
153 ,p_eei_information15 in varchar2 default null
154 ,p_eei_information16 in varchar2 default null
155 ,p_eei_information17 in varchar2 default null
156 ,p_eei_information18 in varchar2 default null
157 ,p_eei_information19 in varchar2 default null
158 ,p_eei_information20 in varchar2 default null
159 ,p_eei_information21 in varchar2 default null
160 ,p_eei_information22 in varchar2 default null
161 ,p_eei_information23 in varchar2 default null
162 ,p_eei_information24 in varchar2 default null
163 ,p_eei_information25 in varchar2 default null
164 ,p_eei_information26 in varchar2 default null
165 ,p_eei_information27 in varchar2 default null
166 ,p_eei_information28 in varchar2 default null
167 ,p_eei_information29 in varchar2 default null
168 ,p_eei_information30 in varchar2 default null
169 ,p_element_type_extra_info_id out nocopy number
170 ,p_object_version_number out nocopy number
171 );
172 --
173 -- ----------------------------------------------------------------------------
174 -- |------------------------< update_element_extra_info >---------------------|
175 -- ----------------------------------------------------------------------------
176 --
177 -- {Start Of Comments}
178 /*#
179 * This API updates extra information for a given element.
180 *
181 * The role of this process is to perform a validated update of an existing row
182 * in the pay_element_type_extra_info table of the HR schema.
183 *
184 * <p><b>Licensing</b><br>
185 * This API is licensed for use with Human Resources.
186 *
187 * <p><b>Prerequisites</b><br>
188 * The element extra info as identified by the in parameter
189 * p_element_type_extra_info_id and the in out parameter
190 * p_object_version_number must already exist.
191 *
192 * <p><b>Post Success</b><br>
193 * The element extra information will have been successfully updated in the
194 * database.
195 *
196 * <p><b>Post Failure</b><br>
197 * The element extra information will not be updated and an error will be
198 * raised.
199 * @param p_validate If true, then validation alone will be performed and the
200 * database will remain unchanged. If false and all validation checks pass,
201 * then the database will be modified.
202 * @param p_element_type_extra_info_id {@rep:casecolumn
203 * PAY_ELEMENT_TYPE_EXTRA_INFO.ELEMENT_TYPE_EXTRA_INFO_ID}
204 * @param p_object_version_number Pass in the current version number of the
205 * element type extra information to be updated. When the API completes if
206 * p_validate is false, will be set to the new version number of the updated
207 * element type extra information. If p_validate is true will be set to the
208 * same value which was passed in.
209 * @param p_eei_attribute_category This context value determines which
210 * Flexfield Structure to use with the Descriptive flexfield segments.
211 * @param p_eei_attribute1 Descriptive flexfield segment.
212 * @param p_eei_attribute2 Descriptive flexfield segment.
213 * @param p_eei_attribute3 Descriptive flexfield segment.
214 * @param p_eei_attribute4 Descriptive flexfield segment.
215 * @param p_eei_attribute5 Descriptive flexfield segment.
216 * @param p_eei_attribute6 Descriptive flexfield segment.
217 * @param p_eei_attribute7 Descriptive flexfield segment.
218 * @param p_eei_attribute8 Descriptive flexfield segment.
219 * @param p_eei_attribute9 Descriptive flexfield segment.
220 * @param p_eei_attribute10 Descriptive flexfield segment.
221 * @param p_eei_attribute11 Descriptive flexfield segment.
222 * @param p_eei_attribute12 Descriptive flexfield segment.
223 * @param p_eei_attribute13 Descriptive flexfield segment.
224 * @param p_eei_attribute14 Descriptive flexfield segment.
225 * @param p_eei_attribute15 Descriptive flexfield segment.
226 * @param p_eei_attribute16 Descriptive flexfield segment.
227 * @param p_eei_attribute17 Descriptive flexfield segment.
228 * @param p_eei_attribute18 Descriptive flexfield segment.
229 * @param p_eei_attribute19 Descriptive flexfield segment.
230 * @param p_eei_attribute20 Descriptive flexfield segment.
231 * @param p_eei_information_category This context value determines which
232 * Flexfield Structure to use with the Developer Descriptive flexfield
233 * segments.
234 * @param p_eei_information1 Developer Descriptive flexfield segment.
235 * @param p_eei_information2 Developer Descriptive flexfield segment.
236 * @param p_eei_information3 Developer Descriptive flexfield segment.
237 * @param p_eei_information4 Developer Descriptive flexfield segment.
238 * @param p_eei_information5 Developer Descriptive flexfield segment.
239 * @param p_eei_information6 Developer Descriptive flexfield segment.
240 * @param p_eei_information7 Developer Descriptive flexfield segment.
241 * @param p_eei_information8 Developer Descriptive flexfield segment.
242 * @param p_eei_information9 Developer Descriptive flexfield segment.
243 * @param p_eei_information10 Developer Descriptive flexfield segment.
244 * @param p_eei_information11 Developer Descriptive flexfield segment.
245 * @param p_eei_information12 Developer Descriptive flexfield segment.
246 * @param p_eei_information13 Developer Descriptive flexfield segment.
247 * @param p_eei_information14 Developer Descriptive flexfield segment.
248 * @param p_eei_information15 Developer Descriptive flexfield segment.
249 * @param p_eei_information16 Developer Descriptive flexfield segment.
250 * @param p_eei_information17 Developer Descriptive flexfield segment.
251 * @param p_eei_information18 Developer Descriptive flexfield segment.
252 * @param p_eei_information19 Developer Descriptive flexfield segment.
253 * @param p_eei_information20 Developer Descriptive flexfield segment.
254 * @param p_eei_information21 Developer Descriptive flexfield segment.
255 * @param p_eei_information22 Developer Descriptive flexfield segment.
256 * @param p_eei_information23 Developer Descriptive flexfield segment.
257 * @param p_eei_information24 Developer Descriptive flexfield segment.
258 * @param p_eei_information25 Developer Descriptive flexfield segment.
259 * @param p_eei_information26 Developer Descriptive flexfield segment.
260 * @param p_eei_information27 Developer Descriptive flexfield segment.
261 * @param p_eei_information28 Developer Descriptive flexfield segment.
262 * @param p_eei_information29 Developer Descriptive flexfield segment.
263 * @param p_eei_information30 Developer Descriptive flexfield segment.
264 * @rep:displayname Update Extra Information for an Element
265 * @rep:category BUSINESS_ENTITY PAY_ELEMENT
266 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
267 * @rep:scope public
268 * @rep:lifecycle active
269 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
270 */
271 --
272 -- {End Of Comments}
273 --
274 procedure update_element_extra_info
275 (p_validate in boolean default false
276 ,p_element_type_extra_info_id in number
277 ,p_object_version_number in out nocopy number
278 ,p_eei_attribute_category in varchar2 default hr_api.g_varchar2
279 ,p_eei_attribute1 in varchar2 default hr_api.g_varchar2
280 ,p_eei_attribute2 in varchar2 default hr_api.g_varchar2
281 ,p_eei_attribute3 in varchar2 default hr_api.g_varchar2
282 ,p_eei_attribute4 in varchar2 default hr_api.g_varchar2
283 ,p_eei_attribute5 in varchar2 default hr_api.g_varchar2
287 ,p_eei_attribute9 in varchar2 default hr_api.g_varchar2
284 ,p_eei_attribute6 in varchar2 default hr_api.g_varchar2
285 ,p_eei_attribute7 in varchar2 default hr_api.g_varchar2
286 ,p_eei_attribute8 in varchar2 default hr_api.g_varchar2
288 ,p_eei_attribute10 in varchar2 default hr_api.g_varchar2
289 ,p_eei_attribute11 in varchar2 default hr_api.g_varchar2
290 ,p_eei_attribute12 in varchar2 default hr_api.g_varchar2
291 ,p_eei_attribute13 in varchar2 default hr_api.g_varchar2
292 ,p_eei_attribute14 in varchar2 default hr_api.g_varchar2
293 ,p_eei_attribute15 in varchar2 default hr_api.g_varchar2
294 ,p_eei_attribute16 in varchar2 default hr_api.g_varchar2
295 ,p_eei_attribute17 in varchar2 default hr_api.g_varchar2
296 ,p_eei_attribute18 in varchar2 default hr_api.g_varchar2
297 ,p_eei_attribute19 in varchar2 default hr_api.g_varchar2
298 ,p_eei_attribute20 in varchar2 default hr_api.g_varchar2
299 ,p_eei_information_category in varchar2 default hr_api.g_varchar2
300 ,p_eei_information1 in varchar2 default hr_api.g_varchar2
301 ,p_eei_information2 in varchar2 default hr_api.g_varchar2
302 ,p_eei_information3 in varchar2 default hr_api.g_varchar2
303 ,p_eei_information4 in varchar2 default hr_api.g_varchar2
304 ,p_eei_information5 in varchar2 default hr_api.g_varchar2
305 ,p_eei_information6 in varchar2 default hr_api.g_varchar2
306 ,p_eei_information7 in varchar2 default hr_api.g_varchar2
307 ,p_eei_information8 in varchar2 default hr_api.g_varchar2
308 ,p_eei_information9 in varchar2 default hr_api.g_varchar2
309 ,p_eei_information10 in varchar2 default hr_api.g_varchar2
310 ,p_eei_information11 in varchar2 default hr_api.g_varchar2
311 ,p_eei_information12 in varchar2 default hr_api.g_varchar2
312 ,p_eei_information13 in varchar2 default hr_api.g_varchar2
313 ,p_eei_information14 in varchar2 default hr_api.g_varchar2
314 ,p_eei_information15 in varchar2 default hr_api.g_varchar2
315 ,p_eei_information16 in varchar2 default hr_api.g_varchar2
316 ,p_eei_information17 in varchar2 default hr_api.g_varchar2
317 ,p_eei_information18 in varchar2 default hr_api.g_varchar2
318 ,p_eei_information19 in varchar2 default hr_api.g_varchar2
319 ,p_eei_information20 in varchar2 default hr_api.g_varchar2
320 ,p_eei_information21 in varchar2 default hr_api.g_varchar2
321 ,p_eei_information22 in varchar2 default hr_api.g_varchar2
322 ,p_eei_information23 in varchar2 default hr_api.g_varchar2
323 ,p_eei_information24 in varchar2 default hr_api.g_varchar2
324 ,p_eei_information25 in varchar2 default hr_api.g_varchar2
325 ,p_eei_information26 in varchar2 default hr_api.g_varchar2
326 ,p_eei_information27 in varchar2 default hr_api.g_varchar2
327 ,p_eei_information28 in varchar2 default hr_api.g_varchar2
328 ,p_eei_information29 in varchar2 default hr_api.g_varchar2
329 ,p_eei_information30 in varchar2 default hr_api.g_varchar2
330 );
331 --
332 -- ----------------------------------------------------------------------------
333 -- |------------------------< delete_element_extra_info >---------------------|
334 -- ----------------------------------------------------------------------------
335 --
336 -- {Start Of Comments}
337 /*#
338 * This API deletes extra information for a given element.
339 *
340 * The role of this process is to perform a validated delete of an existing row
341 * in the pay_element_type_extra_info table of the HR schema.
342 *
343 * <p><b>Licensing</b><br>
344 * This API is licensed for use with Human Resources.
345 *
346 * <p><b>Prerequisites</b><br>
347 * The element extra info as identified by the in parameter
348 * p_element_type_extra_info_id and the in out parameter
349 * p_object_version_number must already exist.
350 *
351 * <p><b>Post Success</b><br>
352 * The element extra information will have been successfully removed from the
353 * database.
354 *
355 * <p><b>Post Failure</b><br>
356 * The element extra information will not be deleted and an error will be
357 * raised.
358 * @param p_validate If true, then validation alone will be performed and the
359 * database will remain unchanged. If false and all validation checks pass,
360 * then the database will be modified.
361 * @param p_element_type_extra_info_id {@rep:casecolumn
362 * PAY_ELEMENT_TYPE_EXTRA_INFO.ELEMENT_TYPE_EXTRA_INFO_ID}
363 * @param p_object_version_number Pass in the current version number of the
364 * element type extra information to be deleted. When the API completes if
365 * p_validate is false, will be set to the new version number of the deleted
366 * element type extra information. If p_validate is true will be set to the
367 * same value which was passed in.
368 * @rep:displayname Delete Extra Information for an Element
369 * @rep:category BUSINESS_ENTITY PAY_ELEMENT
370 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
371 * @rep:scope public
372 * @rep:lifecycle active
373 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
374 */
375 --
376 -- {End Of Comments}
377 --
378 procedure delete_element_extra_info
382 );
379 (p_validate in boolean default false
380 ,p_element_type_extra_info_id in number
381 ,p_object_version_number in number
383 --
384 end pay_element_extra_info_api;
[Home] [Help]