DBA Data[Home] [Help]

PACKAGE: APPS.HR_PERSON_ABSENCE_CASE_API

Source


1 Package hr_person_absence_case_api AUTHID CURRENT_USER as
2 /* $Header: peabcapi.pkh 120.4 2008/03/31 04:36:53 ubhat noship $ */
3 /*#
4  * This package contains API procedures to maintain Employee Absence Cases.
5  * @rep:scope public
6  * @rep:product per
7  * @rep:displayname Absence Cases
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |------------------------< create_person_absence_case >--------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16  * This API creates a new Absence Case for an Employee.
17  *
18  * <p><b>Licensing</b><br>
19  * This API is licensed for use with Human Resources.
20  *
21  * <p><b>Prerequisites</b><br>
22  * The person selected must be an Employee in the system.
23  *
24  * <p><b>Post Success</b><br>
25  * An Absence Case is created for the selected Employee.
26  *
27  * <p><b>Post Failure</b><br>
28  * An error is raised.
29  *
30  * @param p_validate If true, then validation alone will be performed and the
31  * database will remain unchanged. If false and all validation checks pass,
32  * then the database will be modified.
33  * @param p_person_id Identifies the person record to which Absence Case is
34  * created.
35  * @param p_name Absence Case Name.
36  * @param p_business_group_id The business group associated with this person.
37  * @param p_incident_id Identifies the Work incident that is attached to the Absence Case.
38  * @param p_absence_category Identifies the Absence Category.
39  * @param p_ac_attribute_category This context value determines which
40  * flexfield structure to use with the descriptive flexfield segments.
41  * @param p_attribute1 Descriptive flexfield segment.
42  * @param p_attribute2 Descriptive flexfield segment.
43  * @param p_attribute3 Descriptive flexfield segment.
44  * @param p_attribute4 Descriptive flexfield segment.
45  * @param p_attribute5 Descriptive flexfield segment.
46  * @param p_attribute6 Descriptive flexfield segment.
47  * @param p_attribute7 Descriptive flexfield segment.
48  * @param p_attribute8 Descriptive flexfield segment.
49  * @param p_attribute9 Descriptive flexfield segment.
50  * @param p_attribute10 Descriptive flexfield segment.
51  * @param p_attribute11 Descriptive flexfield segment.
52  * @param p_attribute12 Descriptive flexfield segment.
53  * @param p_attribute13 Descriptive flexfield segment.
54  * @param p_attribute14 Descriptive flexfield segment.
55  * @param p_attribute15 Descriptive flexfield segment.
56  * @param p_attribute16 Descriptive flexfield segment.
57  * @param p_attribute17 Descriptive flexfield segment.
58  * @param p_attribute18 Descriptive flexfield segment.
59  * @param p_attribute19 Descriptive flexfield segment.
60  * @param p_attribute20 Descriptive flexfield segment.
61  * @param p_attribute21 Descriptive flexfield segment.
62  * @param p_attribute22 Descriptive flexfield segment.
63  * @param p_attribute23 Descriptive flexfield segment.
64  * @param p_attribute24 Descriptive flexfield segment.
65  * @param p_attribute25 Descriptive flexfield segment.
66  * @param p_attribute26 Descriptive flexfield segment.
67  * @param p_attribute27 Descriptive flexfield segment.
68  * @param p_attribute28 Descriptive flexfield segment.
69  * @param p_attribute29 Descriptive flexfield segment.
70  * @param p_attribute30 Descriptive flexfield segment.
71  * @param p_ac_information_category This context value determines which
72  * Flexfield Structure to use with the Developer Descriptive flexfield
73  * segments.
74  * @param p_ac_information1 Developer Descriptive flexfield segment.
75  * @param p_ac_information2 Developer Descriptive flexfield segment.
76  * @param p_ac_information3 Developer Descriptive flexfield segment.
77  * @param p_ac_information4 Developer Descriptive flexfield segment.
78  * @param p_ac_information5 Developer Descriptive flexfield segment.
79  * @param p_ac_information6 Developer Descriptive flexfield segment.
80  * @param p_ac_information7 Developer Descriptive flexfield segment.
81  * @param p_ac_information8 Developer Descriptive flexfield segment.
82  * @param p_ac_information9 Developer Descriptive flexfield segment.
83  * @param p_ac_information10 Developer Descriptive flexfield segment.
84  * @param p_ac_information11 Developer Descriptive flexfield segment.
85  * @param p_ac_information12 Developer Descriptive flexfield segment.
86  * @param p_ac_information13 Developer Descriptive flexfield segment.
87  * @param p_ac_information14 Developer Descriptive flexfield segment.
88  * @param p_ac_information15 Developer Descriptive flexfield segment.
89  * @param p_ac_information16 Developer Descriptive flexfield segment.
90  * @param p_ac_information17 Developer Descriptive flexfield segment.
91  * @param p_ac_information18 Developer Descriptive flexfield segment.
92  * @param p_ac_information19 Developer Descriptive flexfield segment.
93  * @param p_ac_information20 Developer Descriptive flexfield segment.
94  * @param p_ac_information21 Developer Descriptive flexfield segment.
95  * @param p_ac_information22 Developer Descriptive flexfield segment.
96  * @param p_ac_information23 Developer Descriptive flexfield segment.
97  * @param p_ac_information24 Developer Descriptive flexfield segment.
98  * @param p_ac_information25 Developer Descriptive flexfield segment.
99  * @param p_ac_information26 Developer Descriptive flexfield segment.
100  * @param p_ac_information27 Developer Descriptive flexfield segment.
101  * @param p_ac_information28 Developer Descriptive flexfield segment.
102  * @param p_ac_information29 Developer Descriptive flexfield segment.
103  * @param p_ac_information30 Developer Descriptive flexfield segment.
104  * @param p_comments Comment Text.
105  * @param p_absence_case_id If p_validate is false, then this uniquely
106  * identifies the absence case record created. If p_validate is true, then
107  * this is set to null.
108  * @param p_object_version_number If p_validate is false, then set to the
109  * version number of the created absence record. If p_validate is true, then
110  * the value will be null.
111  * @rep:displayname Create Person Absence Case
112  * @rep:category BUSINESS_ENTITY PER_EMPLOYEE_ABSENCE
113  * @rep:lifecycle active
114  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
115  * @rep:scope public
116  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
117 */
118 --
119 -- {End Of Comments}
120 --
121 procedure create_person_absence_case
122   (p_validate                      in     boolean  default false
123   ,p_person_id                     in     number
124   ,p_name                          in     varchar2
125   ,p_business_group_id             in     number
126   ,p_incident_id                   in     number   default null
127   ,p_absence_category              in     varchar2 default null
128   ,p_ac_attribute_category         in     varchar2 default null
129   ,p_attribute1                    in     varchar2 default null
130   ,p_attribute2                    in     varchar2 default null
131   ,p_attribute3                    in     varchar2 default null
132   ,p_attribute4                    in     varchar2 default null
133   ,p_attribute5                    in     varchar2 default null
134   ,p_attribute6                    in     varchar2 default null
135   ,p_attribute7                    in     varchar2 default null
136   ,p_attribute8                    in     varchar2 default null
137   ,p_attribute9                    in     varchar2 default null
138   ,p_attribute10                   in     varchar2 default null
139   ,p_attribute11                   in     varchar2 default null
140   ,p_attribute12                   in     varchar2 default null
141   ,p_attribute13                   in     varchar2 default null
142   ,p_attribute14                   in     varchar2 default null
143   ,p_attribute15                   in     varchar2 default null
144   ,p_attribute16                   in     varchar2 default null
145   ,p_attribute17                   in     varchar2 default null
146   ,p_attribute18                   in     varchar2 default null
147   ,p_attribute19                   in     varchar2 default null
148   ,p_attribute20                   in     varchar2 default null
149   ,p_attribute21                   in     varchar2 default null
150   ,p_attribute22                   in     varchar2 default null
151   ,p_attribute23                   in     varchar2 default null
152   ,p_attribute24                   in     varchar2 default null
153   ,p_attribute25                   in     varchar2 default null
154   ,p_attribute26                   in     varchar2 default null
155   ,p_attribute27                   in     varchar2 default null
156   ,p_attribute28                   in     varchar2 default null
157   ,p_attribute29                   in     varchar2 default null
158   ,p_attribute30                   in     varchar2 default null
159   ,p_ac_information_category       in     varchar2 default null
160   ,p_ac_information1               in     varchar2 default null
161   ,p_ac_information2               in     varchar2 default null
162   ,p_ac_information3               in     varchar2 default null
163   ,p_ac_information4               in     varchar2 default null
164   ,p_ac_information5               in     varchar2 default null
165   ,p_ac_information6               in     varchar2 default null
166   ,p_ac_information7               in     varchar2 default null
167   ,p_ac_information8               in     varchar2 default null
168   ,p_ac_information9               in     varchar2 default null
169   ,p_ac_information10              in     varchar2 default null
170   ,p_ac_information11              in     varchar2 default null
171   ,p_ac_information12              in     varchar2 default null
172   ,p_ac_information13              in     varchar2 default null
173   ,p_ac_information14              in     varchar2 default null
174   ,p_ac_information15              in     varchar2 default null
175   ,p_ac_information16              in     varchar2 default null
176   ,p_ac_information17              in     varchar2 default null
177   ,p_ac_information18              in     varchar2 default null
178   ,p_ac_information19              in     varchar2 default null
179   ,p_ac_information20              in     varchar2 default null
180   ,p_ac_information21              in     varchar2 default null
181   ,p_ac_information22              in     varchar2 default null
182   ,p_ac_information23              in     varchar2 default null
183   ,p_ac_information24              in     varchar2 default null
184   ,p_ac_information25              in     varchar2 default null
185   ,p_ac_information26              in     varchar2 default null
186   ,p_ac_information27              in     varchar2 default null
187   ,p_ac_information28              in     varchar2 default null
188   ,p_ac_information29              in     varchar2 default null
189   ,p_ac_information30              in     varchar2 default null
190   ,p_comments                      in     varchar2 default null
191   ,p_absence_case_id               out    nocopy    number
192   ,p_object_version_number         out    nocopy    number
193   );
194 --
195 -- ----------------------------------------------------------------------------
196 -- |------------------------< update_person_absence_case >--------------------|
197 -- ----------------------------------------------------------------------------
198 --
199 -- {Start Of Comments}
200 /*#
201  * This API updates the absence case as identified by the in
202  * parameter p_absence_case_id.
203  *
204  * <p><b>Licensing</b><br>
205  * This API is licensed for use with Human Resources.
206  *
207  * <p><b>Prerequisites</b><br>
208  * The absence case as identified by the in parameter p_absence_case_id
209  * and the in out parameter p_object_version_number must already exist.
210  *
211  * <p><b>Post Success</b><br>
212  * Absence Case details are updated.
213  *
214  * <p><b>Post Failure</b><br>
215  * The absence case record will not be updated and an error will be raised.
216  *
217  * @param p_validate If true, then validation alone will be performed and the
218  * database will remain unchanged. If false and all validation checks pass,
219  * then the database will be modified.
220  * @param p_absence_case_id This uniquely identifies the absence case record
221  * being updated.
222  * @param p_name Absence Case Name.
223  * @param p_incident_id Identifies the Work incident that is attached to the
224  * Absence Case.
225  * @param p_absence_category Identifies the Absence Category.
226  * @param p_ac_attribute_category This context value determines which flexfield
227  * structure to use with the descriptive flexfield segments.
228  * @param p_attribute1 Descriptive flexfield segment.
229  * @param p_attribute2 Descriptive flexfield segment.
230  * @param p_attribute3 Descriptive flexfield segment.
231  * @param p_attribute4 Descriptive flexfield segment.
232  * @param p_attribute5 Descriptive flexfield segment.
233  * @param p_attribute6 Descriptive flexfield segment.
234  * @param p_attribute7 Descriptive flexfield segment.
235  * @param p_attribute8 Descriptive flexfield segment.
236  * @param p_attribute9 Descriptive flexfield segment.
237  * @param p_attribute10 Descriptive flexfield segment.
238  * @param p_attribute11 Descriptive flexfield segment.
239  * @param p_attribute12 Descriptive flexfield segment.
240  * @param p_attribute13 Descriptive flexfield segment.
241  * @param p_attribute14 Descriptive flexfield segment.
242  * @param p_attribute15 Descriptive flexfield segment.
243  * @param p_attribute16 Descriptive flexfield segment.
244  * @param p_attribute17 Descriptive flexfield segment.
245  * @param p_attribute18 Descriptive flexfield segment.
246  * @param p_attribute19 Descriptive flexfield segment.
247  * @param p_attribute20 Descriptive flexfield segment.
248  * @param p_attribute21 Descriptive flexfield segment.
249  * @param p_attribute22 Descriptive flexfield segment.
250  * @param p_attribute23 Descriptive flexfield segment.
251  * @param p_attribute24 Descriptive flexfield segment.
252  * @param p_attribute25 Descriptive flexfield segment.
253  * @param p_attribute26 Descriptive flexfield segment.
254  * @param p_attribute27 Descriptive flexfield segment.
255  * @param p_attribute28 Descriptive flexfield segment.
256  * @param p_attribute29 Descriptive flexfield segment.
257  * @param p_attribute30 Descriptive flexfield segment.
258  * @param p_ac_information_category This context value determines which
259  * Flexfield Structure to use with the Developer Descriptive flexfield
260  * segments.
261  * @param p_ac_information1 Developer Descriptive flexfield segment.
262  * @param p_ac_information2 Developer Descriptive flexfield segment.
263  * @param p_ac_information3 Developer Descriptive flexfield segment.
264  * @param p_ac_information4 Developer Descriptive flexfield segment.
265  * @param p_ac_information5 Developer Descriptive flexfield segment.
266  * @param p_ac_information6 Developer Descriptive flexfield segment.
267  * @param p_ac_information7 Developer Descriptive flexfield segment.
268  * @param p_ac_information8 Developer Descriptive flexfield segment.
269  * @param p_ac_information9 Developer Descriptive flexfield segment.
270  * @param p_ac_information10 Developer Descriptive flexfield segment.
271  * @param p_ac_information11 Developer Descriptive flexfield segment.
272  * @param p_ac_information12 Developer Descriptive flexfield segment.
273  * @param p_ac_information13 Developer Descriptive flexfield segment.
274  * @param p_ac_information14 Developer Descriptive flexfield segment.
275  * @param p_ac_information15 Developer Descriptive flexfield segment.
276  * @param p_ac_information16 Developer Descriptive flexfield segment.
277  * @param p_ac_information17 Developer Descriptive flexfield segment.
278  * @param p_ac_information18 Developer Descriptive flexfield segment.
279  * @param p_ac_information19 Developer Descriptive flexfield segment.
280  * @param p_ac_information20 Developer Descriptive flexfield segment.
281  * @param p_ac_information21 Developer Descriptive flexfield segment.
282  * @param p_ac_information22 Developer Descriptive flexfield segment.
283  * @param p_ac_information23 Developer Descriptive flexfield segment.
284  * @param p_ac_information24 Developer Descriptive flexfield segment.
285  * @param p_ac_information25 Developer Descriptive flexfield segment.
286  * @param p_ac_information26 Developer Descriptive flexfield segment.
287  * @param p_ac_information27 Developer Descriptive flexfield segment.
288  * @param p_ac_information28 Developer Descriptive flexfield segment.
289  * @param p_ac_information29 Developer Descriptive flexfield segment.
290  * @param p_ac_information30 Developer Descriptive flexfield segment.
291  * @param p_comments Comment Text.
292  * @param p_object_version_number Pass in the current version number of the
293  * Absence Case to be updated. When the API completes if p_validate is false,
294  * will be set to the new version number of the updated Absence. If p_validate
295  * is true will be set to the same value which was passed in.
296  * @rep:displayname Update Person Absence Case
297  * @rep:category BUSINESS_ENTITY PER_EMPLOYEE_ABSENCE
298  * @rep:lifecycle active
299  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
300  * @rep:scope public
301  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
302 */
303 --
304 -- {End Of Comments}
305 --
306 procedure update_person_absence_case
307   (p_validate                      in     boolean  default false
308   ,p_absence_case_id               in     number
309   ,p_name                          in     varchar2 default hr_api.g_varchar2
310   ,p_incident_id                   in     number   default hr_api.g_number
311   ,p_absence_category              in     varchar2 default null
312   ,p_ac_attribute_category         in     varchar2 default hr_api.g_varchar2
313   ,p_attribute1                    in     varchar2 default hr_api.g_varchar2
314   ,p_attribute2                    in     varchar2 default hr_api.g_varchar2
315   ,p_attribute3                    in     varchar2 default hr_api.g_varchar2
316   ,p_attribute4                    in     varchar2 default hr_api.g_varchar2
317   ,p_attribute5                    in     varchar2 default hr_api.g_varchar2
318   ,p_attribute6                    in     varchar2 default hr_api.g_varchar2
319   ,p_attribute7                    in     varchar2 default hr_api.g_varchar2
320   ,p_attribute8                    in     varchar2 default hr_api.g_varchar2
321   ,p_attribute9                    in     varchar2 default hr_api.g_varchar2
322   ,p_attribute10                   in     varchar2 default hr_api.g_varchar2
323   ,p_attribute11                   in     varchar2 default hr_api.g_varchar2
324   ,p_attribute12                   in     varchar2 default hr_api.g_varchar2
325   ,p_attribute13                   in     varchar2 default hr_api.g_varchar2
326   ,p_attribute14                   in     varchar2 default hr_api.g_varchar2
327   ,p_attribute15                   in     varchar2 default hr_api.g_varchar2
328   ,p_attribute16                   in     varchar2 default hr_api.g_varchar2
329   ,p_attribute17                   in     varchar2 default hr_api.g_varchar2
330   ,p_attribute18                   in     varchar2 default hr_api.g_varchar2
331   ,p_attribute19                   in     varchar2 default hr_api.g_varchar2
332   ,p_attribute20                   in     varchar2 default hr_api.g_varchar2
333   ,p_attribute21                   in     varchar2 default hr_api.g_varchar2
334   ,p_attribute22                   in     varchar2 default hr_api.g_varchar2
335   ,p_attribute23                   in     varchar2 default hr_api.g_varchar2
336   ,p_attribute24                   in     varchar2 default hr_api.g_varchar2
337   ,p_attribute25                   in     varchar2 default hr_api.g_varchar2
338   ,p_attribute26                   in     varchar2 default hr_api.g_varchar2
339   ,p_attribute27                   in     varchar2 default hr_api.g_varchar2
340   ,p_attribute28                   in     varchar2 default hr_api.g_varchar2
341   ,p_attribute29                   in     varchar2 default hr_api.g_varchar2
342   ,p_attribute30                   in     varchar2 default hr_api.g_varchar2
343   ,p_ac_information_category       in     varchar2 default hr_api.g_varchar2
344   ,p_ac_information1               in     varchar2 default hr_api.g_varchar2
345   ,p_ac_information2               in     varchar2 default hr_api.g_varchar2
346   ,p_ac_information3               in     varchar2 default hr_api.g_varchar2
347   ,p_ac_information4               in     varchar2 default hr_api.g_varchar2
348   ,p_ac_information5               in     varchar2 default hr_api.g_varchar2
349   ,p_ac_information6               in     varchar2 default hr_api.g_varchar2
350   ,p_ac_information7               in     varchar2 default hr_api.g_varchar2
351   ,p_ac_information8               in     varchar2 default hr_api.g_varchar2
352   ,p_ac_information9               in     varchar2 default hr_api.g_varchar2
353   ,p_ac_information10              in     varchar2 default hr_api.g_varchar2
354   ,p_ac_information11              in     varchar2 default hr_api.g_varchar2
355   ,p_ac_information12              in     varchar2 default hr_api.g_varchar2
356   ,p_ac_information13              in     varchar2 default hr_api.g_varchar2
357   ,p_ac_information14              in     varchar2 default hr_api.g_varchar2
358   ,p_ac_information15              in     varchar2 default hr_api.g_varchar2
359   ,p_ac_information16              in     varchar2 default hr_api.g_varchar2
360   ,p_ac_information17              in     varchar2 default hr_api.g_varchar2
361   ,p_ac_information18              in     varchar2 default hr_api.g_varchar2
362   ,p_ac_information19              in     varchar2 default hr_api.g_varchar2
363   ,p_ac_information20              in     varchar2 default hr_api.g_varchar2
364   ,p_ac_information21              in     varchar2 default hr_api.g_varchar2
365   ,p_ac_information22              in     varchar2 default hr_api.g_varchar2
366   ,p_ac_information23              in     varchar2 default hr_api.g_varchar2
367   ,p_ac_information24              in     varchar2 default hr_api.g_varchar2
368   ,p_ac_information25              in     varchar2 default hr_api.g_varchar2
369   ,p_ac_information26              in     varchar2 default hr_api.g_varchar2
370   ,p_ac_information27              in     varchar2 default hr_api.g_varchar2
371   ,p_ac_information28              in     varchar2 default hr_api.g_varchar2
372   ,p_ac_information29              in     varchar2 default hr_api.g_varchar2
373   ,p_ac_information30              in     varchar2 default hr_api.g_varchar2
374   ,p_comments                      in     varchar2 default hr_api.g_varchar2
375   ,p_object_version_number         in out nocopy number
376   );
377 --
378 -- ----------------------------------------------------------------------------
379 -- |------------------------< delete_person_absence_case >--------------------|
380 -- ----------------------------------------------------------------------------
381 --
382 -- {Start Of Comments}
383 /*#
384  * This API Deletes an absence case for the specified person, and delinks the
385  * associated Absences from the case if any exists.
386  *
387  * <p><b>Licensing</b><br>
388  * This API is licensed for use with Human Resources.
389  *
390  * <p><b>Prerequisites</b><br>
391  * The absence case being Deleted must already exist.
392  *
393  * <p><b>Post Success</b><br>
394  * The absence case for the person will have been deleted.
395  *
396  * <p><b>Post Failure</b><br>
397  * The absence case will not be deleted and an error will be raised.
398  *
399  * @param p_validate If true, then validation alone will be performed and the
400  * database will remain unchanged. If false and all validation checks pass,
401  * then the database will be modified.
402  * @param p_absence_case_id This uniquely identifies the absence case record
403  * being deleted.
404  * @param p_object_version_number Current version number of the Absence to be
405  * deleted.
406  * @rep:displayname Delete Person Absence Case
407  * @rep:category BUSINESS_ENTITY PER_EMPLOYEE_ABSENCE
408  * @rep:lifecycle active
409  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
410  * @rep:scope public
411  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
412 */
413 --
414 -- {End Of Comments}
415 --
416 procedure delete_person_absence_case
417   (p_validate                      in     boolean  default false
418   ,p_absence_case_id         in     number
419   ,p_object_version_number         in     number
420   );
421 
422 end hr_person_absence_case_api;