1 Package hr_nl_employee_api as
2 /* $Header: peempnli.pkh 120.1 2005/10/02 02:16:29 aroussel $ */
3 /*#
4 * This package contains employee APIs for the Netherlands.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Employee for Netherlands
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------------< create_nl_employee >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a new employee for the Netherlands.
17 *
18 * The creation of a new Dutch employee includes a default primary assignment
19 * and a period of service for the employee. The API calls the generic API
20 * create_employee, with the parameters set as appropriate for a Dutch
21 * employee. Secure user functionality is not included in this version of the
22 * API. As this API is effectively an alternative to the API create_employee,
23 * see that API for further explanation.
24 *
25 * <p><b>Licensing</b><br>
26 * This API is licensed for use with Human Resources.
27 *
28 * <p><b>Prerequisites</b><br>
29 * See API create_employee.
30 *
31 * <p><b>Post Success</b><br>
32 * When the person, primary assignment and period of service have been
33 * successfully inserted, the following out parameters are set.
34 *
35 * <p><b>Post Failure</b><br>
36 * The API does not create the employee, default assignment or period of
37 * service, and raises an error.
38 * @param p_validate If true, then validation alone will be performed and the
39 * database will remain unchanged. If false and all validation checks pass,
40 * then the database will be modified.
41 * @param p_hire_date Hire Date.
42 * @param p_business_group_id Business group of the person.
43 * @param p_last_name Last name.
44 * @param p_sex Legal gender. Valid values are defined by the SEX lookup type.
45 * @param p_person_type_id Type of employee being created.
46 * @param p_comments Employee comment text.
47 * @param p_date_employee_data_verified The date on which the employee data was
48 * last verified.
49 * @param p_date_of_birth Date of birth.
50 * @param p_email_address Email address.
51 * @param p_employee_number The business group's employee number generation
52 * method determines when the API derives and passes out an employee number or
53 * when the calling program should pass in a value. When the API call completes
54 * if p_validate is false then will be set to the employee number. If
55 * p_validate is true then will be set to the passed value.
56 * @param p_expense_check_send_to_addres Mailing address.
57 * @param p_first_name First name.
58 * @param p_known_as Preferred name.
59 * @param p_marital_status Marital status. Valid values are defined by the
60 * MAR_STATUS lookup type.
61 * @param p_middle_names Middle names.
62 * @param p_nationality Nationality. Valid values are defined by the
63 * NATIONALITY lookup type.
64 * @param p_sofi_number SOFI Number. Subject to 11-proof validation.
65 * @param p_previous_last_name Previous last name.
66 * @param p_registered_disabled_flag Flag indicating whether the person is
67 * classified as disabled.
68 * @param p_title Title. Valid values are defined by the TITLE lookup type.
69 * @param p_vendor_id Obsolete parameter, do not use.
70 * @param p_work_telephone Obsolete parameter, do not use.
71 * @param p_attribute_category This context value determines which flexfield
72 * structure to use with the descriptive flexfield segments.
73 * @param p_attribute1 Descriptive flexfield segment.
74 * @param p_attribute2 Descriptive flexfield segment.
75 * @param p_attribute3 Descriptive flexfield segment.
76 * @param p_attribute4 Descriptive flexfield segment.
77 * @param p_attribute5 Descriptive flexfield segment.
78 * @param p_attribute6 Descriptive flexfield segment.
79 * @param p_attribute7 Descriptive flexfield segment.
80 * @param p_attribute8 Descriptive flexfield segment.
81 * @param p_attribute9 Descriptive flexfield segment.
82 * @param p_attribute10 Descriptive flexfield segment.
83 * @param p_attribute11 Descriptive flexfield segment.
84 * @param p_attribute12 Descriptive flexfield segment.
85 * @param p_attribute13 Descriptive flexfield segment.
86 * @param p_attribute14 Descriptive flexfield segment.
87 * @param p_attribute15 Descriptive flexfield segment.
88 * @param p_attribute16 Descriptive flexfield segment.
89 * @param p_attribute17 Descriptive flexfield segment.
90 * @param p_attribute18 Descriptive flexfield segment.
91 * @param p_attribute19 Descriptive flexfield segment.
92 * @param p_attribute20 Descriptive flexfield segment.
93 * @param p_attribute21 Descriptive flexfield segment.
94 * @param p_attribute22 Descriptive flexfield segment.
95 * @param p_attribute23 Descriptive flexfield segment.
96 * @param p_attribute24 Descriptive flexfield segment.
97 * @param p_attribute25 Descriptive flexfield segment.
98 * @param p_attribute26 Descriptive flexfield segment.
99 * @param p_attribute27 Descriptive flexfield segment.
100 * @param p_attribute28 Descriptive flexfield segment.
101 * @param p_attribute29 Descriptive flexfield segment.
102 * @param p_attribute30 Descriptive flexfield segment.
103 * @param p_date_of_death Date of death.
104 * @param p_background_check_status Flag indicating whether the person's
105 * background has been checked.
106 * @param p_background_date_check Date on which the background check was
107 * performed.
108 * @param p_blood_type Blood type.
109 * @param p_correspondence_language Preferred language for correspondence.
110 * @param p_fast_path_employee New parameter, available on the latest version
111 * of this API.
112 * @param p_fte_capacity Obsolete parameter, do not use.
113 * @param p_academic_title Honors or degrees awarded. Valid values are defined
114 * by the lookup type 'HR_NL_ACADEMIC_TITLE'.
115 * @param p_internal_location Internal location of office.
116 * @param p_mailstop Internal mail location.
117 * @param p_last_medical_test_by Name of physician who performed the last
118 * medical test.
119 * @param p_last_medical_test_date Date of last medical test.
120 * @param p_office_number Office number.
121 * @param p_on_military_service Flag indicating whether the person is on
122 * military service.
123 * @param p_pre_name_adjunct First part of the last name.
124 * @param p_rehire_recommendation New parameter, available on the latest
125 * version of this API.
126 * @param p_projected_start_date Obsolete parameter, do not use.
127 * @param p_resume_exists Flag indicating whether the person's resume is on
128 * file.
129 * @param p_resume_last_updated Date on which the resume was last updated.
130 * @param p_second_passport_exists Flag indicating whether a person has
131 * multiple passports.
132 * @param p_student_status If this employee is a student, this field is used to
133 * capture their status. Valid values are defined by the STUDENT_STATUS lookup
134 * type.
135 * @param p_work_schedule The days on which this person will work.
136 * @param p_suffix Suffix after the person's last name e.g. Sr., Jr., III.
137 * @param p_benefit_group_id Benefit group to which this person will belong.
138 * @param p_receipt_of_death_cert_date Date death certificate was received.
139 * @param p_coord_ben_med_pln_no Secondary medical plan name. Column used for
140 * external processing.
141 * @param p_coord_ben_no_cvg_flag No secondary medical plan coverage. Column
142 * used for external processing.
143 * @param p_coord_ben_med_ext_er Secondary external medical coverage. Column
144 * used for external processing.
145 * @param p_coord_ben_med_pl_name Secondary medical coverage name. Column used
146 * for external processing.
147 * @param p_coord_ben_med_insr_crr_name Secondary medical coverage insurance
148 * carrier name. Column used for external processing.
149 * @param p_coord_ben_med_insr_crr_ident Identifies the secondary medical
150 * coverage insurance carrier. Column used for external processing.
151 * @param p_coord_ben_med_cvg_strt_dt Secondary medical coverage effective
152 * start date. Column used for external processing.
153 * @param p_coord_ben_med_cvg_end_dt Secondary medical coverage effective end
154 * date. Column used for external processing.
155 * @param p_uses_tobacco_flag Flag indicating whether the person uses tobacco.
156 * @param p_dpdnt_adoption_date Date on which the dependent was adopted.
157 * @param p_dpdnt_vlntry_svce_flag Flag indicating whether the dependent is on
158 * voluntary service.
159 * @param p_original_date_of_hire Original date of hire.
160 * @param p_adjusted_svc_date New parameter, available on the latest version of
161 * this API.
162 * @param p_town_of_birth Town or city of birth.
163 * @param p_region_of_birth Geographical region of birth.
164 * @param p_country_of_birth Country of birth.
165 * @param p_global_person_id Obsolete parameter, do not use.
166 * @param p_party_id TCA party for whom you create the person record.
167 * @param p_initials Initials of person.
168 * @param p_special_title Special Title. Valid values are defined by the lookup
169 * type 'HR_NL_SPECIAL_TITLE'.
170 * @param p_subsequent_academic_title Subsequent Academic Title. Valid values
171 * are defined by the lookup type 'HR_NL_SUB_ACADEMIC_TITLE'.
172 * @param p_fullname_format Full Name Format. Valid values are defined by the
173 * lookup type 'HR_NL_FULL_NAME_FORMAT'.
174 * @param p_partner_prefix Partner Prefix.
175 * @param p_partner_surname Partner Surname.
176 * @param p_objection_received Objection Received Indicator. Valid values are
177 * defined by the lookup type 'HR_NL_YES_NO'.
178 * @param p_objection_statement Objection Statement. A statement made by the
179 * employee explaining why they object to the ethnic origin information being
180 * held.
181 * @param p_target_group Target Group Indicator as to whether an employee is
182 * classed as being in a target group or not. Valid values are defined by the
183 * lookup type 'HR_NL_YES_NO'.
184 * @param p_birth_country_father Birth Country Father. Valid values are the
185 * same as for parameter p_country_of_birth.
186 * @param p_birth_country_mother Birth Country Mother. Valid values are the
187 * same as for parameter p_country_of_birth.
188 * @param p_addressing_female_employee Addressing Female Employee. How this is
189 * done. Valid values are defined by the lookup type
190 * 'NL_ADDRESSING_FEMALE_EMP'.
191 * @param p_person_id If p_validate is false, then this uniquely identifies the
192 * person created. If p_validate is true, then set to null.
193 * @param p_assignment_id If p_validate is false, then this uniquely identifies
194 * the created assignment. If p_validate is true, then set to null.
195 * @param p_per_object_version_number If p_validate is false, then set to the
196 * version number of the created person. If p_validate is true, then set to
197 * null.
198 * @param p_asg_object_version_number If p_validate is false, then this
199 * parameter is set to the version number of the assignment created. If
200 * p_validate is true, then this parameter is null.
201 * @param p_per_effective_start_date If p_validate is false, then set to the
202 * earliest effective start date for the created person. If p_validate is true,
203 * then set to null.
204 * @param p_per_effective_end_date If p_validate is false, then set to the
205 * effective end date for the created person. If p_validate is true, then set
206 * to null.
207 * @param p_full_name If p_validate is false, then set to the complete full
208 * name of the person. If p_validate is true, then set to null.
209 * @param p_per_comment_id If p_validate is false and comment text was
210 * provided, then will be set to the identifier of the created person comment
211 * record. If p_validate is true or no comment text was provided, then will be
212 * null.
213 * @param p_assignment_sequence If p_validate is false, then set to the
214 * sequence number of the default assignment. If p_validate is true, then set
215 * to null.
216 * @param p_assignment_number If p_validate is false, then set to the
217 * assignment number of the default assignment. If p_validate is true, then set
218 * to null.
219 * @param p_name_combination_warning If set to true, then the combination of
220 * last name, first name and date of birth existed prior to calling this API.
221 * @param p_assign_payroll_warning If set to true, then the date of birth is
222 * not entered. If set to false, then the date of birth has been entered.
223 * Indicates if it will be possible to set the payroll on any of this person's
224 * assignments.
225 * @param p_orig_hire_warning Set to true if the original hire date is
226 * populated and the person type is not "Employee", "Employee and Applicant",
227 * "Ex-employee" or "Ex-employee and Applicant".
228 * @param p_contract_at_other_company New parameter, available on the latest
229 * version of this API.
230 * @param p_work_abroad_exceeding_year New parameter, available on the latest
231 * version of this API.
232 * @param p_iza_participant_number New parameter, available on the latest
233 * version of this API.
234 * @rep:displayname Create Employee for Netherlands
235 * @rep:category BUSINESS_ENTITY PER_EMPLOYEE
236 * @rep:scope public
237 * @rep:lifecycle active
238 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
239 */
240 --
241 -- {End Of Comments}
242 --
243 procedure create_nl_employee
244 (p_validate in boolean default false
245 ,p_hire_date in date
246 ,p_business_group_id in number
247 ,p_last_name in varchar2
248 ,p_sex in varchar2
249 ,p_person_type_id in number default null
250 ,p_comments in varchar2 default null
251 ,p_date_employee_data_verified in date default null
252 ,p_date_of_birth in date default null
253 ,p_email_address in varchar2 default null
254 ,p_employee_number in out nocopy varchar2
255 ,p_expense_check_send_to_addres in varchar2 default null
256 ,p_first_name in varchar2 default null
257 ,p_known_as in varchar2 default null
258 ,p_marital_status in varchar2 default null
259 ,p_middle_names in varchar2 default null
260 ,p_nationality in varchar2 default null
261 ,p_sofi_number in varchar2 default null
262 ,p_previous_last_name in varchar2 default null
263 ,p_registered_disabled_flag in varchar2 default null
264 ,p_title in varchar2 default null
265 ,p_vendor_id in number default null
266 ,p_work_telephone in varchar2 default null
267 ,p_attribute_category in varchar2 default null
268 ,p_attribute1 in varchar2 default null
269 ,p_attribute2 in varchar2 default null
270 ,p_attribute3 in varchar2 default null
271 ,p_attribute4 in varchar2 default null
272 ,p_attribute5 in varchar2 default null
273 ,p_attribute6 in varchar2 default null
274 ,p_attribute7 in varchar2 default null
275 ,p_attribute8 in varchar2 default null
276 ,p_attribute9 in varchar2 default null
277 ,p_attribute10 in varchar2 default null
278 ,p_attribute11 in varchar2 default null
279 ,p_attribute12 in varchar2 default null
280 ,p_attribute13 in varchar2 default null
281 ,p_attribute14 in varchar2 default null
285 ,p_attribute18 in varchar2 default null
282 ,p_attribute15 in varchar2 default null
283 ,p_attribute16 in varchar2 default null
284 ,p_attribute17 in varchar2 default null
286 ,p_attribute19 in varchar2 default null
287 ,p_attribute20 in varchar2 default null
288 ,p_attribute21 in varchar2 default null
289 ,p_attribute22 in varchar2 default null
290 ,p_attribute23 in varchar2 default null
291 ,p_attribute24 in varchar2 default null
292 ,p_attribute25 in varchar2 default null
293 ,p_attribute26 in varchar2 default null
294 ,p_attribute27 in varchar2 default null
295 ,p_attribute28 in varchar2 default null
296 ,p_attribute29 in varchar2 default null
297 ,p_attribute30 in varchar2 default null
298 ,p_date_of_death in date default null
299 ,p_background_check_status in varchar2 default null
300 ,p_background_date_check in varchar2 default null
301 ,p_blood_type in varchar2 default null
302 ,p_correspondence_language in varchar2 default null
303 ,p_fast_path_employee in varchar2 default null
304 ,p_fte_capacity in number default null
305 ,p_academic_title in varchar2 default null
306 ,p_internal_location in varchar2 default null
307 ,p_mailstop in varchar2 default null
308 ,p_last_medical_test_by in varchar2 default null
309 ,p_last_medical_test_date in date default null
310 ,p_office_number in varchar2 default null
311 ,p_on_military_service in varchar2 default null
312 ,p_pre_name_adjunct in varchar2 default null
313 ,p_rehire_recommendation in varchar2 default null
314 ,p_projected_start_date in date default null
315 ,p_resume_exists in varchar2 default null
316 ,p_resume_last_updated in date default null
317 ,p_second_passport_exists in varchar2 default null
318 ,p_student_status in varchar2 default null
319 ,p_work_schedule in varchar2 default null
320 ,p_suffix in varchar2 default null
321 ,p_benefit_group_id in number default null
322 ,p_receipt_of_death_cert_date in date default null
323 ,p_coord_ben_med_pln_no in varchar2 default null
324 ,p_coord_ben_no_cvg_flag in varchar2 default 'N'
325 ,p_coord_ben_med_ext_er in varchar2 default null
326 ,p_coord_ben_med_pl_name in varchar2 default null
327 ,p_coord_ben_med_insr_crr_name in varchar2 default null
328 ,p_coord_ben_med_insr_crr_ident in varchar2 default null
329 ,p_coord_ben_med_cvg_strt_dt in date default null
330 ,p_coord_ben_med_cvg_end_dt in date default null
331 ,p_uses_tobacco_flag in varchar2 default null
332 ,p_dpdnt_adoption_date in date default null
333 ,p_dpdnt_vlntry_svce_flag in varchar2 default 'N'
334 ,p_original_date_of_hire in date default null
335 ,p_adjusted_svc_date in date default null
336 ,p_town_of_birth in varchar2 default null
337 ,p_region_of_birth in varchar2 default null
338 ,p_country_of_birth in varchar2 default null
339 ,p_global_person_id in varchar2 default null
340 ,p_party_id in number default null
341 ,p_initials in varchar2 default null
342 ,p_special_title in varchar2 default null
343 ,p_subsequent_academic_title in varchar2 default null
344 ,p_fullname_format in varchar2
345 ,p_partner_prefix in varchar2 default null
346 ,p_partner_surname in varchar2 default null
347 ,p_objection_received in varchar2 default null
348 ,p_objection_statement in varchar2 default null
349 ,p_target_group in varchar2 default null
350 ,p_birth_country_father in varchar2 default null
351 ,p_birth_country_mother in varchar2 default null
352 ,p_addressing_female_employee in varchar2 default null
353 ,p_work_abroad_exceeding_year in varchar2 default 'N'
354 ,p_iza_participant_number in number default null
355 ,p_contract_at_other_company in varchar2 default null
356 ,p_person_id out nocopy number
357 ,p_assignment_id out nocopy number
358 ,p_per_object_version_number out nocopy number
359 ,p_asg_object_version_number out nocopy number
360 ,p_per_effective_start_date out nocopy date
361 ,p_per_effective_end_date out nocopy date
362 ,p_full_name out nocopy varchar2
363 ,p_per_comment_id out nocopy number
364 ,p_assignment_sequence out nocopy number
365 ,p_assignment_number out nocopy varchar2
366 ,p_name_combination_warning out nocopy boolean
367 ,p_assign_payroll_warning out nocopy boolean
368 ,p_orig_hire_warning out nocopy boolean
369 );
370 --
371 end hr_nl_employee_api;
[Home] [Help]