1 package hr_ae_employee_api as
2 /* $Header: peempaei.pkh 120.5 2006/04/26 23:55:45 spendhar noship $ */
3 /*#
4 * This package contains employee APIs.
5 * @rep:scope public
6 * @rep:product PER
7 * @rep:displayname Employee for UAE
8 */
9 --
10 --
11 -- ----------------------------------------------------------------------------
12 -- |-------------------------< create_ae_employee >--------------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates a new employee, including a default primary assignment
18 * and a period of service for the employee.
19 * Secure user functionality is included in this version of the API. The
20 * employee will be visible to secure users in the business group.
21 *
22 * The following parameters are currently unsupported and must have a null
23 * value :
24 * p_fast_path_employee
25 * p_projected_start_date
26 *
27 * <p><b>Licensing</b><br>
28 * This API is licensed for use with Human Resources.
29 *
30 * <p><b>Prerequisites</b><br>
31 * If person_type_id is supplied, it must have a corresponding system person
32 * type of 'EMP', must be active and be in the same business group as that
33 * of the employee being created.
34 *
35 * <p><b>Post Success</b><br>
36 * The API creates a person, primary assignment and period of service.
37 *
38 * <p><b>Post Failure</b><br>
39 * The API does not create the person, primary assignment or period of
40 * service and raises an error.
41 *
42 * @param p_validate If true, then validation alone will be performed and the
43 * database will remain unchanged. If false and all validation checks pass,
44 * then the database will be modified.
45 * @param p_hire_date The employee hire date and thus the effective start
46 * date of the person, primary assignment and period of service.
47 * @param p_business_group_id Identifies the employee's business group.
48 * @param p_family_name Employee's family name.
49 * @param p_sex Employee sex.
50 * @param p_person_type_id Identifies the person type id. If a person_type_id
51 * is not specified, then the API will use the default 'EMP' type for the
52 * business group.
53 * @param p_comments Employee comments.
54 * @param p_date_employee_data_verified The date on which the Employee data
55 * was last verified.
56 * @param p_date_of_birth Date of birth.
57 * @param p_email_address E-mail address.
58 * @param p_expense_check_send_to_addres Address to use as mailing address.
59 * @param p_first_name Employee's first name.
60 * @param p_known_as Alternate name.
61 * @param p_marital_status Marital status.
62 * @param p_national_identifier National identifier.
63 * @param p_previous_last_name Previous last name.
64 * @param p_registered_disabled_flag Registered disabled flag.
65 * @param p_title Employee's title.
66 * @param p_vendor_id Foreign key to PO_VENDORS.
67 * @param p_work_telephone Work telephone.
68 * @param p_attribute_category This context value determines which flexfield
69 * structure to use with the descriptive flexfield segments.
70 * @param p_attribute1 Descriptive flexfield segment.
71 * @param p_attribute2 Descriptive flexfield segment.
72 * @param p_attribute3 Descriptive flexfield segment.
73 * @param p_attribute4 Descriptive flexfield segment.
74 * @param p_attribute5 Descriptive flexfield segment.
75 * @param p_attribute6 Descriptive flexfield segment.
76 * @param p_attribute7 Descriptive flexfield segment.
77 * @param p_attribute8 Descriptive flexfield segment.
78 * @param p_attribute9 Descriptive flexfield segment.
79 * @param p_attribute10 Descriptive flexfield segment.
80 * @param p_attribute11 Descriptive flexfield segment.
81 * @param p_attribute12 Descriptive flexfield segment.
82 * @param p_attribute13 Descriptive flexfield segment.
83 * @param p_attribute14 Descriptive flexfield segment.
84 * @param p_attribute15 Descriptive flexfield segment.
85 * @param p_attribute16 Descriptive flexfield segment.
86 * @param p_attribute17 Descriptive flexfield segment.
87 * @param p_attribute18 Descriptive flexfield segment.
88 * @param p_attribute19 Descriptive flexfield segment.
89 * @param p_attribute20 Descriptive flexfield segment.
90 * @param p_attribute21 Descriptive flexfield segment.
91 * @param p_attribute22 Descriptive flexfield segment.
92 * @param p_attribute23 Descriptive flexfield segment.
93 * @param p_attribute24 Descriptive flexfield segment.
94 * @param p_attribute25 Descriptive flexfield segment.
95 * @param p_attribute26 Descriptive flexfield segment.
96 * @param p_attribute27 Descriptive flexfield segment.
97 * @param p_attribute28 Descriptive flexfield segment.
98 * @param p_attribute29 Descriptive flexfield segment.
99 * @param p_attribute30 Descriptive flexfield segment.
100 * @param p_father_name Father's Name.
101 * @param p_grandfather_name Grandfather's Name.
102 * @param p_mother_name Mother's Name.
103 * @param p_alt_first_name Alternate first name.
104 * @param p_alt_father_name Father's alternate name.
105 * @param p_alt_grandfather_name Grandfather's alternate name.
106 * @param p_alt_family_name Alternate family name.
107 * @param p_alt_mother_name Alternate mother name.
108 * @param p_previous_nationality Previous Nationality.
109 * @param p_religion Religion.
110 * @param p_education_level Education level.
111 * @param p_alt_place_of_birth Alternate place of birth.
112 * @param p_date_of_change Date of change of nationality.
113 * @param p_reason_for_change Reason for change of nationality.
114 * @param p_nationality Employee's nationality.
115 * @param p_date_of_death Date of death.
116 * @param p_background_check_status Y/N flag indicates whether
117 * background check has been performed.
118 * @param p_background_date_check Date background check was performed.
119 * @param p_blood_type Blood type.
120 * @param p_correspondence_language Preferred language for correspondence.
121 * @param p_fast_path_employee Currently unsupported.
122 * @param p_fte_capacity Full time/part time availability for work.
123 * @param p_honors Honors or degrees awarded.
124 * @param p_internal_location Internal location of office.
125 * @param p_last_medical_test_by Name of physician who performed
126 * last medical test.
127 * @param p_last_medical_test_date Date of last medical test.
128 * @param p_mailstop Office identifier for internal mail.
129 * @param p_office_number Office number.
130 * @param p_on_military_service Y/N flag indicating whether person
131 * is employed in military service
132 * @param p_projected_start_date Currently unsupported
133 * @param p_resume_exists Y/N flag indicating whether resume is on file.
134 * @param p_resume_last_updated Date resume last updated.
135 * @param p_second_passport_exists Y/N flag indicaing whether person has
136 * multiple passports.
137 * @param p_student_status Full time/part time status of student.
138 * @param p_work_schedule Type of work schedule indicating which
139 * days person works.
140 * @param p_benefit_group_id Benefit group id.
141 * @param p_receipt_of_death_cert_date Date the death certificate is received.
142 * @param p_coord_ben_med_pln_no Coordinated benefit medical plan number.
143 * @param p_coord_ben_no_cvg_flag Coordinated benefit no other coverage flag.
144 * @param p_coord_ben_med_ext_er Secondary medical coverage external employer.
145 * @param p_coord_ben_med_pl_name Secondary medical coverage name.
146 * @param p_coord_ben_med_insr_crr_name Secondary medical coverage
147 * insurance carrier.
148 * @param p_coord_ben_med_insr_crr_ident Secondary medical coverage insurance
149 * carrier id.
150 * @param p_coord_ben_med_cvg_strt_dt Secondary medical coverage effective
151 * start date
152 * @param p_coord_ben_med_cvg_end_dt Secondary medical coverage effective
153 * end date.
154 * @param p_uses_tobacco_flag Y/N flag indicating use of tobacco.
155 * @param p_dpdnt_adoption_date Dependent's adoption date.
156 * @param p_dpdnt_vlntry_svce_flag Dependent's voluntary service flag.
157 * @param p_original_date_of_hire Original date of hire.
158 * @param p_adjusted_svc_date Adjusted service date.
159 * @param p_place_of_birth Town or city of birth.
160 * @param p_region_of_birth Geographical region of birth.
161 * @param p_country_of_birth Country of birth.
162 * @param p_global_person_id Global ID for the person.
163 * @param p_employee_number If p_validate is false this will be set to the
164 * the person created. If p_validate is true this will be set to the same
165 * value as passed in.
166 * @param p_person_id If p_validate is false, this uniquely identifies the
167 * person created. If p_validate is true this parameter will be null.
168 * @param p_assignment_id If p_validate is false, this uniquely identifies
169 * the primary assignment created. If p_validate is true this will be null.
170 * @param p_per_object_version_number If p_validate is false, this will be set
171 * to the version number of the person created. If p_validate is true this
172 * parameter will be set to null.
173 * @param p_asg_object_version_number If p_validate is false, then this
174 * parameter is set to the version number of the assignment created. If
175 * p_validate is true, then this parameter is null.
176 * @param p_per_effective_start_date If p_validate is false, this will
177 * be set to the effective start date of the person. If p_validate is true
178 * this will be null.
179 * @param p_per_effective_end_date If p_validate is false, this will
180 * be set to the effective end date of the person. If p_validate is true
181 * this will be null.
182 * @param p_full_name If p_validate is false, then this will be set to the
183 * complete full name of the person. If p_validate is true, then set to null.
184 * @param p_per_comment_id If p_validate is false, then this will be set to the
185 * ID of the corresponding person comment row, if any comment text exists. If
186 * p_validate is true, then set to null.
187 * @param p_assignment_sequence If p_validate is false, then this will be set
188 * to the sequence number of the default assignment. If p_validate is true,
189 * then set to null.
190 * @param p_assignment_number If p_validate is false this will be set to the
191 * assignment number of the primary assignment. If p_validate is true this
192 * will be null.
193 * @param p_name_combination_warning If set to true, then the combination of
194 * last name, first name and date of birth existed prior to calling this API.
195 * @param p_assign_payroll_warning Set to true if the date of birth has not been set.
196 * @param p_orig_hire_warning Set to true, if the original date of hire is not
197 * null and the person type is not EMP,EMP_APL, EX_EMP, or EX_EMP_APL.
198 * @rep:displayname Create Employee for UAE
199 * @rep:category BUSINESS_ENTITY PER_EMPLOYEE
200 * @rep:lifecycle active
201 * @rep:scope public
202 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
203 */
204 --
205 -- {End Of Comments}
206 --
207
208 PROCEDURE create_ae_employee
209 (p_validate in boolean default false
210 ,p_hire_date in date
211 ,p_business_group_id in number
212 ,p_family_name in varchar2
213 ,p_sex in varchar2
214 ,p_person_type_id in number default null
215 ,p_comments in varchar2 default null
216 ,p_date_employee_data_verified in date default null
217 ,p_date_of_birth in date default null
218 ,p_email_address in varchar2 default null
219 ,p_employee_number in out nocopy varchar2
220 ,p_expense_check_send_to_addres in varchar2 default null
221 ,p_first_name in varchar2
222 ,p_known_as in varchar2 default null
223 ,p_marital_status in varchar2 default null
224 ,p_national_identifier in varchar2 default null
225 ,p_previous_last_name in varchar2 default null
226 ,p_registered_disabled_flag in varchar2 default null
227 ,p_title in varchar2 default null
228 ,p_vendor_id in number default null
229 ,p_work_telephone in varchar2 default null
230 ,p_attribute_category in varchar2 default null
231 ,p_attribute1 in varchar2 default null
232 ,p_attribute2 in varchar2 default null
233 ,p_attribute3 in varchar2 default null
234 ,p_attribute4 in varchar2 default null
235 ,p_attribute5 in varchar2 default null
236 ,p_attribute6 in varchar2 default null
237 ,p_attribute7 in varchar2 default null
238 ,p_attribute8 in varchar2 default null
239 ,p_attribute9 in varchar2 default null
243 ,p_attribute13 in varchar2 default null
240 ,p_attribute10 in varchar2 default null
241 ,p_attribute11 in varchar2 default null
242 ,p_attribute12 in varchar2 default null
244 ,p_attribute14 in varchar2 default null
245 ,p_attribute15 in varchar2 default null
246 ,p_attribute16 in varchar2 default null
247 ,p_attribute17 in varchar2 default null
248 ,p_attribute18 in varchar2 default null
249 ,p_attribute19 in varchar2 default null
250 ,p_attribute20 in varchar2 default null
251 ,p_attribute21 in varchar2 default null
252 ,p_attribute22 in varchar2 default null
253 ,p_attribute23 in varchar2 default null
254 ,p_attribute24 in varchar2 default null
255 ,p_attribute25 in varchar2 default null
256 ,p_attribute26 in varchar2 default null
257 ,p_attribute27 in varchar2 default null
258 ,p_attribute28 in varchar2 default null
259 ,p_attribute29 in varchar2 default null
260 ,p_attribute30 in varchar2 default null
261 ,p_father_name in varchar2 default null
262 ,p_grandfather_name in varchar2 default null
263 ,p_mother_name in varchar2 default null
264 ,p_alt_first_name in varchar2 default null
265 ,p_alt_father_name in varchar2 default null
266 ,p_alt_grandfather_name in varchar2 default null
267 ,p_alt_family_name in varchar2 default null
268 ,p_alt_mother_name in varchar2 default null
269 ,p_previous_nationality in varchar2 default null
270 ,p_religion in varchar2 default null
271 ,p_education_level in varchar2 default null
272 ,p_alt_place_of_birth in varchar2 default null
273 ,p_date_of_change in varchar2 default null
274 ,p_reason_for_change in varchar2 default null
275 ,p_nationality in varchar2
276 ,p_date_of_death in date default null
277 ,p_background_check_status in varchar2 default null
278 ,p_background_date_check in date default null
279 ,p_blood_type in varchar2 default null
280 ,p_correspondence_language in varchar2 default null
281 ,p_fast_path_employee in varchar2 default null
282 ,p_fte_capacity in number default null
283 ,p_honors in varchar2 default null
284 ,p_internal_location in varchar2 default null
285 ,p_last_medical_test_by in varchar2 default null
286 ,p_last_medical_test_date in date default null
287 ,p_mailstop in varchar2 default null
288 ,p_office_number in varchar2 default null
289 ,p_on_military_service in varchar2 default null
290 ,p_projected_start_date in date default null
291 ,p_resume_exists in varchar2 default null
292 ,p_resume_last_updated in date default null
293 ,p_second_passport_exists in varchar2 default null
294 ,p_student_status in varchar2 default null
295 ,p_work_schedule in varchar2 default null
296 ,p_benefit_group_id in number default null
297 ,p_receipt_of_death_cert_date in date default null
298 ,p_coord_ben_med_pln_no in varchar2 default null
299 ,p_coord_ben_no_cvg_flag in varchar2 default 'N'
300 ,p_coord_ben_med_ext_er in varchar2 default null
301 ,p_coord_ben_med_pl_name in varchar2 default null
302 ,p_coord_ben_med_insr_crr_name in varchar2 default null
303 ,p_coord_ben_med_insr_crr_ident in varchar2 default null
304 ,p_coord_ben_med_cvg_strt_dt in date default null
305 ,p_coord_ben_med_cvg_end_dt in date default null
306 ,p_uses_tobacco_flag in varchar2 default null
307 ,p_dpdnt_adoption_date in date default null
308 ,p_dpdnt_vlntry_svce_flag in varchar2 default 'N'
309 ,p_original_date_of_hire in date default null
310 ,p_adjusted_svc_date in date default null
311 ,p_place_of_birth in varchar2 default null
312 ,p_region_of_birth in varchar2 default null
313 ,p_country_of_birth in varchar2 default null
314 ,p_global_person_id in varchar2 default null
315 ,p_person_id out nocopy number
316 ,p_assignment_id out nocopy number
317 ,p_per_object_version_number out nocopy number
318 ,p_asg_object_version_number out nocopy number
319 ,p_per_effective_start_date out nocopy date
320 ,p_per_effective_end_date out nocopy date
321 ,p_full_name out nocopy varchar2
322 ,p_per_comment_id out nocopy number
323 ,p_assignment_sequence out nocopy number
324 ,p_assignment_number out nocopy varchar2
325 ,p_name_combination_warning out nocopy boolean
326 ,p_assign_payroll_warning out nocopy boolean
327 ,p_orig_hire_warning out nocopy boolean);
328 --
329 END hr_ae_employee_api;
[Home] [Help]