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