1 PACKAGE HR_FI_PERSON_API as
2 /* $Header: peperfii.pkh 120.5.12010000.1 2008/07/28 05:13:32 appldev ship $ */
3 /*#
4 * This package contains person APIs for Finland.
5 * @rep:scope public
6 * @rep:product PER
7 * @rep:displayname Person for Finland
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-----------------------------< update_fi_person >-------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * The following procedure updates the record of a Finnish Person.
17 *
18 * This API is effectively an alternative to the API update_person. If
19 * p_validate is set to false, then the person record is updated.
20 *
21 * <p><b>Licensing</b><br>
22 * This API is licensed for use with Human Resources.
23 *
24 * <p><b>Prerequisites</b><br>
25 * The person record must exist on the effective date.
26 *
27 * <p><b>Post Success</b><br>
28 * The person will have been updated.
29 *
30 * <p><b>Post Failure</b><br>
31 * The API does not update the person and raises an error.
32 *
33 * @param p_validate If true, then validation alone will be performed and the
34 * database will remain unchanged. If false and all validation checks pass,
35 * then the database will be modified.
36 * @param p_effective_date Determines when the DateTrack operation comes into
37 * force.
38 * @param p_datetrack_update_mode Indicates which DateTrack mode to use when
39 * updating the record. You must set to either UPDATE, CORRECTION,
40 * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
41 * particular record depend on the dates of previous record changes and the
42 * effective date of this change.
43 * @param p_person_id Person whose record needs to be modified.
44 * @param p_object_version_number Pass in the current version number of the
45 * person to be updated. When the API completes if p_validate is false, will be
46 * set to the new version number of the updated person. If p_validate is true
47 * will be set to the same value which was passed in.
48 * @param p_person_type_id Person Type id.
49 * @param p_last_name Last name of the person.
50 * @param p_applicant_number The business group's applicant number generation
51 * method determines when the API derives and passes out an applicant number or
52 * when the calling program should pass in a value. When the API call completes
53 * if p_validate is true then will be set to the applicant number. If
54 * p_validate is true then will be set to the passed value.
55 * @param p_comments Comment text.
56 * @param p_date_employee_data_verified The date on which the person data was
57 * last verified.
58 * @param p_date_of_birth Date of birth.
59 * @param p_email_address Email address.
60 * @param p_employee_number The business group's employee number generation
61 * method determines when you can update the employee value. To keep the
62 * existing employee number pass in hr_api.g_varchar2. When the API call
63 * completes if p_validate is false then will be set to the employee number. If
64 * p_validate is true then will be set to the passed value.
65 * @param p_expense_check_send_to_addres Address to use as mailing address.
66 * @param p_first_name Person's first name.
67 * @param p_known_as Alternative name.
68 * @param p_marital_status Marital status. Valid values are defined by
69 * 'MAR_STATUS' lookup type.
70 * @param p_nationality Person's nationality. Valid values are defined by
71 * 'NATIONALITY' lookup type.
72 * @param p_national_identifier National identifier.
73 * @param p_previous_last_name Previous last name.
74 * @param p_registered_disabled_flag Registered disabled flag.Valid values are
75 * defined by 'REGISTERED_DISABLED' lookup type.
76 * @param p_sex Legal gender. Valid values are defined by the SEX lookup type.
77 * @param p_title Person's title. Valid values are defined by 'TITLE' lookup
78 * type.
79 * @param p_vendor_id Obsolete parameter, do not use.
80 * @param p_work_telephone Obsolete parameter, do not use.
81 * @param p_attribute_category This context value determines which flexfield
82 * structure to use with the descriptive flexfield segments.
83 * @param p_attribute1 Descriptive flexfield segment.
84 * @param p_attribute2 Descriptive flexfield segment.
85 * @param p_attribute3 Descriptive flexfield segment.
86 * @param p_attribute4 Descriptive flexfield segment.
87 * @param p_attribute5 Descriptive flexfield segment.
88 * @param p_attribute6 Descriptive flexfield segment.
89 * @param p_attribute7 Descriptive flexfield segment.
90 * @param p_attribute8 Descriptive flexfield segment.
91 * @param p_attribute9 Descriptive flexfield segment.
92 * @param p_attribute10 Descriptive flexfield segment.
93 * @param p_attribute11 Descriptive flexfield segment.
94 * @param p_attribute12 Descriptive flexfield segment.
95 * @param p_attribute13 Descriptive flexfield segment.
96 * @param p_attribute14 Descriptive flexfield segment.
97 * @param p_attribute15 Descriptive flexfield segment.
98 * @param p_attribute16 Descriptive flexfield segment.
99 * @param p_attribute17 Descriptive flexfield segment.
100 * @param p_attribute18 Descriptive flexfield segment.
101 * @param p_attribute19 Descriptive flexfield segment.
102 * @param p_attribute20 Descriptive flexfield segment.
103 * @param p_attribute21 Descriptive flexfield segment.
104 * @param p_attribute22 Descriptive flexfield segment.
105 * @param p_attribute23 Descriptive flexfield segment.
106 * @param p_attribute24 Descriptive flexfield segment.
107 * @param p_attribute25 Descriptive flexfield segment.
108 * @param p_attribute26 Descriptive flexfield segment.
109 * @param p_attribute27 Descriptive flexfield segment.
110 * @param p_attribute28 Descriptive flexfield segment.
111 * @param p_attribute29 Descriptive flexfield segment.
112 * @param p_attribute30 Descriptive flexfield segment.
113 * @param p_place_of_residence Place of residence.
114 * @param p_secondary_email Secondary e-mail.
115 * @param p_epost_address E-post address.
116 * @param p_speed_dial_number Speed dial number.
117 * @param p_qualification Qualification.
118 * @param p_level Level.Valid values are defined by 'FI_QUAL_LEVEL' lookup
119 * type.
120 * @param p_field Field.Valid values are defined by 'FI_QUAL_FIELD' lookup
121 * type.
122 * @param p_retirement_date Retirement date.
123 * @param p_date_of_death Date of death.
124 * @param p_background_check_status Y/N flag indicates whether background check
125 * has been performed.
126 * @param p_background_date_check Date background check was performed.
127 * @param p_blood_type Blood group.
128 * @param p_correspondence_language Preferred language for correspondence.
129 * @param p_fast_path_employee Obsolete parameter, do not use.
130 * @param p_fte_capacity Currently unsupported.
131 * @param p_hold_applicant_date_until Date until when the applicant's
132 * information is to be maintained.
133 * @param p_honors Honors or degrees awarded.
134 * @param p_internal_location Internal location of office.
135 * @param p_last_medical_test_by Name of physician who performed last medical
136 * test.
137 * @param p_last_medical_test_date Date of last medical test.
138 * @param p_mailstop Internal mail location.
139 * @param p_office_number Office number.
140 * @param p_on_military_service Type of military service.
141 * @param p_projected_start_date Currently unsupported.
142 * @param p_rehire_authorizor Currently unsupported.
143 * @param p_rehire_recommendation Rehire recommendation.
144 * @param p_resume_exists Y/N flag indicating whether resume is on file.
145 * @param p_resume_last_updated Date on which the resume was last updated.
146 * @param p_second_passport_exists Y/N flag indicating whether person has
147 * multiple passports.
148 * @param p_student_status Type of student status.Valid values are defined by
149 * 'STUDENT_STATUS' lookup type.
150 * @param p_work_schedule Type of work schedule indicating which days person
151 * works.Valid values are defined by 'WORK_SCHEDULE' lookup type.
152 * @param p_rehire_reason Reason for re-hiring.
153 * @param p_benefit_group_id Benefit group id.
154 * @param p_receipt_of_death_cert_date Date the death certificate is received.
155 * @param p_coord_ben_med_pln_no Number of an externally provided medical plan.
156 * @param p_coord_ben_no_cvg_flag No other coverage flag.
157 * @param p_coord_ben_med_ext_er Secondary medical coverage external employer.
158 * @param p_coord_ben_med_pl_name Secondary medical coverage name.
159 * @param p_coord_ben_med_insr_crr_name Secondary medical coverage insurance
160 * carrier.
161 * @param p_coord_ben_med_insr_crr_ident Secondary medical coverage insurance
162 * carrier id.
163 * @param p_coord_ben_med_cvg_strt_dt Secondary medical coverage effective
164 * start date.
165 * @param p_coord_ben_med_cvg_end_dt Secondary medical coverage effective end
166 * date.
167 * @param p_uses_tobacco_flag Uses tobacco list of values.Valid values are
168 * defined by 'TOBACCO_USER' lookup type.
169 * @param p_dpdnt_adoption_date Dependent's adoption date.
170 * @param p_dpdnt_vlntry_svce_flag Dependent's voluntary service flag.
171 * @param p_original_date_of_hire Original date of hire.
172 * @param p_adjusted_svc_date Adjusted service date.
173 * @param p_town_of_birth Town or city of birth.
174 * @param p_region_of_birth Geographical region of birth.
175 * @param p_country_of_birth Country of birth.
176 * @param p_global_person_id Global ID for the person.
177 * @param p_party_id Party ID for the person.
178 * @param p_npw_number Non-payrolled worker number.
179 * @param p_effective_start_date If p_validate is false, then set to the
180 * effective start date on the updated person row which now exists as of the
181 * effective date. If p_validate is true, then set to null.
182 * @param p_effective_end_date If p_validate is false, then set to the
183 * effective end date on the updated person row which now exists as of the
184 * effective date. If p_validate is true, then set to null.
185 * @param p_full_name If p_validate is false, set to the complete full name of
186 * the person. If p_validate is true, set to null.
187 * @param p_comment_id If p_validate is false and new or existing comment text
188 * exists, then will be set to the identifier of the person comment record. If
189 * p_validate is true or no comment text exists, then will be null.
190 * @param p_name_combination_warning If set to true, then the combination of
191 * last name, first name and date of birth existed prior to calling this API.
192 * @param p_assign_payroll_warning If set to true, then the date of birth is
193 * not entered. If set to false, then the date of birth has been entered.
194 * Indicates if it will be possible to set the payroll on any of this person's
195 * assignments.
196 * @param p_orig_hire_warning If set to true, an orginal date of hire exists
197 * for a person who has never been an employee.
198 * @param p_union_name Name of the Trade Union to which the person belongs.
199 * @param p_membership_number Person's Trade Union membership number.
200 * @param p_payment_mode Mode of Payment. The lookup type
201 * 'FI_TRADE_UNION_FEE_TYPE' defines the valid values.
202 * @param p_fixed_amount Amount to deducted as Union membership
203 * fees.
204 * @param p_percentage Percentage of gross salary to deducted as Union
205 * membership fees.
206 * @param p_pension_joining_date Pension joining date.
207 * @param p_pension_type Type of Pension. The lookup type
208 * 'FI_PENSION_TYPES defines the valid values.
209 * @param p_pension_group Pension Group.
210 * @param p_planned_retirement_age Planned retirement date.
211 * @param p_membership_start_date Union membership start date.
212 * @param p_membership_end_date Union membership end date.
213 * @param p_termination_date Termination date.
214 * @param p_termination_reason Termination reason.
215 * @param p_mother_tongue Mother Tongue
216 * @param p_foreign_personal_id Foreign Personal ID
217 * @param p_pension_insurance_number Pension Insurance Number
218 * @rep:displayname Update Person for Finland
219 * @rep:category BUSINESS_ENTITY HR_PERSON
220 * @rep:lifecycle active
221 * @rep:scope public
222 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
223 */
224 --
225 -- {End Of Comments}
226 --
227 procedure update_fi_person
228 (p_validate in boolean default false
229 ,p_effective_date in date
230 ,p_datetrack_update_mode in varchar2
231 ,p_person_id in number
232 ,p_object_version_number in out nocopy number
233 ,p_person_type_id in number default hr_api.g_number
234 ,p_last_name in varchar2 default hr_api.g_varchar2
235 ,p_applicant_number in varchar2 default hr_api.g_varchar2
236 ,p_comments in varchar2 default hr_api.g_varchar2
237 ,p_date_employee_data_verified in date default hr_api.g_date
238 ,p_date_of_birth in date default hr_api.g_date
239 ,p_email_address in varchar2 default hr_api.g_varchar2
240 ,p_employee_number in out nocopy varchar2
241 ,p_expense_check_send_to_addres in varchar2 default hr_api.g_varchar2
242 ,p_first_name in varchar2 default hr_api.g_varchar2
243 ,p_known_as in varchar2 default hr_api.g_varchar2
244 ,p_marital_status in varchar2 default hr_api.g_varchar2
245 ,p_nationality in varchar2 default hr_api.g_varchar2
246 ,p_national_identifier in varchar2 default hr_api.g_varchar2
247 ,p_previous_last_name in varchar2 default hr_api.g_varchar2
248 ,p_registered_disabled_flag in varchar2 default hr_api.g_varchar2
249 ,p_sex in varchar2 default hr_api.g_varchar2
250 ,p_title in varchar2 default hr_api.g_varchar2
251 ,p_vendor_id in number default hr_api.g_number
252 ,p_work_telephone in varchar2 default hr_api.g_varchar2
253 ,p_attribute_category in varchar2 default hr_api.g_varchar2
254 ,p_attribute1 in varchar2 default hr_api.g_varchar2
255 ,p_attribute2 in varchar2 default hr_api.g_varchar2
256 ,p_attribute3 in varchar2 default hr_api.g_varchar2
257 ,p_attribute4 in varchar2 default hr_api.g_varchar2
258 ,p_attribute5 in varchar2 default hr_api.g_varchar2
259 ,p_attribute6 in varchar2 default hr_api.g_varchar2
260 ,p_attribute7 in varchar2 default hr_api.g_varchar2
261 ,p_attribute8 in varchar2 default hr_api.g_varchar2
262 ,p_attribute9 in varchar2 default hr_api.g_varchar2
263 ,p_attribute10 in varchar2 default hr_api.g_varchar2
264 ,p_attribute11 in varchar2 default hr_api.g_varchar2
265 ,p_attribute12 in varchar2 default hr_api.g_varchar2
266 ,p_attribute13 in varchar2 default hr_api.g_varchar2
267 ,p_attribute14 in varchar2 default hr_api.g_varchar2
268 ,p_attribute15 in varchar2 default hr_api.g_varchar2
269 ,p_attribute16 in varchar2 default hr_api.g_varchar2
270 ,p_attribute17 in varchar2 default hr_api.g_varchar2
271 ,p_attribute18 in varchar2 default hr_api.g_varchar2
272 ,p_attribute19 in varchar2 default hr_api.g_varchar2
273 ,p_attribute20 in varchar2 default hr_api.g_varchar2
274 ,p_attribute21 in varchar2 default hr_api.g_varchar2
275 ,p_attribute22 in varchar2 default hr_api.g_varchar2
276 ,p_attribute23 in varchar2 default hr_api.g_varchar2
277 ,p_attribute24 in varchar2 default hr_api.g_varchar2
278 ,p_attribute25 in varchar2 default hr_api.g_varchar2
279 ,p_attribute26 in varchar2 default hr_api.g_varchar2
280 ,p_attribute27 in varchar2 default hr_api.g_varchar2
281 ,p_attribute28 in varchar2 default hr_api.g_varchar2
282 ,p_attribute29 in varchar2 default hr_api.g_varchar2
283 ,p_attribute30 in varchar2 default hr_api.g_varchar2
284 ,p_place_of_residence in varchar2 default hr_api.g_varchar2
285 ,p_secondary_email in varchar2 default hr_api.g_varchar2
286 ,p_epost_address in varchar2 default hr_api.g_varchar2
287 ,p_speed_dial_number in varchar2 default hr_api.g_varchar2
288 ,p_qualification in varchar2 default hr_api.g_varchar2
289 ,p_level in varchar2 default hr_api.g_varchar2
290 ,p_field in varchar2 default hr_api.g_varchar2
291 ,p_retirement_date in varchar2 default hr_api.g_varchar2
292 ,p_union_name in varchar2 default hr_api.g_varchar2
293 ,p_membership_number in varchar2 default hr_api.g_varchar2
294 ,p_payment_mode in varchar2 default hr_api.g_varchar2
295 ,p_fixed_amount in varchar2 default hr_api.g_varchar2
296 ,p_percentage in varchar2 default hr_api.g_varchar2
297 ,p_pension_joining_date in varchar2 default hr_api.g_varchar2
298 ,p_pension_type in varchar2 default hr_api.g_varchar2
299 ,p_pension_group in varchar2 default hr_api.g_varchar2
300 ,p_planned_retirement_age in varchar2 default hr_api.g_varchar2
301 ,p_membership_start_date in varchar2 default hr_api.g_varchar2
302 ,p_membership_end_date in varchar2 default hr_api.g_varchar2
303 ,p_termination_date in varchar2 default hr_api.g_varchar2
304 ,p_termination_reason in varchar2 default hr_api.g_varchar2
305 ,p_mother_tongue in varchar2 default hr_api.g_varchar2
306 ,p_foreign_personal_id in varchar2 default hr_api.g_varchar2
307 ,p_pension_insurance_number in varchar2 default hr_api.g_varchar2
308 ,p_date_of_death in date default hr_api.g_date
309 ,p_background_check_status in varchar2 default hr_api.g_varchar2
310 ,p_background_date_check in date default hr_api.g_date
311 ,p_blood_type in varchar2 default hr_api.g_varchar2
312 ,p_correspondence_language in varchar2 default hr_api.g_varchar2
313 ,p_fast_path_employee in varchar2 default hr_api.g_varchar2
314 ,p_fte_capacity in number default hr_api.g_number
315 ,p_hold_applicant_date_until in date default hr_api.g_date
316 ,p_honors in varchar2 default hr_api.g_varchar2
317 ,p_internal_location in varchar2 default hr_api.g_varchar2
318 ,p_last_medical_test_by in varchar2 default hr_api.g_varchar2
319 ,p_last_medical_test_date in date default hr_api.g_date
320 ,p_mailstop in varchar2 default hr_api.g_varchar2
321 ,p_office_number in varchar2 default hr_api.g_varchar2
322 ,p_on_military_service in varchar2 default hr_api.g_varchar2
323 ,p_projected_start_date in date default hr_api.g_date
324 ,p_rehire_authorizor in varchar2 default hr_api.g_varchar2
325 ,p_rehire_recommendation in varchar2 default hr_api.g_varchar2
326 ,p_resume_exists in varchar2 default hr_api.g_varchar2
327 ,p_resume_last_updated in date default hr_api.g_date
328 ,p_second_passport_exists in varchar2 default hr_api.g_varchar2
329 ,p_student_status in varchar2 default hr_api.g_varchar2
330 ,p_work_schedule in varchar2 default hr_api.g_varchar2
331 ,p_rehire_reason in varchar2 default hr_api.g_varchar2
332 ,p_benefit_group_id in number default hr_api.g_number
333 ,p_receipt_of_death_cert_date in date default hr_api.g_date
334 ,p_coord_ben_med_pln_no in varchar2 default hr_api.g_varchar2
335 ,p_coord_ben_no_cvg_flag in varchar2 default hr_api.g_varchar2
336 ,p_coord_ben_med_ext_er in varchar2 default hr_api.g_varchar2
337 ,p_coord_ben_med_pl_name in varchar2 default hr_api.g_varchar2
338 ,p_coord_ben_med_insr_crr_name in varchar2 default hr_api.g_varchar2
339 ,p_coord_ben_med_insr_crr_ident in varchar2 default hr_api.g_varchar2
340 ,p_coord_ben_med_cvg_strt_dt in date default hr_api.g_date
341 ,p_coord_ben_med_cvg_end_dt in date default hr_api.g_date
342 ,p_uses_tobacco_flag in varchar2 default hr_api.g_varchar2
343 ,p_dpdnt_adoption_date in date default hr_api.g_date
344 ,p_dpdnt_vlntry_svce_flag in varchar2 default hr_api.g_varchar2
345 ,p_original_date_of_hire in date default hr_api.g_date
346 ,p_adjusted_svc_date in date default hr_api.g_date
347 ,p_town_of_birth in varchar2 default hr_api.g_varchar2
348 ,p_region_of_birth in varchar2 default hr_api.g_varchar2
349 ,p_country_of_birth in varchar2 default hr_api.g_varchar2
350 ,p_global_person_id in varchar2 default hr_api.g_varchar2
351 ,p_party_id in number default hr_api.g_number
352 ,p_npw_number in varchar2 default hr_api.g_varchar2
353 ,p_effective_start_date out nocopy date
354 ,p_effective_end_date out nocopy date
355 ,p_full_name out nocopy varchar2
356 ,p_comment_id out nocopy number
357 ,p_name_combination_warning out nocopy boolean
358 ,p_assign_payroll_warning out nocopy boolean
359 ,p_orig_hire_warning out nocopy boolean
360 );
361
362 end HR_FI_PERSON_API;