1 package hr_sa_person_api as
2 /* $Header: pepersai.pkh 120.4 2005/10/02 02:21:10 aroussel $ */
3 /*#
4 * This package contains person APIs for Saudi Arabia.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Person for Saudi Arabia
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-----------------------------< update_sa_person >-------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API updates information for an existing person in a Saudi Arabia
17 * business group.
18 *
19 * The API calls the generic API update_person, with parameters set as
20 * appropriate for the Saudi person. As this API is effectively an alternative
21 * to the API update_person, 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 update_person
28 *
29 * <p><b>Post Success</b><br>
30 * The person record is successfully updated in the database.
31 *
32 * <p><b>Post Failure</b><br>
33 * The API does not update the person record and raises an error.
34 * @param p_validate If true, then validation alone will be performed and the
35 * database will remain unchanged. If false and all validation checks pass,
36 * then the database will be modified.
37 * @param p_effective_date Determines when the DateTrack operation comes into
38 * force.
39 * @param p_datetrack_update_mode Indicates which DateTrack mode to use when
40 * updating the record. You must set to either UPDATE, CORRECTION,
41 * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
42 * particular record depend on the dates of previous record changes and the
43 * effective date of this change.
44 * @param p_person_id Person whose record needs to be modified.
45 * @param p_object_version_number Pass in the current version number of the
46 * person to be updated. When the API completes if p_validate is false, will be
47 * set to the new version number of the updated person. If p_validate is true
48 * will be set to the same value which was passed in.
49 * @param p_person_type_id Type of person being updated.
50 * @param p_family_name Family Name
51 * @param p_applicant_number The business group's applicant number generation
52 * method determines when the API derives and passes out an applicant number or
53 * when the calling program should pass in a value. When the API call completes
54 * if p_validate is true then will be set to the applicant number. If
55 * p_validate is true then will be set to the passed value.
56 * @param p_comments Comment text.
57 * @param p_date_employee_data_verified The date on which the person data was
58 * last verified.
59 * @param p_date_of_birth Date of birth.
60 * @param p_email_address Email address.
61 * @param p_employee_number The business group's employee number generation
62 * method determines when the API derives and passes out an employee number or
63 * when the calling program should pass in a value. When the API call completes
64 * if p_validate is false then will be set to the employee number. If
65 * p_validate is true then will be set to the passed value.
66 * @param p_expense_check_send_to_addres Mailing address.
67 * @param p_first_name First name.
68 * @param p_known_as Preferred name.
69 * @param p_marital_status Marital status. Valid values are defined by the
70 * MAR_STATUS lookup type.
71 * @param p_nationality Nationality. Valid values are defined by the
72 * NATIONALITY lookup type.
73 * @param p_national_identifier Number by which a person is identified in a
74 * given legislation.
75 * @param p_previous_last_name Previous last name.
76 * @param p_registered_disabled_flag Flag indicating whether the person is
77 * classified as disabled.
78 * @param p_sex Legal gender. Valid values are defined by the SEX lookup type.
79 * @param p_title Title. Valid values are defined by the TITLE lookup type.
80 * @param p_vendor_id Obsolete parameter, do not use.
81 * @param p_work_telephone Obsolete parameter, do not use.
82 * @param p_attribute_category This context value determines which flexfield
83 * structure to use with the descriptive flexfield segments.
84 * @param p_attribute1 Descriptive flexfield segment.
85 * @param p_attribute2 Descriptive flexfield segment.
86 * @param p_attribute3 Descriptive flexfield segment.
87 * @param p_attribute4 Descriptive flexfield segment.
88 * @param p_attribute5 Descriptive flexfield segment.
89 * @param p_attribute6 Descriptive flexfield segment.
90 * @param p_attribute7 Descriptive flexfield segment.
91 * @param p_attribute8 Descriptive flexfield segment.
92 * @param p_attribute9 Descriptive flexfield segment.
93 * @param p_attribute10 Descriptive flexfield segment.
94 * @param p_attribute11 Descriptive flexfield segment.
95 * @param p_attribute12 Descriptive flexfield segment.
96 * @param p_attribute13 Descriptive flexfield segment.
97 * @param p_attribute14 Descriptive flexfield segment.
98 * @param p_attribute15 Descriptive flexfield segment.
99 * @param p_attribute16 Descriptive flexfield segment.
100 * @param p_attribute17 Descriptive flexfield segment.
101 * @param p_attribute18 Descriptive flexfield segment.
102 * @param p_attribute19 Descriptive flexfield segment.
103 * @param p_attribute20 Descriptive flexfield segment.
104 * @param p_attribute21 Descriptive flexfield segment.
105 * @param p_attribute22 Descriptive flexfield segment.
106 * @param p_attribute23 Descriptive flexfield segment.
107 * @param p_attribute24 Descriptive flexfield segment.
108 * @param p_attribute25 Descriptive flexfield segment.
109 * @param p_attribute26 Descriptive flexfield segment.
110 * @param p_attribute27 Descriptive flexfield segment.
111 * @param p_attribute28 Descriptive flexfield segment.
112 * @param p_attribute29 Descriptive flexfield segment.
113 * @param p_attribute30 Descriptive flexfield segment.
114 * @param p_father_name Father's Name
115 * @param p_grandfather_name Grandfather's Name
116 * @param p_alt_first_name Specifies First Name in alternative language
117 * @param p_alt_father_name Specifies Father's Name in alternative language
118 * @param p_alt_grandfather_name Specifies Grandfather's Name in alternative
119 * language
120 * @param p_alt_family_name Specifies Family Name in alternative language
121 * @param p_religion Religion
122 * @param p_hijrah_birth_date Date of birth according to the Hijrah calendar.
123 * @param p_date_of_death Date of death.
124 * @param p_background_check_status Flag indicating whether the person's
125 * background has been checked.
126 * @param p_background_date_check Date on which the background check was
127 * performed.
128 * @param p_blood_type Blood type.
129 * @param p_correspondence_language Preferred language for correspondence.
130 * @param p_fast_path_employee Obsolete parameter, do not use.
131 * @param p_fte_capacity Obsolete parameter, do not use.
132 * @param p_hold_applicant_date_until Date until when the applicant's
133 * information is to be maintained.
134 * @param p_honors Honors awarded.
135 * @param p_internal_location Internal location of office.
136 * @param p_last_medical_test_by Name of physician who performed the last
137 * medical test.
138 * @param p_last_medical_test_date Date of last medical test.
139 * @param p_mailstop Internal mail location.
140 * @param p_office_number Office number.
141 * @param p_on_military_service Flag indicating whether the person is on
142 * military service.
143 * @param p_projected_start_date Obsolete parameter, do not use.
144 * @param p_rehire_authorizor Obsolete parameter, do not use.
145 * @param p_rehire_recommendation Flag indicating whether this person should be
146 * considered for rehire. Valid values are defined in YES_NO lookup type.
147 * @param p_resume_exists Flag indicating whether the person's resume is on
148 * file.
149 * @param p_resume_last_updated Date on which the resume was last updated.
150 * @param p_second_passport_exists Flag indicating whether a person has
151 * multiple passports.
152 * @param p_student_status If this person is a student, this field is used to
153 * capture their status. Valid values are defined by the STUDENT_STATUS lookup
154 * type.
155 * @param p_work_schedule Days on which this person will work.
156 * @param p_rehire_reason Rehire reason.
157 * @param p_benefit_group_id Benefit group to which this person will belong.
158 * @param p_receipt_of_death_cert_date Date death certificate was received.
159 * @param p_coord_ben_med_pln_no Secondary medical plan name. Column used for
160 * external processing.
161 * @param p_coord_ben_no_cvg_flag No secondary medical plan coverage. Column
162 * used for external processing.
163 * @param p_coord_ben_med_ext_er Secondary external medical coverage. Column
164 * used for external processing.
165 * @param p_coord_ben_med_pl_name Secondary medical coverage name. Column used
166 * for external processing.
167 * @param p_coord_ben_med_insr_crr_name Secondary medical coverage insurance
168 * carrier name. Column used for external processing.
169 * @param p_coord_ben_med_insr_crr_ident Secondary medical coverage insurance
170 * carrier identifier. Column used for external processing.
171 * @param p_coord_ben_med_cvg_strt_dt Secondary medical coverage effective
172 * start date. Column used for external processing.
173 * @param p_coord_ben_med_cvg_end_dt Secondary medical coverage effective end
174 * date. Column used for external processing.
175 * @param p_uses_tobacco_flag Flag indicating whether the person uses tobacco.
176 * @param p_dpdnt_adoption_date Date on which the dependent was adopted.
177 * @param p_dpdnt_vlntry_svce_flag Flag indicating whether the dependent is on
178 * voluntary service.
179 * @param p_original_date_of_hire Original date of hire.
180 * @param p_adjusted_svc_date Adjusted service date.
181 * @param p_town_of_birth Town or city of birth.
182 * @param p_region_of_birth Geographical region of birth.
183 * @param p_country_of_birth Country of birth.
184 * @param p_global_person_id Obsolete parameter, do not use.
185 * @param p_party_id TCA party for whom you are modifying the person record.
186 * @param p_npw_number The business group's contingent worker number generation
187 * method determines when the API derives and passes out a contingent worker
188 * number or when the calling program should pass in a value. When the API call
189 * completes if p_validate is true then will be set to the contingent worker
190 * number. If p_validate is true then will be set to the passed value.
191 * @param p_effective_start_date If p_validate is false, then set to the
192 * effective start date on the updated person row which now exists as of the
193 * effective date. If p_validate is true, then set to null.
194 * @param p_effective_end_date If p_validate is false, then set to the
195 * effective end date on the updated person row which now exists as of the
196 * effective date. If p_validate is true, then set to null.
197 * @param p_full_name If p_validate is false, then set to the complete full
198 * name of the person. If p_validate is true, then set to null.
199 * @param p_comment_id If p_validate is false and comment text was provided,
200 * then will be set to the identifier of the created person comment record. If
201 * p_validate is true or no comment text was provided, then will be null.
202 * @param p_name_combination_warning If set to true, then the combination of
203 * last name, first name and date of birth existed prior to calling this API.
204 * @param p_assign_payroll_warning If set to true, then the date of birth is
205 * not entered. If set to false, then the date of birth has been entered.
206 * Indicates if it will be possible to set the payroll on any of this person's
207 * assignments.
208 * @param p_orig_hire_warning If set to true, an orginal date of hire exists
209 * for a person who has never been an employee.
210 * @param p_education_level New parameter, available on the latest version of this API
211 * @rep:displayname Update Person for Saudi Arabia
212 * @rep:category BUSINESS_ENTITY HR_PERSON
213 * @rep:scope public
214 * @rep:lifecycle active
215 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
216 */
217 --
218 -- {End Of Comments}
219 --
220 procedure update_sa_person
221 (p_validate in boolean default false
222 ,p_effective_date in date
223 ,p_datetrack_update_mode in varchar2
224 ,p_person_id in number
225 ,p_object_version_number in out nocopy number
226 ,p_person_type_id in number default hr_api.g_number
227 ,p_family_name in varchar2 default hr_api.g_varchar2
228 ,p_applicant_number in varchar2 default hr_api.g_varchar2
229 ,p_comments in varchar2 default hr_api.g_varchar2
230 ,p_date_employee_data_verified in date default hr_api.g_date
231 ,p_date_of_birth in date default hr_api.g_date
232 ,p_email_address in varchar2 default hr_api.g_varchar2
233 ,p_employee_number in out nocopy varchar2
234 ,p_expense_check_send_to_addres in varchar2 default hr_api.g_varchar2
235 ,p_first_name in varchar2 default hr_api.g_varchar2
236 ,p_known_as in varchar2 default hr_api.g_varchar2
237 ,p_marital_status in varchar2 default hr_api.g_varchar2
238 ,p_nationality in varchar2 default hr_api.g_varchar2
239 ,p_national_identifier in varchar2 default hr_api.g_varchar2
240 ,p_previous_last_name in varchar2 default hr_api.g_varchar2
241 ,p_registered_disabled_flag in varchar2 default hr_api.g_varchar2
242 ,p_sex in varchar2 default hr_api.g_varchar2
243 ,p_title in varchar2 default hr_api.g_varchar2
244 ,p_vendor_id in number default hr_api.g_number
245 ,p_work_telephone in varchar2 default hr_api.g_varchar2
246 ,p_attribute_category in varchar2 default hr_api.g_varchar2
247 ,p_attribute1 in varchar2 default hr_api.g_varchar2
248 ,p_attribute2 in varchar2 default hr_api.g_varchar2
249 ,p_attribute3 in varchar2 default hr_api.g_varchar2
250 ,p_attribute4 in varchar2 default hr_api.g_varchar2
251 ,p_attribute5 in varchar2 default hr_api.g_varchar2
252 ,p_attribute6 in varchar2 default hr_api.g_varchar2
253 ,p_attribute7 in varchar2 default hr_api.g_varchar2
254 ,p_attribute8 in varchar2 default hr_api.g_varchar2
255 ,p_attribute9 in varchar2 default hr_api.g_varchar2
256 ,p_attribute10 in varchar2 default hr_api.g_varchar2
257 ,p_attribute11 in varchar2 default hr_api.g_varchar2
258 ,p_attribute12 in varchar2 default hr_api.g_varchar2
259 ,p_attribute13 in varchar2 default hr_api.g_varchar2
260 ,p_attribute14 in varchar2 default hr_api.g_varchar2
261 ,p_attribute15 in varchar2 default hr_api.g_varchar2
262 ,p_attribute16 in varchar2 default hr_api.g_varchar2
263 ,p_attribute17 in varchar2 default hr_api.g_varchar2
264 ,p_attribute18 in varchar2 default hr_api.g_varchar2
265 ,p_attribute19 in varchar2 default hr_api.g_varchar2
266 ,p_attribute20 in varchar2 default hr_api.g_varchar2
267 ,p_attribute21 in varchar2 default hr_api.g_varchar2
268 ,p_attribute22 in varchar2 default hr_api.g_varchar2
269 ,p_attribute23 in varchar2 default hr_api.g_varchar2
270 ,p_attribute24 in varchar2 default hr_api.g_varchar2
271 ,p_attribute25 in varchar2 default hr_api.g_varchar2
272 ,p_attribute26 in varchar2 default hr_api.g_varchar2
273 ,p_attribute27 in varchar2 default hr_api.g_varchar2
274 ,p_attribute28 in varchar2 default hr_api.g_varchar2
278 ,p_grandfather_name in varchar2 default hr_api.g_varchar2
275 ,p_attribute29 in varchar2 default hr_api.g_varchar2
276 ,p_attribute30 in varchar2 default hr_api.g_varchar2
277 ,p_father_name in varchar2 default hr_api.g_varchar2
279 ,p_alt_first_name in varchar2 default hr_api.g_varchar2
280 ,p_alt_father_name in varchar2 default hr_api.g_varchar2
281 ,p_alt_grandfather_name in varchar2 default hr_api.g_varchar2
282 ,p_alt_family_name in varchar2 default hr_api.g_varchar2
283 ,p_religion in varchar2 default hr_api.g_varchar2
284 ,p_hijrah_birth_date in varchar2 default hr_api.g_varchar2
285 ,p_date_of_death in date default hr_api.g_date
286 ,p_education_level in varchar2 default hr_api.g_varchar2
287 ,p_background_check_status in varchar2 default hr_api.g_varchar2
288 ,p_background_date_check in date default hr_api.g_date
289 ,p_blood_type in varchar2 default hr_api.g_varchar2
290 ,p_correspondence_language in varchar2 default hr_api.g_varchar2
291 ,p_fast_path_employee in varchar2 default hr_api.g_varchar2
292 ,p_fte_capacity in number default hr_api.g_number
293 ,p_hold_applicant_date_until in date default hr_api.g_date
294 ,p_honors in varchar2 default hr_api.g_varchar2
295 ,p_internal_location in varchar2 default hr_api.g_varchar2
296 ,p_last_medical_test_by in varchar2 default hr_api.g_varchar2
297 ,p_last_medical_test_date in date default hr_api.g_date
298 ,p_mailstop in varchar2 default hr_api.g_varchar2
299 ,p_office_number in varchar2 default hr_api.g_varchar2
300 ,p_on_military_service in varchar2 default hr_api.g_varchar2
301 ,p_projected_start_date in date default hr_api.g_date
302 ,p_rehire_authorizor in varchar2 default hr_api.g_varchar2
303 ,p_rehire_recommendation in varchar2 default hr_api.g_varchar2
304 ,p_resume_exists in varchar2 default hr_api.g_varchar2
305 ,p_resume_last_updated in date default hr_api.g_date
306 ,p_second_passport_exists in varchar2 default hr_api.g_varchar2
307 ,p_student_status in varchar2 default hr_api.g_varchar2
308 ,p_work_schedule in varchar2 default hr_api.g_varchar2
309 ,p_rehire_reason in varchar2 default hr_api.g_varchar2
310 ,p_benefit_group_id in number default hr_api.g_number
311 ,p_receipt_of_death_cert_date in date default hr_api.g_date
312 ,p_coord_ben_med_pln_no in varchar2 default hr_api.g_varchar2
313 ,p_coord_ben_no_cvg_flag in varchar2 default hr_api.g_varchar2
314 ,p_coord_ben_med_ext_er in varchar2 default hr_api.g_varchar2
315 ,p_coord_ben_med_pl_name in varchar2 default hr_api.g_varchar2
316 ,p_coord_ben_med_insr_crr_name in varchar2 default hr_api.g_varchar2
317 ,p_coord_ben_med_insr_crr_ident in varchar2 default hr_api.g_varchar2
318 ,p_coord_ben_med_cvg_strt_dt in date default hr_api.g_date
319 ,p_coord_ben_med_cvg_end_dt in date default hr_api.g_date
320 ,p_uses_tobacco_flag in varchar2 default hr_api.g_varchar2
321 ,p_dpdnt_adoption_date in date default hr_api.g_date
322 ,p_dpdnt_vlntry_svce_flag in varchar2 default hr_api.g_varchar2
323 ,p_original_date_of_hire in date default hr_api.g_date
324 ,p_adjusted_svc_date in date default hr_api.g_date
325 ,p_town_of_birth in varchar2 default hr_api.g_varchar2
326 ,p_region_of_birth in varchar2 default hr_api.g_varchar2
327 ,p_country_of_birth in varchar2 default hr_api.g_varchar2
328 ,p_global_person_id in varchar2 default hr_api.g_varchar2
332 ,p_effective_end_date out nocopy date
329 ,p_party_id in number default hr_api.g_number
330 ,p_npw_number in varchar2 default hr_api.g_varchar2
331 ,p_effective_start_date out nocopy date
333 ,p_full_name out nocopy varchar2
334 ,p_comment_id out nocopy number
335 ,p_name_combination_warning out nocopy boolean
336 ,p_assign_payroll_warning out nocopy boolean
337 ,p_orig_hire_warning out nocopy boolean
338 );
339
340 end hr_sa_person_api;
[Home] [Help]