1 package hr_kw_employee_api as
2 /* $Header: peempkwi.pkh 120.2 2005/10/02 02:41:27 aroussel $ */
3 /*#
4 * This package contains employee APIs for Kuwait.
5 * @rep:scope public
6 * @rep:product PER
7 * @rep:displayname Employee for Kuwait
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------------< create_kw_employee >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a new employee record with a default primary assignment and
17 * a period of service for the employee.
18 *
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. The
21 * following parameters are currently unsupported and must have a null value:
22 * p_fast_path_employee p_projected_start_date. Prerequisites: If
23 * person_type_id is supplied, then it must have a corresponding, active system
24 * person type of 'EMP', and be in the same business group as the employee
25 * being created.
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 the person_type_id is supplied, then it must have a corresponding system
32 * person type of 'EMP', must be active and be in the same business group as
33 * the employee being created.
34 *
35 * <p><b>Post Success</b><br>
36 * The person, primary assignment, and period of service will be successfully
37 * inserted into the database.
38 *
39 * <p><b>Post Failure</b><br>
40 * The person, primary assignment or period of service will not be created and
41 * an error will be raised.
42 *
43 * @param p_validate If true, then validation alone will be performed and the
44 * database will remain unchanged. If false and all validation checks pass,
45 * then the database will be modified.
46 * @param p_hire_date The employee hire date is the effective start date of the
47 * person, primary assignment and period of service.
48 * @param p_business_group_id The employee's business group.
49 * @param p_family_name The employee's family name.
50 * @param p_sex Employee's sex. Valid values are defined in the 'SEX' lookup
51 * type.
52 * @param p_person_type_id Person type id. If this value is omitted then the
53 * person_type_id of the default `EMP' system person type in the employee's
54 * business group is used.
55 * @param p_comments Comments for employee record.
56 * @param p_date_employee_data_verified The date on which the employee data was
57 * last verified.
58 * @param p_date_of_birth The employee's date of birth.
59 * @param p_email_address The employee's email address.
60 * @param p_employee_number If p_validate is false this will be set to the
61 * employee number of the person created. If p_validate is true this will be
62 * set to the same value as passed in.
63 * @param p_expense_check_send_to_addres Address to use as mailing address.
64 * @param p_first_name Employee's first name.
65 * @param p_known_as Employee's alternative name.
66 * @param p_marital_status The employee's marital status.
67 * @param p_nationality Employee's nationality.
68 * @param p_national_identifier National identifier.
69 * @param p_previous_last_name Previous last name.
70 * @param p_registered_disabled_flag Registered disabled flag.
71 * @param p_title Employee's title.
72 * @param p_vendor_id Foreign key to PO_VENDORS.
73 * @param p_work_telephone The employee's work telephone.
74 * @param p_attribute_category This context value determines which flexfield
75 * structure to use with the descriptive flexfield segments.
76 * @param p_attribute1 Descriptive flexfield segment.
77 * @param p_attribute2 Descriptive flexfield segment.
78 * @param p_attribute3 Descriptive flexfield segment.
79 * @param p_attribute4 Descriptive flexfield segment.
80 * @param p_attribute5 Descriptive flexfield segment.
81 * @param p_attribute6 Descriptive flexfield segment.
82 * @param p_attribute7 Descriptive flexfield segment.
83 * @param p_attribute8 Descriptive flexfield segment.
84 * @param p_attribute9 Descriptive flexfield segment.
85 * @param p_attribute10 Descriptive flexfield segment.
89 * @param p_attribute14 Descriptive flexfield segment.
86 * @param p_attribute11 Descriptive flexfield segment.
87 * @param p_attribute12 Descriptive flexfield segment.
88 * @param p_attribute13 Descriptive flexfield segment.
90 * @param p_attribute15 Descriptive flexfield segment.
91 * @param p_attribute16 Descriptive flexfield segment.
92 * @param p_attribute17 Descriptive flexfield segment.
93 * @param p_attribute18 Descriptive flexfield segment.
94 * @param p_attribute19 Descriptive flexfield segment.
95 * @param p_attribute20 Descriptive flexfield segment.
96 * @param p_attribute21 Descriptive flexfield segment.
97 * @param p_attribute22 Descriptive flexfield segment.
98 * @param p_attribute23 Descriptive flexfield segment.
99 * @param p_attribute24 Descriptive flexfield segment.
100 * @param p_attribute25 Descriptive flexfield segment.
101 * @param p_attribute26 Descriptive flexfield segment.
102 * @param p_attribute27 Descriptive flexfield segment.
103 * @param p_attribute28 Descriptive flexfield segment.
104 * @param p_attribute29 Descriptive flexfield segment.
105 * @param p_attribute30 Descriptive flexfield segment.
106 * @param p_father_name Father's Name.
107 * @param p_grandfather_name Grandfather's Name.
108 * @param p_alt_first_name Alternate first name.
109 * @param p_alt_father_name Father's alternate name.
110 * @param p_alt_grandfather_name Grandfather's alternate name.
111 * @param p_alt_family_name Alternate family name.
112 * @param p_previous_nationality Previous Nationality.
113 * @param p_religion The employee's religion.
114 * @param p_date_of_death The employee's date of death.
115 * @param p_background_check_status Y/N flag indicates whether background check
116 * has been performed.
117 * @param p_background_date_check Date background check was performed.
118 * @param p_blood_type The employee's blood type.
119 * @param p_correspondence_language The employee's preferred language for
120 * 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 last medical
126 * 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 Number of office.
130 * @param p_on_military_service Y/N flag indicating whether person is employed
131 * 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 indicating 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 days a person
139 * 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 insurance
147 * 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 end
153 * date.
154 * @param p_uses_tobacco_flag Type of tobacco used by the employee.
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_town_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_person_id If p_validate is false, this uniquely identifies the
164 * person created. If p_validate is true this parameter will be null.
165 * @param p_assignment_id If p_validate is false, this uniquely identifies the
166 * primary assignment created. If p_validate is true this parameter will be
167 * null.
168 * @param p_per_object_version_number If p_validate is false, this will be set
169 * to the version number of the person created. If p_validate is true this
170 * parameter will be set to null.
174 * @param p_per_effective_start_date If p_validate is false, then this will be
171 * @param p_asg_object_version_number If p_validate is false, then this
172 * parameter is set to the version number of the assignment created. If
173 * p_validate is true, then this parameter is null.
175 * set to the effective start date of the person. If p_validate is true, then
176 * this will be null.
177 * @param p_per_effective_end_date If p_validate is false, then this will be
178 * set to the effective end date of the person. If p_validate is true, then
179 * this will be null.
180 * @param p_full_name If p_validate is false, then this will be set to the
181 * complete full name of the person. If p_validate is true, then this will be
182 * null.
183 * @param p_per_comment_id If p_validate is false this will be set to the id of
184 * the corresponding person comment row, if any comment text exists. If
185 * p_validate is true this will be null.
186 * @param p_assignment_sequence If p_validate is false, then this will be set
187 * to the sequence number of the primary assignment. If p_validate is true,
188 * then this will be null.
189 * @param p_assignment_number If p_validate is false, then this will be set to
190 * the assignment number of the primary assignment. If p_validate is true, then
191 * this will be null.
192 * @param p_name_combination_warning If set to true, then the combination of
193 * last name, first name and date of birth existed prior to calling this API.
194 * @param p_assign_payroll_warning If set to true, then the date of birth is
195 * not entered. If set to false, then the date of birth has been entered.
196 * Indicates if it will be possible to set the payroll on any of this person's
197 * assignments.
201 * @rep:category BUSINESS_ENTITY PER_EMPLOYEE
198 * @param p_orig_hire_warning Set to true if the original date of hire is not
199 * null and the person type is not EMP,EMP_APL, EX_EMP or EX_EMP_APL.
200 * @rep:displayname Create Employee for Kuwait
202 * @rep:lifecycle active
203 * @rep:scope public
204 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
205 */
206 --
207 -- {End Of Comments}
208 --
209 PROCEDURE create_kw_employee
210 (p_validate in boolean default false
211 ,p_hire_date in date
212 ,p_business_group_id in number
213 ,p_family_name in varchar2
214 ,p_sex in varchar2
215 ,p_person_type_id in number default null
216 ,p_comments in varchar2 default null
217 ,p_date_employee_data_verified in date default null
218 ,p_date_of_birth in date default null
219 ,p_email_address in varchar2 default null
220 ,p_employee_number in out nocopy varchar2
221 ,p_expense_check_send_to_addres in varchar2 default null
222 ,p_first_name in varchar2
223 ,p_known_as in varchar2 default null
224 ,p_marital_status in varchar2 default null
225 ,p_nationality in varchar2
226 ,p_national_identifier in varchar2 default null
227 ,p_previous_last_name in varchar2 default null
228 ,p_registered_disabled_flag in varchar2 default null
229 ,p_title in varchar2 default null
230 ,p_vendor_id in number default null
231 ,p_work_telephone in varchar2 default null
232 ,p_attribute_category in varchar2 default null
233 ,p_attribute1 in varchar2 default null
234 ,p_attribute2 in varchar2 default null
235 ,p_attribute3 in varchar2 default null
236 ,p_attribute4 in varchar2 default null
237 ,p_attribute5 in varchar2 default null
238 ,p_attribute6 in varchar2 default null
239 ,p_attribute7 in varchar2 default null
240 ,p_attribute8 in varchar2 default null
241 ,p_attribute9 in varchar2 default null
242 ,p_attribute10 in varchar2 default null
243 ,p_attribute11 in varchar2 default null
244 ,p_attribute12 in varchar2 default null
245 ,p_attribute13 in varchar2 default null
246 ,p_attribute14 in varchar2 default null
247 ,p_attribute15 in varchar2 default null
248 ,p_attribute16 in varchar2 default null
249 ,p_attribute17 in varchar2 default null
250 ,p_attribute18 in varchar2 default null
251 ,p_attribute19 in varchar2 default null
252 ,p_attribute20 in varchar2 default null
253 ,p_attribute21 in varchar2 default null
254 ,p_attribute22 in varchar2 default null
255 ,p_attribute23 in varchar2 default null
256 ,p_attribute24 in varchar2 default null
257 ,p_attribute25 in varchar2 default null
258 ,p_attribute26 in varchar2 default null
259 ,p_attribute27 in varchar2 default null
260 ,p_attribute28 in varchar2 default null
261 ,p_attribute29 in varchar2 default null
262 ,p_attribute30 in varchar2 default null
263 ,p_father_name in varchar2 default null
264 ,p_grandfather_name in varchar2 default null
268 ,p_alt_family_name in varchar2 default null
265 ,p_alt_first_name in varchar2 default null
266 ,p_alt_father_name in varchar2 default null
267 ,p_alt_grandfather_name in varchar2 default null
269 ,p_previous_nationality in varchar2 default null
270 ,p_religion in varchar2 default null
271 ,p_date_of_death in date default null
272 ,p_background_check_status in varchar2 default null
273 ,p_background_date_check in date default null
274 ,p_blood_type in varchar2 default null
275 ,p_correspondence_language in varchar2 default null
276 ,p_fast_path_employee in varchar2 default null
277 ,p_fte_capacity in number default null
278 ,p_honors in varchar2 default null
279 ,p_internal_location in varchar2 default null
280 ,p_last_medical_test_by in varchar2 default null
281 ,p_last_medical_test_date in date default null
282 ,p_mailstop in varchar2 default null
283 ,p_office_number in varchar2 default null
284 ,p_on_military_service in varchar2 default null
285 ,p_projected_start_date in date default null
286 ,p_resume_exists in varchar2 default null
287 ,p_resume_last_updated in date default null
288 ,p_second_passport_exists in varchar2 default null
289 ,p_student_status in varchar2 default null
290 ,p_work_schedule in varchar2 default null
291 ,p_benefit_group_id in number default null
292 ,p_receipt_of_death_cert_date in date default null
293 ,p_coord_ben_med_pln_no in varchar2 default null
294 ,p_coord_ben_no_cvg_flag in varchar2 default 'N'
295 ,p_coord_ben_med_ext_er in varchar2 default null
296 ,p_coord_ben_med_pl_name in varchar2 default null
300 ,p_coord_ben_med_cvg_end_dt in date default null
297 ,p_coord_ben_med_insr_crr_name in varchar2 default null
298 ,p_coord_ben_med_insr_crr_ident in varchar2 default null
299 ,p_coord_ben_med_cvg_strt_dt in date default null
301 ,p_uses_tobacco_flag in varchar2 default null
302 ,p_dpdnt_adoption_date in date default null
303 ,p_dpdnt_vlntry_svce_flag in varchar2 default 'N'
304 ,p_original_date_of_hire in date default null
305 ,p_adjusted_svc_date in date default null
306 ,p_town_of_birth in varchar2 default null
307 ,p_region_of_birth in varchar2 default null
308 ,p_country_of_birth in varchar2 default null
309 ,p_global_person_id in varchar2 default null
310 ,p_person_id out nocopy number
311 ,p_assignment_id out nocopy number
312 ,p_per_object_version_number out nocopy number
313 ,p_asg_object_version_number out nocopy number
314 ,p_per_effective_start_date out nocopy date
315 ,p_per_effective_end_date out nocopy date
316 ,p_full_name out nocopy varchar2
317 ,p_per_comment_id out nocopy number
318 ,p_assignment_sequence out nocopy number
319 ,p_assignment_number out nocopy varchar2
320 ,p_name_combination_warning out nocopy boolean
321 ,p_assign_payroll_warning out nocopy boolean
322 ,p_orig_hire_warning out nocopy boolean);
323 --
324 END hr_kw_employee_api;
[Home] [Help]