1 package per_sa_disability_api as
2 /* $Header: pedissai.pkh 120.1 2005/10/02 02:14:54 aroussel $ */
3 /*#
4 * This package contains disability APIs for Saudi Arabia.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Disability for Saudi Arabia
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |---------------------------< create_sa_disability >-----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates disability information for a person in a Saudi Arabia
17 * business group.
18 *
19 * The API calls the generic API create_disability, with parameters set as
20 * appropriate for the Saudi person. As this API is effectively an alternative
21 * to the API create_disability, see that API for further explanation.
22 *
23 * <p><b>Licensing</b><br>
24 * This API is licensed for use with Human Resources.
25 *
26 * <p><b>Prerequisites</b><br>
27 * See API create_disability
28 *
29 * <p><b>Post Success</b><br>
30 * The API sucessfully creates the disability information record in the
31 * database.
32 *
33 * <p><b>Post Failure</b><br>
34 * The API does not create the disability information record and raises an
35 * error.
36 * @param p_validate If true, then validation alone will be performed and the
37 * database will remain unchanged. If false and all validation checks pass,
38 * then the database will be modified.
39 * @param p_effective_date Determines when the DateTrack operation comes into
40 * force.
41 * @param p_person_id Identifies the person for whom you create the disability
42 * record.
43 * @param p_category The official category of the disability the person has.
44 * Valid values are defined by the 'DISABILITY_CATEGORY' lookup type.
45 * @param p_status The status of the disability record. Valid values are
46 * defined by the 'DISABILITY_STATUS' lookup type.
47 * @param p_quota_fte The full time earnings measure that is accorded to the
48 * person due to the disability. The default value created is 1.00.
49 * @param p_organization_id Uniquely identifies the official disability
50 * organisation the person is registered with.
51 * @param p_registration_id The registration code given to the person by the
52 * disability organisation.
53 * @param p_registration_date The date the person was registered disabled.
54 * @param p_registration_exp_date The date the disability registration expires.
55 * @param p_description Text description of the disability.
56 * @param p_degree The percentage degree of disability the person has. This is
57 * an officially assessed figure, provided during the process of disability
58 * registration.
59 * @param p_reason The reason for disability. Valid values are defined by the
60 * 'DISABILITY_REASON' lookup type.
61 * @param p_work_restriction Text describing any restrictions to work the
62 * disabled person has.
63 * @param p_incident_id Uniquely identifies a work incident record which is
64 * being linked as a causal factor in the disability.
65 * @param p_medical_assessment_id Uniquely identifies the medical assessment
66 * record for this disability.
67 * @param p_pre_registration_job The name of the job the person was doing on
68 * the date they were registered disabled.
69 * @param p_attribute_category This context value determines which flexfield
70 * structure to use with the descriptive flexfield segments.
71 * @param p_attribute1 Descriptive flexfield segment.
72 * @param p_attribute2 Descriptive flexfield segment.
73 * @param p_attribute3 Descriptive flexfield segment.
74 * @param p_attribute4 Descriptive flexfield segment.
75 * @param p_attribute5 Descriptive flexfield segment.
76 * @param p_attribute6 Descriptive flexfield segment.
77 * @param p_attribute7 Descriptive flexfield segment.
78 * @param p_attribute8 Descriptive flexfield segment.
79 * @param p_attribute9 Descriptive flexfield segment.
80 * @param p_attribute10 Descriptive flexfield segment.
81 * @param p_attribute11 Descriptive flexfield segment.
82 * @param p_attribute12 Descriptive flexfield segment.
83 * @param p_attribute13 Descriptive flexfield segment.
84 * @param p_attribute14 Descriptive flexfield segment.
85 * @param p_attribute15 Descriptive flexfield segment.
86 * @param p_attribute16 Descriptive flexfield segment.
87 * @param p_attribute17 Descriptive flexfield segment.
88 * @param p_attribute18 Descriptive flexfield segment.
89 * @param p_attribute19 Descriptive flexfield segment.
90 * @param p_attribute20 Descriptive flexfield segment.
91 * @param p_attribute21 Descriptive flexfield segment.
92 * @param p_attribute22 Descriptive flexfield segment.
93 * @param p_attribute23 Descriptive flexfield segment.
94 * @param p_attribute24 Descriptive flexfield segment.
95 * @param p_attribute25 Descriptive flexfield segment.
96 * @param p_attribute26 Descriptive flexfield segment.
97 * @param p_attribute27 Descriptive flexfield segment.
98 * @param p_attribute28 Descriptive flexfield segment.
99 * @param p_attribute29 Descriptive flexfield segment.
100 * @param p_attribute30 Descriptive flexfield segment.
101 * @param p_employment_office Saudi Employment Office. Valid values are all
102 * organizations classified as Saudi Employment Office.
103 * @param p_disability_id If p_validate is false, uniquely identifies the
104 * disability created by the API. If p_validate is true then set to null.
105 * @param p_object_version_number If p_validate is false, then set to the
106 * version number of the created disability. If p_validate is true, then the
107 * value will be null.
108 * @param p_effective_start_date If p_validate is false, then set to the
109 * earliest effective start date for the created disability. If p_validate is
110 * true, then set to null.
111 * @param p_effective_end_date If p_validate is false, then set to the
112 * effective end date for the created disability. If p_validate is true, then
113 * set to null.
114 * @rep:displayname Create Disability for Saudi Arabia
115 * @rep:category BUSINESS_ENTITY PER_DISABILITY
116 * @rep:scope public
117 * @rep:lifecycle active
118 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
119 */
120 --
121 -- {End Of Comments}
122 --
123 procedure create_sa_disability
124 (p_validate in boolean default false
125 ,p_effective_date in date
126 ,p_person_id in number
127 ,p_category in varchar2
128 ,p_status in varchar2
129 ,p_quota_fte in number default 1.00
130 ,p_organization_id in number default null
131 ,p_registration_id in varchar2 default null
132 ,p_registration_date in date default null
133 ,p_registration_exp_date in date default null
134 ,p_description in varchar2 default null
135 ,p_degree in number default null
136 ,p_reason in varchar2 default null
137 ,p_work_restriction in varchar2 default null
138 ,p_incident_id in number default null
139 ,p_medical_assessment_id in number default null
140 ,p_pre_registration_job in varchar2 default null
141 ,p_attribute_category in varchar2 default null
142 ,p_attribute1 in varchar2 default null
143 ,p_attribute2 in varchar2 default null
144 ,p_attribute3 in varchar2 default null
145 ,p_attribute4 in varchar2 default null
146 ,p_attribute5 in varchar2 default null
147 ,p_attribute6 in varchar2 default null
148 ,p_attribute7 in varchar2 default null
149 ,p_attribute8 in varchar2 default null
150 ,p_attribute9 in varchar2 default null
151 ,p_attribute10 in varchar2 default null
152 ,p_attribute11 in varchar2 default null
153 ,p_attribute12 in varchar2 default null
154 ,p_attribute13 in varchar2 default null
155 ,p_attribute14 in varchar2 default null
156 ,p_attribute15 in varchar2 default null
157 ,p_attribute16 in varchar2 default null
158 ,p_attribute17 in varchar2 default null
159 ,p_attribute18 in varchar2 default null
160 ,p_attribute19 in varchar2 default null
161 ,p_attribute20 in varchar2 default null
162 ,p_attribute21 in varchar2 default null
163 ,p_attribute22 in varchar2 default null
164 ,p_attribute23 in varchar2 default null
165 ,p_attribute24 in varchar2 default null
166 ,p_attribute25 in varchar2 default null
167 ,p_attribute26 in varchar2 default null
168 ,p_attribute27 in varchar2 default null
169 ,p_attribute28 in varchar2 default null
170 ,p_attribute29 in varchar2 default null
171 ,p_attribute30 in varchar2 default null
172 ,p_employment_office in varchar2 default null
173 ,p_disability_id out nocopy number
174 ,p_object_version_number out nocopy number
175 ,p_effective_start_date out nocopy date
176 ,p_effective_end_date out nocopy date
177 );
178 --
179 -- ----------------------------------------------------------------------------
180 -- |---------------------------< update_sa_disability >-----------------------|
181 -- ----------------------------------------------------------------------------
182 --
183 -- {Start Of Comments}
184 /*#
185 * This API updates disability information for a person in a Saudi Arabia
186 * business group.
187 *
188 * The API calls the generic API update_disability, with parameters set as
189 * appropriate for the Saudi person. As this API is effectively an alternative
190 * to the API update_disability, see that API for further explanation.
191 *
192 * <p><b>Licensing</b><br>
193 * This API is licensed for use with Human Resources.
194 *
195 * <p><b>Prerequisites</b><br>
196 * See API update_disability
197 *
198 * <p><b>Post Success</b><br>
199 * The disability information record is successfully updated in the database.
200 *
201 * <p><b>Post Failure</b><br>
202 * The API does not update the disability information record and raises an
203 * error.
204 * @param p_validate If true, then validation alone will be performed and the
205 * database will remain unchanged. If false and all validation checks pass,
206 * then the database will be modified.
207 * @param p_effective_date Determines when the DateTrack operation comes into
208 * force.
209 * @param p_datetrack_mode Indicates which DateTrack mode to use when updating
210 * the record. You must set to either UPDATE, CORRECTION, UPDATE_OVERRIDE or
211 * UPDATE_CHANGE_INSERT. Modes available for use with a particular record
212 * depend on the dates of previous record changes and the effective date of
213 * this change.
214 * @param p_disability_id Uniquely identifies the disability to be updated.
215 * @param p_object_version_number Pass in the current version number of the
216 * disability to be updated. When the API completes if p_validate is false,
217 * will be set to the new version number of the updated disability. If
218 * p_validate is true will be set to the same value which was passed in.
219 * @param p_category The official category of the disability the person has.
220 * Valid values are defined by the 'DISABILITY_CATEGORY' lookup type.
221 * @param p_status The status of the disability record. Valid values are
222 * defined by the 'DISABILITY_STATUS' lookup type.
223 * @param p_quota_fte The full time earnings measure that is accorded to the
224 * person due to the disability. The default value created is 1.00.
225 * @param p_organization_id Uniquely identifies the official disability
226 * organisation the person is registered with.
227 * @param p_registration_id The registration code given to the person by the
228 * disability organisation.
229 * @param p_registration_date The date the person was registered disabled.
230 * @param p_registration_exp_date The date the disability registration expires.
231 * @param p_description Text description of the disability.
232 * @param p_degree The percentage degree of disability the person has. This is
233 * an officially assessed figure, provided during the process of disability
234 * registration.
235 * @param p_reason The reason for disability. Valid values are defined by the
236 * 'DISABILITY_REASON' lookup type.
237 * @param p_work_restriction Text describing any restrictions to work the
238 * disabled person has.
239 * @param p_incident_id Uniquely identifies a work incident record which is
240 * being linked as a causal factor in the disability.
241 * @param p_medical_assessment_id Uniquely identifies the medical assessment
242 * record for this disability.
243 * @param p_pre_registration_job The name of the job the person was doing on
244 * the date they were registered disabled.
245 * @param p_attribute_category This context value determines which flexfield
246 * structure to use with the descriptive flexfield segments.
247 * @param p_attribute1 Descriptive flexfield segment.
248 * @param p_attribute2 Descriptive flexfield segment.
249 * @param p_attribute3 Descriptive flexfield segment.
250 * @param p_attribute4 Descriptive flexfield segment.
251 * @param p_attribute5 Descriptive flexfield segment.
252 * @param p_attribute6 Descriptive flexfield segment.
253 * @param p_attribute7 Descriptive flexfield segment.
254 * @param p_attribute8 Descriptive flexfield segment.
255 * @param p_attribute9 Descriptive flexfield segment.
256 * @param p_attribute10 Descriptive flexfield segment.
257 * @param p_attribute11 Descriptive flexfield segment.
258 * @param p_attribute12 Descriptive flexfield segment.
259 * @param p_attribute13 Descriptive flexfield segment.
260 * @param p_attribute14 Descriptive flexfield segment.
261 * @param p_attribute15 Descriptive flexfield segment.
262 * @param p_attribute16 Descriptive flexfield segment.
263 * @param p_attribute17 Descriptive flexfield segment.
264 * @param p_attribute18 Descriptive flexfield segment.
265 * @param p_attribute19 Descriptive flexfield segment.
266 * @param p_attribute20 Descriptive flexfield segment.
267 * @param p_attribute21 Descriptive flexfield segment.
268 * @param p_attribute22 Descriptive flexfield segment.
269 * @param p_attribute23 Descriptive flexfield segment.
270 * @param p_attribute24 Descriptive flexfield segment.
271 * @param p_attribute25 Descriptive flexfield segment.
272 * @param p_attribute26 Descriptive flexfield segment.
273 * @param p_attribute27 Descriptive flexfield segment.
274 * @param p_attribute28 Descriptive flexfield segment.
275 * @param p_attribute29 Descriptive flexfield segment.
276 * @param p_attribute30 Descriptive flexfield segment.
277 * @param p_employment_office Saudi Employment Office. Valid values are all
278 * organizations classified as Saudi Employment Office.
279 * @param p_effective_start_date If p_validate is false, then set to the
280 * effective start date on the updated disability row which now exists as of
281 * the effective date. If p_validate is true, then set to null.
282 * @param p_effective_end_date If p_validate is false, then set to the
283 * effective end date on the updated disability row which now exists as of the
284 * effective date. If p_validate is true, then set to null.
285 * @rep:displayname Update Disability for Saudi Arabia
286 * @rep:category BUSINESS_ENTITY PER_DISABILITY
287 * @rep:scope public
288 * @rep:lifecycle active
289 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
290 */
291 --
292 -- {End Of Comments}
293 --
294 procedure update_sa_disability
295 (p_validate in boolean default false
296 ,p_effective_date in date
297 ,p_datetrack_mode in varchar2
298 ,p_disability_id in number
299 ,p_object_version_number in out nocopy number
300 ,p_category in varchar2 default hr_api.g_varchar2
301 ,p_status in varchar2 default hr_api.g_varchar2
302 ,p_quota_fte in number default hr_api.g_number
303 ,p_organization_id in number default hr_api.g_number
304 ,p_registration_id in varchar2 default hr_api.g_varchar2
305 ,p_registration_date in date default hr_api.g_date
306 ,p_registration_exp_date in date default hr_api.g_date
307 ,p_description in varchar2 default hr_api.g_varchar2
308 ,p_degree in number default hr_api.g_number
309 ,p_reason in varchar2 default hr_api.g_varchar2
310 ,p_work_restriction in varchar2 default hr_api.g_varchar2
311 ,p_incident_id in number default hr_api.g_number
312 ,p_medical_assessment_id in number default hr_api.g_number
313 ,p_pre_registration_job in varchar2 default hr_api.g_varchar2
314 ,p_attribute_category in varchar2 default hr_api.g_varchar2
315 ,p_attribute1 in varchar2 default hr_api.g_varchar2
316 ,p_attribute2 in varchar2 default hr_api.g_varchar2
317 ,p_attribute3 in varchar2 default hr_api.g_varchar2
318 ,p_attribute4 in varchar2 default hr_api.g_varchar2
319 ,p_attribute5 in varchar2 default hr_api.g_varchar2
320 ,p_attribute6 in varchar2 default hr_api.g_varchar2
321 ,p_attribute7 in varchar2 default hr_api.g_varchar2
322 ,p_attribute8 in varchar2 default hr_api.g_varchar2
323 ,p_attribute9 in varchar2 default hr_api.g_varchar2
324 ,p_attribute10 in varchar2 default hr_api.g_varchar2
325 ,p_attribute11 in varchar2 default hr_api.g_varchar2
326 ,p_attribute12 in varchar2 default hr_api.g_varchar2
327 ,p_attribute13 in varchar2 default hr_api.g_varchar2
328 ,p_attribute14 in varchar2 default hr_api.g_varchar2
329 ,p_attribute15 in varchar2 default hr_api.g_varchar2
330 ,p_attribute16 in varchar2 default hr_api.g_varchar2
331 ,p_attribute17 in varchar2 default hr_api.g_varchar2
332 ,p_attribute18 in varchar2 default hr_api.g_varchar2
333 ,p_attribute19 in varchar2 default hr_api.g_varchar2
334 ,p_attribute20 in varchar2 default hr_api.g_varchar2
335 ,p_attribute21 in varchar2 default hr_api.g_varchar2
336 ,p_attribute22 in varchar2 default hr_api.g_varchar2
337 ,p_attribute23 in varchar2 default hr_api.g_varchar2
338 ,p_attribute24 in varchar2 default hr_api.g_varchar2
339 ,p_attribute25 in varchar2 default hr_api.g_varchar2
340 ,p_attribute26 in varchar2 default hr_api.g_varchar2
341 ,p_attribute27 in varchar2 default hr_api.g_varchar2
342 ,p_attribute28 in varchar2 default hr_api.g_varchar2
343 ,p_attribute29 in varchar2 default hr_api.g_varchar2
344 ,p_attribute30 in varchar2 default hr_api.g_varchar2
345 ,p_employment_office in varchar2 default hr_api.g_varchar2
346 ,p_effective_start_date out nocopy date
347 ,p_effective_end_date out nocopy date
348 );
349
350 end per_sa_disability_api;
[Home] [Help]