1 Package hr_es_applicant_api as
2 /* $Header: peappesi.pkh 120.1 2005/10/02 02:10:12 aroussel $ */
3 /*#
4 * This package contains applicant APIs for Spain.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Applicant for Spain
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |---------------------------< create_es_applicant >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a new applicant for Spain.
17 *
18 * This API creates a new applicant, an application, a default applicant
19 * assignment, and if required, associated assignment budget values, and a
20 * letter request. The applicant is added to security lists so that secure
21 * users can see them. If a valid person_type_id is specified, with a
22 * corresponding system type of 'APL', it must be active and in the same
23 * business group as that of the applicant being created. If a person_type_id
24 * is not specified, the API will use the default 'APL' type for the business
25 * group.
26 *
27 * <p><b>Licensing</b><br>
28 * This API is licensed for use with Human Resources.
29 *
30 * <p><b>Prerequisites</b><br>
31 * A valid business group id for Spain.
32 *
33 * <p><b>Post Success</b><br>
34 * The API creates an applicant successfully.
35 *
36 * <p><b>Post Failure</b><br>
37 * The API does not create the applicant and raises an error.
38 * @param p_validate If true, then validation alone will be performed and the
39 * database will remain unchanged. If false and all validation checks pass,
40 * then the database will be modified.
41 * @param p_date_received Date an application was received.
42 * @param p_business_group_id Business group of the person.
43 * @param p_first_last_name Applicant's last name.
44 * @param p_person_type_id Type of applicant being created.
45 * @param p_applicant_number The business group's applicant number generation
46 * method determines when the API derives and passes out an applicant number or
47 * when the calling program should pass in a value. When the API call completes
48 * if p_validate is true then will be set to the applicant number. If
49 * p_validate is true then will be set to the passed value.
50 * @param p_per_comments Person comment text
51 * @param p_date_employee_data_verified Date on which the applicant data was
52 * last verified.
53 * @param p_date_of_birth Date of birth.
54 * @param p_email_address Email address.
55 * @param p_expense_check_send_to_addres Mailing address.
56 * @param p_name Applicant's first name
57 * @param p_preferred_name Alternative name
58 * @param p_marital_status Marital status. Valid values are defined by the
59 * MAR_STATUS lookup type.
60 * @param p_middle_names Middle names.
61 * @param p_nationality Nationality. Valid values are defined by the
62 * NATIONALITY lookup type.
63 * @param p_nif_value National identifier.
64 * @param p_maiden_name Previous last name.
65 * @param p_registered_disabled_flag Flag indicating whether the person is
66 * classified as disabled.
67 * @param p_sex Legal gender. Valid values are defined by the SEX lookup type.
68 * @param p_title Title. Valid values are defined by the TITLE lookup type.
69 * @param p_work_telephone Obsolete parameter, do not use.
70 * @param p_attribute_category This context value determines which flexfield
71 * structure to use with the descriptive flexfield segments.
72 * @param p_attribute1 Descriptive flexfield segment.
73 * @param p_attribute2 Descriptive flexfield segment.
74 * @param p_attribute3 Descriptive flexfield segment.
75 * @param p_attribute4 Descriptive flexfield segment.
76 * @param p_attribute5 Descriptive flexfield segment.
77 * @param p_attribute6 Descriptive flexfield segment.
78 * @param p_attribute7 Descriptive flexfield segment.
79 * @param p_attribute8 Descriptive flexfield segment.
80 * @param p_attribute9 Descriptive flexfield segment.
81 * @param p_attribute10 Descriptive flexfield segment.
82 * @param p_attribute11 Descriptive flexfield segment.
83 * @param p_attribute12 Descriptive flexfield segment.
84 * @param p_attribute13 Descriptive flexfield segment.
85 * @param p_attribute14 Descriptive flexfield segment.
86 * @param p_attribute15 Descriptive flexfield segment.
87 * @param p_attribute16 Descriptive flexfield segment.
88 * @param p_attribute17 Descriptive flexfield segment.
89 * @param p_attribute18 Descriptive flexfield segment.
90 * @param p_attribute19 Descriptive flexfield segment.
91 * @param p_attribute20 Descriptive flexfield segment.
92 * @param p_attribute21 Descriptive flexfield segment.
93 * @param p_attribute22 Descriptive flexfield segment.
94 * @param p_attribute23 Descriptive flexfield segment.
95 * @param p_attribute24 Descriptive flexfield segment.
96 * @param p_attribute25 Descriptive flexfield segment.
97 * @param p_attribute26 Descriptive flexfield segment.
98 * @param p_attribute27 Descriptive flexfield segment.
99 * @param p_attribute28 Descriptive flexfield segment.
100 * @param p_attribute29 Descriptive flexfield segment.
101 * @param p_attribute30 Descriptive flexfield segment.
102 * @param p_per_information_category Obsolete parameter, do not use.
103 * @param p_second_last_name Applicant's second last name
104 * @param p_identifier_type Alternative to National Identifier. Valid values
105 * exist in the 'ES_IDENTIFIER_TYPE' lookup type.
106 * @param p_identifier_value Identifier type value
107 * @param p_overtime_approval Under 18 overtime approval flag. Valid values
108 * exist in the 'YES_NO' lookup type.
109 * @param p_per_information5 Developer descriptive flexfield segment.
110 * @param p_per_information6 Developer descriptive flexfield segment.
111 * @param p_per_information7 Developer descriptive flexfield segment.
112 * @param p_per_information8 Developer descriptive flexfield segment.
113 * @param p_per_information9 Developer descriptive flexfield segment.
114 * @param p_per_information10 Developer descriptive flexfield segment.
115 * @param p_per_information11 Developer descriptive flexfield segment.
116 * @param p_per_information12 Developer descriptive flexfield segment.
117 * @param p_per_information13 Developer descriptive flexfield segment.
118 * @param p_per_information14 Developer descriptive flexfield segment.
119 * @param p_per_information15 Developer descriptive flexfield segment.
120 * @param p_per_information16 Developer descriptive flexfield segment.
121 * @param p_per_information17 Developer descriptive flexfield segment.
122 * @param p_per_information18 Developer descriptive flexfield segment.
123 * @param p_per_information19 Developer descriptive flexfield segment.
124 * @param p_per_information20 Developer descriptive flexfield segment.
125 * @param p_per_information21 Developer descriptive flexfield segment.
126 * @param p_per_information22 Developer descriptive flexfield segment.
127 * @param p_per_information23 Developer descriptive flexfield segment.
128 * @param p_per_information24 Developer descriptive flexfield segment.
129 * @param p_per_information25 Developer descriptive flexfield segment.
130 * @param p_per_information26 Developer descriptive flexfield segment.
131 * @param p_per_information27 Developer descriptive flexfield segment.
132 * @param p_per_information28 Developer descriptive flexfield segment.
133 * @param p_per_information29 Developer descriptive flexfield segment.
134 * @param p_per_information30 Developer descriptive flexfield segment.
135 * @param p_background_check_status Flag indicating whether the person's
136 * background has been checked.
137 * @param p_background_date_check Date on which the background check was
138 * performed.
139 * @param p_correspondence_language Preferred language for correspondence.
140 * @param p_fte_capacity Obsolete parameter, do not use.
141 * @param p_hold_applicant_date_until Date until when the applicant's
142 * information is to be maintained.
143 * @param p_honors Honors awarded.
144 * @param p_mailstop Internal mail location.
145 * @param p_office_number Office number.
146 * @param p_on_military_service Flag indicating whether the person is on
147 * military service.
148 * @param p_prefix Applicant's name prefix.
149 * @param p_projected_start_date Obsolete parameter, do not use.
150 * @param p_resume_exists Flag indicating whether the person's resume is on
151 * file.
152 * @param p_resume_last_updated Date on which the resume was last updated.
153 * @param p_student_status If this applicant is a student, this field is used
154 * to capture their status. Valid values are defined by the STUDENT_STATUS
155 * lookup type.
156 * @param p_work_schedule Days on which this person will work.
157 * @param p_suffix Suffix after the person's last name e.g. Sr., Jr., III.
158 * @param p_date_of_death Date of death.
159 * @param p_benefit_group_id Benefit group to which this person will belong.
160 * @param p_receipt_of_death_cert_date Date death certificate was received.
161 * @param p_coord_ben_med_pln_no Secondary medical plan name. Column used for
162 * external processing.
163 * @param p_coord_ben_no_cvg_flag No secondary medical plan coverage. Column
164 * used for external processing.
165 * @param p_uses_tobacco_flag Flag indicating whether the person uses tobacco.
166 * @param p_dpdnt_adoption_date Date on which the dependent was adopted.
167 * @param p_dpdnt_vlntry_svce_flag Flag indicating whether the dependent is on
168 * voluntary service.
169 * @param p_original_date_of_hire Original date of hire.
170 * @param p_town_of_birth Town or city of birth.
171 * @param p_region_of_birth Geographical region of birth.
172 * @param p_country_of_birth Country of birth.
173 * @param p_global_person_id Obsolete parameter, do not use.
174 * @param p_party_id TCA party for whom you create the person record.
175 * @param p_person_id If p_validate is false, then this uniquely identifies the
176 * person created. If p_validate is true, then set to null.
177 * @param p_assignment_id If p_validate is false, then this uniquely identifies
178 * the created assignment. If p_validate is true, then set to null.
179 * @param p_application_id If p_validate is false, then this uniquely
180 * identifies the application created. If p_validate is true, then set to null.
181 * @param p_per_object_version_number If p_validate is false, then set to the
182 * version number of the created person. If p_validate is true, then the value
183 * will be null.
184 * @param p_asg_object_version_number If p_validate is false, then this
185 * parameter is set to the version number of the assignment created. If
186 * p_validate is true, then this parameter is null.
187 * @param p_apl_object_version_number If p_validate is false, then set to the
188 * version number of the created application. If p_validate is true, then set
189 * to null.
190 * @param p_per_effective_start_date If p_validate is false, then set to the
191 * earliest effective start date for the created person. If p_validate is true,
192 * then set to null.
193 * @param p_per_effective_end_date If p_validate is false, then set to the
194 * effective end date for the created person. If p_validate is true, then set
195 * to null.
196 * @param p_full_name If p_validate is false, then set to the complete full
197 * name of the person. If p_validate is true, then set to null.
198 * @param p_per_comment_id If p_validate is false and comment text was
199 * provided, then will be set to the identifier of the created person comment
200 * record. If p_validate is true or no comment text was provided, then will be
201 * null.
202 * @param p_assignment_sequence If p_validate is false, then set to the
203 * sequence number of the default assignment. If p_validate is true, then set
204 * to null.
205 * @param p_name_combination_warning If set to true, then the combination of
206 * last name, first name and date of birth existed prior to calling this API.
207 * @param p_orig_hire_warning If set to true, an orginal date of hire exists
208 * for an applicant who has never been an employee.
209 * @rep:displayname Create Applicant for Spain
210 * @rep:category BUSINESS_ENTITY PER_APPLICANT
211 * @rep:scope public
212 * @rep:lifecycle active
213 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
214 */
215 --
216 -- {End Of Comments}
217 --
218 procedure create_es_applicant
219 (p_validate in boolean default false
220 ,p_date_received in date
221 ,p_business_group_id in number
222 ,p_first_last_name in varchar2
223 ,p_person_type_id in number default null
224 ,p_applicant_number in out nocopy varchar2
225 ,p_per_comments in varchar2 default null
226 ,p_date_employee_data_verified in date default null
227 ,p_date_of_birth in date default null
228 ,p_email_address in varchar2 default null
229 ,p_expense_check_send_to_addres in varchar2 default null
230 ,p_name in varchar2 default null
231 ,p_preferred_name in varchar2 default null
232 ,p_marital_status in varchar2 default null
233 ,p_middle_names in varchar2 default null
234 ,p_nationality in varchar2 default null
235 ,p_nif_value in varchar2 default null
236 ,p_maiden_name in varchar2 default null
237 ,p_registered_disabled_flag in varchar2 default null
238 ,p_sex in varchar2 default null
239 ,p_title in varchar2 default null
240 ,p_work_telephone in varchar2 default null
241 ,p_attribute_category in varchar2 default null
242 ,p_attribute1 in varchar2 default null
243 ,p_attribute2 in varchar2 default null
244 ,p_attribute3 in varchar2 default null
245 ,p_attribute4 in varchar2 default null
246 ,p_attribute5 in varchar2 default null
247 ,p_attribute6 in varchar2 default null
248 ,p_attribute7 in varchar2 default null
249 ,p_attribute8 in varchar2 default null
250 ,p_attribute9 in varchar2 default null
251 ,p_attribute10 in varchar2 default null
252 ,p_attribute11 in varchar2 default null
253 ,p_attribute12 in varchar2 default null
254 ,p_attribute13 in varchar2 default null
255 ,p_attribute14 in varchar2 default null
256 ,p_attribute15 in varchar2 default null
257 ,p_attribute16 in varchar2 default null
258 ,p_attribute17 in varchar2 default null
259 ,p_attribute18 in varchar2 default null
260 ,p_attribute19 in varchar2 default null
261 ,p_attribute20 in varchar2 default null
262 ,p_attribute21 in varchar2 default null
263 ,p_attribute22 in varchar2 default null
264 ,p_attribute23 in varchar2 default null
265 ,p_attribute24 in varchar2 default null
266 ,p_attribute25 in varchar2 default null
267 ,p_attribute26 in varchar2 default null
268 ,p_attribute27 in varchar2 default null
269 ,p_attribute28 in varchar2 default null
270 ,p_attribute29 in varchar2 default null
271 ,p_attribute30 in varchar2 default null
272 ,p_per_information_category in varchar2 default null
273 ,p_second_last_name in varchar2 default null
274 ,p_identifier_type in varchar2 default null
275 ,p_identifier_value in varchar2 default null
276 ,p_overtime_approval in varchar2 default null
277 ,p_per_information5 in varchar2 default null
278 ,p_per_information6 in varchar2 default null
279 ,p_per_information7 in varchar2 default null
280 ,p_per_information8 in varchar2 default null
281 ,p_per_information9 in varchar2 default null
282 ,p_per_information10 in varchar2 default null
283 ,p_per_information11 in varchar2 default null
284 ,p_per_information12 in varchar2 default null
285 ,p_per_information13 in varchar2 default null
286 ,p_per_information14 in varchar2 default null
287 ,p_per_information15 in varchar2 default null
288 ,p_per_information16 in varchar2 default null
289 ,p_per_information17 in varchar2 default null
290 ,p_per_information18 in varchar2 default null
294 ,p_per_information22 in varchar2 default null
291 ,p_per_information19 in varchar2 default null
292 ,p_per_information20 in varchar2 default null
293 ,p_per_information21 in varchar2 default null
295 ,p_per_information23 in varchar2 default null
296 ,p_per_information24 in varchar2 default null
297 ,p_per_information25 in varchar2 default null
298 ,p_per_information26 in varchar2 default null
299 ,p_per_information27 in varchar2 default null
300 ,p_per_information28 in varchar2 default null
301 ,p_per_information29 in varchar2 default null
302 ,p_per_information30 in varchar2 default null
303 ,p_background_check_status in varchar2 default null
304 ,p_background_date_check in date default null
305 ,p_correspondence_language in varchar2 default null
306 ,p_fte_capacity in number default null
307 ,p_hold_applicant_date_until in date default null
308 ,p_honors in varchar2 default null
309 ,p_mailstop in varchar2 default null
310 ,p_office_number in varchar2 default null
311 ,p_on_military_service in varchar2 default null
312 ,p_prefix in varchar2 default null
313 ,p_projected_start_date in date default null
314 ,p_resume_exists in varchar2 default null
315 ,p_resume_last_updated in date default null
316 ,p_student_status in varchar2 default null
317 ,p_work_schedule in varchar2 default null
318 ,p_suffix in varchar2 default null
319 ,p_date_of_death in date default null
320 ,p_benefit_group_id in number default null
321 ,p_receipt_of_death_cert_date in date default null
322 ,p_coord_ben_med_pln_no in varchar2 default null
323 ,p_coord_ben_no_cvg_flag in varchar2 default 'N'
324 ,p_uses_tobacco_flag in varchar2 default null
325 ,p_dpdnt_adoption_date in date default null
326 ,p_dpdnt_vlntry_svce_flag in varchar2 default 'N'
327 ,p_original_date_of_hire in date default null
328 ,p_town_of_birth in varchar2 default null
329 ,p_region_of_birth in varchar2 default null
330 ,p_country_of_birth in varchar2 default null
331 ,p_global_person_id in varchar2 default null
332 ,p_party_id in number default null
333 ,p_person_id out nocopy number
334 ,p_assignment_id out nocopy number
335 ,p_application_id out nocopy number
336 ,p_per_object_version_number out nocopy number
337 ,p_asg_object_version_number out nocopy number
338 ,p_apl_object_version_number out nocopy number
339 ,p_per_effective_start_date out nocopy date
340 ,p_per_effective_end_date out nocopy date
341 ,p_full_name out nocopy varchar2
342 ,p_per_comment_id out nocopy number
343 ,p_assignment_sequence out nocopy number
344 ,p_name_combination_warning out nocopy boolean
345 ,p_orig_hire_warning out nocopy boolean
346 );
347 END hr_es_applicant_api;
[Home] [Help]