1 Package hr_absence_type_api as
2 /* $Header: peabbapi.pkh 120.4.12010000.1 2008/07/28 03:59:56 appldev ship $ */
3 /*#
4 * This package contains Absence Attendance Type APIs.
5 * @rep:scope public
6 * @rep:product PER
7 * @rep:displayname Absence Attendance Type
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |---------------------------< create_absence_type >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates an Absence Attendance Type record.
17 *
18 *
19 * <p><b>Licensing</b><br>
20 * This API is licensed for use with Human Resources.
21 *
22 * <p><b>Prerequisites</b><br>
23 * A business group must exist within which to create the absence type.
24 *
25 * <p><b>Post Success</b><br>
26 * The API creates an absence attendance type in the database.
27 *
28 * <p><b>Post Failure</b><br>
29 * The API does not create an absence attendance type and raises an error.
30 *
31 * @param p_validate If true, then validation alone will be performed and the
32 * database will remain unchanged. If false and all validation checks pass,
33 * then the database will be modified.
34 * @param p_language_code Specifies to which language the translation values
35 * apply. You can set to the base or any installed language. The default value
36 * of hr_api.userenv_lang is equivalent to the RDBMS userenv('LANG') function
37 * value.
38 * @param p_business_group_id Identifies the business group in which the
39 * absence attendance type is to be created.
40 * @param p_input_value_id Identifies the input value of an element entry to
41 * associate with the absence attendance type.
42 * @param p_date_effective The start date for this absence attendance type.
43 * @param p_date_end If p_validate is false, and a value not passed, will be
44 * set to end date of input value if less than end of time. If p_validate is
45 * true, set to the value passed in.
46 * @param p_name The unique name for the absence attendance type.
47 * @param p_absence_category The category for the absence attendance type.
48 * Valid values are defined by the 'ABSENCE_CATEGORY' lookup type.
49 * @param p_comments Absence Attendance Type comment text.
50 * @param p_hours_or_days Specifies the unit of measure associated with this
51 * absence attendance type, valid values are 'H' for hours and 'D' for days.
52 * The value must correspond with the unit of measure of the input value if
53 * set. If p_input_value_id is not set, p_hours_or_days must be null.
54 * @param p_inc_or_dec_flag Specifies whether this absence attendance type
55 * should have an increasing or decreasing total. Valid values are 'I' for
56 * increasing, and 'D' for decreasing. Must be null if p_input_value is not
57 * set.
58 * @param p_attribute_category This context value determines which flexfield
59 * structure to use with the descriptive flexfield segments.
60 * @param p_attribute1 Descriptive flexfield segment.
61 * @param p_attribute2 Descriptive flexfield segment.
62 * @param p_attribute3 Descriptive flexfield segment.
63 * @param p_attribute4 Descriptive flexfield segment.
64 * @param p_attribute5 Descriptive flexfield segment.
65 * @param p_attribute6 Descriptive flexfield segment.
66 * @param p_attribute7 Descriptive flexfield segment.
67 * @param p_attribute8 Descriptive flexfield segment.
68 * @param p_attribute9 Descriptive flexfield segment.
69 * @param p_attribute10 Descriptive flexfield segment.
70 * @param p_attribute11 Descriptive flexfield segment.
71 * @param p_attribute12 Descriptive flexfield segment.
72 * @param p_attribute13 Descriptive flexfield segment.
73 * @param p_attribute14 Descriptive flexfield segment.
74 * @param p_attribute15 Descriptive flexfield segment.
75 * @param p_attribute16 Descriptive flexfield segment.
76 * @param p_attribute17 Descriptive flexfield segment.
77 * @param p_attribute18 Descriptive flexfield segment.
78 * @param p_attribute19 Descriptive flexfield segment.
79 * @param p_attribute20 Descriptive flexfield segment.
80 * @param p_information_category This context value determines which flexfield
81 * structure to use with the developer descriptive flexfield segments.
82 * @param p_information1 Developer descriptive flexfield segment.
83 * @param p_information2 Developer descriptive flexfield segment.
84 * @param p_information3 Developer descriptive flexfield segment.
85 * @param p_information4 Developer descriptive flexfield segment.
86 * @param p_information5 Developer descriptive flexfield segment.
87 * @param p_information6 Developer descriptive flexfield segment.
88 * @param p_information7 Developer descriptive flexfield segment.
89 * @param p_information8 Developer descriptive flexfield segment.
90 * @param p_information9 Developer descriptive flexfield segment.
91 * @param p_information10 Developer descriptive flexfield segment.
92 * @param p_information11 Developer descriptive flexfield segment.
93 * @param p_information12 Developer descriptive flexfield segment.
94 * @param p_information13 Developer descriptive flexfield segment.
95 * @param p_information14 Developer descriptive flexfield segment.
96 * @param p_information15 Developer descriptive flexfield segment.
97 * @param p_information16 Developer descriptive flexfield segment.
98 * @param p_information17 Developer descriptive flexfield segment.
99 * @param p_information18 Developer descriptive flexfield segment.
100 * @param p_information19 Developer descriptive flexfield segment.
101 * @param p_information20 Developer descriptive flexfield segment.
102 * @param p_user_role Identifes the User Role of the Absence Type.
103 * @param p_assignment_status_type_id Identifies the Assignment Status
104 * related to the Absence Type.
105 * @param p_advance_pay Identifies whether Advance Pay is associated
106 * to the Absence Type or not.
107 * @param p_absence_overlap_flag Identifies whether overlap of absence
108 * is permitted to the Absence Type or not.
109 * @param p_absence_attendance_type_id If p_validate is false, uniquely
110 * identifies the absence attendance type created. If p_validate is true, set
111 * to null.
112 * @param p_object_version_number If p_validate is false, then set to the
113 * version number of the created absence attendance type. If p_validate is
114 * true, then the value will be null.
115 * @rep:displayname Create Absence Attendance Type
116 * @rep:category BUSINESS_ENTITY PER_EMPLOYEE_ABSENCE
117 * @rep:lifecycle active
118 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
119 * @rep:scope public
120 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
121 */
122 --
123 -- {End Of Comments}
124 --
125 procedure create_absence_type
126 (p_validate in boolean default false
127 ,p_language_code in varchar2 default hr_api.userenv_lang
128 ,p_business_group_id in number default null
129 ,p_input_value_id in number default null
130 ,p_date_effective in date
131 ,p_date_end in out nocopy date
132 ,p_name in varchar2
133 ,p_absence_category in varchar2 default null
134 ,p_comments in varchar2 default null
135 ,p_hours_or_days in varchar2 default null
136 ,p_inc_or_dec_flag in varchar2 default null
137 ,p_attribute_category in varchar2 default null
138 ,p_attribute1 in varchar2 default null
139 ,p_attribute2 in varchar2 default null
140 ,p_attribute3 in varchar2 default null
141 ,p_attribute4 in varchar2 default null
142 ,p_attribute5 in varchar2 default null
143 ,p_attribute6 in varchar2 default null
144 ,p_attribute7 in varchar2 default null
145 ,p_attribute8 in varchar2 default null
146 ,p_attribute9 in varchar2 default null
147 ,p_attribute10 in varchar2 default null
148 ,p_attribute11 in varchar2 default null
149 ,p_attribute12 in varchar2 default null
150 ,p_attribute13 in varchar2 default null
151 ,p_attribute14 in varchar2 default null
152 ,p_attribute15 in varchar2 default null
153 ,p_attribute16 in varchar2 default null
154 ,p_attribute17 in varchar2 default null
155 ,p_attribute18 in varchar2 default null
156 ,p_attribute19 in varchar2 default null
157 ,p_attribute20 in varchar2 default null
158 ,p_information_category in varchar2 default null
159 ,p_information1 in varchar2 default null
160 ,p_information2 in varchar2 default null
161 ,p_information3 in varchar2 default null
162 ,p_information4 in varchar2 default null
163 ,p_information5 in varchar2 default null
164 ,p_information6 in varchar2 default null
165 ,p_information7 in varchar2 default null
166 ,p_information8 in varchar2 default null
167 ,p_information9 in varchar2 default null
168 ,p_information10 in varchar2 default null
169 ,p_information11 in varchar2 default null
170 ,p_information12 in varchar2 default null
171 ,p_information13 in varchar2 default null
172 ,p_information14 in varchar2 default null
173 ,p_information15 in varchar2 default null
174 ,p_information16 in varchar2 default null
175 ,p_information17 in varchar2 default null
176 ,p_information18 in varchar2 default null
177 ,p_information19 in varchar2 default null
178 ,p_information20 in varchar2 default null
179 ,p_user_role in varchar2 default null
180 ,p_assignment_status_type_id in number default null
181 ,p_advance_pay in varchar2 default null
182 ,p_absence_overlap_flag in varchar2 default null
183 ,p_absence_attendance_type_id out nocopy number
184 ,p_object_version_number out nocopy number
185 );
186 --
187 -- ----------------------------------------------------------------------------
188 -- |---------------------------< update_absence_type >------------------------|
189 -- ----------------------------------------------------------------------------
190 --
191 -- {Start Of Comments}
192 /*#
193 * This API updates an existing Absence Attendance Type record.
194 *
195 *
196 * <p><b>Licensing</b><br>
197 * This API is licensed for use with Human Resources.
198 *
199 * <p><b>Prerequisites</b><br>
200 * The absence type must already exist.
201 *
202 * <p><b>Post Success</b><br>
203 * The API updates an absence attendance type.
204 *
205 * <p><b>Post Failure</b><br>
206 * The API does not update the absence attendance type and raises an error.
207 *
208 * @param p_validate If true, then validation alone will be performed and the
209 * database will remain unchanged. If false and all validation checks pass,
210 * then the database will be modified.
211 * @param p_absence_attendance_type_id Unique identifier of the absence
212 * attendance type to update.
213 * @param p_language_code Specifies to which language the translation values
214 * apply. You can set to the base or any installed language. The default value
218 * associate with the absence attendance type. If a value has already been set
215 * of hr_api.userenv_lang is equivalent to the RDBMS userenv('LANG') function
216 * value.
217 * @param p_input_value_id Identifies the input value of an element entry to
219 * in the database, then it cannot be changed.
220 * @param p_date_effective The start date for this absence attendance type.
221 * @param p_date_end If p_validate is false, and a value not passed, will be
222 * set to end date of input value if less than end of time. If p_validate is
223 * true, set to the value passed in automatically if input_value has end date
224 * @param p_name The unique name for the absence attendance type.
225 * @param p_absence_category The category for the absence attendance type.
226 * Valid values are defined by the 'ABSENCE_CATEGORY' lookup type.
227 * @param p_comments Absence Attendance type comment text.
228 * @param p_hours_or_days Specifies the unit of measure associated with this
229 * absence attendance type, valid values are 'H' for hours and 'D' for days.
230 * The value must correspond with the unit of measure of the input value if
231 * set. If p_input_value_id is not set, p_hours_or_days must be null. If a
232 * value has already been set on the database record, then it cannot be
233 * changed.
234 * @param p_inc_or_dec_flag Specifies whether this absence attendance type
235 * should have an increasing or decreasing total. Valid values are 'I' for
236 * increasing, and 'D' for decreasing. Must be null if p_input_value is not
237 * set. If a value has already been set on the database record, then it cannot
238 * be changed
239 * @param p_attribute_category This context value determines which flexfield
240 * structure to use with the descriptive flexfield segments.
241 * @param p_attribute1 Descriptive flexfield segment.
242 * @param p_attribute2 Descriptive flexfield segment.
243 * @param p_attribute3 Descriptive flexfield segment.
244 * @param p_attribute4 Descriptive flexfield segment.
245 * @param p_attribute5 Descriptive flexfield segment.
246 * @param p_attribute6 Descriptive flexfield segment.
247 * @param p_attribute7 Descriptive flexfield segment.
248 * @param p_attribute8 Descriptive flexfield segment.
249 * @param p_attribute9 Descriptive flexfield segment.
250 * @param p_attribute10 Descriptive flexfield segment.
251 * @param p_attribute11 Descriptive flexfield segment.
252 * @param p_attribute12 Descriptive flexfield segment.
253 * @param p_attribute13 Descriptive flexfield segment.
254 * @param p_attribute14 Descriptive flexfield segment.
255 * @param p_attribute15 Descriptive flexfield segment.
256 * @param p_attribute16 Descriptive flexfield segment.
257 * @param p_attribute17 Descriptive flexfield segment.
258 * @param p_attribute18 Descriptive flexfield segment.
259 * @param p_attribute19 Descriptive flexfield segment.
260 * @param p_attribute20 Descriptive flexfield segment.
261 * @param p_information_category This context value determines which flexfield
262 * structure to use with the developer descriptive flexfield segments.
263 * @param p_information1 Developer descriptive flexfield segment.
264 * @param p_information2 Developer descriptive flexfield segment.
265 * @param p_information3 Developer descriptive flexfield segment.
266 * @param p_information4 Developer descriptive flexfield segment.
267 * @param p_information5 Developer descriptive flexfield segment.
268 * @param p_information6 Developer descriptive flexfield segment.
269 * @param p_information7 Developer descriptive flexfield segment.
270 * @param p_information8 Developer descriptive flexfield segment.
271 * @param p_information9 Developer descriptive flexfield segment.
272 * @param p_information10 Developer descriptive flexfield segment.
273 * @param p_information11 Developer descriptive flexfield segment.
274 * @param p_information12 Developer descriptive flexfield segment.
275 * @param p_information13 Developer descriptive flexfield segment.
276 * @param p_information14 Developer descriptive flexfield segment.
277 * @param p_information15 Developer descriptive flexfield segment.
278 * @param p_information16 Developer descriptive flexfield segment.
279 * @param p_information17 Developer descriptive flexfield segment.
280 * @param p_information18 Developer descriptive flexfield segment.
281 * @param p_information19 Developer descriptive flexfield segment.
282 * @param p_information20 Developer descriptive flexfield segment.
283 * @param p_user_role Identifes the User Role of the Absence Type.
284 * @param p_assignment_status_type_id Identifies the Assignment Status
285 * related to the Absence Type.
286 * @param p_advance_pay Identifies whether Advance Pay is associated
287 * to the Absence Type or not.
288 * @param p_absence_overlap_flag Identifies whether overlap of absence
289 * is permitted to the Absence Type or not.
290 * @param p_object_version_number Pass in the current version number of the
291 * Absence Attendance Type to be updated. When the API completes if p_validate
292 * is false, will be set to the new version number of the updated Absence
293 * Attendance Type. If p_validate is true will be set to the same value which
294 * was passed in.
295 * @rep:displayname Update Absence Attendance Type
296 * @rep:category BUSINESS_ENTITY PER_EMPLOYEE_ABSENCE
297 * @rep:lifecycle active
298 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
299 * @rep:scope public
300 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
301 */
302 --
303 -- {End Of Comments}
304 --
305 procedure update_absence_type
306 (p_validate in boolean default false
307 ,p_absence_attendance_type_id in number
311 ,p_date_end in out nocopy date
308 ,p_language_code in varchar2 default hr_api.userenv_lang
309 ,p_input_value_id in number default hr_api.g_number
310 ,p_date_effective in date default hr_api.g_date
312 ,p_name in varchar2 default hr_api.g_varchar2
313 ,p_absence_category in varchar2 default hr_api.g_varchar2
314 ,p_comments in varchar2 default hr_api.g_varchar2
315 ,p_hours_or_days in varchar2 default hr_api.g_varchar2
316 ,p_inc_or_dec_flag in varchar2 default hr_api.g_varchar2
317 ,p_attribute_category in varchar2 default hr_api.g_varchar2
318 ,p_attribute1 in varchar2 default hr_api.g_varchar2
319 ,p_attribute2 in varchar2 default hr_api.g_varchar2
320 ,p_attribute3 in varchar2 default hr_api.g_varchar2
321 ,p_attribute4 in varchar2 default hr_api.g_varchar2
322 ,p_attribute5 in varchar2 default hr_api.g_varchar2
323 ,p_attribute6 in varchar2 default hr_api.g_varchar2
324 ,p_attribute7 in varchar2 default hr_api.g_varchar2
325 ,p_attribute8 in varchar2 default hr_api.g_varchar2
326 ,p_attribute9 in varchar2 default hr_api.g_varchar2
327 ,p_attribute10 in varchar2 default hr_api.g_varchar2
328 ,p_attribute11 in varchar2 default hr_api.g_varchar2
329 ,p_attribute12 in varchar2 default hr_api.g_varchar2
330 ,p_attribute13 in varchar2 default hr_api.g_varchar2
331 ,p_attribute14 in varchar2 default hr_api.g_varchar2
332 ,p_attribute15 in varchar2 default hr_api.g_varchar2
333 ,p_attribute16 in varchar2 default hr_api.g_varchar2
334 ,p_attribute17 in varchar2 default hr_api.g_varchar2
335 ,p_attribute18 in varchar2 default hr_api.g_varchar2
336 ,p_attribute19 in varchar2 default hr_api.g_varchar2
337 ,p_attribute20 in varchar2 default hr_api.g_varchar2
338 ,p_information_category in varchar2 default hr_api.g_varchar2
339 ,p_information1 in varchar2 default hr_api.g_varchar2
340 ,p_information2 in varchar2 default hr_api.g_varchar2
341 ,p_information3 in varchar2 default hr_api.g_varchar2
342 ,p_information4 in varchar2 default hr_api.g_varchar2
343 ,p_information5 in varchar2 default hr_api.g_varchar2
344 ,p_information6 in varchar2 default hr_api.g_varchar2
345 ,p_information7 in varchar2 default hr_api.g_varchar2
346 ,p_information8 in varchar2 default hr_api.g_varchar2
347 ,p_information9 in varchar2 default hr_api.g_varchar2
348 ,p_information10 in varchar2 default hr_api.g_varchar2
349 ,p_information11 in varchar2 default hr_api.g_varchar2
350 ,p_information12 in varchar2 default hr_api.g_varchar2
351 ,p_information13 in varchar2 default hr_api.g_varchar2
352 ,p_information14 in varchar2 default hr_api.g_varchar2
353 ,p_information15 in varchar2 default hr_api.g_varchar2
354 ,p_information16 in varchar2 default hr_api.g_varchar2
355 ,p_information17 in varchar2 default hr_api.g_varchar2
356 ,p_information18 in varchar2 default hr_api.g_varchar2
357 ,p_information19 in varchar2 default hr_api.g_varchar2
358 ,p_information20 in varchar2 default hr_api.g_varchar2
359 ,p_user_role in varchar2 default hr_api.g_varchar2
360 ,p_assignment_status_type_id in number default hr_api.g_number
361 ,p_advance_pay in varchar2 default hr_api.g_varchar2
362 ,p_absence_overlap_flag in varchar2 default hr_api.g_varchar2
363 ,p_object_version_number in out nocopy number
364 );
365 --
366 -- ----------------------------------------------------------------------------
367 -- |---------------------------< delete_absence_type >------------------------|
368 -- ----------------------------------------------------------------------------
369 --
370 -- {Start Of Comments}
371 /*#
372 * This API deletes an Absence Attendance Type record.
373 *
374 *
375 * <p><b>Licensing</b><br>
376 * This API is licensed for use with Human Resources.
377 *
378 * <p><b>Prerequisites</b><br>
379 * The absence type must already exist.
380 *
381 * <p><b>Post Success</b><br>
382 * The API deletes an absence attendance type.
383 *
384 * <p><b>Post Failure</b><br>
385 * The API does not delete the absence attendance type and raises an error.
386 *
387 * @param p_validate If true, then validation alone will be performed and the
388 * database will remain unchanged. If false and all validation checks pass,
389 * then the database will be modified.
390 * @param p_absence_attendance_type_id Unique identifier of the absence
391 * attendance type to delete.
392 * @param p_object_version_number Current version number of the Absence
393 * Attendance Type to be deleted.
394 * @rep:displayname Delete Absence Attendance Type
395 * @rep:category BUSINESS_ENTITY PER_EMPLOYEE_ABSENCE
396 * @rep:lifecycle active
400 */
397 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
398 * @rep:scope public
399 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
401 --
402 -- {End Of Comments}
403 --
404 procedure delete_absence_type
405 (p_validate in boolean default false
406 ,p_absence_attendance_type_id in number
407 ,p_object_version_number in number
408 );
409 --
410 end hr_absence_type_api;
[Home] [Help]