1 Package hr_be_employee_api as
2 /* $Header: peempbei.pkh 120.1 2005/10/02 02:15:54 aroussel $ */
3 /*#
4 * This package contains employee APIs for Belgium.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Employee for Belgium
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------------< create_be_employee >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a new employee for Belgium, including a default primary
17 * assignment and a period of service for the employee.
18 *
19 * The API calls the generic API create_employee, with the parameters set as
20 * appropriate for a BE employee. See the create_employee API for further
21 * documentaion as this API is effectively an alternative.
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_employee.
28 *
29 * <p><b>Post Success</b><br>
30 * The person, primary assignment and period of service are successfully
31 * inserted into the database.
32 *
33 * <p><b>Post Failure</b><br>
34 * The API does not create the employee, default assignment or period of
35 * service and raises an 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_hire_date Hire Date.
40 * @param p_business_group_id Business group of the person.
41 * @param p_last_name Last name.
42 * @param p_sex Legal gender. Valid values are defined by the SEX lookup type.
43 * @param p_person_type_id Type of employee being created.
44 * @param p_per_comments Person comment text
45 * @param p_date_employee_data_verified The date on which the employee data was
46 * last verified.
47 * @param p_date_of_birth Date of birth.
48 * @param p_email_address Email address.
49 * @param p_employee_number The business group's employee number generation
50 * method determines when the API derives and passes out an employee number or
51 * when the calling program should pass in a value. When the API call completes
52 * if p_validate is false then will be set to the employee number. If
53 * p_validate is true then will be set to the passed value.
54 * @param p_expense_check_send_to_addres Mailing address.
55 * @param p_first_name First name.
56 * @param p_known_as Preferred name.
57 * @param p_marital_status Marital status. Valid values are defined by the
58 * MAR_STATUS lookup type.
59 * @param p_middle_names Middle names.
60 * @param p_nationality Nationality. Valid values are defined by the
61 * NATIONALITY lookup type.
62 * @param p_ni_number National Insurance number used to identify an employee in
63 * Belgium.
64 * @param p_previous_last_name Previous last name.
65 * @param p_registered_disabled_flag Flag indicating whether the person is
66 * classified as disabled.
67 * @param p_title Title. Valid values are defined by the TITLE lookup type.
68 * @param p_vendor_id Obsolete parameter, do not use.
69 * @param p_work_telephone Obsolete parameter, do not use.
70 * @param p_attribute_category This context value determines which flexfield
71 * structure to use with the descriptive flexfield segments.
72 * @param p_attribute1 Descriptive flexfield segment.
73 * @param p_attribute2 Descriptive flexfield segment.
74 * @param p_attribute3 Descriptive flexfield segment.
75 * @param p_attribute4 Descriptive flexfield segment.
76 * @param p_attribute5 Descriptive flexfield segment.
77 * @param p_attribute6 Descriptive flexfield segment.
78 * @param p_attribute7 Descriptive flexfield segment.
79 * @param p_attribute8 Descriptive flexfield segment.
80 * @param p_attribute9 Descriptive flexfield segment.
81 * @param p_attribute10 Descriptive flexfield segment.
82 * @param p_attribute11 Descriptive flexfield segment.
83 * @param p_attribute12 Descriptive flexfield segment.
84 * @param p_attribute13 Descriptive flexfield segment.
85 * @param p_attribute14 Descriptive flexfield segment.
86 * @param p_attribute15 Descriptive flexfield segment.
87 * @param p_attribute16 Descriptive flexfield segment.
88 * @param p_attribute17 Descriptive flexfield segment.
89 * @param p_attribute18 Descriptive flexfield segment.
90 * @param p_attribute19 Descriptive flexfield segment.
91 * @param p_attribute20 Descriptive flexfield segment.
92 * @param p_attribute21 Descriptive flexfield segment.
93 * @param p_attribute22 Descriptive flexfield segment.
94 * @param p_attribute23 Descriptive flexfield segment.
95 * @param p_attribute24 Descriptive flexfield segment.
96 * @param p_attribute25 Descriptive flexfield segment.
97 * @param p_attribute26 Descriptive flexfield segment.
98 * @param p_attribute27 Descriptive flexfield segment.
99 * @param p_attribute28 Descriptive flexfield segment.
100 * @param p_attribute29 Descriptive flexfield segment.
101 * @param p_attribute30 Descriptive flexfield segment.
102 * @param p_previous_employment_end_date The date left previous employment
103 * @param p_child_allowance_reg Child Allowance registration
104 * @param p_holiday_insurance_reg Holiday Insurance registration
105 * @param p_pension_registration Pension registration
106 * @param p_id_number ID number
107 * @param p_registered_disabled_ind Obsolete parameter, do not use
108 * @param p_percentage_disabled Obsolete parameter, do not use
109 * @param p_school_leaver School Leaver (Y/N)
110 * @param p_date_of_death Date of death.
111 * @param p_background_check_status Flag indicating whether the person's
112 * background has been checked.
113 * @param p_background_date_check Date on which the background check was
114 * performed.
115 * @param p_blood_type Blood type.
116 * @param p_correspondence_language Preferred language for correspondence.
117 * @param p_fast_path_employee New parameter, available on the latest version
118 * of this API.
119 * @param p_fte_capacity Obsolete parameter, do not use.
120 * @param p_honors Honors awarded.
121 * @param p_internal_location Internal location of office.
122 * @param p_mailstop Internal mail location.
123 * @param p_last_medical_test_by Name of physician who performed the last
124 * medical test.
125 * @param p_last_medical_test_date Date of last medical test.
126 * @param p_office_number Office number.
127 * @param p_on_military_service Flag indicating whether the person is on
128 * military service.
129 * @param p_pre_name_adjunct First part of the last name.
130 * @param p_projected_start_date Obsolete parameter, do not use.
131 * @param p_resume_exists Flag indicating whether the person's resume is on
132 * file.
133 * @param p_resume_last_updated Date on which the resume was last updated.
134 * @param p_second_passport_exists Flag indicating whether a person has
135 * multiple passports.
136 * @param p_student_status If this employee is a student, this field is used to
137 * capture their status. Valid values are defined by the STUDENT_STATUS lookup
138 * type.
139 * @param p_work_schedule The days on which this person will work.
140 * @param p_suffix Suffix after the person's last name e.g. Sr., Jr., III.
141 * @param p_benefit_group_id Benefit group to which this person will belong.
142 * @param p_receipt_of_death_cert_date Date death certificate was received.
143 * @param p_coord_ben_med_pln_no Secondary medical plan name. Column used for
144 * external processing.
145 * @param p_coord_ben_no_cvg_flag No secondary medical plan coverage. Column
146 * used for external processing.
147 * @param p_uses_tobacco_flag Flag indicating whether the person uses tobacco.
148 * @param p_dpdnt_adoption_date Date on which the dependent was adopted.
149 * @param p_dpdnt_vlntry_svce_flag Flag indicating whether the dependent is on
150 * voluntary service.
151 * @param p_original_date_of_hire Original date of hire.
152 * @param p_adjusted_svc_date New parameter, available on the latest version of
153 * this API.
154 * @param p_town_of_birth Town or city of birth.
155 * @param p_country_of_birth Country of birth.
156 * @param p_global_person_id Obsolete parameter, do not use.
157 * @param p_person_id If p_validate is false, then this uniquely identifies the
158 * person created. If p_validate is true, then set to null.
159 * @param p_assignment_id If p_validate is false, then this uniquely identifies
160 * the created assignment. If p_validate is true, then set to null.
161 * @param p_per_object_version_number If p_validate is false, then set to the
162 * version number of the created person. If p_validate is true, then set to
163 * null.
164 * @param p_asg_object_version_number If p_validate is false, then this
165 * parameter is set to the version number of the assignment created. If
166 * p_validate is true, then this parameter is null.
167 * @param p_per_effective_start_date If p_validate is false, then set to the
168 * earliest effective start date for the created person. If p_validate is true,
169 * then set to null.
170 * @param p_per_effective_end_date If p_validate is false, then set to the
171 * effective end date for the created person. If p_validate is true, then set
172 * to null.
173 * @param p_full_name If p_validate is false, then set to the complete full
174 * name of the person. If p_validate is true, then set to null.
175 * @param p_per_comment_id If p_validate is false and comment text was
176 * provided, then will be set to the identifier of the created person comment
177 * record. If p_validate is true or no comment text was provided, then will be
178 * null.
179 * @param p_assignment_sequence If p_validate is false, then set to the
180 * sequence number of the default assignment. If p_validate is true, then set
181 * to null.
182 * @param p_assignment_number If p_validate is false, then set to the
183 * assignment number of the default assignment. If p_validate is true, then set
184 * to null.
185 * @param p_name_combination_warning If set to true, then the combination of
186 * last name, first name and date of birth existed prior to calling this API.
187 * @param p_assign_payroll_warning If set to true, then the date of birth is
188 * not entered. If set to false, then the date of birth has been entered.
189 * Indicates if it will be possible to set the payroll on any of this person's
190 * assignments.
191 * @param p_orig_hire_warning Set to true if the original hire date is
192 * populated and the person type is not "Employee", "Employee and Applicant",
193 * "Ex-employee" or "Ex-employee and Applicant".
194 * @rep:displayname Create Employee for Belgium
195 * @rep:category BUSINESS_ENTITY PER_EMPLOYEE
196 * @rep:scope public
197 * @rep:lifecycle active
198 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
199 */
200 --
201 -- {End Of Comments}
202 --
203 procedure create_be_employee
204 (p_validate in boolean default false
205 ,p_hire_date in date
206 ,p_business_group_id in number
207 ,p_last_name in varchar2
208 ,p_sex in varchar2
209 ,p_person_type_id in number default null
210 ,p_per_comments in varchar2 default null
211 ,p_date_employee_data_verified in date default null
212 ,p_date_of_birth in date default null
213 ,p_email_address in varchar2 default null
214 ,p_employee_number in out nocopy varchar2
215 ,p_expense_check_send_to_addres in varchar2 default null
216 ,p_first_name in varchar2 default null
217 ,p_known_as in varchar2 default null
218 ,p_marital_status in varchar2 default null
219 ,p_middle_names in varchar2 default null
220 ,p_nationality in varchar2 default null
221 ,p_ni_number in varchar2 default null
222 ,p_previous_last_name in varchar2 default null
223 ,p_registered_disabled_flag in varchar2 default null
224 ,p_title in varchar2 default null
225 ,p_vendor_id in number default null
226 ,p_work_telephone in varchar2 default null
227 ,p_attribute_category in varchar2 default null
228 ,p_attribute1 in varchar2 default null
229 ,p_attribute2 in varchar2 default null
230 ,p_attribute3 in varchar2 default null
231 ,p_attribute4 in varchar2 default null
232 ,p_attribute5 in varchar2 default null
233 ,p_attribute6 in varchar2 default null
234 ,p_attribute7 in varchar2 default null
235 ,p_attribute8 in varchar2 default null
236 ,p_attribute9 in varchar2 default null
237 ,p_attribute10 in varchar2 default null
238 ,p_attribute11 in varchar2 default null
239 ,p_attribute12 in varchar2 default null
240 ,p_attribute13 in varchar2 default null
241 ,p_attribute14 in varchar2 default null
242 ,p_attribute15 in varchar2 default null
243 ,p_attribute16 in varchar2 default null
244 ,p_attribute17 in varchar2 default null
245 ,p_attribute18 in varchar2 default null
246 ,p_attribute19 in varchar2 default null
247 ,p_attribute20 in varchar2 default null
248 ,p_attribute21 in varchar2 default null
249 ,p_attribute22 in varchar2 default null
250 ,p_attribute23 in varchar2 default null
251 ,p_attribute24 in varchar2 default null
252 ,p_attribute25 in varchar2 default null
253 ,p_attribute26 in varchar2 default null
254 ,p_attribute27 in varchar2 default null
255 ,p_attribute28 in varchar2 default null
256 ,p_attribute29 in varchar2 default null
257 ,p_attribute30 in varchar2 default null
258 ,p_previous_employment_end_date in varchar2 default null
259 ,p_child_allowance_reg in varchar2 default null
260 ,p_holiday_insurance_reg in varchar2 default null
261 ,p_pension_registration in varchar2 default null
262 ,p_id_number in varchar2 default null
263 ,p_registered_disabled_ind in varchar2 default null
264 ,p_percentage_disabled in varchar2 default null
265 ,p_school_leaver in varchar2 default null
266 ,p_date_of_death in date default null
267 ,p_background_check_status in varchar2 default null
268 ,p_background_date_check in varchar2 default null
269 ,p_blood_type in varchar2 default null
270 ,p_correspondence_language in varchar2 default null
271 ,p_fast_path_employee in varchar2 default null
272 ,p_fte_capacity in number default null
273 ,p_honors in varchar2 default null
274 ,p_internal_location in varchar2 default null
275 ,p_mailstop in varchar2 default null
276 ,p_last_medical_test_by in varchar2 default null
277 ,p_last_medical_test_date in date default null
278 ,p_office_number in varchar2 default null
279 ,p_on_military_service in varchar2 default null
280 ,p_pre_name_adjunct in varchar2 default null
281 ,p_projected_start_date in date default null
282 ,p_resume_exists in varchar2 default null
283 ,p_resume_last_updated in date default null
284 ,p_second_passport_exists in varchar2 default null
285 ,p_student_status in varchar2 default null
286 ,p_work_schedule in varchar2 default null
287 ,p_suffix in varchar2 default null
288 ,p_benefit_group_id in number default null
289 ,p_receipt_of_death_cert_date in date default null
290 ,p_coord_ben_med_pln_no in varchar2 default null
291 ,p_coord_ben_no_cvg_flag in varchar2 default 'N'
292 ,p_uses_tobacco_flag in varchar2 default null
293 ,p_dpdnt_adoption_date in date default null
294 ,p_dpdnt_vlntry_svce_flag in varchar2 default 'N'
295 ,p_original_date_of_hire in date default null
296 ,p_adjusted_svc_date in date default null
300 ,p_person_id out nocopy number
297 ,p_town_of_birth in varchar2 default null
298 ,p_country_of_birth in varchar2 default null
299 ,p_global_person_id in varchar2 default null
301 ,p_assignment_id out nocopy number
302 ,p_per_object_version_number out nocopy number
303 ,p_asg_object_version_number out nocopy number
304 ,p_per_effective_start_date out nocopy date
305 ,p_per_effective_end_date out nocopy date
306 ,p_full_name out nocopy varchar2
307 ,p_per_comment_id out nocopy number
308 ,p_assignment_sequence out nocopy number
309 ,p_assignment_number out nocopy varchar2
310 ,p_name_combination_warning out nocopy boolean
311 ,p_assign_payroll_warning out nocopy boolean
312 ,p_orig_hire_warning out nocopy boolean
313 );
314 --
315 -- ----------------------------------------------------------------------------
316 -- |----------------------------< create_be_employee >------------------------|
317 -- ----------------------------------------------------------------------------
318 --
319 -- This version of the API is now out-of-date however it has been provided to
320 -- you for backward compatibility support and will be removed in the future.
321 -- Oracle recommends you to modify existing calling programs in advance of the
322 -- support being withdrawn thus avoiding any potential disruption.
323 --
324 procedure create_be_employee
325 (p_validate in boolean default false
326 ,p_hire_date in date
327 ,p_business_group_id in number
328 ,p_last_name in varchar2
329 ,p_sex in varchar2
330 ,p_person_type_id in number default null
331 ,p_per_comments in varchar2 default null
332 ,p_date_employee_data_verified in date default null
333 ,p_date_of_birth in date default null
334 ,p_email_address in varchar2 default null
335 ,p_employee_number in out nocopy varchar2
336 ,p_expense_check_send_to_addres in varchar2 default null
337 ,p_first_name in varchar2 default null
338 ,p_known_as in varchar2 default null
339 ,p_marital_status in varchar2 default null
340 ,p_middle_names in varchar2 default null
341 ,p_nationality in varchar2 default null
342 ,p_ni_number in varchar2 default null
343 ,p_previous_last_name in varchar2 default null
344 ,p_registered_disabled_flag in varchar2 default null
345 ,p_title in varchar2 default null
346 ,p_vendor_id in number default null
347 ,p_work_telephone in varchar2 default null
348 ,p_attribute_category in varchar2 default null
349 ,p_attribute1 in varchar2 default null
350 ,p_attribute2 in varchar2 default null
351 ,p_attribute3 in varchar2 default null
352 ,p_attribute4 in varchar2 default null
353 ,p_attribute5 in varchar2 default null
354 ,p_attribute6 in varchar2 default null
355 ,p_attribute7 in varchar2 default null
356 ,p_attribute8 in varchar2 default null
357 ,p_attribute9 in varchar2 default null
358 ,p_attribute10 in varchar2 default null
359 ,p_attribute11 in varchar2 default null
360 ,p_attribute12 in varchar2 default null
361 ,p_attribute13 in varchar2 default null
362 ,p_attribute14 in varchar2 default null
363 ,p_attribute15 in varchar2 default null
364 ,p_attribute16 in varchar2 default null
365 ,p_attribute17 in varchar2 default null
366 ,p_attribute18 in varchar2 default null
367 ,p_attribute19 in varchar2 default null
368 ,p_attribute20 in varchar2 default null
369 ,p_attribute21 in varchar2 default null
370 ,p_attribute22 in varchar2 default null
371 ,p_attribute23 in varchar2 default null
372 ,p_attribute24 in varchar2 default null
373 ,p_attribute25 in varchar2 default null
374 ,p_attribute26 in varchar2 default null
375 ,p_attribute27 in varchar2 default null
376 ,p_attribute28 in varchar2 default null
377 ,p_attribute29 in varchar2 default null
378 ,p_attribute30 in varchar2 default null
379 ,p_previous_employment_end_date in varchar2 default null
380 ,p_child_allowance_reg in varchar2 default null
381 ,p_holiday_insurance_reg in varchar2 default null
382 ,p_pension_registration in varchar2 default null
383 ,p_id_number in varchar2 default null
384 ,p_registered_disabled_ind in varchar2 default null
385 ,p_percentage_disabled in varchar2 default null
386 ,p_school_leaver in varchar2 default null
387 ,p_date_of_death in date default null
388 ,p_background_check_status in varchar2 default null
392 ,p_fast_path_employee in varchar2 default null
389 ,p_background_date_check in varchar2 default null
390 ,p_blood_type in varchar2 default null
391 ,p_correspondence_language in varchar2 default null
393 ,p_fte_capacity in number default null
394 ,p_honors in varchar2 default null
395 ,p_internal_location in varchar2 default null
396 ,p_mailstop in varchar2 default null
397 ,p_last_medical_test_by in varchar2 default null
398 ,p_last_medical_test_date in date default null
399 ,p_office_number in varchar2 default null
400 ,p_on_military_service in varchar2 default null
401 ,p_pre_name_adjunct in varchar2 default null
402 ,p_projected_start_date in date default null
403 ,p_resume_exists in varchar2 default null
404 ,p_resume_last_updated in date default null
405 ,p_second_passport_exists in varchar2 default null
406 ,p_student_status in varchar2 default null
407 ,p_work_schedule in varchar2 default null
408 ,p_suffix in varchar2 default null
409 ,p_benefit_group_id in number default null
410 ,p_receipt_of_death_cert_date in date default null
411 ,p_coord_ben_med_pln_no in varchar2 default null
412 ,p_coord_ben_no_cvg_flag in varchar2 default 'N'
413 ,p_uses_tobacco_flag in varchar2 default null
414 ,p_dpdnt_adoption_date in date default null
415 ,p_dpdnt_vlntry_svce_flag in varchar2 default 'N'
416 ,p_original_date_of_hire in date default null
417 ,p_adjusted_svc_date in date default null
418 ,p_town_of_birth in varchar2 default null
419 ,p_country_of_birth in varchar2 default null
420 ,p_global_person_id in varchar2 default null
421 ,p_person_id out nocopy number
422 ,p_assignment_id out nocopy number
423 ,p_per_object_version_number out nocopy number
424 ,p_asg_object_version_number out nocopy number
425 ,p_per_effective_start_date out nocopy date
426 ,p_per_effective_end_date out nocopy date
427 ,p_full_name out nocopy varchar2
428 ,p_per_comment_id out nocopy number
429 ,p_assignment_sequence out nocopy number
430 ,p_assignment_number out nocopy varchar2
431 ,p_name_combination_warning out nocopy boolean
432 ,p_assign_payroll_warning out nocopy boolean
433 );
434 end hr_be_employee_api;
[Home] [Help]