1 Package hr_applicant_api as
2 /* $Header: peappapi.pkh 120.5.12010000.1 2008/07/28 04:06:30 appldev ship $ */
3 /*#
4 * This package contains applicant APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Applicant
8 */
9 --
10 -- ---------------------------------------------------------------------------
11 -- |--------------------------< create_applicant >---------------------------|
12 -- ---------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a new applicant.
17 *
18 * The API creates the person details, an application, a default applicant
19 * assignment, and if required associated assignment budget values, and a
20 * letter request. The API adds the applicant to the security lists so that
21 * secure users can see the applicant. If a person_type_id is not specified the
22 * API will use the default 'APL' type for the business group.
23 *
24 * <p><b>Licensing</b><br>
25 * This API is licensed for use with Oracle Human Resources and iRecruitment.
26 *
27 * <p><b>Prerequisites</b><br>
28 * A valid business group must exist. Also a valid person_type_id, with a
29 * corresponding system type of 'APL' must be active and in the same business
30 * group as that of the applicant being created.
31 *
32 * <p><b>Post Success</b><br>
33 * The API successfully creates the person, application, default applicant
34 * assignment and if required associated assignment budget values, and a letter
35 * request.
36 *
37 * <p><b>Post Failure</b><br>
38 * The API does not create the person, default applicant assignment, associated
39 * assignment budget values, and a letter request and raises an error.
40 *
41 * @param p_validate If true, then validation alone will be performed and the
42 * database will remain unchanged. If false and all validation checks pass,
43 * then the database will be modified.
44 * @param p_date_received The date an application was received and thus the
45 * effective start date of the person, application, and assignment.
46 * @param p_business_group_id The applicant's business group.
47 * @param p_last_name The applicant's last name.
48 * @param p_person_type_id Person type id. If a person_type_id is not specified
49 * , then the API will use the default 'APL' type for the business group.
50 * @param p_applicant_number Identifies the applicant number. If the number
51 * generation method is Manual, then this parameter is mandatory. If the number
52 * generation method is Automatic, then the value of this parameter must be
53 * null. If p_validate is false and the applicant number generation method is
54 * Automatic, then this will be set to the generated applicant number of the
55 * person created. If p_validate is false and the applicant number generation
56 * method is manual, then this will be set to the same value passed in. If
57 * p_validate is true, then this will be set to the same value as passed in.
58 * @param p_per_comments Comments for the person record.
59 * @param p_date_employee_data_verified The date on which the applicant data
60 * was last verified.
61 * @param p_date_of_birth Date of birth of the applicant.
62 * @param p_email_address E-mail address of the applicant.
63 * @param p_expense_check_send_to_addres Address to use as the applicant's
64 * mailing address.
65 * @param p_first_name Applicant's first name.
66 * @param p_known_as Applicant's alternative name.
67 * @param p_marital_status Applicant's marital status. Valid values are defined
68 * by the 'MAR_STATUS' lookup type.
69 * @param p_middle_names Applicant's middle name(s).
70 * @param p_nationality Applicant's nationality. Valid values are defined by
71 * the 'NATIONALITY' lookup type.
72 * @param p_national_identifier Applicant's national identifier.
73 * @param p_previous_last_name Applicant's previous last name.
74 * @param p_registered_disabled_flag Indicates whether person is classified as
75 * disabled. Valid values exist in the 'REGISTERED_DISABLED' lookup type.
76 * @param p_sex The sex of the applicant.
77 * @param p_title The title of the applicant. Valid values are defined by the
78 * 'TITLE' lookup type.
79 * @param p_work_telephone Work telephone of the applicant.
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_per_information_category Obsolete parameter, do not use.
113 * @param p_per_information1 Developer descriptive flexfield segment.
114 * @param p_per_information2 Developer descriptive flexfield segment.
115 * @param p_per_information3 Developer descriptive flexfield segment.
116 * @param p_per_information4 Developer descriptive flexfield segment.
117 * @param p_per_information5 Developer descriptive flexfield segment.
118 * @param p_per_information6 Developer descriptive flexfield segment.
119 * @param p_per_information7 Developer descriptive flexfield segment.
120 * @param p_per_information8 Developer descriptive flexfield segment.
121 * @param p_per_information9 Developer descriptive flexfield segment.
122 * @param p_per_information10 Developer descriptive flexfield segment.
123 * @param p_per_information11 Developer descriptive flexfield segment.
124 * @param p_per_information12 Developer descriptive flexfield segment.
125 * @param p_per_information13 Developer descriptive flexfield segment.
126 * @param p_per_information14 Developer descriptive flexfield segment.
127 * @param p_per_information15 Developer descriptive flexfield segment.
128 * @param p_per_information16 Developer descriptive flexfield segment.
129 * @param p_per_information17 Developer descriptive flexfield segment.
130 * @param p_per_information18 Developer descriptive flexfield segment.
131 * @param p_per_information19 Developer descriptive flexfield segment.
132 * @param p_per_information20 Developer descriptive flexfield segment.
133 * @param p_per_information21 Developer descriptive flexfield segment.
134 * @param p_per_information22 Developer descriptive flexfield segment.
135 * @param p_per_information23 Developer descriptive flexfield segment.
136 * @param p_per_information24 Developer descriptive flexfield segment.
137 * @param p_per_information25 Developer descriptive flexfield segment.
138 * @param p_per_information26 Developer descriptive flexfield segment.
139 * @param p_per_information27 Developer descriptive flexfield segment.
140 * @param p_per_information28 Developer descriptive flexfield segment.
141 * @param p_per_information29 Developer descriptive flexfield segment.
142 * @param p_per_information30 Developer descriptive flexfield segment.
143 * @param p_background_check_status Indicates whether the person's background
144 * has been checked. Valid values exist in the 'YES_NO' lookup type.
145 * @param p_background_date_check Date when the background check was performed
146 * on the applicant.
147 * @param p_correspondence_language Applicant's preferred language for
148 * correspondence.
149 * @param p_fte_capacity This parameter is currently not supported.
150 * @param p_hold_applicant_date_until Date till the applicant's information is
151 * to be maintained.
152 * @param p_honors Honors or degrees awarded.
153 * @param p_mailstop Office identifier for internal mail.
154 * @param p_office_number Office number of the applicant.
155 * @param p_on_military_service Type of military service.
156 * @param p_pre_name_adjunct First part of surname such as Van or De.
157 * @param p_projected_start_date This parameter is currently not supported.
158 * @param p_resume_exists Y/N flag indicating whether the applicant's resume
159 * exists in the database.
160 * @param p_resume_last_updated Date when the resume was last updated.
161 * @param p_student_status Indicates the type of student status. Valid values
162 * are defined by the 'STUDENT_STATUS' lookup type.
163 * @param p_work_schedule Type of work schedule indicating days on which the
164 * person works. Valid values are defined by the 'WORK_SCHEDULE' lookup type.
165 * @param p_suffix Suffix after the person's last name.
166 * @param p_date_of_death Date of death of the applicant.
167 * @param p_benefit_group_id Identification number for the benefit group.
168 * @param p_receipt_of_death_cert_date Date when the death certificate was
169 * received.
170 * @param p_coord_ben_med_pln_no Number of the medical plan provided by an
171 * external organization.
172 * @param p_coord_ben_no_cvg_flag Indicates that the person is not covered by
173 * any other benefit plan.
174 * @param p_uses_tobacco_flag Tobacco type used by the person. Valid values are
175 * defined by 'TOBACCO_USER' lookup type.
176 * @param p_dpdnt_adoption_date Date on which the dependent was adopted.
177 * @param p_dpdnt_vlntry_svce_flag Indicates whether the dependent is on
178 * voluntary service.
179 * @param p_original_date_of_hire Original date of hire.
180 * @param p_town_of_birth Town or city of birth of the applicant.
181 * @param p_region_of_birth Geographical region of birth of the applicant.
182 * @param p_country_of_birth Country of birth of the applicant.
183 * @param p_global_person_id Global identification number for the person.
184 * @param p_party_id TCA party ID for whom you create the person record.
185 * @param p_vacancy_id Identifies the vacancy for which the person has applied.
186 * @param p_person_id If p_validate is false, then this uniquely identifies the
187 * person created. If p_validate is true, then set to null.
188 * @param p_assignment_id If p_validate is false, then this uniquely identifies
189 * the created assignment. If p_validate is true, then set to null.
190 * @param p_application_id If p_validate is false, this uniquely identifies the
191 * application created. If p_validate is true this parameter will be null.
192 * @param p_per_object_version_number If p_validate is false, then set to the
193 * version number of the created person. If p_validate is true, then set to
194 * null.
195 * @param p_asg_object_version_number If p_validate is false, then this
196 * parameter is set to the version number of the assignment created. If
197 * p_validate is true, then this parameter is null.
198 * @param p_apl_object_version_number If p_validate is false, this will be set
199 * to the version number of the application created. If p_validate is true this
200 * parameter will be set to null.
201 * @param p_per_effective_start_date If p_validate is false, this will be set
202 * to the effective start date of the person. If p_validate is true this will
203 * be null.
204 * @param p_per_effective_end_date If p_validate is false, this will be set to
205 * the effective end date of the person. If p_validate is true this will be
206 * null.
207 * @param p_full_name If p_validate is false, this will be set to the complete
208 * full name of the person. If p_validate is true this will be null.
209 * @param p_per_comment_id If p_validate is false, then this will be set to the
210 * id of the corresponding person comment row, if any comment text exists. If
211 * p_validate is true this will be null.
212 * @param p_assignment_sequence If p_validate is false this will be set to the
213 * sequence number of the default assignment. If p_validate is true this will
214 * be null.
215 * @param p_name_combination_warning If set to true, then the combination of
216 * last name, first name and date of birth existed prior to calling this API.
217 * @param p_orig_hire_warning Set to true if the original date of hire is not
218 * null and the person type is not EMP,EMP_APL, EX_EMP or EX_EMP_APL.
219 * @rep:displayname Create Applicant
220 * @rep:category BUSINESS_ENTITY PER_APPLICANT
221 * @rep:lifecycle active
222 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
223 * @rep:scope public
224 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
225 */
226 -- {End Of Comments}
227 --
228 procedure create_applicant
229 (p_validate in boolean default false
230 ,p_date_received in date
231 ,p_business_group_id in number
232 ,p_last_name in varchar2
233 ,p_person_type_id in number default null
234 ,p_applicant_number in out nocopy varchar2
235 ,p_per_comments in varchar2 default null
236 ,p_date_employee_data_verified in date default null
237 ,p_date_of_birth in date default null
238 ,p_email_address in varchar2 default null
239 ,p_expense_check_send_to_addres in varchar2 default null
240 ,p_first_name in varchar2 default null
241 ,p_known_as in varchar2 default null
242 ,p_marital_status in varchar2 default null
243 ,p_middle_names in varchar2 default null
244 ,p_nationality in varchar2 default null
245 ,p_national_identifier in varchar2 default null
246 ,p_previous_last_name in varchar2 default null
247 ,p_registered_disabled_flag in varchar2 default null
248 ,p_sex in varchar2 default null
249 ,p_title in varchar2 default null
250 ,p_work_telephone in varchar2 default null
251 ,p_attribute_category in varchar2 default null
252 ,p_attribute1 in varchar2 default null
253 ,p_attribute2 in varchar2 default null
254 ,p_attribute3 in varchar2 default null
255 ,p_attribute4 in varchar2 default null
256 ,p_attribute5 in varchar2 default null
257 ,p_attribute6 in varchar2 default null
258 ,p_attribute7 in varchar2 default null
259 ,p_attribute8 in varchar2 default null
260 ,p_attribute9 in varchar2 default null
261 ,p_attribute10 in varchar2 default null
262 ,p_attribute11 in varchar2 default null
263 ,p_attribute12 in varchar2 default null
264 ,p_attribute13 in varchar2 default null
265 ,p_attribute14 in varchar2 default null
266 ,p_attribute15 in varchar2 default null
267 ,p_attribute16 in varchar2 default null
268 ,p_attribute17 in varchar2 default null
269 ,p_attribute18 in varchar2 default null
270 ,p_attribute19 in varchar2 default null
271 ,p_attribute20 in varchar2 default null
272 ,p_attribute21 in varchar2 default null
273 ,p_attribute22 in varchar2 default null
274 ,p_attribute23 in varchar2 default null
275 ,p_attribute24 in varchar2 default null
276 ,p_attribute25 in varchar2 default null
277 ,p_attribute26 in varchar2 default null
278 ,p_attribute27 in varchar2 default null
279 ,p_attribute28 in varchar2 default null
280 ,p_attribute29 in varchar2 default null
281 ,p_attribute30 in varchar2 default null
282 ,p_per_information_category in varchar2 default null
286 ,p_per_information3 in varchar2 default null
283 -- p_per_information_category - Obsolete parameter, do not use
284 ,p_per_information1 in varchar2 default null
285 ,p_per_information2 in varchar2 default null
287 ,p_per_information4 in varchar2 default null
288 ,p_per_information5 in varchar2 default null
289 ,p_per_information6 in varchar2 default null
290 ,p_per_information7 in varchar2 default null
291 ,p_per_information8 in varchar2 default null
292 ,p_per_information9 in varchar2 default null
293 ,p_per_information10 in varchar2 default null
294 ,p_per_information11 in varchar2 default null
295 ,p_per_information12 in varchar2 default null
296 ,p_per_information13 in varchar2 default null
297 ,p_per_information14 in varchar2 default null
298 ,p_per_information15 in varchar2 default null
299 ,p_per_information16 in varchar2 default null
300 ,p_per_information17 in varchar2 default null
301 ,p_per_information18 in varchar2 default null
302 ,p_per_information19 in varchar2 default null
303 ,p_per_information20 in varchar2 default null
304 ,p_per_information21 in varchar2 default null
305 ,p_per_information22 in varchar2 default null
306 ,p_per_information23 in varchar2 default null
307 ,p_per_information24 in varchar2 default null
308 ,p_per_information25 in varchar2 default null
309 ,p_per_information26 in varchar2 default null
310 ,p_per_information27 in varchar2 default null
311 ,p_per_information28 in varchar2 default null
312 ,p_per_information29 in varchar2 default null
313 ,p_per_information30 in varchar2 default null
314 ,p_background_check_status in varchar2 default null
315 ,p_background_date_check in date default null
316 ,p_correspondence_language in varchar2 default null
317 ,p_fte_capacity in number default null
318 ,p_hold_applicant_date_until in date default null
319 ,p_honors in varchar2 default null
320 ,p_mailstop in varchar2 default null
321 ,p_office_number in varchar2 default null
322 ,p_on_military_service in varchar2 default null
323 ,p_pre_name_adjunct in varchar2 default null
324 ,p_projected_start_date in date default null
325 ,p_resume_exists in varchar2 default null
326 ,p_resume_last_updated in date default null
327 ,p_student_status in varchar2 default null
328 ,p_work_schedule in varchar2 default null
329 ,p_suffix in varchar2 default null
330 ,p_date_of_death in date default null
331 ,p_benefit_group_id in number default null
332 ,p_receipt_of_death_cert_date in date default null
333 ,p_coord_ben_med_pln_no in varchar2 default null
334 ,p_coord_ben_no_cvg_flag in varchar2 default 'N'
335 ,p_uses_tobacco_flag in varchar2 default null
336 ,p_dpdnt_adoption_date in date default null
337 ,p_dpdnt_vlntry_svce_flag in varchar2 default 'N'
338 ,p_original_date_of_hire in date default null
339 ,p_town_of_birth in varchar2 default null
340 ,p_region_of_birth in varchar2 default null
341 ,p_country_of_birth in varchar2 default null
342 ,p_global_person_id in varchar2 default null
343 ,p_party_id in number default null
344 ,p_vacancy_id in number default null
345 ,p_person_id out nocopy number
346 ,p_assignment_id out nocopy number
347 ,p_application_id out nocopy number
348 ,p_per_object_version_number out nocopy number
349 ,p_asg_object_version_number out nocopy number
350 ,p_apl_object_version_number out nocopy number
351 ,p_per_effective_start_date out nocopy date
352 ,p_per_effective_end_date out nocopy date
353 ,p_full_name out nocopy varchar2
354 ,p_per_comment_id out nocopy number
355 ,p_assignment_sequence out nocopy number
356 ,p_name_combination_warning out nocopy boolean
357 ,p_orig_hire_warning out nocopy boolean
358 );
359 --
360 -- ----------------------------------------------------------------------------
361 -- |-------------------------< create_gb_applicant >--------------------------|
362 -- ----------------------------------------------------------------------------
363 --
364 -- {Start Of Comments}
365 /*#
366 * This API creates an applicant in the United Kingdom business group.
367 *
368 * The API creates the person details including a default primary assignment,
369 * and an application for the applicant. The API calls the generic API
370 * create_applicant, with the parameters set as appropriate for a British
371 * applicant. See the create_applicant API for further documentation as this
372 * API is effectively an alternative.
373 *
374 * <p><b>Licensing</b><br>
375 * This API is licensed for use with Oracle Human Resources and iRecruitment.
376 *
377 * <p><b>Prerequisites</b><br>
381 *
378 * A valid United Kingdom business group must exist. Also a valid
379 * person_type_id, with a corresponding system type of 'APL' must be active and
380 * in the same business group as that of the applicant being created.
382 * <p><b>Post Success</b><br>
383 * The API successfully creates the applicant, default assignment or
384 * application.
385 *
386 * <p><b>Post Failure</b><br>
387 * The API does not create the applicant, default assignment or application and
388 * raises an error.
389 *
390 * @param p_validate If true, then validation alone will be performed and the
391 * database will remain unchanged. If false and all validation checks pass,
392 * then the database will be modified.
393 * @param p_date_received The date an application was received and thus the
394 * effective start date of the person, application, and assignment.
395 * @param p_business_group_id The applicant's business group.
396 * @param p_last_name The applicant's last name.
397 * @param p_sex The sex of the applicant.
398 * @param p_person_type_id Person type id. If this value is omitted, then the
399 * API uses theperson_type_id of the active default `APL' system person type in
400 * the applicant's business group.
401 * @param p_applicant_number Identifes the applicant number. If the number
402 * generation method is Manual, then this parameter is mandatory. If the number
403 * generation method is Automatic, then the value of this parameter must be
404 * null. If p_validate is false and the applicant number generation method is
405 * Automatic, then this will be set to the generated applicant number of the
406 * person created. If p_validate is false and the applicant number generation
407 * method is manual, then this will be set to the same value passed in. If
408 * p_validate is true, then this will be set to the same value as passed in.
409 * @param p_comments Comment text.
410 * @param p_date_employee_data_verified The date on which the applicant data
411 * was last verified.
412 * @param p_date_of_birth Date of birth of the applicant.
413 * @param p_email_address E-mail address of the applicant.
414 * @param p_expense_check_send_to_addres Address to use as the applicant's
415 * mailing address.
416 * @param p_first_name Applicant's first name.
417 * @param p_known_as Applicant's alternative name.
418 * @param p_marital_status Applicant's marital status. Valid values are defined
419 * by the 'MAR_STATUS' lookup type.
420 * @param p_middle_names Applicant's middle name(s).
421 * @param p_nationality Applicant's nationality. Valid values are defined by
422 * the 'NATIONALITY' lookup type.
423 * @param p_ni_number Number by which a person is identified in the United
424 * Kingdom legislation.
425 * @param p_previous_last_name Applicant's previous last name.
426 * @param p_registered_disabled_flag Indicates whether person is classified as
427 * disabled. Valid values exist in the 'REGISTERED_DISABLED' lookup type.
428 * @param p_title The title of the applicant. Valid values are defined by the
429 * 'TITLE' lookup type.
430 * @param p_work_telephone Work telephone of the applicant.
431 * @param p_attribute_category This context value determines which flexfield
432 * structure to use with the descriptive flexfield segments.
433 * @param p_attribute1 Descriptive flexfield segment.
434 * @param p_attribute2 Descriptive flexfield segment.
435 * @param p_attribute3 Descriptive flexfield segment.
436 * @param p_attribute4 Descriptive flexfield segment.
437 * @param p_attribute5 Descriptive flexfield segment.
438 * @param p_attribute6 Descriptive flexfield segment.
439 * @param p_attribute7 Descriptive flexfield segment.
440 * @param p_attribute8 Descriptive flexfield segment.
441 * @param p_attribute9 Descriptive flexfield segment.
442 * @param p_attribute10 Descriptive flexfield segment.
443 * @param p_attribute11 Descriptive flexfield segment.
444 * @param p_attribute12 Descriptive flexfield segment.
445 * @param p_attribute13 Descriptive flexfield segment.
446 * @param p_attribute14 Descriptive flexfield segment.
447 * @param p_attribute15 Descriptive flexfield segment.
448 * @param p_attribute16 Descriptive flexfield segment.
449 * @param p_attribute17 Descriptive flexfield segment.
450 * @param p_attribute18 Descriptive flexfield segment.
451 * @param p_attribute19 Descriptive flexfield segment.
452 * @param p_attribute20 Descriptive flexfield segment.
453 * @param p_attribute21 Descriptive flexfield segment.
454 * @param p_attribute22 Descriptive flexfield segment.
455 * @param p_attribute23 Descriptive flexfield segment.
456 * @param p_attribute24 Descriptive flexfield segment.
457 * @param p_attribute25 Descriptive flexfield segment.
458 * @param p_attribute26 Descriptive flexfield segment.
459 * @param p_attribute27 Descriptive flexfield segment.
460 * @param p_attribute28 Descriptive flexfield segment.
461 * @param p_attribute29 Descriptive flexfield segment.
462 * @param p_attribute30 Descriptive flexfield segment.
463 * @param p_ethnic_origin Applicant's ethnic origin. Valid values are defined
464 * by the ETH_TYPE lookup type.
465 * @param p_director Indicates whether the person is a company director.
466 * @param p_pensioner Indicates whether the person is a pensioner.
467 * @param p_work_permit_number Identifies the work permit number of the
468 * applicant.
469 * @param p_addl_pension_years Additional pension years.
470 * @param p_addl_pension_months Additional pension months.
471 * @param p_addl_pension_days Additional pension days.
472 * @param p_ni_multiple_asg Identifies whether national insurance should be
473 * calculated according to the multiple assignments rules. Valid values are
477 * @param p_background_date_check Date when the background check was performed
474 * defined by the YES_NO lookup type.
475 * @param p_background_check_status Indicates whether the person's background
476 * has been checked. Valid values exist in the 'YES_NO' lookup type.
478 * on the applicant.
479 * @param p_correspondence_language Applicant's preferred language for
480 * correspondence.
481 * @param p_fte_capacity This parameter is currently not supported.
482 * @param p_hold_applicant_date_until Date til the applicant's information is
483 * to be maintained.
484 * @param p_honors Honors or degrees awarded.
485 * @param p_mailstop Office identifier for internal mail.
486 * @param p_office_number Office number of the applicant.
487 * @param p_on_military_service Type of military service.
488 * @param p_pre_name_adjunct First part of surname such as Van or De.
489 * @param p_projected_start_date This parameter is currently not supported.
490 * @param p_resume_exists Y/N flag indicating whether the applicant's resume
491 * exists in the database.
492 * @param p_resume_last_updated Date when the resume was last updated.
493 * @param p_student_status Indiciates the type of student status. Valid values
494 * are defined by the 'STUDENT_STATUS' lookup type.
495 * @param p_work_schedule Type of work schedule indicating days on which the
496 * person works. Valid values are defined by the 'WORK_SCHEDULE' lookup type.
497 * @param p_suffix Suffix after the person's last name.
498 * @param p_date_of_death Date of death of the applicant.
499 * @param p_benefit_group_id Identification number for the benefit group.
500 * @param p_receipt_of_death_cert_date Date when the death certificate was
501 * received.
502 * @param p_coord_ben_med_pln_no Number of the medical plan provided by an
503 * external organization.
504 * @param p_coord_ben_no_cvg_flag Indicates that the person is not covered by
505 * any other benefit plan.
506 * @param p_uses_tobacco_flag Tobacco type used by the person. Valid values are
507 * defined by 'TOBACCO_USER' lookup type.
508 * @param p_dpdnt_adoption_date Date on which the dependent was adopted.
509 * @param p_dpdnt_vlntry_svce_flag Indicates whether the dependent is on
510 * voluntary service.
511 * @param p_original_date_of_hire Original date of hire.
512 * @param p_town_of_birth Town or city of birth of the applicant.
513 * @param p_region_of_birth Geographical region of birth of the applicant.
514 * @param p_country_of_birth Country of birth of the applicant.
515 * @param p_global_person_id Global identification number for the person.
516 * @param p_party_id TCA party ID for whom you create the person record.
517 * @param p_person_id If p_validate is false, then this uniquely identifies the
518 * person created. If p_validate is true, then set to null.
519 * @param p_assignment_id If p_validate is false, then this uniquely identifies
520 * the created assignment. If p_validate is true, then set to null.
521 * @param p_application_id If p_validate is false, this uniquely identifies the
522 * application created. If p_validate is true this parameter will be null.
523 * @param p_per_object_version_number If p_validate is false, then set to the
524 * version number of the created person. If p_validate is true, then the value
525 * will be null.
526 * @param p_asg_object_version_number If p_validate is false, then this
527 * parameter is set to the version number of the assignment created. If
528 * p_validate is true, then this parameter is null.
529 * @param p_apl_object_version_number If p_validate is false, this will be set
530 * to the version number of the application created. If p_validate is true this
531 * parameter will be set to null.
532 * @param p_per_effective_start_date If p_validate is false, this will be set
533 * to the effective start date of the person. If p_validate is true this will
534 * be null.
535 * @param p_per_effective_end_date If p_validate is false, this will be set to
536 * the effective end date of the person. If p_validate is true this will be
537 * null.
538 * @param p_full_name If p_validate is false, this will be set to the complete
539 * full name of the person. If p_validate is true this will be null.
540 * @param p_per_comment_id If p_validate is false, then this will be set to the
541 * id of the corresponding person comment row, if any comment text exists. If
542 * p_validate is true this will be null.
543 * @param p_assignment_sequence If p_validate is false this will be set to the
544 * sequence number of the primary assignment. If p_validate is true this will
545 * be null.
546 * @param p_name_combination_warning If set to true, then the combination of
547 * last name, first name and date of birth existed prior to calling this API.
548 * @param p_orig_hire_warning Set to true if the original date of hire is not
549 * null and the person type is not EMP,EMP_APL, EX_EMP or EX_EMP_APL.
550 * @rep:displayname Create Applicant for United Kingdom
551 * @rep:category BUSINESS_ENTITY PER_APPLICANT
552 * @rep:lifecycle active
553 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
554 * @rep:scope public
555 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
556 */
557 -- {End Of Comments}
558 --
559 procedure create_gb_applicant
560 (p_validate in boolean default false
561 ,p_date_received in date
562 ,p_business_group_id in number
563 ,p_last_name in varchar2
564 ,p_sex in varchar2 default null
565 ,p_person_type_id in number default null
566 ,p_applicant_number in out nocopy varchar2
567 ,p_comments in varchar2 default null
571 ,p_expense_check_send_to_addres in varchar2 default null
568 ,p_date_employee_data_verified in date default null
569 ,p_date_of_birth in date default null
570 ,p_email_address in varchar2 default null
572 ,p_first_name in varchar2 default null
573 ,p_known_as in varchar2 default null
574 ,p_marital_status in varchar2 default null
575 ,p_middle_names in varchar2 default null
576 ,p_nationality in varchar2 default null
577 ,p_ni_number in varchar2 default null
578 ,p_previous_last_name in varchar2 default null
579 ,p_registered_disabled_flag in varchar2 default null
580 ,p_title in varchar2 default null
581 ,p_work_telephone in varchar2 default null
582 ,p_attribute_category in varchar2 default null
583 ,p_attribute1 in varchar2 default null
584 ,p_attribute2 in varchar2 default null
585 ,p_attribute3 in varchar2 default null
586 ,p_attribute4 in varchar2 default null
587 ,p_attribute5 in varchar2 default null
588 ,p_attribute6 in varchar2 default null
589 ,p_attribute7 in varchar2 default null
590 ,p_attribute8 in varchar2 default null
591 ,p_attribute9 in varchar2 default null
592 ,p_attribute10 in varchar2 default null
593 ,p_attribute11 in varchar2 default null
594 ,p_attribute12 in varchar2 default null
595 ,p_attribute13 in varchar2 default null
596 ,p_attribute14 in varchar2 default null
597 ,p_attribute15 in varchar2 default null
598 ,p_attribute16 in varchar2 default null
599 ,p_attribute17 in varchar2 default null
600 ,p_attribute18 in varchar2 default null
601 ,p_attribute19 in varchar2 default null
602 ,p_attribute20 in varchar2 default null
603 ,p_attribute21 in varchar2 default null
604 ,p_attribute22 in varchar2 default null
605 ,p_attribute23 in varchar2 default null
606 ,p_attribute24 in varchar2 default null
607 ,p_attribute25 in varchar2 default null
608 ,p_attribute26 in varchar2 default null
609 ,p_attribute27 in varchar2 default null
610 ,p_attribute28 in varchar2 default null
611 ,p_attribute29 in varchar2 default null
612 ,p_attribute30 in varchar2 default null
613 ,p_ethnic_origin in varchar2 default null
614 ,p_director in varchar2 default 'N'
615 ,p_pensioner in varchar2 default 'N'
616 ,p_work_permit_number in varchar2 default null
617 ,p_addl_pension_years in varchar2 default null
618 ,p_addl_pension_months in varchar2 default null
619 ,p_addl_pension_days in varchar2 default null
620 ,p_ni_multiple_asg in varchar2 default null
621 ,p_background_check_status in varchar2 default null
622 ,p_background_date_check in date default null
623 ,p_correspondence_language in varchar2 default null
624 ,p_fte_capacity in number default null
625 ,p_hold_applicant_date_until in date default null
626 ,p_honors in varchar2 default null
627 ,p_mailstop in varchar2 default null
628 ,p_office_number in varchar2 default null
629 ,p_on_military_service in varchar2 default null
630 ,p_pre_name_adjunct in varchar2 default null
631 ,p_projected_start_date in date default null
632 ,p_resume_exists in varchar2 default null
633 ,p_resume_last_updated in date default null
634 ,p_student_status in varchar2 default null
635 ,p_work_schedule in varchar2 default null
636 ,p_suffix in varchar2 default null
637 ,p_date_of_death in date default null
638 ,p_benefit_group_id in number default null
639 ,p_receipt_of_death_cert_date in date default null
640 ,p_coord_ben_med_pln_no in varchar2 default null
641 ,p_coord_ben_no_cvg_flag in varchar2 default 'N'
642 ,p_uses_tobacco_flag in varchar2 default null
643 ,p_dpdnt_adoption_date in date default null
644 ,p_dpdnt_vlntry_svce_flag in varchar2 default 'N'
645 ,p_original_date_of_hire in date default null
646 ,p_town_of_birth in varchar2 default null
647 ,p_region_of_birth in varchar2 default null
648 ,p_country_of_birth in varchar2 default null
649 ,p_global_person_id in varchar2 default null
650 ,p_party_id in number default null
651 ,p_person_id out nocopy number
652 ,p_assignment_id out nocopy number
653 ,p_application_id out nocopy number
654 ,p_per_object_version_number out nocopy number
655 ,p_asg_object_version_number out nocopy number
659 ,p_full_name out nocopy varchar2
656 ,p_apl_object_version_number out nocopy number
657 ,p_per_effective_start_date out nocopy date
658 ,p_per_effective_end_date out nocopy date
660 ,p_per_comment_id out nocopy number
661 ,p_assignment_sequence out nocopy number
662 ,p_name_combination_warning out nocopy boolean
663 ,p_orig_hire_warning out nocopy boolean
664 );
665 --
666 --
667 -- ----------------------------------------------------------------------------
668 -- |-------------------------< create_us_applicant >--------------------------|
669 -- ----------------------------------------------------------------------------
670 --
671 -- {Start Of Comments}
672 /*#
673 * This API creates an applicant in the United States business group.
674 *
675 * The API creates the person details including a default primary assignment,
676 * and an application for the applicant. The API calls the generic API
677 * create_applicant, with the parameters set as appropriate for a US applicant.
678 * See the create_applicant API for further documentation as this API is
679 * effectively an alternative.
680 *
681 * <p><b>Licensing</b><br>
682 * This API is licensed for use with Oracle Human Resources and iRecruitment.
683 *
684 * <p><b>Prerequisites</b><br>
685 * A business group with a legislation of US must exist. Also a valid
686 * person_type_id, with a corresponding system type of 'APL' must be active and
687 * in the same business group as that of the applicant being created.
688 *
689 * <p><b>Post Success</b><br>
690 * The API successfully creates the person, primary assignment and period of
691 * service.
692 *
693 * <p><b>Post Failure</b><br>
694 * The API does not create the applicant, default assignment or application and
695 * raises an error.
696 *
697 * @param p_validate If true, then validation alone will be performed and the
698 * database will remain unchanged. If false and all validation checks pass,
699 * then the database will be modified.
700 * @param p_date_received The date an application was received and thus the
701 * effective start date of the person, application, and assignment.
702 * @param p_business_group_id The applicant's business group.
703 * @param p_last_name The applicant's last name.
704 * @param p_sex The sex of the applicant.
705 * @param p_person_type_id Person type id. If this value is omitted, then the
706 * API uses theperson_type_id of the active default `APL' system person type in
707 * the applicant's business group.
708 * @param p_applicant_number Identifies the applicant number. If the number
709 * generation method is Manual, then this parameter is mandatory. If the number
710 * generation method is Automatic, then the value of this parameter must be
711 * null. If p_validate is false and the applicant number generation method is
712 * Automatic, then this will be set to the generated applicant number of the
713 * person created. If p_validate is false and the applicant number generation
714 * method is manual, then this will be set to the same value passed in. If
715 * p_validate is true, then this will be set to the same value as passed in.
716 * @param p_comments Comment text.
717 * @param p_date_employee_data_verified The date on which the applicant data
718 * was last verified.
719 * @param p_date_of_birth Date of birth of the applicant.
720 * @param p_email_address E-mail address of the applicant.
721 * @param p_expense_check_send_to_addres Address to use as the applicant's
722 * mailing address.
723 * @param p_first_name Applicant's first name.
724 * @param p_known_as Applicant's alternative name.
725 * @param p_marital_status Applicant's marital status. Valid values are defined
726 * by the 'MAR_STATUS' lookup type.
727 * @param p_middle_names Applicant's middle name(s).
728 * @param p_nationality Applicant's nationality. Valid values are defined by
729 * the 'NATIONALITY' lookup type.
730 * @param p_ss_number Social security number of the person.
731 * @param p_previous_last_name Applicant's previous last name.
732 * @param p_registered_disabled_flag Indicates whether person is classified as
733 * disabled. Valid values exist in the 'REGISTERED_DISABLED' lookup type.
734 * @param p_title The title of the applicant. Valid values are defined by the
735 * 'TITLE' lookup type.
736 * @param p_work_telephone Work telephone of the applicant.
737 * @param p_attribute_category This context value determines which flexfield
738 * structure to use with the descriptive flexfield segments.
739 * @param p_attribute1 Descriptive flexfield segment.
740 * @param p_attribute2 Descriptive flexfield segment.
741 * @param p_attribute3 Descriptive flexfield segment.
742 * @param p_attribute4 Descriptive flexfield segment.
743 * @param p_attribute5 Descriptive flexfield segment.
744 * @param p_attribute6 Descriptive flexfield segment.
745 * @param p_attribute7 Descriptive flexfield segment.
746 * @param p_attribute8 Descriptive flexfield segment.
747 * @param p_attribute9 Descriptive flexfield segment.
748 * @param p_attribute10 Descriptive flexfield segment.
749 * @param p_attribute11 Descriptive flexfield segment.
750 * @param p_attribute12 Descriptive flexfield segment.
751 * @param p_attribute13 Descriptive flexfield segment.
752 * @param p_attribute14 Descriptive flexfield segment.
753 * @param p_attribute15 Descriptive flexfield segment.
754 * @param p_attribute16 Descriptive flexfield segment.
755 * @param p_attribute17 Descriptive flexfield segment.
756 * @param p_attribute18 Descriptive flexfield segment.
760 * @param p_attribute22 Descriptive flexfield segment.
757 * @param p_attribute19 Descriptive flexfield segment.
758 * @param p_attribute20 Descriptive flexfield segment.
759 * @param p_attribute21 Descriptive flexfield segment.
761 * @param p_attribute23 Descriptive flexfield segment.
762 * @param p_attribute24 Descriptive flexfield segment.
763 * @param p_attribute25 Descriptive flexfield segment.
764 * @param p_attribute26 Descriptive flexfield segment.
765 * @param p_attribute27 Descriptive flexfield segment.
766 * @param p_attribute28 Descriptive flexfield segment.
767 * @param p_attribute29 Descriptive flexfield segment.
768 * @param p_attribute30 Descriptive flexfield segment.
769 * @param p_ethnic_origin Applicant's ethnic origin. Valid values are defined
770 * by the ETH_TYPE lookup type.
771 * @param p_i_9 Status of I9 Visa. Valid values are defined by the
772 * PER_US_I9_STATE lookup type.
773 * @param p_i_9_expiration_date I_9 expiration date.
774 * @param p_veteran_status Identifies the veteran status of the applicant.
775 * @param p_new_hire Status of the new hire. Valid values are defined by the
776 * US_NEW_HIRE_STATUS lookup type.
777 * @param p_exception_reason New hire exception reason. Valid values are
778 * defined by the US_NEW_HIRE_EXCEPTIONS lookup type.
779 * @param p_child_support_obligation Flag indicating whether the person has a
780 * child support obligation.
781 * @param p_opted_for_medicare_flag Flag indicating whether the person has
782 * opted for additional medicare.
783 * @param p_background_check_status Indicates whether the person's background
784 * has been checked. Valid values exist in the 'YES_NO' lookup type.
785 * @param p_background_date_check Date when the background check was performed
786 * on the applicant.
787 * @param p_correspondence_language Applicant's preferred language for
788 * correspondence.
789 * @param p_fte_capacity This parameter is currently not supported.
790 * @param p_hold_applicant_date_until Date till the applicant's information is
791 * to be maintained.
792 * @param p_honors Honors or degrees awarded.
793 * @param p_mailstop Office identifier for internal mail.
794 * @param p_office_number Office number of the applicant.
795 * @param p_on_military_service Type of military service.
796 * @param p_pre_name_adjunct First part of surname such as Van or De.
797 * @param p_projected_start_date This parameter is currently not supported.
798 * @param p_resume_exists Y/N flag indicating whether the applicant's resume
799 * exists in the database.
800 * @param p_resume_last_updated Date when the resume was last updated.
801 * @param p_student_status Indicates the type of student status. Valid values
802 * are defined by the 'STUDENT_STATUS' lookup type.
803 * @param p_work_schedule Type of work schedule indicating days on which the
804 * person works. Valid values are defined by the 'WORK_SCHEDULE' lookup type.
805 * @param p_suffix Suffix after the person's last name.
806 * @param p_date_of_death Date of death of the applicant.
807 * @param p_benefit_group_id Identification number for the benefit group.
808 * @param p_receipt_of_death_cert_date Date when the death certificate was
809 * received.
810 * @param p_coord_ben_med_pln_no Number of the medical plan provided by an
811 * external organization.
812 * @param p_coord_ben_no_cvg_flag Indicates that the person is not covered by
813 * any other benefit plan.
814 * @param p_uses_tobacco_flag Tobacco type used by the person. Valid values are
815 * defined by 'TOBACCO_USER' lookup type.
816 * @param p_dpdnt_adoption_date Date on which the dependent was adopted.
817 * @param p_dpdnt_vlntry_svce_flag Indicates whether the dependent is on
818 * voluntary service.
819 * @param p_original_date_of_hire Original date of hire.
820 * @param p_town_of_birth Town or city of birth of the applicant.
821 * @param p_region_of_birth Geographical region of birth of the applicant.
822 * @param p_country_of_birth Country of birth of the applicant.
823 * @param p_global_person_id Global identification number for the person.
824 * @param p_party_id TCA party ID for whom you create the person record.
825 * @param p_person_id If p_validate is false, then this uniquely identifies the
826 * person created. If p_validate is true, then set to null.
827 * @param p_assignment_id If p_validate is false, then this uniquely identifies
828 * the created assignment. If p_validate is true, then set to null.
829 * @param p_application_id If p_validate is false, this uniquely identifies the
830 * application created. If p_validate is true this parameter will be null.
831 * @param p_per_object_version_number If p_validate is false, then set to the
832 * version number of the created person. If p_validate is true, then the value
833 * will be null.
834 * @param p_asg_object_version_number If p_validate is false, then this
835 * parameter is set to the version number of the assignment created. If
836 * p_validate is true, then this parameter is null.
837 * @param p_apl_object_version_number If p_validate is false, this will be set
838 * to the version number of the application created. If p_validate is true this
839 * parameter will be set to null.
840 * @param p_per_effective_start_date If p_validate is false, this will be set
841 * to the effective start date of the person. If p_validate is true this will
842 * be null.
843 * @param p_per_effective_end_date If p_validate is false, this will be set to
844 * the effective end date of the person. If p_validate is true this will be
845 * null.
846 * @param p_full_name If p_validate is false, this will be set to the complete
847 * full name of the person. If p_validate is true this will be null.
848 * @param p_per_comment_id If p_validate is false, then this will be set to the
852 * sequence number of the primary assignment. If p_validate is true this will
849 * id of the corresponding person comment row, if any comment text exists. If
850 * p_validate is true this will be null.
851 * @param p_assignment_sequence If p_validate is false this will be set to the
853 * be null.
854 * @param p_name_combination_warning If set to true, then the combination of
855 * last name, first name and date of birth existed prior to calling this API.
856 * @param p_orig_hire_warning Set to true if the original date of hire is not
857 * null and the person type is not EMP, EMP_APL, EX_EMP or EX_EMP_APL.
858 * @rep:displayname Create US Applicant
859 * @rep:category BUSINESS_ENTITY PER_APPLICANT
860 * @rep:lifecycle active
861 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
862 * @rep:scope public
863 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
864 */
865 --
866 -- {End Of Comments}
867 --
868 procedure create_us_applicant
869 (p_validate in boolean default false
870 ,p_date_received in date
871 ,p_business_group_id in number
872 ,p_last_name in varchar2
873 ,p_sex in varchar2 default null
874 ,p_person_type_id in number default null
875 ,p_applicant_number in out nocopy varchar2
876 ,p_comments in varchar2 default null
877 ,p_date_employee_data_verified in date default null
878 ,p_date_of_birth in date default null
879 ,p_email_address in varchar2 default null
880 ,p_expense_check_send_to_addres in varchar2 default null
881 ,p_first_name in varchar2 default null
882 ,p_known_as in varchar2 default null
883 ,p_marital_status in varchar2 default null
884 ,p_middle_names in varchar2 default null
885 ,p_nationality in varchar2 default null
886 ,p_ss_number in varchar2 default null
887 ,p_previous_last_name in varchar2 default null
888 ,p_registered_disabled_flag in varchar2 default null
889 ,p_title in varchar2 default null
890 ,p_work_telephone in varchar2 default null
891 ,p_attribute_category in varchar2 default null
892 ,p_attribute1 in varchar2 default null
893 ,p_attribute2 in varchar2 default null
894 ,p_attribute3 in varchar2 default null
895 ,p_attribute4 in varchar2 default null
896 ,p_attribute5 in varchar2 default null
897 ,p_attribute6 in varchar2 default null
898 ,p_attribute7 in varchar2 default null
899 ,p_attribute8 in varchar2 default null
900 ,p_attribute9 in varchar2 default null
901 ,p_attribute10 in varchar2 default null
902 ,p_attribute11 in varchar2 default null
903 ,p_attribute12 in varchar2 default null
904 ,p_attribute13 in varchar2 default null
905 ,p_attribute14 in varchar2 default null
906 ,p_attribute15 in varchar2 default null
907 ,p_attribute16 in varchar2 default null
908 ,p_attribute17 in varchar2 default null
909 ,p_attribute18 in varchar2 default null
910 ,p_attribute19 in varchar2 default null
911 ,p_attribute20 in varchar2 default null
912 ,p_attribute21 in varchar2 default null
913 ,p_attribute22 in varchar2 default null
914 ,p_attribute23 in varchar2 default null
915 ,p_attribute24 in varchar2 default null
916 ,p_attribute25 in varchar2 default null
917 ,p_attribute26 in varchar2 default null
918 ,p_attribute27 in varchar2 default null
919 ,p_attribute28 in varchar2 default null
920 ,p_attribute29 in varchar2 default null
921 ,p_attribute30 in varchar2 default null
922 ,p_ethnic_origin in varchar2 default null
923 ,p_I_9 in varchar2 default 'N'
924 ,p_I_9_expiration_date in varchar2 default null
925 -- ,p_visa_type in varchar2 default null
926 ,p_veteran_status in varchar2 default null
927 ,p_new_hire in varchar2 default null
928 ,p_exception_reason in varchar2 default null
929 ,p_child_support_obligation in varchar2 default 'N'
930 ,p_opted_for_medicare_flag in varchar2 default 'N'
931 ,p_background_check_status in varchar2 default null
932 ,p_background_date_check in date default null
933 ,p_correspondence_language in varchar2 default null
934 ,p_fte_capacity in number default null
935 ,p_hold_applicant_date_until in date default null
936 ,p_honors in varchar2 default null
937 ,p_mailstop in varchar2 default null
938 ,p_office_number in varchar2 default null
939 ,p_on_military_service in varchar2 default null
940 ,p_pre_name_adjunct in varchar2 default null
944 ,p_student_status in varchar2 default null
941 ,p_projected_start_date in date default null
942 ,p_resume_exists in varchar2 default null
943 ,p_resume_last_updated in date default null
945 ,p_work_schedule in varchar2 default null
946 ,p_suffix in varchar2 default null
947 ,p_date_of_death in date default null
948 ,p_benefit_group_id in number default null
949 ,p_receipt_of_death_cert_date in date default null
950 ,p_coord_ben_med_pln_no in varchar2 default null
951 ,p_coord_ben_no_cvg_flag in varchar2 default 'N'
952 ,p_uses_tobacco_flag in varchar2 default null
953 ,p_dpdnt_adoption_date in date default null
954 ,p_dpdnt_vlntry_svce_flag in varchar2 default 'N'
955 ,p_original_date_of_hire in date default null
956 ,p_town_of_birth in varchar2 default null
957 ,p_region_of_birth in varchar2 default null
958 ,p_country_of_birth in varchar2 default null
959 ,p_global_person_id in varchar2 default null
960 ,p_party_id in number default null
961 ,p_person_id out nocopy number
962 ,p_assignment_id out nocopy number
963 ,p_application_id out nocopy number
964 ,p_per_object_version_number out nocopy number
965 ,p_asg_object_version_number out nocopy number
966 ,p_apl_object_version_number out nocopy number
967 ,p_per_effective_start_date out nocopy date
968 ,p_per_effective_end_date out nocopy date
969 ,p_full_name out nocopy varchar2
970 ,p_per_comment_id out nocopy number
971 ,p_assignment_sequence out nocopy number
972 ,p_name_combination_warning out nocopy boolean
973 ,p_orig_hire_warning out nocopy boolean
974 );
975 --
976 -- ---------------------------------------------------------------------------
977 -- |--------------------------< hire_applicant >---------------------------|
978 -- ---------------------------------------------------------------------------
979 --
980 -- This version of the API is now out-of-date however it has been provided to
981 -- you for backward compatibility support and will be removed in the future.
982 -- Oracle recommends you to modify existing calling programs in advance of the
983 -- support being withdrawn thus avoiding any potential disruption.
984 --
985 procedure hire_applicant
986 (p_validate in boolean default false,
987 p_hire_date in date,
988 p_person_id in per_all_people_f.person_id%TYPE,
989 p_assignment_id in number default null,
990 p_person_type_id in number default null,
991 p_per_object_version_number in out nocopy per_all_people_f.object_version_number%TYPE,
992 p_employee_number in out nocopy per_all_people_f.employee_number%TYPE,
993 p_per_effective_start_date out nocopy date,
994 p_per_effective_end_date out nocopy date,
995 p_unaccepted_asg_del_warning out nocopy boolean,
996 p_assign_payroll_warning out nocopy boolean,
997 p_original_date_of_hire in date default null,
998 p_migrate in boolean default true,
999 p_source in boolean default false
1000 );
1001 --
1002 --
1003 -- ---------------------------------------------------------------------------
1004 -- |--------------------------< hire_applicant >---------------------------|
1005 -- ---------------------------------------------------------------------------
1006 --
1007 -- {Start Of Comments}
1008 /*#
1009 * This API converts an applicant to an employee.
1010 *
1011 * This API converts data about a person of type applicant (APL, APL_EX_APL or
1012 * EX_EMP_APL) to a person type of employee (EMP). This procedure is overloaded
1013 * to keep the parameters in line with the base release. This is achieved by:
1014 * terminating the application record, terminating unaccepted applicant
1015 * assignments, setting person to an EMP, creating a period of service record,
1016 * and converting accepted applicant assignments to active employee
1017 * assignments.
1018 *
1019 * <p><b>Licensing</b><br>
1020 * This API is licensed for use with Oracle Human Resources.
1021 *
1022 * <p><b>Prerequisites</b><br>
1023 * If person_type_id is supplied, then it must have an active corresponding
1024 * system person type of 'EMP' and must be in the same business group as that
1025 * of the applicant being changed to employee.
1026 *
1027 * <p><b>Post Success</b><br>
1028 * The applicant has been successfully hired as an employee with a default
1029 * employee assignment.
1030 *
1031 * <p><b>Post Failure</b><br>
1032 * The applicant is not hired as an employee and an error is raised.
1033 *
1034 * @param p_validate If true, then validation alone will be performed and the
1035 * database will remain unchanged. If false and all validation checks pass,
1036 * then the database will be modified.
1037 * @param p_hire_date The person hire date and thus the effective start date of
1038 * the person, assignment, and period of service.
1039 * @param p_person_id Identifies the person record to be modified.
1040 * @param p_assignment_id Identifies the assignment for which you create the
1041 * person record.
1045 * @param p_national_identifier Applicant's national identifier.
1042 * @param p_person_type_id Person type id. The default value is null. . If this
1043 * value is omitted, then the API uses the person_type_id of the default `EMP'
1044 * system person type in the employee's business group.
1046 * @param p_per_object_version_number Pass in the current version number of the
1047 * person to be updated. When the API completes if p_validate is false, will be
1048 * set to the new version number of the updated person. If p_validate is true
1049 * will be set to the same value which was passed in.
1050 * @param p_employee_number The business group's employee number generation
1051 * method determines when you can update the employee value. To keep the
1052 * existing employee number pass in hr_api.g_varchar2. When the API call
1053 * completes if p_validate is true then will be set to the employee number. If
1054 * p_validate is true then will be set to the passed value.
1055 * @param p_per_effective_start_date If p_validate is false, this will be set
1056 * to the effective start date of the person. If p_validate is true this will
1057 * be null.
1058 * @param p_per_effective_end_date If p_validate is false, this will be set to
1059 * the effective end date of the person. If p_validate is true this will be
1060 * null.
1061 * @param p_unaccepted_asg_del_warning If set to true, then the unaccepted
1062 * applicant assignments are terminated. Set to false if the unaccepted
1063 * applicant assignments do not exist.
1064 * @param p_assign_payroll_warning If set to true, then the date of birth is
1065 * not entered. If set to false, then the date of birth has been entered.
1066 * Indicates if it will be possible to set the payroll on any of this person's
1067 * assignments.
1068 * @param p_oversubscribed_vacancy_id If one of the vacancies that the
1069 * applicant was hired from is now oversubscribed, this will contain the id of
1070 * the vacancy, otherwise it will be null for the applicant. The default is
1071 * null.
1072 * @param p_original_date_of_hire Original date of hire.
1073 * @param p_migrate Default True. When True, will migrate global data of
1074 * @param p_source default false . Used to identify whether the api is called from SSHR or not.
1075 * applicant to the local use (addresses, phones, previous employers,
1076 * qualifications etc).
1077 * @rep:displayname Hire Applicant
1078 * @rep:category BUSINESS_ENTITY PER_APPLICANT
1079 * @rep:lifecycle active
1080 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
1081 * @rep:scope public
1082 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
1083 */
1084 --
1085 -- {End Of Comments}
1086 --
1087 procedure hire_applicant
1088 (p_validate in boolean default false,
1089 p_hire_date in date,
1090 p_person_id in per_all_people_f.person_id%TYPE,
1091 p_assignment_id in number default null,
1092 p_person_type_id in number default null,
1093 p_national_identifier in per_all_people_f.national_identifier%type default hr_api.g_varchar2,
1094 p_per_object_version_number in out nocopy per_all_people_f.object_version_number%TYPE,
1095 p_employee_number in out nocopy per_all_people_f.employee_number%TYPE,
1096 p_per_effective_start_date out nocopy date,
1097 p_per_effective_end_date out nocopy date,
1098 p_unaccepted_asg_del_warning out nocopy boolean,
1099 p_assign_payroll_warning out nocopy boolean,
1100 p_oversubscribed_vacancy_id out nocopy number,
1101 p_original_date_of_hire in date default null,
1102 p_migrate in boolean default true,
1103 p_source in boolean default false
1104 );
1105 --
1106 --
1107 -- -----------------------------------------------------------------------------
1108 -- |--------------------------< terminate_applicant >--------------------------|
1109 -- -----------------------------------------------------------------------------
1110 --
1111 -- This version of the API is now out-of-date however it has been provided to
1112 -- you for backward compatibility support and will be removed in the future.
1113 -- Oracle recommends you to modify existing calling programs in advance of the
1114 -- support being withdrawn thus avoiding any potential disruption.
1115 --
1116 PROCEDURE terminate_applicant
1117 (p_validate IN BOOLEAN DEFAULT FALSE
1118 ,p_effective_date IN DATE
1119 ,p_person_id IN per_all_people_f.person_id%TYPE
1120 ,p_object_version_number IN OUT NOCOPY per_all_people_f.object_version_number%TYPE
1121 ,p_person_type_id IN per_person_types.person_type_id%TYPE DEFAULT hr_api.g_number
1122 ,p_termination_reason IN per_applications.termination_reason%TYPE DEFAULT NULL
1123 ,p_effective_start_date OUT NOCOPY per_all_people_f.effective_start_date%TYPE
1124 ,p_effective_end_date OUT NOCOPY per_all_people_f.effective_end_date%TYPE
1125 );
1126 -- -----------------------------------------------------------------------------
1127 -- |-----------------------< terminate_applicant(New) >------------------------|
1128 -- -----------------------------------------------------------------------------
1129 --
1130 -- This version of the API is now out-of-date however it has been provided to
1131 -- you for backward compatibility support and will be removed in the future.
1132 -- Oracle recommends you to modify existing calling programs in advance of the
1133 -- support being withdrawn thus avoiding any potential disruption.
1134 --
1135 PROCEDURE terminate_applicant
1139 ,p_object_version_number IN OUT NOCOPY per_all_people_f.object_version_number%TYPE
1136 (p_validate IN BOOLEAN DEFAULT FALSE
1137 ,p_effective_date IN DATE
1138 ,p_person_id IN per_all_people_f.person_id%TYPE
1140 ,p_person_type_id IN per_person_types.person_type_id%TYPE DEFAULT hr_api.g_number
1141 ,p_termination_reason IN per_applications.termination_reason%TYPE DEFAULT NULL
1142 ,p_assignment_status_type_id IN per_all_assignments_f.assignment_status_type_id%TYPE --#3371944
1143 ,p_effective_start_date OUT NOCOPY per_all_people_f.effective_start_date%TYPE
1144 ,p_effective_end_date OUT NOCOPY per_all_people_f.effective_end_date%TYPE
1145 );
1146 -- ----------------------------------------------------------------------------
1147 -- |-----------------------< terminate_applicant(New2) >----------------------|
1148 -- ----------------------------------------------------------------------------
1149 --
1150 -- This version of the API is now out-of-date however it has been provided to
1151 -- you for backward compatibility support and will be removed in the future.
1152 -- Oracle recommends you to modify existing calling programs in advance of the
1153 -- support being withdrawn thus avoiding any potential disruption.
1154 --
1155 PROCEDURE terminate_applicant
1156 (p_validate IN BOOLEAN
1157 ,p_effective_date IN DATE
1158 ,p_person_id IN per_all_people_f.person_id%TYPE
1159 ,p_object_version_number IN OUT NOCOPY per_all_people_f.object_version_number%TYPE
1160 ,p_person_type_id IN per_person_types.person_type_id%TYPE
1161 ,p_termination_reason IN per_applications.termination_reason%TYPE
1162 ,p_assignment_status_type_id IN per_all_assignments_f.assignment_status_type_id%TYPE
1163 ,p_effective_start_date OUT NOCOPY per_all_people_f.effective_start_date%TYPE
1164 ,p_effective_end_date OUT NOCOPY per_all_people_f.effective_end_date%TYPE
1165 ,p_remove_fut_asg_warning OUT NOCOPY BOOLEAN -- 3652025
1166 );
1167 -- ----------------------------------------------------------------------------
1168 -- |-----------------------< terminate_applicant(New3) >----------------------|
1169 -- ----------------------------------------------------------------------------
1170 --
1171 -- {Start of Comments}
1172 /*#
1173 * This API terminates an applicant.
1174 *
1175 * This API converts a person of type Applicant to a person of type
1176 * Ex-Applicant. The person's application and any applicant assignments are
1177 * ended.
1178 *
1179 * <p><b>Licensing</b><br>
1180 * This API is licensed for use with Oracle Human Resources.
1181 *
1182 * <p><b>Prerequisites</b><br>
1183 * The applicant must exist in the relevant business group.
1184 *
1185 * <p><b>Post Success</b><br>
1186 * The applicant is terminated successfully.
1187 *
1188 * <p><b>Post Failure</b><br>
1189 * The applicant is not terminated and an error is raised.
1190 *
1191 * @param p_validate If true, then validation alone will be performed and the
1192 * database will remain unchanged. If false and all validation checks pass,
1193 * then the database will be modified.
1194 * @param p_effective_date Determines when the DateTrack operation comes into
1195 * force.
1196 * @param p_person_id Identifies the person record to be modified.
1197 * @param p_object_version_number Pass in the current version number of the
1198 * person to be updated. When the API completes if p_validate is false, will be
1199 * set to the new version number of the updated person. If p_validate is true
1200 * will be set to the same value which was passed in.
1201 * @param p_person_type_id Person type the person is to become. If this value
1202 * is omitted the person type id of the default system person type required in
1203 * the person's business group is used.
1204 * @param p_termination_reason Reason for terminating the applicant. Valid
1205 * values are defined by the TERM_APL_REASON lookup type.
1206 * @param p_change_reason Reason for the assignment status change. If there is
1207 * no change reason the parameter can be null. Valid values are defined in the
1208 * EMP_ASSIGN_REASON lookup type.
1209 * @param p_assignment_status_type_id Identifies the applicant assignment
1210 * status.
1211 * @param p_effective_start_date If p_validate is false, then set to the
1212 * effective start date on the updated person row which now exists as of the
1213 * effective date. If p_validate is true, then set to null.
1214 * @param p_effective_end_date If p_validate is false, then set to the
1215 * effective end date on the updated person row which now exists as of the
1216 * effective date. If p_validate is true, then set to null.
1217 * @param p_remove_fut_asg_warning If p_validate is false, set to TRUE if
1218 * future-dated assignments and/or assignment future datetrack changes have
1219 * been removed, otherwise is set to FALSE. If p_validate is true, set to null.
1220 * @rep:displayname Terminate Applicant
1221 * @rep:category BUSINESS_ENTITY PER_APPLICANT
1222 * @rep:lifecycle active
1223 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
1224 * @rep:scope public
1225 */
1226 --
1227 -- {End of Comments}
1228 --
1229 --
1230 PROCEDURE terminate_applicant
1231 (p_validate IN BOOLEAN DEFAULT FALSE
1232 ,p_effective_date IN DATE
1233 ,p_person_id IN per_all_people_f.person_id%TYPE
1234 ,p_object_version_number IN OUT NOCOPY per_all_people_f.object_version_number%TYPE
1238 ,p_change_reason IN per_all_assignments_f.change_reason%TYPE -- 4066579
1235 ,p_person_type_id IN per_person_types.person_type_id%TYPE DEFAULT hr_api.g_number
1236 ,p_termination_reason IN per_applications.termination_reason%TYPE DEFAULT NULL
1237 ,p_assignment_status_type_id IN per_all_assignments_f.assignment_status_type_id%TYPE DEFAULT hr_api.g_number
1239 ,p_effective_start_date OUT NOCOPY per_all_people_f.effective_start_date%TYPE
1240 ,p_effective_end_date OUT NOCOPY per_all_people_f.effective_end_date%TYPE
1241 ,p_remove_fut_asg_warning OUT NOCOPY BOOLEAN -- 3652025
1242 );
1243 --
1244 -- -----------------------------------------------------------------------------
1245 -- |------------------------< convert_to_applicant >---------------------------|
1246 -- -----------------------------------------------------------------------------
1247 --
1248 -- This version of the API is now out-of-date however it has been provided to
1249 -- you for backward compatibility support and will be removed in the future.
1250 -- Oracle recommends you to modify existing calling programs in advance of the
1251 -- support being withdrawn thus avoiding any potential disruption.
1252 --
1253 PROCEDURE convert_to_applicant
1254 (p_validate IN BOOLEAN DEFAULT FALSE
1255 ,p_effective_date IN DATE
1256 ,p_person_id IN per_all_people_f.person_id%TYPE
1257 ,p_object_version_number IN OUT NOCOPY per_all_people_f.object_version_number%TYPE
1258 ,p_applicant_number IN OUT NOCOPY per_all_people_f.applicant_number%TYPE
1259 ,p_person_type_id IN per_person_types.person_type_id%TYPE DEFAULT NULL
1260 ,p_effective_start_date OUT NOCOPY per_all_people_f.effective_start_date%TYPE
1261 ,p_effective_end_date OUT NOCOPY per_all_people_f.effective_end_date%TYPE
1262 );
1263 -- NEW
1264 -- -----------------------------------------------------------------------------
1265 -- |------------------------< convert_to_applicant >---------------------------|
1266 -- -----------------------------------------------------------------------------
1267 --
1268 -- {Start Of Comments}
1269 /*#
1270 * This API converts a person into an applicant.
1271 *
1272 * The API sets the the person type to APL type. It creates an application or
1273 * updates an existing one. It also creates a default application assignment
1274 * and updates the security lists.
1275 *
1276 * <p><b>Licensing</b><br>
1277 * This API is licensed for use with Oracle Human Resources.
1278 *
1279 * <p><b>Prerequisites</b><br>
1280 * Person must exist in the relevant business group.
1281 *
1282 * <p><b>Post Success</b><br>
1283 * The API updates the person and application records.
1284 *
1285 * <p><b>Post Failure</b><br>
1286 * The API does not convert the person to an applicant and raises an error.
1287 *
1288 * @param p_validate If true, then validation alone will be performed and the
1289 * database will remain unchanged. If false and all validation checks pass,
1290 * then the database will be modified.
1291 * @param p_effective_date Determines when the DateTrack operation comes into
1292 * force.
1293 * @param p_person_id Identifies the person record to be modified.
1294 * @param p_object_version_number Pass in the current version number of the
1295 * person to be updated. When the API completes if p_validate is false, will be
1296 * set to the new version number of the updated person. If p_validate is true
1297 * will be set to the same value which was passed in.
1298 * @param p_applicant_number Identifies the applicant number. The API ignores
1299 * this if the person already has an applicant number. This parameter is
1300 * required if the number generation method is manual. It must be null if the
1301 * number generation method is automatic. If p_validate is false, set to the
1302 * applicant number of the person. If p_validate is true, set to the value
1303 * passed in.
1304 * @param p_person_type_id Person type id the person is to become. If this
1305 * value is omitted the person type id of the default system person type
1306 * required in the person's business group is used.
1307 * @param p_effective_start_date If p_validate is false, then set to the
1308 * effective start date on the updated person row which now exists as of the
1309 * effective date. If p_validate is true, then set to null.
1310 * @param p_effective_end_date If p_validate is false, then set to the
1311 * effective end date on the updated person row which now exists as of the
1312 * effective date. If p_validate is true, then set to null.
1313 * @param p_appl_override_warning If p_validate is false, this is set to TRUE
1314 * if future applications have been overwritten. If p_validate is true this is
1315 * set to null.
1316 * @rep:displayname Convert To Applicant
1317 * @rep:category BUSINESS_ENTITY PER_APPLICANT
1318 * @rep:lifecycle active
1319 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
1320 * @rep:scope public
1321 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
1322 */
1323 --
1324 -- {End Of Comments}
1325 --
1326 PROCEDURE convert_to_applicant
1327 (p_validate IN BOOLEAN DEFAULT FALSE
1328 ,p_effective_date IN DATE
1329 ,p_person_id IN per_all_people_f.person_id%TYPE
1330 ,p_object_version_number IN OUT NOCOPY per_all_people_f.object_version_number%TYPE
1331 ,p_applicant_number IN OUT NOCOPY per_all_people_f.applicant_number%TYPE
1332 ,p_person_type_id IN per_person_types.person_type_id%TYPE DEFAULT NULL
1333 ,p_effective_start_date OUT NOCOPY per_all_people_f.effective_start_date%TYPE
1334 ,p_effective_end_date OUT NOCOPY per_all_people_f.effective_end_date%TYPE
1335 ,p_appl_override_warning OUT NOCOPY boolean -- 3652025
1336 );
1337 --
1338 -- ----------------------------------------------------------------------------+
1339 -- |---------------------< apply_for_job_anytime >-----------------------------|
1340 -- ----------------------------------------------------------------------------+
1341 --
1342 -- {Start Of Comments}
1343 /*#
1344 * This API converts an existing person into an applicant.
1345 *
1346 * The API creates a new applicant assignment and an application for the
1347 * person. If person has been an applicant, the application might be reopened
1348 * depending on the effective date. The process updates the security lists.
1349 *
1350 * <p><b>Licensing</b><br>
1351 * This API is licensed for use with Oracle Human Resources.
1352 *
1353 * <p><b>Prerequisites</b><br>
1354 * The person must exist in the system.
1355 *
1356 * <p><b>Post Success</b><br>
1357 * When the person is successfully updated, applicant assignment and
1358 * application are successfully inserted.
1359 *
1360 * <p><b>Post Failure</b><br>
1361 * The API does not update the person or create the applicant assignment or
1362 * application and raises an error.
1363 *
1364 * @param p_validate If true, then validation alone will be performed and the
1365 * database will remain unchanged. If false and all validation checks pass,
1366 * then the database will be modified.
1367 * @param p_effective_date Determines when the DateTrack operation comes into
1368 * force.
1369 * @param p_person_id Identifies the person record to be modified.
1370 * @param p_applicant_number Identifies the applicant number. If the number
1371 * generation method is Manual, then this parameter is mandatory. If the number
1372 * generation is Automatic, then the value of this parameter defaults to null
1373 * and the application will provide the corresponding value.
1374 * @param p_per_object_version_number Pass in the current version number of the
1375 * person to be updated. When the API completes if p_validate is false, will be
1376 * set to the new version number of the updated person. If p_validate is true
1377 * will be set to the same value which was passed in.
1378 * @param p_vacancy_id Identifies the vacancy for which the person has applied.
1379 * @param p_person_type_id Person Type ID of 'APL' flavor. If set to null, the
1380 * application will retrieve the default APL person type.
1381 * @param p_assignment_status_type_id Applicant assignment status type id. If
1382 * set to null, then the application will use the default status defined for
1383 * the person's business group.
1384 * @param p_application_id If p_validate is false, this uniquely identifies the
1385 * application created or reopened . If p_validate is true this parameter is
1386 * null.
1387 * @param p_assignment_id Identifies the assignment for which you create the
1388 * person record.
1389 * @param p_apl_object_version_number If p_validate is false, this will be set
1390 * to the version number of the application created or updated. If p_validate
1391 * is true this parameter is set to null.
1392 * @param p_asg_object_version_number If p_validate is false, then this
1393 * parameter is set to the version number of the assignment created. If
1394 * p_validate is true, then this parameter is null.
1395 * @param p_assignment_sequence If p_validate is false, this will be set to the
1396 * assignment sequence of the assignment created. If p_validate is true, this
1397 * parameter is set to null.
1398 * @param p_per_effective_start_date If p_validate is false, this is set to the
1399 * effective start date of the person. If p_validate is true this is null.
1400 * @param p_per_effective_end_date If p_validate is false, this is set to the
1401 * effective end date of the person. If p_validate is true this is set null.
1402 * @param p_appl_override_warning if set to true, future applications existed
1403 * prior to calling this API. These applications have been removed after
1404 * successful conversion of the person into applicant. If set to false, then no
1405 * future applications were found.
1406 * @rep:displayname Apply For Job Anytime
1407 * @rep:category BUSINESS_ENTITY PER_APPLICANT
1408 * @rep:lifecycle active
1409 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
1410 * @rep:scope public
1411 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
1412 */
1413 --
1414 -- {End Of Comments}
1415 --
1416 procedure apply_for_job_anytime
1417 (p_validate in boolean default false
1418 ,p_effective_date in date
1419 ,p_person_id in number
1420 ,p_applicant_number in out nocopy varchar2
1421 ,p_per_object_version_number in out nocopy number
1422 ,p_vacancy_id in number default null
1423 ,p_person_type_id in number default hr_api.g_number
1424 ,p_assignment_status_type_id in number
1425 ,p_application_id out nocopy number
1426 ,p_assignment_id out nocopy number
1427 ,p_apl_object_version_number out nocopy number
1428 ,p_asg_object_version_number out nocopy number
1429 ,p_assignment_sequence out nocopy number
1430 ,p_per_effective_start_date out nocopy date
1431 ,p_per_effective_end_date out nocopy date
1432 ,p_appl_override_warning out nocopy boolean
1433 );
1434 --
1435 end hr_applicant_api;
[Home] [Help]