1 PACKAGE hr_nz_employee_api AS
2 /* $Header: hrnzwree.pkh 120.3 2005/10/17 07:20:01 rpalli noship $ */
3 /*#
4 * This package contains employee APIs for New Zealand.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Employee for New Zealand
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------------< create_nz_employee >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates an employee in a New Zealand business group.
17 *
18 * The API calls the generic API create_employee, with the parameters set as
19 * appropriate for a New Zealand employee.Performs mapping of Developer
20 * Descriptive Flexfield segments. This ensures appropriate identification
21 * information has been entered ie. National identifier or Passport
22 * information.
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 * If person_type_id is supplied, it must have a corresponding system person
29 * type of 'EMP', must be active and be in the same business group as that of
30 * the employee being created. Also the business group supplied should be a New
31 * Zealand business group.
32 *
33 * <p><b>Post Success</b><br>
34 * Successfully creates the person, primary assignment and period of service in
35 * the database.
36 *
37 * <p><b>Post Failure</b><br>
38 * The API does not create the person, primary assignment or period of service
39 * and raises an error.
40 * @param p_validate If true, then validation alone will be performed and the
41 * database will remain unchanged. If false and all validation checks pass,
42 * then the database will be modified.
43 * @param p_hire_date Indicates the date on which the employee is hired.
44 * @param p_business_group_id {@rep:casecolumn
45 * PER_ALL_PEOPLE_F.BUSINESS_GROUP_ID}
46 * @param p_last_name {@rep:casecolumn PER_ALL_PEOPLE_F.LAST_NAME}
47 * @param p_sex Indicates the Employee's Legal gender. Valid values are defined
48 * by 'SEX' lookup type.
49 * @param p_person_type_id {@rep:casecolumn PER_ALL_PEOPLE_F.PERSON_TYPE_ID}
50 * @param p_comments Comment text.
51 * @param p_date_employee_data_verified {@rep:casecolumn
52 * PER_ALL_PEOPLE_F.DATE_EMPLOYEE_DATA_VERIFIED}
53 * @param p_date_of_birth {@rep:casecolumn PER_ALL_PEOPLE_F.DATE_OF_BIRTH}
54 * @param p_email_address {@rep:casecolumn PER_ALL_PEOPLE_F.EMAIL_ADDRESS}
55 * @param p_employee_number The business group's employee number generation
56 * method determines when the API derives and passes out an employee number or
57 * when the calling program should pass in a value. When the API call completes
58 * if p_validate is false then will be set to the employee number. If
59 * p_validate is true then will be set to the passed value.
60 * @param p_expense_check_send_to_addres Indicates the Employee's Address to
61 * which the expense must be sent. Valid values are determined by 'HOME_OFFICE'
62 * lookup type.
63 * @param p_first_name {@rep:casecolumn PER_ALL_PEOPLE_F.FIRST_NAME}
64 * @param p_known_as {@rep:casecolumn PER_ALL_PEOPLE_F.KNOWN_AS}
65 * @param p_marital_status Indicates the Employee's Marital status. Valid
66 * values are defined by 'MAR_STATUS' lookup type.
67 * @param p_middle_names {@rep:casecolumn PER_ALL_PEOPLE_F.MIDDLE_NAMES}
68 * @param p_nationality Indicates the Employee's Nationality. Valid values are
69 * defined by 'NATIONALITY' lookup type.
70 * @param p_ird_number {@rep:casecolumn PER_ALL_PEOPLE_F.NATIONAL_IDENTIFIER}
71 * @param p_previous_last_name {@rep:casecolumn
72 * PER_ALL_PEOPLE_F.PREVIOUS_LAST_NAME}
73 * @param p_registered_disabled_flag Flag indicating whether Employee is
74 * classified as disabled. Valid values are defined by 'REGISTERED_DISABLED'
75 * lookup type.
76 * @param p_title Employee's Title e.g. Mr, Mrs, Dr. Valid values are defined
77 * by 'TITLE' lookup type.
78 * @param p_vendor_id {@rep:casecolumn PER_ALL_PEOPLE_F.VENDOR_ID}
79 * @param p_work_telephone {@rep:casecolumn PER_ALL_PEOPLE_F.WORK_TELEPHONE}
80 * @param p_attribute_category This context value determines which flexfield
81 * structure to use with the descriptive flexfield segments.
82 * @param p_attribute1 Descriptive flexfield segment.
83 * @param p_attribute2 Descriptive flexfield segment.
84 * @param p_attribute3 Descriptive flexfield segment.
85 * @param p_attribute4 Descriptive flexfield segment.
86 * @param p_attribute5 Descriptive flexfield segment.
87 * @param p_attribute6 Descriptive flexfield segment.
88 * @param p_attribute7 Descriptive flexfield segment.
89 * @param p_attribute8 Descriptive flexfield segment.
90 * @param p_attribute9 Descriptive flexfield segment.
91 * @param p_attribute10 Descriptive flexfield segment.
92 * @param p_attribute11 Descriptive flexfield segment.
93 * @param p_attribute12 Descriptive flexfield segment.
94 * @param p_attribute13 Descriptive flexfield segment.
95 * @param p_attribute14 Descriptive flexfield segment.
96 * @param p_attribute15 Descriptive flexfield segment.
97 * @param p_attribute16 Descriptive flexfield segment.
98 * @param p_attribute17 Descriptive flexfield segment.
99 * @param p_attribute18 Descriptive flexfield segment.
100 * @param p_attribute19 Descriptive flexfield segment.
101 * @param p_attribute20 Descriptive flexfield segment.
102 * @param p_attribute21 Descriptive flexfield segment.
103 * @param p_attribute22 Descriptive flexfield segment.
104 * @param p_attribute23 Descriptive flexfield segment.
105 * @param p_attribute24 Descriptive flexfield segment.
106 * @param p_attribute25 Descriptive flexfield segment.
107 * @param p_attribute26 Descriptive flexfield segment.
108 * @param p_attribute27 Descriptive flexfield segment.
109 * @param p_attribute28 Descriptive flexfield segment.
110 * @param p_attribute29 Descriptive flexfield segment.
111 * @param p_attribute30 Descriptive flexfield segment.
112 * @param p_country_born Indicates the country of birth of Employee. Valid
113 * values are defined by the view FND_TERRITORIES_VL
114 * @param p_work_permit_number Identifies the employee with the 7 digit work
115 * permit number.
116 * @param p_work_permit_expiry_date Indicates the Employee's work permit expiry
117 * date.
118 * @param p_ethnic_origin Indicates the ethnic origin of the employee. Valid
119 * values are defined by 'NZ_ETHNIC_ORIGIN' lookup type.
120 * @param p_tribal_group Indicates the Employee's tribal group. Valid values
121 * are defined by 'NZ_TRIBAL_GROUP' lookup type.
122 * @param p_district_of_origin Indiactes the Employee's district of origin.
123 * Valid values are defined by 'NZ_DISTRICT_OF_ORIGIN' lookup type.
124 * @param p_employment_category Statistics New Zealand employment category.
125 * Valid values are defined by 'NZ_STATS_NZ_EMP_CAT' lookup type.
126 * @param p_working_time Statistics New Zealand working time. Valid values are
127 * defined by 'NZ_STATS_NZ_WORKING_TIME' lookup type.
128 * @param p_date_of_death {@rep:casecolumn PER_ALL_PEOPLE_F.DATE_OF_DEATH}
129 * @param p_background_check_status Indicates the Background check status of
130 * the employee. Valid values as applicable are defined by 'YES_NO' lookup
131 * type.
132 * @param p_background_date_check {@rep:casecolumn
133 * PER_ALL_PEOPLE_F.BACKGROUND_DATE_CHECK}
134 * @param p_blood_type Indicates the Employee's Blood Group. Valid values are
135 * defined by 'BLOOD_TYPE' lookup type.
136 * @param p_correspondence_language {@rep:casecolumn
137 * PER_ALL_PEOPLE_F.CORRESPONDENCE_LANGUAGE}
138 * @param p_fast_path_employee {@rep:casecolumn
139 * PER_ALL_PEOPLE_F.FAST_PATH_EMPLOYEE}
140 * @param p_fte_capacity {@rep:casecolumn PER_ALL_PEOPLE_F.FTE_CAPACITY}
141 * @param p_honors {@rep:casecolumn PER_ALL_PEOPLE_F.HONORS}
142 * @param p_internal_location {@rep:casecolumn
143 * PER_ALL_PEOPLE_F.INTERNAL_LOCATION}
144 * @param p_last_medical_test_by {@rep:casecolumn
145 * PER_ALL_PEOPLE_F.LAST_MEDICAL_TEST_BY}
146 * @param p_last_medical_test_date {@rep:casecolumn
147 * PER_ALL_PEOPLE_F.LAST_MEDICAL_TEST_DATE}
148 * @param p_mailstop {@rep:casecolumn PER_ALL_PEOPLE_F.MAILSTOP}
149 * @param p_office_number {@rep:casecolumn PER_ALL_PEOPLE_F.OFFICE_NUMBER}
150 * @param p_on_military_service Indicates whether the employee was in the
151 * military service. Valid values as applicable are defined by 'YES_NO' lookup
152 * type.
153 * @param p_pre_name_adjunct {@rep:casecolumn
154 * PER_ALL_PEOPLE_F.PRE_NAME_ADJUNCT}
155 * @param p_projected_start_date {@rep:casecolumn
156 * PER_ALL_PEOPLE_F.PROJECTED_START_DATE}
157 * @param p_resume_exists Indicates whether the Employee's Resume already
158 * exists in the database. Valid values as applicable are defined by 'YES_NO'
159 * lookup type.
160 * @param p_resume_last_updated {@rep:casecolumn
161 * PER_ALL_PEOPLE_F.RESUME_LAST_UPDATED}
162 * @param p_second_passport_exists Employee's Second passport available, valid
163 * values as applicable are defined by 'YES_NO' lookup type.
164 * @param p_student_status Indicates the student status of the Employee. Valid
165 * values as applicable are defined by 'STUDENT_STATUS' lookup type.
166 * @param p_work_schedule Indicates the Employee's Work schedule. Valid values
167 * are defined by 'WORK_SCHEDULE' lookup type.
168 * @param p_suffix {@rep:casecolumn PER_ALL_PEOPLE_F.SUFFIX}
169 * @param p_benefit_group_id {@rep:casecolumn
170 * PER_ALL_PEOPLE_F.BENEFIT_GROUP_ID}
171 * @param p_receipt_of_death_cert_date {@rep:casecolumn
172 * PER_ALL_PEOPLE_F.RECEIPT_OF_DEATH_CERT_DATE}
173 * @param p_coord_ben_med_pln_no {@rep:casecolumn
174 * PER_ALL_PEOPLE_F.COORD_BEN_MED_PLN_NO}
175 * @param p_coord_ben_no_cvg_flag Indicates whether the employee has any
176 * coverage other than the Coordination of benefits. Valid values as applicable
177 * are defined by 'YES_NO' lookup type.
178 * @param p_uses_tobacco_flag Indicates whether the employee uses tabacco.
179 * Valid values as applicable are defined by 'YES_NO' lookup type.
180 * @param p_dpdnt_adoption_date {@rep:casecolumn
181 * PER_ALL_PEOPLE_F.DPDNT_ADOPTION_DATE}
182 * @param p_dpdnt_vlntry_svce_flag Indicates whether the employee was in the
183 * dependent voluntary service. Valid values are defined by 'YES_NO' lookup
184 * type.
185 * @param p_original_date_of_hire {@rep:casecolumn
186 * PER_ALL_PEOPLE_F.ORIGINAL_DATE_OF_HIRE}
187 * @param p_adjusted_svc_date {@rep:casecolumn
188 * PER_PERIODS_OF_SERVICE.ADJUSTED_SVC_DATE}
189 * @param p_person_id If p_validate is false, then this uniquely identifies the
190 * person created. If p_validate is true, then set to null.
191 * @param p_assignment_id If p_validate is false, then this uniquely identifies
192 * the created assignment. If p_validate is true, then set to null.
193 * @param p_per_object_version_number If p_validate is false, then set to the
194 * version number of the created person. If p_validate is true, then the value
195 * will be null.
196 * @param p_asg_object_version_number If p_validate is false, then set to the
197 * version number of the created assignment. If p_validate is true, then the
198 * value will be null.
199 * @param p_per_effective_start_date If p_validate is false, this will be set
200 * to the effective start date of the person. If p_validate is true this will
201 * be null.
202 * @param p_per_effective_end_date If p_validate is false, this will be set to
203 * the effective end date of the person. If p_validate is true this will be
204 * null.
205 * @param p_full_name If p_validate is false, then set to the full name of the
206 * person. If p_validate is true, then set to null.
207 * @param p_per_comment_id If p_validate is false, this will be set to the
208 * comments for the person. If p_validate is true this will be null.
209 * @param p_assignment_sequence If p_validate is false, this will be set to the
210 * assignment sequence for the person. If p_validate is true this will be null.
211 * @param p_assignment_number If p_validate is false, this will be set to the
212 * assignment number of the person. If p_validate is true this will be null.
213 * @param p_name_combination_warning If set to true, then the combination of
214 * last name, first name and date of birth existed prior to calling this API.
215 * @param p_assign_payroll_warning If set to true, then the date of birth is
216 * not entered. If set to false, then the date of birth has been entered.
217 * Indicates if it will be possible to set the payroll on any of this person's
218 * assignments.
219 * @param p_orig_hire_warning If p_validate is false, the original date of hire
220 * is provided and the person type is not
221 * Employee,Employee-Applicant,Ex-Employee or Ex-Employee Applicant, then set
222 * to true.
223 * @param p_rehire_recommendation Obsolete parameter, do not use.
224 * @param p_coord_ben_med_ext_er Secondary external medical coverage. Column
225 * used for external processing.
226 * @param p_coord_ben_med_pl_name Secondary medical coverage name. Column used
227 * for external processing.
228 * @param p_coord_ben_med_insr_crr_name Secondary medical coverage insurance
229 * carrier name. Column used for external processing.
230 * @param p_coord_ben_med_insr_crr_ident Secondary medical coverage insurance
231 * carrier identifier. Column used for external processing.
232 * @param p_coord_ben_med_cvg_strt_dt Secondary medical coverage effective
233 * start date. Column used for external processing.
234 * @param p_coord_ben_med_cvg_end_dt Secondary medical coverage effective end
235 * date. Column used for external processing.
236 * @param p_town_of_birth Town or city of birth.
237 * @param p_region_of_birth Geographical region of birth.
238 * @param p_country_of_birth Country of birth.
239 * @param p_global_person_id Obsolete parameter, do not use.
240 * @param p_party_id TCA party for whom you create the person record.
241 * @rep:displayname Create Employee for New Zealand busines group
242 * @rep:category BUSINESS_ENTITY PER_EMPLOYEE
243 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
244 * @rep:scope public
245 * @rep:lifecycle active
246 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
247 */
248 --
249 -- {End Of Comments}
250 --
251
252 PROCEDURE create_nz_employee
253 (p_validate IN BOOLEAN DEFAULT FALSE
254 ,p_hire_date IN DATE
255 ,p_business_group_id IN NUMBER
256 ,p_last_name IN VARCHAR2
257 ,p_sex IN VARCHAR2
258 ,p_person_type_id IN NUMBER DEFAULT NULL
259 ,p_comments IN VARCHAR2 DEFAULT NULL
260 ,p_date_employee_data_verified IN DATE DEFAULT NULL
261 ,p_date_of_birth IN DATE DEFAULT NULL
262 ,p_email_address IN VARCHAR2 DEFAULT NULL
263 ,p_employee_number IN OUT NOCOPY VARCHAR2
264 ,p_expense_check_send_to_addres IN VARCHAR2 DEFAULT NULL
265 ,p_first_name IN VARCHAR2 DEFAULT NULL
266 ,p_known_as IN VARCHAR2 DEFAULT NULL
267 ,p_marital_status IN VARCHAR2 DEFAULT NULL
268 ,p_middle_names IN VARCHAR2 DEFAULT NULL
269 ,p_nationality IN VARCHAR2 DEFAULT NULL
270 ,p_ird_number IN VARCHAR2 DEFAULT NULL
271 ,p_previous_last_name IN VARCHAR2 DEFAULT NULL
272 ,p_registered_disabled_flag IN VARCHAR2 DEFAULT NULL
273 ,p_title IN VARCHAR2 DEFAULT NULL
274 ,p_vendor_id IN NUMBER DEFAULT NULL
275 ,p_work_telephone IN VARCHAR2 DEFAULT NULL
276 ,p_attribute_category IN VARCHAR2 DEFAULT NULL
277 ,p_attribute1 IN VARCHAR2 DEFAULT NULL
278 ,p_attribute2 IN VARCHAR2 DEFAULT NULL
279 ,p_attribute3 IN VARCHAR2 DEFAULT NULL
280 ,p_attribute4 IN VARCHAR2 DEFAULT NULL
281 ,p_attribute5 IN VARCHAR2 DEFAULT NULL
282 ,p_attribute6 IN VARCHAR2 DEFAULT NULL
283 ,p_attribute7 IN VARCHAR2 DEFAULT NULL
284 ,p_attribute8 IN VARCHAR2 DEFAULT NULL
285 ,p_attribute9 IN VARCHAR2 DEFAULT NULL
286 ,p_attribute10 IN VARCHAR2 DEFAULT NULL
287 ,p_attribute11 IN VARCHAR2 DEFAULT NULL
288 ,p_attribute12 IN VARCHAR2 DEFAULT NULL
289 ,p_attribute13 IN VARCHAR2 DEFAULT NULL
290 ,p_attribute14 IN VARCHAR2 DEFAULT NULL
291 ,p_attribute15 IN VARCHAR2 DEFAULT NULL
292 ,p_attribute16 IN VARCHAR2 DEFAULT NULL
293 ,p_attribute17 IN VARCHAR2 DEFAULT NULL
294 ,p_attribute18 IN VARCHAR2 DEFAULT NULL
295 ,p_attribute19 IN VARCHAR2 DEFAULT NULL
296 ,p_attribute20 IN VARCHAR2 DEFAULT NULL
297 ,p_attribute21 IN VARCHAR2 DEFAULT NULL
298 ,p_attribute22 IN VARCHAR2 DEFAULT NULL
299 ,p_attribute23 IN VARCHAR2 DEFAULT NULL
300 ,p_attribute24 IN VARCHAR2 DEFAULT NULL
301 ,p_attribute25 IN VARCHAR2 DEFAULT NULL
302 ,p_attribute26 IN VARCHAR2 DEFAULT NULL
303 ,p_attribute27 IN VARCHAR2 DEFAULT NULL
304 ,p_attribute28 IN VARCHAR2 DEFAULT NULL
305 ,p_attribute29 IN VARCHAR2 DEFAULT NULL
306 ,p_attribute30 IN VARCHAR2 DEFAULT NULL
307 ,p_country_born IN VARCHAR2 DEFAULT NULL
308 ,p_work_permit_number IN VARCHAR2 DEFAULT NULL
309 ,p_work_permit_expiry_date IN VARCHAR2 DEFAULT NULL
310 ,p_ethnic_origin IN VARCHAR2 DEFAULT NULL
311 ,p_tribal_group IN VARCHAR2 DEFAULT NULL
312 ,p_district_of_origin IN VARCHAR2 DEFAULT NULL
313 ,p_employment_category IN VARCHAR2 DEFAULT NULL
314 ,p_working_time IN VARCHAR2 DEFAULT NULL
315 ,p_date_of_death IN DATE DEFAULT NULL
316 ,p_background_check_status IN VARCHAR2 DEFAULT NULL
317 ,p_background_date_check IN DATE DEFAULT NULL
318 ,p_blood_type IN VARCHAR2 DEFAULT NULL
319 ,p_correspondence_language IN VARCHAR2 DEFAULT NULL
320 ,p_fast_path_employee IN VARCHAR2 DEFAULT NULL
321 ,p_fte_capacity IN NUMBER DEFAULT NULL
322 ,p_honors IN VARCHAR2 DEFAULT NULL
323 ,p_internal_location IN VARCHAR2 DEFAULT NULL
324 ,p_last_medical_test_by IN VARCHAR2 DEFAULT NULL
325 ,p_last_medical_test_date IN DATE DEFAULT NULL
326 ,p_mailstop IN VARCHAR2 DEFAULT NULL
327 ,p_office_number IN VARCHAR2 DEFAULT NULL
328 ,p_on_military_service IN VARCHAR2 DEFAULT NULL
329 ,p_pre_name_adjunct IN VARCHAR2 DEFAULT NULL
330 ,p_rehire_recommendation IN VARCHAR2 DEFAULT NULL
331 ,p_projected_start_date IN DATE DEFAULT NULL
332 ,p_resume_exists IN VARCHAR2 DEFAULT NULL
333 ,p_resume_last_updated IN DATE DEFAULT NULL
334 ,p_second_passport_exists IN VARCHAR2 DEFAULT NULL
335 ,p_student_status IN VARCHAR2 DEFAULT NULL
336 ,p_work_schedule IN VARCHAR2 DEFAULT NULL
337 ,p_suffix IN VARCHAR2 DEFAULT NULL
338 ,p_benefit_group_id IN NUMBER DEFAULT NULL
339 ,p_receipt_of_death_cert_date IN DATE DEFAULT NULL
340 ,p_coord_ben_med_pln_no IN VARCHAR2 DEFAULT NULL
341 ,p_coord_ben_no_cvg_flag IN VARCHAR2 DEFAULT 'N'
342 ,p_coord_ben_med_ext_er IN VARCHAR2 DEFAULT NULL
343 ,p_coord_ben_med_pl_name IN VARCHAR2 DEFAULT NULL
344 ,p_coord_ben_med_insr_crr_name IN VARCHAR2 DEFAULT NULL
345 ,p_coord_ben_med_insr_crr_ident IN VARCHAR2 DEFAULT NULL
346 ,p_coord_ben_med_cvg_strt_dt IN DATE DEFAULT NULL
347 ,p_coord_ben_med_cvg_end_dt IN DATE DEFAULT NULL
348 ,p_uses_tobacco_flag IN VARCHAR2 DEFAULT NULL
349 ,p_dpdnt_adoption_date IN DATE DEFAULT NULL
350 ,p_dpdnt_vlntry_svce_flag IN VARCHAR2 DEFAULT 'N'
351 ,p_original_date_of_hire IN DATE DEFAULT NULL
352 ,p_adjusted_svc_date IN DATE DEFAULT NULL
353 ,p_town_of_birth IN VARCHAR2 DEFAULT NULL
354 ,p_region_of_birth IN VARCHAR2 DEFAULT NULL
355 ,p_country_of_birth IN VARCHAR2 DEFAULT NULL
356 ,p_global_person_id IN VARCHAR2 DEFAULT NULL
357 ,p_party_id IN NUMBER DEFAULT NULL
358 ,p_person_id OUT NOCOPY NUMBER
359 ,p_assignment_id OUT NOCOPY NUMBER
360 ,p_per_object_version_number OUT NOCOPY NUMBER
361 ,p_asg_object_version_number OUT NOCOPY NUMBER
362 ,p_per_effective_start_date OUT NOCOPY DATE
363 ,p_per_effective_end_date OUT NOCOPY DATE
364 ,p_full_name OUT NOCOPY VARCHAR2
365 ,p_per_comment_id OUT NOCOPY NUMBER
366 ,p_assignment_sequence OUT NOCOPY NUMBER
367 ,p_assignment_number OUT NOCOPY VARCHAR2
368 ,p_name_combination_warning OUT NOCOPY BOOLEAN
369 ,p_assign_payroll_warning OUT NOCOPY BOOLEAN
370 ,p_orig_hire_warning OUT NOCOPY BOOLEAN
371 );
372 END hr_nz_employee_api;
[Home] [Help]