1 PACKAGE hr_in_person_api AUTHID CURRENT_USER AS
2 /* $Header: peperini.pkh 120.2 2007/10/05 11:23:04 sivanara noship $ */
3 /*#
4 * The package contains person APIs.
5 * @rep:scope public
6 * @rep:product PER
7 * @rep:displayname Person for India
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-----------------------------< update_in_person >-------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API updates the person record.
17 *
18 * This API updates the person record as identified by p_person_id and
19 * p_object_version_number. Note: The business group must have the IN
20 * legislation code.
21 *
22 * <p><b>Licensing</b><br>
23 * This API is licensed for use with Human Resources.
24 *
25 * <p><b>Prerequisites</b><br>
26 * The person record, identified by p_person_id and p_object_version_number,
27 * must already exist.
28 *
29 * <p><b>Post Success</b><br>
30 * Updates the person.
31 *
32 * <p><b>Post Failure</b><br>
33 * The API will not update the person and raises an error.
34 *
35 * @param p_validate If true, then validation alone will be performed and the
36 * database will remain unchanged. If false and all validation checks pass,
37 * then the database will be modified.
38 * @param p_effective_date Determines when the DateTrack operation comes into
39 * force.
40 * @param p_datetrack_update_mode Indicates which DateTrack mode to use when
41 * updating the record. You must set to either UPDATE, CORRECTION,
42 * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
43 * particular record depend on the dates of previous record changes and the
44 * effective date of this change.
45 * @param p_person_id Identifies the person record to modify.
46 * @param p_object_version_number Pass in the current version number of the
47 * person to be updated. When the API completes if p_validate is false, will be
48 * set to the new version number of the updated person. If p_validate is true
49 * will be set to the same value which was passed in.
50 * @param p_person_type_id The person type identification of the person record
51 * which needs to be updated.
52 * @param p_last_name Last name of the person.
53 * @param p_applicant_number Applicant number of the person.
54 * @param p_comments Comment text.
55 * @param p_date_employee_data_verified Date when the employee last verified
56 * the data.
57 * @param p_date_of_birth Date of birth of the person.
58 * @param p_email_address Email address of the person.
59 * @param p_employee_number The business group's employee number generation
60 * method determines when you can update the employee value. To keep the
61 * existing employee number pass in hr_api.g_varchar2. When the API call
62 * completes if p_validate is false then will be set to the employee number. If
63 * p_validate is true then will be set to the passed value.
64 * @param p_expense_check_send_to_addres Mailing address of the person.
65 * @param p_first_name First Name of the person.
66 * @param p_alias_name Preferred name of the person, if different from first
67 * name.
68 * @param p_marital_status Marital status of the person. Valid values are
69 * defined by 'MAR_STATUS' lookup type.
70 * @param p_middle_names Person's middle name(s).
71 * @param p_nationality Person's nationality. Valid values are defined by
72 * 'NATIONALITY' lookup type.
73 * @param p_ni_number National Identifier of the person.
74 * @param p_previous_last_name Previous last name of the person.
75 * @param p_registered_disabled_flag Indicates whether person is classified as
76 * disabled. Valid values are defined by 'REGISTERED_DISABLED' lookup type.
77 * @param p_sex Person's sex. Valid values are defined by 'SEX' lookup type.
78 * @param p_title Title of the person. Valid values are defined by 'TITLE'
79 * lookup type.
80 * @param p_vendor_id Identifier of workers supplying organization.
81 * @param p_work_telephone Work telephone of the person.
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_NSSN NSSN of the person. Should be 14 digit number.
115 * @param p_pan PAN of the person. Should be in correct format (XXXXX9999X).
116 * @param p_pan_af PAN Applied for Flag. Valid values are defined by 'YES_NO'
117 * lookup type. Has to be null if p_pan is populated.
118 * @param p_ex_serviceman Military Status. Valid values are defined by 'YES_NO'
119 * lookup type.
120 * @param p_resident_status Residential Status of the person. Valid values are
121 * defined by 'IN_RESIDENTIAL_STATUS' lookup type.
122 * @param p_pf_number PF Number of the person.
123 * @param p_esi_number ESI Nnumber of the person.
124 * @param p_superannuation_number Superannuation Number of the person.
125 * @param p_group_ins_number Group Insurance Number of the person.
126 * @param p_gratuity_number Gratuity Number of the person.
127 * @param p_pension_number Pension Number of the person.
128 * @param p_date_of_death Obsolete Parameter, do not use.
129 * @param p_background_check_status Y/N flag indicates whether background check
130 * has been performed.
131 * @param p_background_date_check Date background check was performed.
132 * @param p_blood_type Type of blood group of the employee. Valid values are
133 * defined by 'BLOOD_TYPE' lookup type
134 * @param p_correspondence_language Preferred language for correspondance.
135 * @param p_fast_path_employee Obsolete Parameter, do not use.
136 * @param p_fte_capacity Full-time employment capacity of the person.
137 * @param p_hold_applicant_date_until Date until which the applicant should be
138 * put on hold.
139 * @param p_honors Honors or degrees awarded.
140 * @param p_internal_location Internal location of office of the person.
141 * @param p_last_medical_test_by Name of physician who performed last medical
142 * test.
143 * @param p_last_medical_test_date Date of last medical test.
144 * @param p_mailstop Internal mail location for the person.
145 * @param p_office_number Office Number of the person.
146 * @param p_on_military_service Y/N flag indicating whether the person is
147 * employed in military service.
148 * @param p_pre_name_adjunct Name prefix.
149 * @param p_projected_start_date Obsolete Parameter, do not use.
150 * @param p_rehire_authorizor Obsolete Parameter, do not use.
151 * @param p_rehire_recommendation Re-hire recommendation
152 * @param p_resume_exists Y/N flag indicating whether resume is on file.
153 * @param p_resume_last_updated Date when the resume was last updated.
154 * @param p_second_passport_exists Y/N flag indicaing whether the person has
155 * multiple passports.
156 * @param p_student_status Full time/part time status of the person.
157 * @param p_work_schedule Type of work schedule indicating which days the
158 * person works. Valid values are defined by 'WORK_SCHEDULE' lookup type.
159 * @param p_rehire_reason Reason for re-hiring the person.
160 * @param p_suffix Person's suffix.
161 * @param p_benefit_group_id Identification for benefit group.
162 * @param p_receipt_of_death_cert_date Date death certificate is received.
163 * @param p_coord_ben_med_pln_no Number of an externally provided medical plan.
164 * @param p_coord_ben_no_cvg_flag No other coverage flag.
165 * @param p_coord_ben_med_ext_er Secondary medical coverage external employer.
166 * @param p_coord_ben_med_pl_name Secondary medical coverage name.
167 * @param p_coord_ben_med_insr_crr_name Secondary medical coverage insurance
168 * carrier.
169 * @param p_coord_ben_med_insr_crr_ident Identifier for secondary medical
170 * coverage insurance carrier.
171 * @param p_coord_ben_med_cvg_strt_dt Secondary medical coverage effective
172 * start date.
173 * @param p_coord_ben_med_cvg_end_dt Secondary medical coverage effective end
174 * date.
175 * @param p_uses_tobacco_flag Tobacco type used by the person. Valid values are
176 * defined by 'TOBACCO_USER' lookup type.
177 * @param p_dpdnt_adoption_date Date dependent was adopted.
178 * @param p_dpdnt_vlntry_svce_flag Indicates whether the dependent is on
179 * voluntary service.
180 * @param p_original_date_of_hire Original date of hire of the person.
181 * @param p_adjusted_svc_date Adjusted service date.
182 * @param p_place_of_birth Town or city of birth of the person.
183 * @param p_region_of_birth Geographical region of birth of the person.
184 * @param p_country_of_birth Country of birth of the person. Valid values are
185 * defined in FND_TERRITORIES.
186 * @param p_global_person_id Global Identification number for the person.
187 * @param p_party_id Identifier for the party.
188 * @param p_npw_number Number of non-payrolled worker.
189 * @param p_effective_start_date If p_validate is false, then set to the
190 * effective start date on the updated person row which now exists as of the
191 * effective date. If p_validate is true, then set to null.
192 * @param p_effective_end_date If p_validate is false, then set to the
193 * effective end date on the updated person row which now exists as of the
194 * effective date. If p_validate is true, then set to null.
195 * @param p_full_name If p_validate is false, set to the complete full name of
196 * the person. If p_validate is true, set to null.
197 * @param p_comment_id If p_validate is false and new or existing comment text
198 * exists, then will be set to the identifier of the person comment record. If
199 * p_validate is true or no comment text exists, then will be null.
200 * @param p_name_combination_warning If set to true, then the combination of
201 * last name, first name and date of birth existed prior to calling this API.
202 * @param p_assign_payroll_warning If set to true, then the date of birth is
203 * not entered. If set to false, then the date of birth has been entered.
204 * Indicates if it will be possible to set the payroll on any of this person's
205 * assignments.
206 * @param p_orig_hire_warning Set to true if the original date of hire is not
207 * null and the person type is not EMP,EMP_APL, EX_EMP or EX_EMP_APL..
208 * @rep:displayname Update Person for India
209 * @rep:category BUSINESS_ENTITY HR_PERSON
210 * @rep:lifecycle active
211 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
212 * @rep:scope public
213 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
214 */
215 --
216 -- {End Of Comments}
217 --
218 procedure update_in_person
219 (p_validate in boolean default false
220 ,p_effective_date in date
221 ,p_datetrack_update_mode in varchar2
222 ,p_person_id in number
223 ,p_object_version_number in out nocopy number
224 ,p_person_type_id in number default hr_api.g_number
225 ,p_last_name in varchar2 default hr_api.g_varchar2
226 ,p_applicant_number in varchar2 default hr_api.g_varchar2
227 ,p_comments in varchar2 default hr_api.g_varchar2
228 ,p_date_employee_data_verified in date default hr_api.g_date
229 ,p_date_of_birth in date default hr_api.g_date
230 ,p_email_address in varchar2 default hr_api.g_varchar2
231 ,p_employee_number in out nocopy varchar2
232 ,p_expense_check_send_to_addres in varchar2 default hr_api.g_varchar2
233 ,p_first_name in varchar2 default hr_api.g_varchar2
234 ,p_alias_name in varchar2 default hr_api.g_varchar2 --Bugfix 3762728
235 ,p_marital_status in varchar2 default hr_api.g_varchar2
236 ,p_middle_names in varchar2 default hr_api.g_varchar2
237 ,p_nationality in varchar2 default hr_api.g_varchar2
238 ,p_ni_number in varchar2 default hr_api.g_varchar2
239 ,p_previous_last_name in varchar2 default hr_api.g_varchar2
240 ,p_registered_disabled_flag in varchar2 default hr_api.g_varchar2
241 ,p_sex in varchar2 default hr_api.g_varchar2
242 ,p_title in varchar2 default hr_api.g_varchar2
243 ,p_vendor_id in number default hr_api.g_number
244 ,p_work_telephone in varchar2 default hr_api.g_varchar2
245 ,p_attribute_category in varchar2 default hr_api.g_varchar2
246 ,p_attribute1 in varchar2 default hr_api.g_varchar2
247 ,p_attribute2 in varchar2 default hr_api.g_varchar2
248 ,p_attribute3 in varchar2 default hr_api.g_varchar2
249 ,p_attribute4 in varchar2 default hr_api.g_varchar2
250 ,p_attribute5 in varchar2 default hr_api.g_varchar2
251 ,p_attribute6 in varchar2 default hr_api.g_varchar2
252 ,p_attribute7 in varchar2 default hr_api.g_varchar2
253 ,p_attribute8 in varchar2 default hr_api.g_varchar2
254 ,p_attribute9 in varchar2 default hr_api.g_varchar2
255 ,p_attribute10 in varchar2 default hr_api.g_varchar2
256 ,p_attribute11 in varchar2 default hr_api.g_varchar2
257 ,p_attribute12 in varchar2 default hr_api.g_varchar2
258 ,p_attribute13 in varchar2 default hr_api.g_varchar2
259 ,p_attribute14 in varchar2 default hr_api.g_varchar2
260 ,p_attribute15 in varchar2 default hr_api.g_varchar2
261 ,p_attribute16 in varchar2 default hr_api.g_varchar2
262 ,p_attribute17 in varchar2 default hr_api.g_varchar2
263 ,p_attribute18 in varchar2 default hr_api.g_varchar2
264 ,p_attribute19 in varchar2 default hr_api.g_varchar2
265 ,p_attribute20 in varchar2 default hr_api.g_varchar2
266 ,p_attribute21 in varchar2 default hr_api.g_varchar2
267 ,p_attribute22 in varchar2 default hr_api.g_varchar2
268 ,p_attribute23 in varchar2 default hr_api.g_varchar2
269 ,p_attribute24 in varchar2 default hr_api.g_varchar2
270 ,p_attribute25 in varchar2 default hr_api.g_varchar2
271 ,p_attribute26 in varchar2 default hr_api.g_varchar2
272 ,p_attribute27 in varchar2 default hr_api.g_varchar2
273 ,p_attribute28 in varchar2 default hr_api.g_varchar2
274 ,p_attribute29 in varchar2 default hr_api.g_varchar2
275 ,p_attribute30 in varchar2 default hr_api.g_varchar2
276 ,p_pan in varchar2 default hr_api.g_varchar2
277 ,p_pan_af in varchar2 default hr_api.g_varchar2
278 ,p_ex_serviceman in varchar2 default hr_api.g_varchar2 --Bugfix 3762728
279 ,p_resident_status in varchar2 default hr_api.g_varchar2
280 ,p_pf_number in varchar2 default hr_api.g_varchar2
281 ,p_esi_number in varchar2 default hr_api.g_varchar2
282 ,p_superannuation_number in varchar2 default hr_api.g_varchar2
283 ,p_group_ins_number in varchar2 default hr_api.g_varchar2
284 ,p_gratuity_number in varchar2 default hr_api.g_varchar2
285 ,p_pension_number in varchar2 default hr_api.g_varchar2
286 ,p_NSSN in varchar2 default hr_api.g_varchar2
287 --,p_employee_category IN varchar2 default hr_api.g_varchar2
288 ,p_date_of_death in date default hr_api.g_date
289 ,p_background_check_status in varchar2 default hr_api.g_varchar2
290 ,p_background_date_check in date default hr_api.g_date
291 ,p_blood_type in varchar2 default hr_api.g_varchar2
292 ,p_correspondence_language in varchar2 default hr_api.g_varchar2
293 ,p_fast_path_employee in varchar2 default hr_api.g_varchar2
294 ,p_fte_capacity in number default hr_api.g_number
295 ,p_hold_applicant_date_until in date default hr_api.g_date
296 ,p_honors in varchar2 default hr_api.g_varchar2
297 ,p_internal_location in varchar2 default hr_api.g_varchar2
298 ,p_last_medical_test_by in varchar2 default hr_api.g_varchar2
299 ,p_last_medical_test_date in date default hr_api.g_date
300 ,p_mailstop in varchar2 default hr_api.g_varchar2
301 ,p_office_number in varchar2 default hr_api.g_varchar2
302 ,p_on_military_service in varchar2 default hr_api.g_varchar2
303 ,p_pre_name_adjunct in varchar2 default hr_api.g_varchar2
304 ,p_projected_start_date in date default hr_api.g_date
305 ,p_rehire_authorizor in varchar2 default hr_api.g_varchar2
306 ,p_rehire_recommendation in varchar2 default hr_api.g_varchar2
307 ,p_resume_exists in varchar2 default hr_api.g_varchar2
308 ,p_resume_last_updated in date default hr_api.g_date
309 ,p_second_passport_exists in varchar2 default hr_api.g_varchar2
310 ,p_student_status in varchar2 default hr_api.g_varchar2
311 ,p_work_schedule in varchar2 default hr_api.g_varchar2
312 ,p_rehire_reason in varchar2 default hr_api.g_varchar2
313 ,p_suffix in varchar2 default hr_api.g_varchar2
314 ,p_benefit_group_id in number default hr_api.g_number
315 ,p_receipt_of_death_cert_date in date default hr_api.g_date
316 ,p_coord_ben_med_pln_no in varchar2 default hr_api.g_varchar2
317 ,p_coord_ben_no_cvg_flag in varchar2 default hr_api.g_varchar2
318 ,p_coord_ben_med_ext_er in varchar2 default hr_api.g_varchar2
319 ,p_coord_ben_med_pl_name in varchar2 default hr_api.g_varchar2
320 ,p_coord_ben_med_insr_crr_name in varchar2 default hr_api.g_varchar2
321 ,p_coord_ben_med_insr_crr_ident in varchar2 default hr_api.g_varchar2
322 ,p_coord_ben_med_cvg_strt_dt in date default hr_api.g_date
323 ,p_coord_ben_med_cvg_end_dt in date default hr_api.g_date
324 ,p_uses_tobacco_flag in varchar2 default hr_api.g_varchar2
325 ,p_dpdnt_adoption_date in date default hr_api.g_date
326 ,p_dpdnt_vlntry_svce_flag in varchar2 default hr_api.g_varchar2
327 ,p_original_date_of_hire in date default hr_api.g_date
328 ,p_adjusted_svc_date in date default hr_api.g_date
329 ,p_place_of_birth in varchar2 default hr_api.g_varchar2 --Bugfix 3762728
330 ,p_region_of_birth in varchar2 default hr_api.g_varchar2
331 ,p_country_of_birth in varchar2 default hr_api.g_varchar2
332 ,p_global_person_id in varchar2 default hr_api.g_varchar2
333 ,p_party_id in number default hr_api.g_number
334 ,p_npw_number in varchar2 default hr_api.g_varchar2
335 ,p_effective_start_date out nocopy date
336 ,p_effective_end_date out nocopy date
337 ,p_full_name out nocopy varchar2
338 ,p_comment_id out nocopy number
339 ,p_name_combination_warning out nocopy boolean
340 ,p_assign_payroll_warning out nocopy boolean
341 ,p_orig_hire_warning out nocopy boolean
342 );
343
344 END hr_in_person_api;
[Home] [Help]