1 Package hr_es_employee_api as
2 /* $Header: peempesi.pkh 120.1 2005/10/02 02:16:11 aroussel $ */
3 /*#
4 * This package contains employee APIs for the Spain.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Employee for Spain
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------------< create_es_employee >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a new employee for Spain.
17 *
18 * The creation of a new Spanish 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 Hungarian
21 * employee. Secure user functionality is not included in this version of the
22 * API. See the API create_employee for a further explanation.
23 *
24 * <p><b>Licensing</b><br>
25 * This API is licensed for use with Human Resources.
26 *
27 * <p><b>Prerequisites</b><br>
28 * Valid business group for Spain.
29 *
30 * <p><b>Post Success</b><br>
31 * Employee created successfully.
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_first_last_name Employee's first 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_name Employee's first name.
56 * @param p_preferred_name Previous last 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_nif_value National identifier.
63 * @param p_maiden_name Employee's maiden name
64 * @param p_registered_disabled_flag Flag indicating whether the person is
65 * classified as disabled.
66 * @param p_title Title. Valid values are defined by the TITLE lookup type.
67 * @param p_vendor_id Obsolete parameter, do not use.
68 * @param p_work_telephone Obsolete parameter, do not use.
69 * @param p_attribute_category This context value determines which flexfield
70 * structure to use with the descriptive flexfield segments.
71 * @param p_attribute1 Descriptive flexfield segment.
72 * @param p_attribute2 Descriptive flexfield segment.
73 * @param p_attribute3 Descriptive flexfield segment.
74 * @param p_attribute4 Descriptive flexfield segment.
75 * @param p_attribute5 Descriptive flexfield segment.
76 * @param p_attribute6 Descriptive flexfield segment.
77 * @param p_attribute7 Descriptive flexfield segment.
78 * @param p_attribute8 Descriptive flexfield segment.
79 * @param p_attribute9 Descriptive flexfield segment.
80 * @param p_attribute10 Descriptive flexfield segment.
81 * @param p_attribute11 Descriptive flexfield segment.
82 * @param p_attribute12 Descriptive flexfield segment.
83 * @param p_attribute13 Descriptive flexfield segment.
84 * @param p_attribute14 Descriptive flexfield segment.
85 * @param p_attribute15 Descriptive flexfield segment.
86 * @param p_attribute16 Descriptive flexfield segment.
87 * @param p_attribute17 Descriptive flexfield segment.
88 * @param p_attribute18 Descriptive flexfield segment.
89 * @param p_attribute19 Descriptive flexfield segment.
90 * @param p_attribute20 Descriptive flexfield segment.
91 * @param p_attribute21 Descriptive flexfield segment.
92 * @param p_attribute22 Descriptive flexfield segment.
93 * @param p_attribute23 Descriptive flexfield segment.
94 * @param p_attribute24 Descriptive flexfield segment.
95 * @param p_attribute25 Descriptive flexfield segment.
96 * @param p_attribute26 Descriptive flexfield segment.
97 * @param p_attribute27 Descriptive flexfield segment.
98 * @param p_attribute28 Descriptive flexfield segment.
99 * @param p_attribute29 Descriptive flexfield segment.
100 * @param p_attribute30 Descriptive flexfield segment.
101 * @param p_per_information_category Obsolete parameter, do not use.
102 * @param p_second_last_name Second last name
103 * @param p_identifier_type Alternative to National Identifier. Valid values
104 * exist in the 'ES_IDENTIFIER_TYPE' lookup type.
105 * @param p_identifier_value Identifier type value
106 * @param p_overtime_approval Under 18 overtime approval flag. Valid values
107 * exist in the 'YES_NO' lookup type.
108 * @param p_per_information5 Developer descriptive flexfield segment.
109 * @param p_per_information6 Developer descriptive flexfield segment.
110 * @param p_per_information7 Developer descriptive flexfield segment.
111 * @param p_per_information8 Developer descriptive flexfield segment.
112 * @param p_per_information9 Developer descriptive flexfield segment.
113 * @param p_per_information10 Developer descriptive flexfield segment.
114 * @param p_per_information11 Developer descriptive flexfield segment.
115 * @param p_per_information12 Developer descriptive flexfield segment.
116 * @param p_per_information13 Developer descriptive flexfield segment.
117 * @param p_per_information14 Developer descriptive flexfield segment.
118 * @param p_per_information15 Developer descriptive flexfield segment.
119 * @param p_per_information16 Developer descriptive flexfield segment.
120 * @param p_per_information17 Developer descriptive flexfield segment.
121 * @param p_per_information18 Developer descriptive flexfield segment.
122 * @param p_per_information19 Developer descriptive flexfield segment.
123 * @param p_per_information20 Developer descriptive flexfield segment.
124 * @param p_per_information21 Developer descriptive flexfield segment.
125 * @param p_per_information22 Developer descriptive flexfield segment.
126 * @param p_per_information23 Developer descriptive flexfield segment.
127 * @param p_per_information24 Developer descriptive flexfield segment.
128 * @param p_per_information25 Developer descriptive flexfield segment.
129 * @param p_per_information26 Developer descriptive flexfield segment.
130 * @param p_per_information27 Developer descriptive flexfield segment.
131 * @param p_per_information28 Developer descriptive flexfield segment.
132 * @param p_per_information29 Developer descriptive flexfield segment.
133 * @param p_per_information30 Developer descriptive flexfield segment.
134 * @param p_date_of_death Date of death.
135 * @param p_background_check_status Flag indicating whether the person's
136 * background has been checked.
137 * @param p_background_date_check Date on which the background check was
138 * performed.
139 * @param p_blood_type Blood type.
140 * @param p_correspondence_language Preferred language for correspondence.
141 * @param p_fast_path_employee New parameter, available on the latest version
142 * of this API.
143 * @param p_fte_capacity Obsolete parameter, do not use.
144 * @param p_honors Honors awarded.
145 * @param p_internal_location Internal location of office.
146 * @param p_last_medical_test_by Name of physician who performed the last
147 * medical test.
148 * @param p_last_medical_test_date Date of last medical test.
149 * @param p_mailstop Internal mail location.
150 * @param p_office_number Office number.
151 * @param p_on_military_service Flag indicating whether the person is on
152 * military service.
153 * @param p_prefix Employee's name prefix.
154 * @param p_projected_start_date Obsolete parameter, do not use.
155 * @param p_resume_exists Flag indicating whether the person's resume is on
156 * file.
157 * @param p_resume_last_updated Date on which the resume was last updated.
158 * @param p_second_passport_exists Flag indicating whether a person has
159 * multiple passports.
160 * @param p_student_status If this employee is a student, this field is used to
161 * capture their status. Valid values are defined by the STUDENT_STATUS lookup
162 * type.
163 * @param p_work_schedule The days on which this person will work.
164 * @param p_suffix Suffix after the person's last name e.g. Sr., Jr., III.
165 * @param p_benefit_group_id Benefit group to which this person will belong.
166 * @param p_receipt_of_death_cert_date Date death certificate was received.
167 * @param p_coord_ben_med_pln_no Secondary medical plan name. Column used for
168 * external processing.
169 * @param p_coord_ben_no_cvg_flag No secondary medical plan coverage. Column
170 * used for external processing.
171 * @param p_coord_ben_med_ext_er Secondary external medical coverage. Column
172 * used for external processing.
173 * @param p_coord_ben_med_pl_name Secondary medical coverage name. Column used
174 * for external processing.
175 * @param p_coord_ben_med_insr_crr_name Secondary medical coverage insurance
176 * carrier name. Column used for external processing.
177 * @param p_coord_ben_med_insr_crr_ident Identifies the secondary medical
178 * coverage insurance carrier. Column used for external processing.
179 * @param p_coord_ben_med_cvg_strt_dt Secondary medical coverage effective
180 * start date. Column used for external processing.
181 * @param p_coord_ben_med_cvg_end_dt Secondary medical coverage effective end
182 * date. Column used for external processing.
183 * @param p_uses_tobacco_flag Flag indicating whether the person uses tobacco.
184 * @param p_dpdnt_adoption_date Date on which the dependent was adopted.
185 * @param p_dpdnt_vlntry_svce_flag Flag indicating whether the dependent is on
186 * voluntary service.
187 * @param p_original_date_of_hire Original date of hire.
188 * @param p_adjusted_svc_date New parameter, available on the latest version of
189 * this API.
190 * @param p_town_of_birth Town or city of birth.
191 * @param p_region_of_birth Geographical region of birth.
192 * @param p_country_of_birth Country of birth.
193 * @param p_global_person_id Obsolete parameter, do not use.
194 * @param p_party_id TCA party for whom you create the person record.
195 * @param p_person_id If p_validate is false, then this uniquely identifies the
196 * person created. If p_validate is true, then set to null.
197 * @param p_assignment_id If p_validate is false, then this uniquely identifies
198 * the created assignment. If p_validate is true, then set to null.
199 * @param p_per_object_version_number If p_validate is false, then set to the
200 * version number of the created person. If p_validate is true, then the value
201 * will be null.
202 * @param p_asg_object_version_number If p_validate is false, then this
203 * parameter is set to the version number of the assignment created. If
204 * p_validate is true, then this parameter is null.
205 * @param p_per_effective_start_date If p_validate is false, then set to the
206 * earliest effective start date for the created person. If p_validate is true,
207 * then set to null.
208 * @param p_per_effective_end_date If p_validate is false, then set to the
209 * effective end date for the created person. If p_validate is true, then set
210 * to null.
211 * @param p_full_name If p_validate is false, then set to the complete full
212 * name of the person. If p_validate is true, then set to null.
213 * @param p_per_comment_id If p_validate is false and comment text was
214 * provided, then will be set to the identifier of the created person comment
215 * record. If p_validate is true or no comment text was provided, then will be
216 * null.
217 * @param p_assignment_sequence If p_validate is false, then set to the
218 * sequence number of the default assignment. If p_validate is true, then set
219 * to null.
220 * @param p_assignment_number If p_validate is false, then set to the
221 * assignment number of the default assignment. If p_validate is true, then set
222 * to null.
223 * @param p_name_combination_warning If set to true, then the combination of
224 * last name, first name and date of birth existed prior to calling this API.
225 * @param p_assign_payroll_warning If set to true, then the date of birth is
226 * not entered. If set to false, then the date of birth has been entered.
227 * Indicates if it will be possible to set the payroll on any of this person's
228 * assignments.
229 * @param p_orig_hire_warning Set to true if the original hire date is
230 * populated and the person type is not "Employee", "Employee and Applicant",
231 * "Ex-employee" or "Ex-employee and Applicant".
232 * @rep:displayname Create Employee for Spain
233 * @rep:category BUSINESS_ENTITY PER_EMPLOYEE
234 * @rep:scope public
235 * @rep:lifecycle active
236 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
237 */
238 --
239 -- {End Of Comments}
240 --
241 procedure create_es_employee
242 (p_validate in boolean default false
243 ,p_hire_date in date
244 ,p_business_group_id in number
245 ,p_first_last_name in varchar2
246 ,p_sex in varchar2
247 ,p_person_type_id in number default null
248 ,p_per_comments in varchar2 default null
249 ,p_date_employee_data_verified in date default null
250 ,p_date_of_birth in date default null
251 ,p_email_address in varchar2 default null
252 ,p_employee_number out nocopy varchar2
253 ,p_expense_check_send_to_addres in varchar2 default null
254 ,p_name in varchar2 default null
255 ,p_preferred_name in varchar2 default null
256 ,p_marital_status in varchar2 default null
257 ,p_middle_names in varchar2 default null
258 ,p_nationality in varchar2 default null
259 ,p_nif_value in varchar2 default null
260 ,p_maiden_name in varchar2 default null
261 ,p_registered_disabled_flag in varchar2 default null
262 ,p_title in varchar2 default null
263 ,p_vendor_id in number default null
264 ,p_work_telephone in varchar2 default null
265 ,p_attribute_category in varchar2 default null
266 ,p_attribute1 in varchar2 default null
267 ,p_attribute2 in varchar2 default null
268 ,p_attribute3 in varchar2 default null
269 ,p_attribute4 in varchar2 default null
270 ,p_attribute5 in varchar2 default null
271 ,p_attribute6 in varchar2 default null
272 ,p_attribute7 in varchar2 default null
273 ,p_attribute8 in varchar2 default null
274 ,p_attribute9 in varchar2 default null
275 ,p_attribute10 in varchar2 default null
276 ,p_attribute11 in varchar2 default null
277 ,p_attribute12 in varchar2 default null
278 ,p_attribute13 in varchar2 default null
279 ,p_attribute14 in varchar2 default null
280 ,p_attribute15 in varchar2 default null
281 ,p_attribute16 in varchar2 default null
282 ,p_attribute17 in varchar2 default null
283 ,p_attribute18 in varchar2 default null
284 ,p_attribute19 in varchar2 default null
285 ,p_attribute20 in varchar2 default null
286 ,p_attribute21 in varchar2 default null
287 ,p_attribute22 in varchar2 default null
288 ,p_attribute23 in varchar2 default null
289 ,p_attribute24 in varchar2 default null
290 ,p_attribute25 in varchar2 default null
291 ,p_attribute26 in varchar2 default null
292 ,p_attribute27 in varchar2 default null
293 ,p_attribute28 in varchar2 default null
294 ,p_attribute29 in varchar2 default null
298 ,p_identifier_type in varchar2 default null
295 ,p_attribute30 in varchar2 default null
296 ,p_per_information_category in varchar2 default null
297 ,p_second_last_name in varchar2 default null
299 ,p_identifier_value in varchar2 default null
300 ,p_overtime_approval in varchar2 default null
301 ,p_per_information5 in varchar2 default null
302 ,p_per_information6 in varchar2 default null
303 ,p_per_information7 in varchar2 default null
304 ,p_per_information8 in varchar2 default null
305 ,p_per_information9 in varchar2 default null
306 ,p_per_information10 in varchar2 default null
307 ,p_per_information11 in varchar2 default null
308 ,p_per_information12 in varchar2 default null
309 ,p_per_information13 in varchar2 default null
310 ,p_per_information14 in varchar2 default null
311 ,p_per_information15 in varchar2 default null
312 ,p_per_information16 in varchar2 default null
313 ,p_per_information17 in varchar2 default null
314 ,p_per_information18 in varchar2 default null
315 ,p_per_information19 in varchar2 default null
316 ,p_per_information20 in varchar2 default null
317 ,p_per_information21 in varchar2 default null
318 ,p_per_information22 in varchar2 default null
319 ,p_per_information23 in varchar2 default null
320 ,p_per_information24 in varchar2 default null
321 ,p_per_information25 in varchar2 default null
322 ,p_per_information26 in varchar2 default null
323 ,p_per_information27 in varchar2 default null
324 ,p_per_information28 in varchar2 default null
325 ,p_per_information29 in varchar2 default null
326 ,p_per_information30 in varchar2 default null
327 ,p_date_of_death in date default null
328 ,p_background_check_status in varchar2 default null
329 ,p_background_date_check in date default null
330 ,p_blood_type in varchar2 default null
331 ,p_correspondence_language in varchar2 default null
332 ,p_fast_path_employee in varchar2 default null
333 ,p_fte_capacity in number default null
334 ,p_honors in varchar2 default null
335 ,p_internal_location in varchar2 default null
336 ,p_last_medical_test_by in varchar2 default null
337 ,p_last_medical_test_date in date default null
338 ,p_mailstop in varchar2 default null
339 ,p_office_number in varchar2 default null
340 ,p_on_military_service in varchar2 default null
341 ,p_prefix in varchar2 default null
342 ,p_projected_start_date in date default null
343 ,p_resume_exists in varchar2 default null
344 ,p_resume_last_updated in date default null
345 ,p_second_passport_exists in varchar2 default null
346 ,p_student_status in varchar2 default null
347 ,p_work_schedule in varchar2 default null
348 ,p_suffix in varchar2 default null
349 ,p_benefit_group_id in number default null
350 ,p_receipt_of_death_cert_date in date default null
351 ,p_coord_ben_med_pln_no in varchar2 default null
352 ,p_coord_ben_no_cvg_flag in varchar2 default 'N'
353 ,p_coord_ben_med_ext_er in varchar2 default null
354 ,p_coord_ben_med_pl_name in varchar2 default null
355 ,p_coord_ben_med_insr_crr_name in varchar2 default null
356 ,p_coord_ben_med_insr_crr_ident in varchar2 default null
357 ,p_coord_ben_med_cvg_strt_dt in date default null
358 ,p_coord_ben_med_cvg_end_dt in date default null
359 ,p_uses_tobacco_flag in varchar2 default null
360 ,p_dpdnt_adoption_date in date default null
361 ,p_dpdnt_vlntry_svce_flag in varchar2 default 'N'
362 ,p_original_date_of_hire in date default null
363 ,p_adjusted_svc_date in date default null
364 ,p_town_of_birth in varchar2 default null
365 ,p_region_of_birth in varchar2 default null
366 ,p_country_of_birth in varchar2 default null
367 ,p_global_person_id in varchar2 default null
368 ,p_party_id in number default null
369 ,p_person_id out nocopy number
370 ,p_assignment_id out nocopy number
371 ,p_per_object_version_number out nocopy number
372 ,p_asg_object_version_number out nocopy number
373 ,p_per_effective_start_date out nocopy date
374 ,p_per_effective_end_date out nocopy date
375 ,p_full_name out nocopy varchar2
376 ,p_per_comment_id out nocopy number
377 ,p_assignment_sequence out nocopy number
378 ,p_assignment_number out nocopy varchar2
379 ,p_name_combination_warning out nocopy boolean
380 ,p_assign_payroll_warning out nocopy boolean
381 ,p_orig_hire_warning out nocopy boolean
382 );
383 --
384
385 END hr_es_employee_api;
[Home] [Help]