1 package hr_sa_applicant_api AUTHID CURRENT_USER as
2 /* $Header: peappsai.pkh 120.4 2005/10/02 02:10:34 aroussel $ */
3 /*#
4 * This package contains applicant APIs for Saudi Arabia.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Applicant for Saudi Arabia
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |---------------------------< create_sa_applicant >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates an applicant for Saudi Arabia.
17 *
18 * The API calls the generic API create_applicant, with parameters set as
19 * appropriate for the Saudi applicant. As this API is effectively an
20 * alternative to the API create_applicant, see that API for further
21 * explanation.
22 *
23 * <p><b>Licensing</b><br>
24 * This API is licensed for use with Human Resources.
25 *
26 * <p><b>Prerequisites</b><br>
27 * See API create_applicant
28 *
29 * <p><b>Post Success</b><br>
30 * The API successfully creates an applicant record in the database.
31 *
32 * <p><b>Post Failure</b><br>
33 * The API does not create the applicant record and raises an error.
34 * @param p_validate If true, then validation alone will be performed and the
35 * database will remain unchanged. If false and all validation checks pass,
36 * then the database will be modified.
37 * @param p_date_received Date an application was received.
38 * @param p_business_group_id Business group of the person.
39 * @param p_family_name Family Name
40 * @param p_person_type_id Type of applicant being created.
41 * @param p_applicant_number The business group's applicant number generation
42 * method determines when the API derives and passes out an applicant number or
43 * when the calling program should pass in a value. When the API call completes
44 * if p_validate is true then will be set to the applicant number. If
45 * p_validate is true then will be set to the passed value.
46 * @param p_comments Comments text
47 * @param p_date_employee_data_verified Date on which the applicant data was
48 * last verified.
49 * @param p_date_of_birth Date of birth.
50 * @param p_email_address Email address.
51 * @param p_expense_check_send_to_addres Mailing address.
52 * @param p_first_name First name.
53 * @param p_known_as Preferred name.
54 * @param p_marital_status Marital status. Valid values are defined by the
55 * MAR_STATUS lookup type.
56 * @param p_nationality Nationality. Valid values are defined by the
57 * NATIONALITY lookup type.
58 * @param p_national_identifier Number by which a person is identified in a
59 * given legislation.
60 * @param p_previous_last_name Previous last name.
61 * @param p_registered_disabled_flag Flag indicating whether the person is
62 * classified as disabled.
63 * @param p_sex Legal gender. Valid values are defined by the SEX lookup type.
64 * @param p_title Title. Valid values are defined by the TITLE lookup type.
65 * @param p_work_telephone Obsolete parameter, do not use.
66 * @param p_attribute_category This context value determines which flexfield
67 * structure to use with the descriptive flexfield segments.
68 * @param p_attribute1 Descriptive flexfield segment.
69 * @param p_attribute2 Descriptive flexfield segment.
70 * @param p_attribute3 Descriptive flexfield segment.
71 * @param p_attribute4 Descriptive flexfield segment.
72 * @param p_attribute5 Descriptive flexfield segment.
73 * @param p_attribute6 Descriptive flexfield segment.
74 * @param p_attribute7 Descriptive flexfield segment.
75 * @param p_attribute8 Descriptive flexfield segment.
76 * @param p_attribute9 Descriptive flexfield segment.
77 * @param p_attribute10 Descriptive flexfield segment.
78 * @param p_attribute11 Descriptive flexfield segment.
79 * @param p_attribute12 Descriptive flexfield segment.
80 * @param p_attribute13 Descriptive flexfield segment.
81 * @param p_attribute14 Descriptive flexfield segment.
82 * @param p_attribute15 Descriptive flexfield segment.
83 * @param p_attribute16 Descriptive flexfield segment.
84 * @param p_attribute17 Descriptive flexfield segment.
85 * @param p_attribute18 Descriptive flexfield segment.
86 * @param p_attribute19 Descriptive flexfield segment.
87 * @param p_attribute20 Descriptive flexfield segment.
88 * @param p_attribute21 Descriptive flexfield segment.
89 * @param p_attribute22 Descriptive flexfield segment.
90 * @param p_attribute23 Descriptive flexfield segment.
91 * @param p_attribute24 Descriptive flexfield segment.
92 * @param p_attribute25 Descriptive flexfield segment.
93 * @param p_attribute26 Descriptive flexfield segment.
94 * @param p_attribute27 Descriptive flexfield segment.
95 * @param p_attribute28 Descriptive flexfield segment.
96 * @param p_attribute29 Descriptive flexfield segment.
97 * @param p_attribute30 Descriptive flexfield segment.
98 * @param p_father_name Father's Name
99 * @param p_grandfather_name Grandfather's Name
100 * @param p_alt_first_name Specifies First Name in alternative language
101 * @param p_alt_father_name Specifies Father's Name in alternative language
102 * @param p_alt_grandfather_name Specifies Grandfather's Name in alternative
103 * language
104 * @param p_alt_family_name Specifies Family Name in alternative language
105 * @param p_religion Religion
106 * @param p_hijrah_birth_date Date of birth according to the Hijrah calendar.
107 * @param p_background_check_status Flag indicating whether the person's
108 * background has been checked.
109 * @param p_background_date_check Date on which the background check was
110 * performed.
111 * @param p_correspondence_language Preferred language for correspondence.
112 * @param p_fte_capacity Obsolete parameter, do not use.
113 * @param p_hold_applicant_date_until Date until when the applicant's
114 * information is to be maintained.
115 * @param p_honors Honors awarded.
116 * @param p_mailstop Internal mail location.
117 * @param p_office_number Office number.
118 * @param p_on_military_service Flag indicating whether the person is on
119 * military service.
120 * @param p_projected_start_date Obsolete parameter, do not use.
121 * @param p_resume_exists Flag indicating whether the person's resume is on
122 * file.
123 * @param p_resume_last_updated Date on which the resume was last updated.
124 * @param p_student_status If this applicant is a student, this field is used
125 * to capture their status. Valid values are defined by the STUDENT_STATUS
126 * lookup type.
127 * @param p_work_schedule Days on which this person will work.
128 * @param p_date_of_death Date of death.
129 * @param p_benefit_group_id Benefit group to which this person will belong.
130 * @param p_receipt_of_death_cert_date Date death certificate was received.
131 * @param p_coord_ben_med_pln_no Secondary medical plan name. Column used for
132 * external processing.
133 * @param p_coord_ben_no_cvg_flag No secondary medical plan coverage. Column
134 * used for external processing.
135 * @param p_uses_tobacco_flag Flag indicating whether the person uses tobacco.
136 * @param p_dpdnt_adoption_date Date on which the dependent was adopted.
137 * @param p_dpdnt_vlntry_svce_flag Flag indicating whether the dependent is on
138 * voluntary service.
139 * @param p_original_date_of_hire Original date of hire.
140 * @param p_town_of_birth Town or city of birth.
141 * @param p_region_of_birth Geographical region of birth.
142 * @param p_country_of_birth Country of birth.
143 * @param p_global_person_id Obsolete parameter, do not use.
144 * @param p_person_id If p_validate is false, then this uniquely identifies the
145 * person created. If p_validate is true, then set to null.
146 * @param p_assignment_id If p_validate is false, then this uniquely identifies
147 * the created assignment. If p_validate is true, then set to null.
148 * @param p_application_id If p_validate is false, then this uniquely
149 * identifies the application created. If p_validate is true, then set to null.
150 * @param p_per_object_version_number If p_validate is false, then set to the
151 * version number of the created person. If p_validate is true, then set to
152 * null.
153 * @param p_asg_object_version_number If p_validate is false, then this
154 * parameter is set to the version number of the assignment created. If
155 * p_validate is true, then this parameter is null.
156 * @param p_apl_object_version_number If p_validate is false, then set to the
157 * version number of the created application. If p_validate is true, then set
158 * to null.
159 * @param p_per_effective_start_date If p_validate is false, then set to the
160 * earliest effective start date for the created person. If p_validate is true,
161 * then set to null.
162 * @param p_per_effective_end_date If p_validate is false, then set to the
163 * effective end date for the created person. If p_validate is true, then set
164 * to null.
165 * @param p_full_name If p_validate is false, then set to the complete full
166 * name of the person. If p_validate is true, then set to null.
167 * @param p_per_comment_id If p_validate is false and comment text was
168 * provided, then will be set to the identifier of the created person comment
169 * record. If p_validate is true or no comment text was provided, then will be
170 * null.
171 * @param p_assignment_sequence If p_validate is false, then set to the
172 * sequence number of the default assignment. If p_validate is true, then set
173 * to null.
174 * @param p_name_combination_warning If set to true, then the combination of
175 * last name, first name and date of birth existed prior to calling this API.
176 * @param p_orig_hire_warning If set to true, an orginal date of hire exists
177 * for an applicant who has never been an employee.
178 * @param p_education_level New parameter, available on the latest version of this API
179 * @rep:displayname Create Applicant for Saudi Arabia
180 * @rep:category BUSINESS_ENTITY PER_APPLICANT
181 * @rep:scope public
182 * @rep:lifecycle active
183 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
184 */
185 --
186 -- {End Of Comments}
187 --
188 PROCEDURE create_sa_applicant
189 (p_validate in boolean default false
190 ,p_date_received in date
191 ,p_business_group_id in number
192 ,p_family_name in varchar2
193 ,p_person_type_id in number default null
194 ,p_applicant_number in out nocopy varchar2
195 ,p_comments in varchar2 default null
196 ,p_date_employee_data_verified in date default null
197 ,p_date_of_birth in date default null
198 ,p_email_address in varchar2 default null
199 ,p_expense_check_send_to_addres in varchar2 default null
200 ,p_first_name in varchar2 default null
201 ,p_known_as in varchar2 default null
202 ,p_marital_status in varchar2 default null
203 ,p_nationality in varchar2 default null
204 ,p_national_identifier in varchar2 default null
205 ,p_previous_last_name in varchar2 default null
206 ,p_registered_disabled_flag in varchar2 default null
207 ,p_sex in varchar2 default null
208 ,p_title in varchar2 default null
209 ,p_work_telephone in varchar2 default null
210 ,p_attribute_category in varchar2 default null
211 ,p_attribute1 in varchar2 default null
212 ,p_attribute2 in varchar2 default null
213 ,p_attribute3 in varchar2 default null
214 ,p_attribute4 in varchar2 default null
215 ,p_attribute5 in varchar2 default null
216 ,p_attribute6 in varchar2 default null
217 ,p_attribute7 in varchar2 default null
218 ,p_attribute8 in varchar2 default null
219 ,p_attribute9 in varchar2 default null
220 ,p_attribute10 in varchar2 default null
221 ,p_attribute11 in varchar2 default null
222 ,p_attribute12 in varchar2 default null
223 ,p_attribute13 in varchar2 default null
224 ,p_attribute14 in varchar2 default null
225 ,p_attribute15 in varchar2 default null
226 ,p_attribute16 in varchar2 default null
227 ,p_attribute17 in varchar2 default null
228 ,p_attribute18 in varchar2 default null
229 ,p_attribute19 in varchar2 default null
230 ,p_attribute20 in varchar2 default null
231 ,p_attribute21 in varchar2 default null
232 ,p_attribute22 in varchar2 default null
233 ,p_attribute23 in varchar2 default null
234 ,p_attribute24 in varchar2 default null
235 ,p_attribute25 in varchar2 default null
236 ,p_attribute26 in varchar2 default null
237 ,p_attribute27 in varchar2 default null
238 ,p_attribute28 in varchar2 default null
239 ,p_attribute29 in varchar2 default null
240 ,p_attribute30 in varchar2 default null
241 ,p_father_name in varchar2 default null
242 ,p_grandfather_name in varchar2 default null
243 ,p_alt_first_name in varchar2 default null
244 ,p_alt_father_name in varchar2 default null
245 ,p_alt_grandfather_name in varchar2 default null
246 ,p_alt_family_name in varchar2 default null
247 ,p_religion in varchar2 default null
248 ,p_hijrah_birth_date in varchar2 default null
249 ,p_education_level in varchar2 default null
250 ,p_background_check_status in varchar2 default null
251 ,p_background_date_check in date default null
252 ,p_correspondence_language in varchar2 default null
253 ,p_fte_capacity in number default null
254 ,p_hold_applicant_date_until in date default null
255 ,p_honors in varchar2 default null
256 ,p_mailstop in varchar2 default null
257 ,p_office_number in varchar2 default null
258 ,p_on_military_service in varchar2 default null
259 ,p_projected_start_date in date default null
260 ,p_resume_exists in varchar2 default null
261 ,p_resume_last_updated in date default null
262 ,p_student_status in varchar2 default null
263 ,p_work_schedule in varchar2 default null
264 ,p_date_of_death in date default null
265 ,p_benefit_group_id in number default null
266 ,p_receipt_of_death_cert_date in date default null
267 ,p_coord_ben_med_pln_no in varchar2 default null
268 ,p_coord_ben_no_cvg_flag in varchar2 default 'N'
269 ,p_uses_tobacco_flag in varchar2 default null
270 ,p_dpdnt_adoption_date in date default null
271 ,p_dpdnt_vlntry_svce_flag in varchar2 default 'N'
272 ,p_original_date_of_hire in date default null
273 ,p_town_of_birth in varchar2 default null
274 ,p_region_of_birth in varchar2 default null
275 ,p_country_of_birth in varchar2 default null
276 ,p_global_person_id in varchar2 default null
277 ,p_person_id out nocopy number
278 ,p_assignment_id out nocopy number
279 ,p_application_id out nocopy number
280 ,p_per_object_version_number out nocopy number
281 ,p_asg_object_version_number out nocopy number
282 ,p_apl_object_version_number out nocopy number
283 ,p_per_effective_start_date out nocopy date
284 ,p_per_effective_end_date out nocopy date
285 ,p_full_name out nocopy varchar2
286 ,p_per_comment_id out nocopy number
287 ,p_assignment_sequence out nocopy number
288 ,p_name_combination_warning out nocopy boolean
289 ,p_orig_hire_warning out nocopy boolean);
290
291 end hr_sa_applicant_api;
[Home] [Help]