DBA Data[Home] [Help]

PACKAGE: APPS.PER_AE_DISABILITY_API

Source


1 package per_ae_disability_api as
2 /* $Header: pedisaei.pkh 120.2 2006/09/27 13:33:39 spendhar noship $ */
3 /*#
4  * This API creates a disability record for a person.
5  * @rep:scope public
6  * @rep:product PER
7  * @rep:displayname UAE Disability APIs
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |---------------------------< create_ae_disability >-----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16  * This API creates a disability record for a person.
17  *
18  *
19  * <p><b>Licensing</b><br>
20  * This API is licensed for use with Oracle Human Resources.
21  *
22  * <p><b>Prerequisites</b><br>
23  * Person must exist on the validation start date.
24  *
25  * <p><b>Post Success</b><br>
26  * Disability is created.
27  *
28  * <p><b>Post Failure</b><br>
29  * The API does not create the disability 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_effective_date The effective start date of this disability.
35  * @param p_person_id The person for whom the disability applies to.
36  * @param p_category The person's official disability category.
37  * @param p_status The status of the disability record.
38  * @param p_quota_fte Disability full time earnings measure (default is 1.00).
39  * @param p_organization_id The system ID of the official disability
40  * organization the person is registered with.
41  * @param p_registration_id The registration code given to the person by the
42  * disability organization.
43  * @param p_registration_date The date the person was registered as disabled.
44  * @param p_registration_exp_date The date disability registration would
45  * expire.
46  * @param p_description Text description of disability.
47  * @param p_degree The person's disability percentage in degrees.
48  * @param p_reason The reason for disability.
49  * @param p_work_restriction Text describing any restrictions for the disabled
50  * person to work.
51  * @param p_incident_id The surrogate key for work incident.
52  * @param p_medical_assessment_id The surrogate key for medical assessment.
53  * @param p_pre_registration_job The person's job on the registration date.
54  * @param p_attribute_category This context value determines which flexfield
55  * structure to use with the descriptive flexfield segments.
56  * @param p_attribute1 Descriptive flexfield segment.
57  * @param p_attribute2 Descriptive flexfield segment.
58  * @param p_attribute3 Descriptive flexfield segment.
59  * @param p_attribute4 Descriptive flexfield segment.
60  * @param p_attribute5 Descriptive flexfield segment.
61  * @param p_attribute6 Descriptive flexfield segment.
62  * @param p_attribute7 Descriptive flexfield segment.
63  * @param p_attribute8 Descriptive flexfield segment.
64  * @param p_attribute9 Descriptive flexfield segment.
65  * @param p_attribute10 Descriptive flexfield segment.
66  * @param p_attribute11 Descriptive flexfield segment.
67  * @param p_attribute12 Descriptive flexfield segment.
68  * @param p_attribute13 Descriptive flexfield segment.
69  * @param p_attribute14 Descriptive flexfield segment.
70  * @param p_attribute15 Descriptive flexfield segment.
71  * @param p_attribute16 Descriptive flexfield segment.
72  * @param p_attribute17 Descriptive flexfield segment.
73  * @param p_attribute18 Descriptive flexfield segment.
74  * @param p_attribute19 Descriptive flexfield segment.
75  * @param p_attribute20 Descriptive flexfield segment.
76  * @param p_attribute21 Descriptive flexfield segment.
77  * @param p_attribute22 Descriptive flexfield segment.
78  * @param p_attribute23 Descriptive flexfield segment.
79  * @param p_attribute24 Descriptive flexfield segment.
80  * @param p_attribute25 Descriptive flexfield segment.
81  * @param p_attribute26 Descriptive flexfield segment.
82  * @param p_attribute27 Descriptive flexfield segment.
83  * @param p_attribute28 Descriptive flexfield segment.
84  * @param p_attribute29 Descriptive flexfield segment.
85  * @param p_attribute30 Descriptive flexfield segment.
86  * @param p_relevant_to_social_security Relevant to social security indicator.
87  * @param p_disability_id Unique ID for the disability created by the API.
88  * @param p_object_version_number Version number of the new disability.
89  * @param p_effective_start_date Effective start date of this disability.
90  * @param p_effective_end_date Effective end date of this disability.
91  * @rep:displayname Create UAE Disability
92  * @rep:category BUSINESS_ENTITY PER_DISABILITY
93  * @rep:lifecycle active
94  * @rep:scope public
95  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
96 */
97 --
98 -- {End Of Comments}
99 --
100 procedure create_ae_disability
101   (p_validate                      in     boolean  default false
102   ,p_effective_date                in     date
103   ,p_person_id                     in     number
104   ,p_category                      in     varchar2
105   ,p_status                        in     varchar2
106   ,p_quota_fte                     in     number   default 1.00
107   ,p_organization_id               in     number   default null
108   ,p_registration_id               in     varchar2 default null
109   ,p_registration_date             in     date     default null
110   ,p_registration_exp_date         in     date     default null
111   ,p_description                   in     varchar2 default null
112   ,p_degree                        in     number   default null
113   ,p_reason                        in     varchar2 default null
114   ,p_work_restriction              in     varchar2 default null
115   ,p_incident_id                   in     number   default null
116   ,p_medical_assessment_id         in     number   default null
117   ,p_pre_registration_job          in     varchar2 default null
118   ,p_attribute_category            in     varchar2 default null
119   ,p_attribute1                    in     varchar2 default null
120   ,p_attribute2                    in     varchar2 default null
121   ,p_attribute3                    in     varchar2 default null
122   ,p_attribute4                    in     varchar2 default null
123   ,p_attribute5                    in     varchar2 default null
124   ,p_attribute6                    in     varchar2 default null
125   ,p_attribute7                    in     varchar2 default null
126   ,p_attribute8                    in     varchar2 default null
127   ,p_attribute9                    in     varchar2 default null
128   ,p_attribute10                   in     varchar2 default null
129   ,p_attribute11                   in     varchar2 default null
130   ,p_attribute12                   in     varchar2 default null
131   ,p_attribute13                   in     varchar2 default null
132   ,p_attribute14                   in     varchar2 default null
133   ,p_attribute15                   in     varchar2 default null
134   ,p_attribute16                   in     varchar2 default null
135   ,p_attribute17                   in     varchar2 default null
136   ,p_attribute18                   in     varchar2 default null
137   ,p_attribute19                   in     varchar2 default null
138   ,p_attribute20                   in     varchar2 default null
139   ,p_attribute21                   in     varchar2 default null
140   ,p_attribute22                   in     varchar2 default null
141   ,p_attribute23                   in     varchar2 default null
142   ,p_attribute24                   in     varchar2 default null
143   ,p_attribute25                   in     varchar2 default null
144   ,p_attribute26                   in     varchar2 default null
145   ,p_attribute27                   in     varchar2 default null
146   ,p_attribute28                   in     varchar2 default null
147   ,p_attribute29                   in     varchar2 default null
148   ,p_attribute30                   in     varchar2 default null
149   ,p_relevant_to_social_security   in     varchar2 default null
150   ,p_disability_id                    out nocopy number
151   ,p_object_version_number            out nocopy number
152   ,p_effective_start_date             out nocopy date
153   ,p_effective_end_date               out nocopy date
154   );
155 --
156 -- ----------------------------------------------------------------------------
157 -- |---------------------------< update_ae_disability >-----------------------|
158 -- ----------------------------------------------------------------------------
159 --
160 -- {Start Of Comments}
161 /*#
162  * This API updates a disability record for a person as identified by
163  * p_disability_id and p_object_version_number.
164  *
165  *
166  * <p><b>Licensing</b><br>
167  * This API is licensed for use with Oracle Human Resources.
168  *
169  * <p><b>Prerequisites</b><br>
170  * The disability record identified by p_disability_id and
171  * object_version_number must exist.
172  *
173  * <p><b>Post Success</b><br>
174  * Disability is updated.
175  *
176  * <p><b>Post Failure</b><br>
177  * The API does not update the disability, and raises an error.
178  *
179  * @param p_validate If true, then validation alone will be performed and the
180  * database will remain unchanged. If false and all validation checks pass,
181  * then the database will be modified.
182  * @param p_effective_date Application effective date.
183  * @param p_datetrack_mode Update mode.
184  * @param p_disability_id Surrogate ID of the disability record.
185  * @param p_object_version_number Version number of the disability record.
186  * @param p_category The official disability category of the person.
187  * @param p_status The status of the disability record.
188  * @param p_quota_fte Disability full time earnings measure.
189  * @param p_organization_id The system ID of the official disability
190  * organization the person is registered with.
191  * @param p_registration_id The person's registration code given by the
192  * disability organization.
193  * @param p_registration_date The date the person was registered as disabled.
194  * @param p_registration_exp_date The date the person's disability registration
195  * would expire.
196  * @param p_description Text description of disability.
197  * @param p_degree The person's disability percentage in degrees.
198  * @param p_reason The reason for disability.
199  * @param p_work_restriction Text describing any restrictions to work the
200  * disabled person has.
201  * @param p_incident_id The surrogate key for work incident.
202  * @param p_medical_assessment_id The surrogate key for medical assessment.
203  * @param p_pre_registration_job The job the person was doing on the
204  * registration_date.
205  * @param p_attribute_category This context value determines which flexfield
206  * structure to use with the descriptive flexfield segments.
207  * @param p_attribute1 Descriptive flexfield segment.
208  * @param p_attribute2 Descriptive flexfield segment.
209  * @param p_attribute3 Descriptive flexfield segment.
210  * @param p_attribute4 Descriptive flexfield segment.
211  * @param p_attribute5 Descriptive flexfield segment.
212  * @param p_attribute6 Descriptive flexfield segment.
213  * @param p_attribute7 Descriptive flexfield segment.
214  * @param p_attribute8 Descriptive flexfield segment.
215  * @param p_attribute9 Descriptive flexfield segment.
216  * @param p_attribute10 Descriptive flexfield segment.
217  * @param p_attribute11 Descriptive flexfield segment.
218  * @param p_attribute12 Descriptive flexfield segment.
219  * @param p_attribute13 Descriptive flexfield segment.
220  * @param p_attribute14 Descriptive flexfield segment.
221  * @param p_attribute15 Descriptive flexfield segment.
222  * @param p_attribute16 Descriptive flexfield segment.
223  * @param p_attribute17 Descriptive flexfield segment.
224  * @param p_attribute18 Descriptive flexfield segment.
225  * @param p_attribute19 Descriptive flexfield segment.
226  * @param p_attribute20 Descriptive flexfield segment.
227  * @param p_attribute21 Descriptive flexfield segment.
228  * @param p_attribute22 Descriptive flexfield segment.
229  * @param p_attribute23 Descriptive flexfield segment.
230  * @param p_attribute24 Descriptive flexfield segment.
231  * @param p_attribute25 Descriptive flexfield segment.
232  * @param p_attribute26 Descriptive flexfield segment.
233  * @param p_attribute27 Descriptive flexfield segment.
234  * @param p_attribute28 Descriptive flexfield segment.
235  * @param p_attribute29 Descriptive flexfield segment.
236  * @param p_attribute30 Descriptive flexfield segment.
237  * @param p_relevant_to_social_security Relevent to social security indicator.
238  * @param p_effective_start_date Effective start date of the disability
239  * changes.
240  * @param p_effective_end_date Effective end date of the disability changes.
241  * @rep:displayname Update UAE Disability
242  * @rep:category BUSINESS_ENTITY PER_DISABILITY
243  * @rep:lifecycle active
244  * @rep:scope public
245  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
246 */
247 --
248 -- {End Of Comments}
249 --
250 procedure update_ae_disability
251   (p_validate                      in     boolean  default false
252   ,p_effective_date                in     date
253   ,p_datetrack_mode                in     varchar2
254   ,p_disability_id                 in     number
255   ,p_object_version_number         in out nocopy number
256   ,p_category                      in     varchar2 default hr_api.g_varchar2
257   ,p_status                        in     varchar2 default hr_api.g_varchar2
258   ,p_quota_fte                     in     number   default hr_api.g_number
259   ,p_organization_id               in     number   default hr_api.g_number
260   ,p_registration_id               in     varchar2 default hr_api.g_varchar2
261   ,p_registration_date             in     date     default hr_api.g_date
262   ,p_registration_exp_date         in     date     default hr_api.g_date
263   ,p_description                   in     varchar2 default hr_api.g_varchar2
264   ,p_degree                        in     number   default hr_api.g_number
265   ,p_reason                        in     varchar2 default hr_api.g_varchar2
266   ,p_work_restriction              in     varchar2 default hr_api.g_varchar2
267   ,p_incident_id                   in     number   default hr_api.g_number
268   ,p_medical_assessment_id         in     number   default hr_api.g_number
272   ,p_attribute2                    in     varchar2 default hr_api.g_varchar2
269   ,p_pre_registration_job          in     varchar2 default hr_api.g_varchar2
270   ,p_attribute_category            in     varchar2 default hr_api.g_varchar2
271   ,p_attribute1                    in     varchar2 default hr_api.g_varchar2
273   ,p_attribute3                    in     varchar2 default hr_api.g_varchar2
274   ,p_attribute4                    in     varchar2 default hr_api.g_varchar2
275   ,p_attribute5                    in     varchar2 default hr_api.g_varchar2
276   ,p_attribute6                    in     varchar2 default hr_api.g_varchar2
277   ,p_attribute7                    in     varchar2 default hr_api.g_varchar2
278   ,p_attribute8                    in     varchar2 default hr_api.g_varchar2
279   ,p_attribute9                    in     varchar2 default hr_api.g_varchar2
280   ,p_attribute10                   in     varchar2 default hr_api.g_varchar2
281   ,p_attribute11                   in     varchar2 default hr_api.g_varchar2
282   ,p_attribute12                   in     varchar2 default hr_api.g_varchar2
286   ,p_attribute16                   in     varchar2 default hr_api.g_varchar2
283   ,p_attribute13                   in     varchar2 default hr_api.g_varchar2
284   ,p_attribute14                   in     varchar2 default hr_api.g_varchar2
285   ,p_attribute15                   in     varchar2 default hr_api.g_varchar2
287   ,p_attribute17                   in     varchar2 default hr_api.g_varchar2
288   ,p_attribute18                   in     varchar2 default hr_api.g_varchar2
289   ,p_attribute19                   in     varchar2 default hr_api.g_varchar2
290   ,p_attribute20                   in     varchar2 default hr_api.g_varchar2
291   ,p_attribute21                   in     varchar2 default hr_api.g_varchar2
292   ,p_attribute22                   in     varchar2 default hr_api.g_varchar2
293   ,p_attribute23                   in     varchar2 default hr_api.g_varchar2
294   ,p_attribute24                   in     varchar2 default hr_api.g_varchar2
295   ,p_attribute25                   in     varchar2 default hr_api.g_varchar2
296   ,p_attribute26                   in     varchar2 default hr_api.g_varchar2
297   ,p_attribute27                   in     varchar2 default hr_api.g_varchar2
298   ,p_attribute28                   in     varchar2 default hr_api.g_varchar2
299   ,p_attribute29                   in     varchar2 default hr_api.g_varchar2
300   ,p_attribute30                   in     varchar2 default hr_api.g_varchar2
301   ,p_relevant_to_social_security   in     varchar2 default hr_api.g_varchar2
302   ,p_effective_start_date             out nocopy date
306 end per_ae_disability_api;
303   ,p_effective_end_date               out nocopy date
304   );
305