1 Package hr_fr_person_api as
2 /* $Header: peperfri.pkh 120.1 2005/10/02 02:20:54 aroussel $ */
3 /*#
4 * This package contains an API to maintain a person record for France.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Person for France
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-----------------------------< update_fr_person >-------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API updates a person in a business group for France.
17 *
18 * This API updates the French person record as identified by p_person_id and
19 * p_object_version_number. Note: The business group must have the FR
20 * legislation code. This API is an alternative to the update_person API. See
21 * update_person API for further details.
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 * The person record, identified by p_person_id and p_object_version_number,
28 * must already exist.
29 *
30 * <p><b>Post Success</b><br>
31 * The person record is successfully updated in the database.
32 *
33 * <p><b>Post Failure</b><br>
34 * The API will not update the person and raises an error.
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 Person whose record needs to be modified.
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 Type of person being updated.
51 * @param p_last_name Last name.
52 * @param p_applicant_number The business group's applicant number generation
53 * method determines when the API derives and passes out an applicant number or
54 * when the calling program should pass in a value. When the API call completes
55 * if p_validate is true then will be set to the applicant number. If
56 * p_validate is true then will be set to the passed value.
57 * @param p_comments Comment text.
58 * @param p_date_employee_data_verified The date on which the person data was
59 * last verified.
60 * @param p_date_of_birth Date of birth.
61 * @param p_email_address Email address.
62 * @param p_employee_number The business group's employee number generation
63 * method determines when the API derives and passes out an employee number or
64 * when the calling program should pass in a value. When the API call completes
65 * if p_validate is false then will be set to the employee number. If
66 * p_validate is true then will be set to the passed value.
67 * @param p_expense_check_send_to_addres Mailing address.
68 * @param p_first_name First name.
69 * @param p_known_as Preferred name.
70 * @param p_marital_status Marital status. Valid values are defined by the
71 * MAR_STATUS lookup type.
72 * @param p_middle_names Middle names.
73 * @param p_nationality Nationality. Valid values are defined by the
74 * NATIONALITY lookup type.
75 * @param p_ni_number National Insurance number used to identify a person in
76 * the format for France.
77 * @param p_previous_last_name Previous last name.
78 * @param p_registered_disabled_flag Flag indicating whether the person is
79 * classified as disabled.
80 * @param p_sex Legal gender. Valid values are defined by the SEX lookup type.
81 * @param p_title Title. Valid values are defined by the TITLE lookup type.
82 * @param p_vendor_id Obsolete parameter, do not use.
83 * @param p_work_telephone Obsolete parameter, do not use.
84 * @param p_attribute_category This context value determines which flexfield
85 * structure to use with the descriptive flexfield segments.
86 * @param p_attribute1 Descriptive flexfield segment.
87 * @param p_attribute2 Descriptive flexfield segment.
88 * @param p_attribute3 Descriptive flexfield segment.
89 * @param p_attribute4 Descriptive flexfield segment.
90 * @param p_attribute5 Descriptive flexfield segment.
91 * @param p_attribute6 Descriptive flexfield segment.
92 * @param p_attribute7 Descriptive flexfield segment.
93 * @param p_attribute8 Descriptive flexfield segment.
94 * @param p_attribute9 Descriptive flexfield segment.
95 * @param p_attribute10 Descriptive flexfield segment.
96 * @param p_attribute11 Descriptive flexfield segment.
97 * @param p_attribute12 Descriptive flexfield segment.
98 * @param p_attribute13 Descriptive flexfield segment.
99 * @param p_attribute14 Descriptive flexfield segment.
100 * @param p_attribute15 Descriptive flexfield segment.
101 * @param p_attribute16 Descriptive flexfield segment.
102 * @param p_attribute17 Descriptive flexfield segment.
103 * @param p_attribute18 Descriptive flexfield segment.
104 * @param p_attribute19 Descriptive flexfield segment.
105 * @param p_attribute20 Descriptive flexfield segment.
106 * @param p_attribute21 Descriptive flexfield segment.
107 * @param p_attribute22 Descriptive flexfield segment.
108 * @param p_attribute23 Descriptive flexfield segment.
109 * @param p_attribute24 Descriptive flexfield segment.
110 * @param p_attribute25 Descriptive flexfield segment.
111 * @param p_attribute26 Descriptive flexfield segment.
112 * @param p_attribute27 Descriptive flexfield segment.
113 * @param p_attribute28 Descriptive flexfield segment.
114 * @param p_attribute29 Descriptive flexfield segment.
115 * @param p_attribute30 Descriptive flexfield segment.
116 * @param p_maiden_name Maiden name
117 * @param p_department_of_birth Department. Valid values exist in the
118 * 'FR_DEPARTMENT' lookup type.
119 * @param p_town_of_birth Town of birth
120 * @param p_country_of_birth Country of birth. Valid values are defined by
121 * values in FND_TERRITORIES.
122 * @param p_number_of_dependents Number of dependents
123 * @param p_military_status Military status. Valid values are defined by the
124 * 'FR_MILITARY_SERVICE_STATUS' lookup type.
125 * @param p_date_last_school_certificate Date of last school certificate
126 * @param p_school_name School name
127 * @param p_level_of_education Level of education. Valid values exist in
128 * PER_QUALIFICATION_TYPES.
129 * @param p_date_first_entry_into_france Date of first entry into France
130 * @param p_cpam_name A valid CPAM organization name defined in your business
131 * group.
132 * @param p_date_of_death Date of death.
133 * @param p_background_check_status Flag indicating whether the person's
134 * background has been checked.
135 * @param p_background_date_check Date on which the background check was
136 * performed.
137 * @param p_blood_type Blood type.
138 * @param p_correspondence_language Preferred language for correspondence.
139 * @param p_fast_path_employee Obsolete parameter, do not use.
140 * @param p_fte_capacity Obsolete parameter, do not use.
141 * @param p_hold_applicant_date_until Date until when the applicant's
142 * information is to be maintained.
143 * @param p_honors Honors awarded.
144 * @param p_internal_location Internal location of office.
145 * @param p_last_medical_test_by Name of physician who performed the last
146 * medical test.
147 * @param p_last_medical_test_date Date of last medical test.
148 * @param p_mailstop Internal mail location.
149 * @param p_office_number Office number.
150 * @param p_on_military_service Flag indicating whether the person is on
151 * military service.
152 * @param p_pre_name_adjunct First part of the last name.
153 * @param p_projected_start_date Obsolete parameter, do not use.
154 * @param p_rehire_authorizor Obsolete parameter, do not use.
155 * @param p_rehire_recommendation Flag indicating whether this person should be
156 * considered for rehire. Valid values are defined in YES_NO lookup type.
157 * @param p_resume_exists Flag indicating whether the person's resume is on
158 * file.
159 * @param p_resume_last_updated Date on which the resume was last updated.
160 * @param p_second_passport_exists Flag indicating whether a person has
161 * multiple passports.
162 * @param p_student_status If this person is a student, this field is used to
163 * capture their status. Valid values are defined by the STUDENT_STATUS lookup
164 * type.
165 * @param p_work_schedule Days on which this person will work.
166 * @param p_rehire_reason Rehire reason.
167 * @param p_suffix Suffix after the person's last name e.g. Sr., Jr., III.
168 * @param p_benefit_group_id Benefit group to which this person will belong.
169 * @param p_receipt_of_death_cert_date Date death certificate was received.
170 * @param p_coord_ben_med_pln_no Secondary medical plan name. Column used for
171 * external processing.
172 * @param p_coord_ben_no_cvg_flag No secondary medical plan coverage. Column
173 * used for external processing.
174 * @param p_uses_tobacco_flag Flag indicating whether the person uses tobacco.
175 * @param p_dpdnt_adoption_date Date on which the dependent was adopted.
176 * @param p_dpdnt_vlntry_svce_flag Flag indicating whether the dependent is on
177 * voluntary service.
178 * @param p_original_date_of_hire Original date of hire.
179 * @param p_adjusted_svc_date Adjusted service date.
180 * @param p_effective_start_date If p_validate is false, then set to the
181 * effective start date on the updated person row which now exists as of the
182 * effective date. If p_validate is true, then set to null.
183 * @param p_effective_end_date If p_validate is false, then set to the
184 * effective end date on the updated person row which now exists as of the
185 * effective date. If p_validate is true, then set to null.
186 * @param p_full_name If p_validate is false, then set to the complete full
187 * name of the person. If p_validate is true, then set to null.
188 * @param p_comment_id If p_validate is false and comment text was provided,
189 * then will be set to the identifier of the created person comment record. If
190 * p_validate is true or no comment text was provided, then will be null.
191 * @param p_name_combination_warning If set to true, then the combination of
192 * last name, first name and date of birth existed prior to calling this API.
193 * @param p_assign_payroll_warning If set to true, then the date of birth is
194 * not entered. If set to false, then the date of birth has been entered.
195 * Indicates if it will be possible to set the payroll on any of this person's
196 * assignments.
197 * @param p_orig_hire_warning If set to true, an orginal date of hire exists
198 * for a person who has never been an employee.
199 * @rep:displayname Update Person for France
200 * @rep:category BUSINESS_ENTITY HR_PERSON
201 * @rep:scope public
202 * @rep:lifecycle active
203 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
204 */
205 --
206 -- {End Of Comments}
207 --
208 procedure update_fr_person
209 (p_validate in boolean default false
210 ,p_effective_date in date
211 ,p_datetrack_update_mode in varchar2
212 ,p_person_id in number
213 ,p_object_version_number in out nocopy number
214 ,p_person_type_id in number default hr_api.g_number
215 ,p_last_name in varchar2 default hr_api.g_varchar2
216 ,p_applicant_number in varchar2 default hr_api.g_varchar2
217 ,p_comments in varchar2 default hr_api.g_varchar2
218 ,p_date_employee_data_verified in date default hr_api.g_date
219 ,p_date_of_birth in date default hr_api.g_date
220 ,p_email_address in varchar2 default hr_api.g_varchar2
221 ,p_employee_number in out nocopy varchar2
222 ,p_expense_check_send_to_addres in varchar2 default hr_api.g_varchar2
223 ,p_first_name in varchar2 default hr_api.g_varchar2
224 ,p_known_as in varchar2 default hr_api.g_varchar2
225 ,p_marital_status in varchar2 default hr_api.g_varchar2
226 ,p_middle_names in varchar2 default hr_api.g_varchar2
227 ,p_nationality in varchar2 default hr_api.g_varchar2
228 ,p_ni_number in varchar2 default hr_api.g_varchar2
229 ,p_previous_last_name in varchar2 default hr_api.g_varchar2
230 ,p_registered_disabled_flag in varchar2 default hr_api.g_varchar2
231 ,p_sex in varchar2 default hr_api.g_varchar2
232 ,p_title in varchar2 default hr_api.g_varchar2
233 ,p_vendor_id in number default hr_api.g_number
234 ,p_work_telephone in varchar2 default hr_api.g_varchar2
235 ,p_attribute_category in varchar2 default hr_api.g_varchar2
236 ,p_attribute1 in varchar2 default hr_api.g_varchar2
237 ,p_attribute2 in varchar2 default hr_api.g_varchar2
238 ,p_attribute3 in varchar2 default hr_api.g_varchar2
239 ,p_attribute4 in varchar2 default hr_api.g_varchar2
240 ,p_attribute5 in varchar2 default hr_api.g_varchar2
241 ,p_attribute6 in varchar2 default hr_api.g_varchar2
242 ,p_attribute7 in varchar2 default hr_api.g_varchar2
243 ,p_attribute8 in varchar2 default hr_api.g_varchar2
244 ,p_attribute9 in varchar2 default hr_api.g_varchar2
245 ,p_attribute10 in varchar2 default hr_api.g_varchar2
246 ,p_attribute11 in varchar2 default hr_api.g_varchar2
247 ,p_attribute12 in varchar2 default hr_api.g_varchar2
248 ,p_attribute13 in varchar2 default hr_api.g_varchar2
249 ,p_attribute14 in varchar2 default hr_api.g_varchar2
250 ,p_attribute15 in varchar2 default hr_api.g_varchar2
251 ,p_attribute16 in varchar2 default hr_api.g_varchar2
252 ,p_attribute17 in varchar2 default hr_api.g_varchar2
253 ,p_attribute18 in varchar2 default hr_api.g_varchar2
254 ,p_attribute19 in varchar2 default hr_api.g_varchar2
255 ,p_attribute20 in varchar2 default hr_api.g_varchar2
256 ,p_attribute21 in varchar2 default hr_api.g_varchar2
257 ,p_attribute22 in varchar2 default hr_api.g_varchar2
258 ,p_attribute23 in varchar2 default hr_api.g_varchar2
259 ,p_attribute24 in varchar2 default hr_api.g_varchar2
260 ,p_attribute25 in varchar2 default hr_api.g_varchar2
261 ,p_attribute26 in varchar2 default hr_api.g_varchar2
262 ,p_attribute27 in varchar2 default hr_api.g_varchar2
263 ,p_attribute28 in varchar2 default hr_api.g_varchar2
264 ,p_attribute29 in varchar2 default hr_api.g_varchar2
265 ,p_attribute30 in varchar2 default hr_api.g_varchar2
266 ,p_maiden_name in varchar2 default hr_api.g_varchar2
267 ,p_department_of_birth in varchar2 default hr_api.g_varchar2
268 ,p_town_of_birth in varchar2 default hr_api.g_varchar2
269 ,p_country_of_birth in varchar2 default hr_api.g_varchar2
270 ,p_number_of_dependents in varchar2 default hr_api.g_varchar2
271 ,p_military_status in varchar2 default hr_api.g_varchar2
272 ,p_date_last_school_certificate in varchar2 default hr_api.g_varchar2
273 ,p_school_name in varchar2 default hr_api.g_varchar2
274 ,p_level_of_education in varchar2 default hr_api.g_varchar2
275 ,p_date_first_entry_into_france in varchar2 default hr_api.g_varchar2
276 ,p_cpam_name in varchar2 default hr_api.g_varchar2
277 ,p_date_of_death in date default hr_api.g_date
278 ,p_background_check_status in varchar2 default hr_api.g_varchar2
279 ,p_background_date_check in date default hr_api.g_date
280 ,p_blood_type in varchar2 default hr_api.g_varchar2
281 ,p_correspondence_language in varchar2 default hr_api.g_varchar2
282 ,p_fast_path_employee in varchar2 default hr_api.g_varchar2
283 ,p_fte_capacity in number default hr_api.g_number
284 ,p_hold_applicant_date_until in date default hr_api.g_date
285 ,p_honors in varchar2 default hr_api.g_varchar2
286 ,p_internal_location in varchar2 default hr_api.g_varchar2
287 ,p_last_medical_test_by in varchar2 default hr_api.g_varchar2
288 ,p_last_medical_test_date in date default hr_api.g_date
289 ,p_mailstop in varchar2 default hr_api.g_varchar2
290 ,p_office_number in varchar2 default hr_api.g_varchar2
291 ,p_on_military_service in varchar2 default hr_api.g_varchar2
292 ,p_pre_name_adjunct in varchar2 default hr_api.g_varchar2
293 ,p_projected_start_date in date default hr_api.g_date
294 ,p_rehire_authorizor in varchar2 default hr_api.g_varchar2
295 ,p_rehire_recommendation in varchar2 default hr_api.g_varchar2
296 ,p_resume_exists in varchar2 default hr_api.g_varchar2
297 ,p_resume_last_updated in date default hr_api.g_date
298 ,p_second_passport_exists in varchar2 default hr_api.g_varchar2
299 ,p_student_status in varchar2 default hr_api.g_varchar2
300 ,p_work_schedule in varchar2 default hr_api.g_varchar2
301 ,p_rehire_reason in varchar2 default hr_api.g_varchar2
302 ,p_suffix in varchar2 default hr_api.g_varchar2
303 ,p_benefit_group_id in number default hr_api.g_number
304 ,p_receipt_of_death_cert_date in date default hr_api.g_date
305 ,p_coord_ben_med_pln_no in varchar2 default hr_api.g_varchar2
306 ,p_coord_ben_no_cvg_flag in varchar2 default hr_api.g_varchar2
307 ,p_uses_tobacco_flag in varchar2 default hr_api.g_varchar2
308 ,p_dpdnt_adoption_date in date default hr_api.g_date
309 ,p_dpdnt_vlntry_svce_flag in varchar2 default hr_api.g_varchar2
310 ,p_original_date_of_hire in date default hr_api.g_date
311 ,p_adjusted_svc_date in date default hr_api.g_date
312 ,p_effective_start_date out nocopy date
313 ,p_effective_end_date out nocopy date
314 ,p_full_name out nocopy varchar2
315 ,p_comment_id out nocopy number
316 ,p_name_combination_warning out nocopy boolean
317 ,p_assign_payroll_warning out nocopy boolean
318 ,p_orig_hire_warning out nocopy boolean
319 );
320 --
321 end hr_fr_person_api;