1 package hr_sg_applicant_api as
2 /* $Header: hrsgwraa.pkh 120.8 2007/10/26 01:36:28 jalin ship $ */
3 /*#
4 * This package contains Applicant related APIs for Singapore.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Applicant for Singapore
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |---------------------------< create_sg_applicant >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates new applicant record for Singapore.
17 *
18 * This API calls the generic create_applicant API, with the parameters set as
19 * appropriate for an applicant in SIngapore. 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 * A business group for Singapore legislation must be specified.
28 *
29 * <p><b>Post Success</b><br>
30 * The API successfully inserts a person, primary assignment and application in
31 * the database.
32 *
33 * <p><b>Post Failure</b><br>
34 * The API does not create the applicant, DEFAULT assignment or application and
35 * raises the error.
36 * @param p_validate If true, then validation alone will be performed and the
37 * database will remain unchanged. If false and all validation checks pass,
38 * then the database will be modified.
39 * @param p_date_received Indicates the applicant hire DATE and thus the
40 * effective start DATE of the person, primary assignment and application.
41 * @param p_business_group_id {@rep:casecolumn
42 * PER_ALL_PEOPLE_F.BUSINESS_GROUP_ID}
43 * @param p_last_name {@rep:casecolumn PER_ALL_PEOPLE_F.LAST_NAME}
44 * @param p_person_type_id {@rep:casecolumn PER_ALL_PEOPLE_F.PERSON_TYPE_ID}
45 * @param p_applicant_number If the number generation method is Manual, then
46 * this parameter is mandatory. If the number generation method is Automatic,
47 * then the value of this parameter must be NULL. When the API completes, if
48 * p_validate is false and the applicant number generation method is Automatic,
49 * then set the applicant number to the generated applicant number of the
50 * person created. If p_validate is false and the applicant number generation
51 * method is manual or if p_validate is true, then set the applicant number to
52 * the same value that was passed.
53 * @param p_comments Comment text.
54 * @param p_date_employee_data_verified {@rep:casecolumn
55 * PER_ALL_PEOPLE_F.DATE_EMPLOYEE_DATA_VERIFIED}
56 * @param p_date_of_birth {@rep:casecolumn PER_ALL_PEOPLE_F.DATE_OF_BIRTH}
57 * @param p_email_address {@rep:casecolumn PER_ALL_PEOPLE_F.EMAIL_ADDRESS}
58 * @param p_expense_check_send_to_addres Indicates the Applicant's Address to
59 * which the expense should be sent. Valid values are determined by
60 * 'HOME_OFFICE' lookup type.
61 * @param p_first_name {@rep:casecolumn PER_ALL_PEOPLE_F.FIRST_NAME}
62 * @param p_known_as {@rep:casecolumn PER_ALL_PEOPLE_F.KNOWN_AS}
63 * @param p_marital_status Indicates the Applicant's Marital status. Valid
64 * values are defined by 'MAR_STATUS' lookup type.
65 * @param p_middle_names {@rep:casecolumn PER_ALL_PEOPLE_F.MIDDLE_NAMES}
66 * @param p_nationality Indicates the Applicant' s Nationality. Valid values
67 * are defined by 'NATIONALITY' lookup type.
68 * @param p_national_identifier {@rep:casecolumn
69 * PER_ALL_PEOPLE_F.NATIONAL_IDENTIFIER}
70 * @param p_previous_last_name {@rep:casecolumn
71 * PER_ALL_PEOPLE_F.PREVIOUS_LAST_NAME}
72 * @param p_registered_disabled_flag Indicates whether an Applicant is
73 * classified as disabled. Valid values are defined by 'REGISTERED_DISABLED'
74 * lookup type.
75 * @param p_sex Indicates the Applicant's Legal gender. Valid values are
76 * defined by 'SEX' lookup type.
77 * @param p_title Title e.g. Mr, Mrs, Dr. Valid values are defined by 'TITLE'
78 * lookup type.
79 * @param p_work_telephone {@rep:casecolumn PER_ALL_PEOPLE_F.WORK_TELEPHONE}
80 * @param p_attribute_category This context value determines which flexfield
81 * structure to use with the descriptive flexfield segments.
82 * @param p_attribute1 Descriptive flexfield segment.
83 * @param p_attribute2 Descriptive flexfield segment.
84 * @param p_attribute3 Descriptive flexfield segment.
85 * @param p_attribute4 Descriptive flexfield segment.
86 * @param p_attribute5 Descriptive flexfield segment.
87 * @param p_attribute6 Descriptive flexfield segment.
88 * @param p_attribute7 Descriptive flexfield segment.
89 * @param p_attribute8 Descriptive flexfield segment.
90 * @param p_attribute9 Descriptive flexfield segment.
91 * @param p_attribute10 Descriptive flexfield segment.
92 * @param p_attribute11 Descriptive flexfield segment.
93 * @param p_attribute12 Descriptive flexfield segment.
94 * @param p_attribute13 Descriptive flexfield segment.
95 * @param p_attribute14 Descriptive flexfield segment.
96 * @param p_attribute15 Descriptive flexfield segment.
97 * @param p_attribute16 Descriptive flexfield segment.
98 * @param p_attribute17 Descriptive flexfield segment.
99 * @param p_attribute18 Descriptive flexfield segment.
100 * @param p_attribute19 Descriptive flexfield segment.
101 * @param p_attribute20 Descriptive flexfield segment.
102 * @param p_attribute21 Descriptive flexfield segment.
103 * @param p_attribute22 Descriptive flexfield segment.
104 * @param p_attribute23 Descriptive flexfield segment.
105 * @param p_attribute24 Descriptive flexfield segment.
106 * @param p_attribute25 Descriptive flexfield segment.
107 * @param p_attribute26 Descriptive flexfield segment.
108 * @param p_attribute27 Descriptive flexfield segment.
109 * @param p_attribute28 Descriptive flexfield segment.
110 * @param p_attribute29 Descriptive flexfield segment.
111 * @param p_attribute30 Descriptive flexfield segment.
112 * @param p_legal_name {@rep:casecolumn PER_ALL_PEOPLE_F.PER_INFORMATION1}
113 * @param p_passport_number {@rep:casecolumn PER_ALL_PEOPLE_F.PER_INFORMATION2}
114 * @param p_passport_country_of_issue {@rep:casecolumn
115 * PER_ALL_PEOPLE_F.PER_INFORMATION3}
116 * @param p_passport_date_issued {@rep:casecolumn
117 * PER_ALL_PEOPLE_F.PER_INFORMATION4}
118 * @param p_passport_expiry_date {@rep:casecolumn
119 * PER_ALL_PEOPLE_F.PER_INFORMATION5}
120 * @param p_permit_type {@rep:casecolumn PER_ALL_PEOPLE_F.PER_INFORMATION6}
121 * @param p_permit_number {@rep:casecolumn PER_ALL_PEOPLE_F.PER_INFORMATION7}
122 * @param p_permit_category {@rep:casecolumn PER_ALL_PEOPLE_F.PER_INFORMATION8}
123 * @param p_permit_date_issued {@rep:casecolumn
124 * PER_ALL_PEOPLE_F.PER_INFORMATION9}
125 * @param p_permit_expiry_date {@rep:casecolumn
126 * PER_ALL_PEOPLE_F.PER_INFORMATION10}
127 * @param p_permit_date_cancelled {@rep:casecolumn
128 * PER_ALL_PEOPLE_F.PER_INFORMATION11}
129 * @param p_income_tax_number {@rep:casecolumn
130 * PER_ALL_PEOPLE_F.PER_INFORMATION12}
131 * @param p_income_tax_number_spouse {@rep:casecolumn
132 * PER_ALL_PEOPLE_F.PER_INFORMATION13}
133 * @param p_cpf_account_number {@rep:casecolumn
134 * PER_ALL_PEOPLE_F.PER_INFORMATION14}
135 * @param p_nric_colour {@rep:casecolumn PER_ALL_PEOPLE_F.PER_INFORMATION15}
136 * @param p_religion {@rep:casecolumn PER_ALL_PEOPLE_F.PER_INFORMATION16}
137 * @param p_cpf_category {@rep:casecolumn PER_ALL_PEOPLE_F.PER_INFORMATION17}
138 * @param p_race {@rep:casecolumn PER_ALL_PEOPLE_F.PER_INFORMATION18}
139 * @param p_community_fund_category {@rep:casecolumn
140 * PER_ALL_PEOPLE_F.PER_INFORMATION19}
141 * @param p_background_check_status Background check status. Valid values are
142 * defined by 'YES_NO' lookup type.
143 * @param p_background_date_check {@rep:casecolumn
144 * PER_ALL_PEOPLE_F.BACKGROUND_DATE_CHECK}
145 * @param p_correspondence_language {@rep:casecolumn
146 * PER_ALL_PEOPLE_F.CORRESPONDENCE_LANGUAGE}
147 * @param p_fte_capacity {@rep:casecolumn PER_ALL_PEOPLE_F.FTE_CAPACITY}
148 * @param p_hold_applicant_date_until {@rep:casecolumn
149 * PER_ALL_PEOPLE_F.HOLD_APPLICANT_DATE_UNTIL}
150 * @param p_honors {@rep:casecolumn PER_ALL_PEOPLE_F.HONORS}
151 * @param p_mailstop {@rep:casecolumn PER_ALL_PEOPLE_F.MAILSTOP}
152 * @param p_office_number {@rep:casecolumn PER_ALL_PEOPLE_F.OFFICE_NUMBER}
153 * @param p_on_military_service Indicates whether the applicant was in the
154 * military service. Valid values as applicable are defined by 'YES_NO' lookup
155 * type.
156 * @param p_pre_name_adjunct {@rep:casecolumn
157 * PER_ALL_PEOPLE_F.PRE_NAME_ADJUNCT}
158 * @param p_projected_start_date {@rep:casecolumn
159 * PER_ALL_PEOPLE_F.PROJECTED_START_DATE}
160 * @param p_resume_exists Indicates whether the Applicant's Resume alreay
161 * exists in the database. Valid values as applicable are defined by 'YES_NO'
162 * lookup type.
163 * @param p_resume_last_updated {@rep:casecolumn
164 * PER_ALL_PEOPLE_F.RESUME_LAST_UPDATED}
165 * @param p_student_status {@rep:casecolumn PER_ALL_PEOPLE_F.STUDENT_STATUS}
166 * @param p_work_schedule Indicates the Applicant's Work schedule. Valid values
167 * are defined by 'WORK_SCHEDULE' lookup type.
168 * @param p_suffix {@rep:casecolumn PER_ALL_PEOPLE_F.SUFFIX}
169 * @param p_date_of_death {@rep:casecolumn PER_ALL_PEOPLE_F.DATE_OF_DEATH}
170 * @param p_benefit_group_id {@rep:casecolumn
171 * PER_ALL_PEOPLE_F.BENEFIT_GROUP_ID}
172 * @param p_receipt_of_death_cert_date {@rep:casecolumn
173 * PER_ALL_PEOPLE_F.RECEIPT_OF_DEATH_CERT_DATE}
174 * @param p_coord_ben_med_pln_no {@rep:casecolumn
175 * PER_ALL_PEOPLE_F.COORD_BEN_MED_PLN_NO}
176 * @param p_coord_ben_no_cvg_flag Indicates whether the Applicant has any
177 * coverage other than the Coordination of benefits. Valid values as applicable
178 * are defined by 'YES_NO' lookup type.
179 * @param p_uses_tobacco_flag Indicates whether the Applicant uses tabacco.
180 * Valid values as applicable are defined by 'YES_NO' lookup type.
181 * @param p_dpdnt_adoption_date {@rep:casecolumn
182 * PER_ALL_PEOPLE_F.DPDNT_ADOPTION_DATE}
183 * @param p_dpdnt_vlntry_svce_flag Indicates whether the applicant was in the
184 * dependent voluntary service. Valid values are defined by 'YES_NO' lookup
185 * type.
186 * @param p_original_date_of_hire {@rep:casecolumn
187 * PER_ALL_PEOPLE_F.ORIGINAL_DATE_OF_HIRE}
188 * @param p_town_of_birth {@rep:casecolumn PER_ALL_PEOPLE_F.TOWN_OF_BIRTH}
189 * @param p_region_of_birth {@rep:casecolumn PER_ALL_PEOPLE_F.REGION_OF_BIRTH}
190 * @param p_country_of_birth {@rep:casecolumn
191 * PER_ALL_PEOPLE_F.COUNTRY_OF_BIRTH}
192 * @param p_global_person_id {@rep:casecolumn
193 * PER_ALL_PEOPLE_F.GLOBAL_PERSON_ID}
194 * @param p_party_id {@rep:casecolumn PER_ALL_PEOPLE_F.PARTY_ID}
195 * @param p_vacancy_id Identifies the vacancy for which the person has applied.
196 * @param p_payee_id_type {@rep:casecolumn PER_ALL_PEOPLE_F.PER_INFORMATION23}
197 * @param p_ee_er_rate {@rep:casecolumn PER_ALL_PEOPLE_F.PER_INFORMATION20}
198 * @param p_mbf {@rep:casecolumn PER_ALL_PEOPLE_F.PER_INFORMATION21}
199 * @param p_mdk {@rep:casecolumn PER_ALL_PEOPLE_F.PER_INFORMATION22}
200 * @param p_person_id If p_validate is false, then this uniquely identifies the
201 * person created. If p_validate is true, then set to null.
202 * @param p_assignment_id If p_validate is false, then this uniquely identifies
203 * the created assignment. If p_validate is true, then set to null.
204 * @param p_application_id If p_validate is FALSE, this uniquely identifies the
205 * application created. If p_validate is true this parameter will be NULL.
206 * @param p_per_object_version_number If p_validate is false, then set to the
207 * version number of the created person. If p_validate is true, then the value
208 * will be null.
209 * @param p_asg_object_version_number If p_validate is false, then set to the
210 * version number of the created assignment. If p_validate is true, then the
211 * value will be null.
212 * @param p_apl_object_version_number If p_validate is false, this will be set
213 * to the version number of the application created. If p_validate is true this
214 * parameter will be set to null.
215 * @param p_per_effective_start_date If p_validate is false, this will be set
216 * to the effective start date of the person. If p_validate is true this will
217 * be null.
218 * @param p_per_effective_end_date If p_validate is false, this will be set to
219 * the effective end date of the person. If p_validate is true this will be
220 * null.
221 * @param p_full_name If p_validate is false, then set to the full name of the
222 * person. If p_validate is true, then set to null.
223 * @param p_per_comment_id If p_validate is false and new or existing comment
224 * text exists, then will be set to the identifier of the applicant comment
225 * record. If p_validate is true or no comment text exists, then will be null.
226 * @param p_assignment_sequence If p_validate is false, this will be set to the
227 * sequence number of the default assignment. If p_validate is true this will
228 * be null.
229 * @param p_name_combination_warning If set to true, then the combination of
230 * last name, first name and date of birth existed prior to calling this API.
231 * @param p_orig_hire_warning If p_validate is false, the original date of hire
232 * is provided and the person type is not
233 * Employee,Employee-Applicant,Ex-Employee or Ex-Employee Applicant, then set
234 * to true.
235 * @rep:displayname Create Applicant for Singapore
236 * @rep:category BUSINESS_ENTITY PER_APPLICANT
237 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
238 * @rep:scope public
239 * @rep:lifecycle active
240 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
241 */
242 --
243 -- {End Of Comments}
244 --
245 PROCEDURE create_sg_applicant
246 (p_validate in boolean default false
247 ,p_date_received in date
248 ,p_business_group_id in number
249 ,p_last_name in varchar2
250 ,p_person_type_id in number default null
251 ,p_applicant_number in out nocopy varchar2
252 ,p_comments in varchar2 default null
253 ,p_date_employee_data_verified in date default null
254 ,p_date_of_birth in date default null
255 ,p_email_address in varchar2 default null
256 ,p_expense_check_send_to_addres in varchar2 default null
257 ,p_first_name in varchar2 default null
258 ,p_known_as in varchar2 default null
259 ,p_marital_status in varchar2 default null
260 ,p_middle_names in varchar2 default null
261 ,p_nationality in varchar2 default null
262 ,p_national_identifier in varchar2 default null
263 ,p_previous_last_name in varchar2 default null
264 ,p_registered_disabled_flag in varchar2 default null
265 ,p_sex in varchar2 default null
266 ,p_title in varchar2 default null
267 ,p_work_telephone in varchar2 default null
268 ,p_attribute_category in varchar2 default null
269 ,p_attribute1 in varchar2 default null
270 ,p_attribute2 in varchar2 default null
271 ,p_attribute3 in varchar2 default null
272 ,p_attribute4 in varchar2 default null
273 ,p_attribute5 in varchar2 default null
274 ,p_attribute6 in varchar2 default null
275 ,p_attribute7 in varchar2 default null
276 ,p_attribute8 in varchar2 default null
280 ,p_attribute12 in varchar2 default null
277 ,p_attribute9 in varchar2 default null
278 ,p_attribute10 in varchar2 default null
279 ,p_attribute11 in varchar2 default null
281 ,p_attribute13 in varchar2 default null
282 ,p_attribute14 in varchar2 default null
283 ,p_attribute15 in varchar2 default null
284 ,p_attribute16 in varchar2 default null
285 ,p_attribute17 in varchar2 default null
286 ,p_attribute18 in varchar2 default null
287 ,p_attribute19 in varchar2 default null
288 ,p_attribute20 in varchar2 default null
289 ,p_attribute21 in varchar2 default null
290 ,p_attribute22 in varchar2 default null
291 ,p_attribute23 in varchar2 default null
292 ,p_attribute24 in varchar2 default null
293 ,p_attribute25 in varchar2 default null
294 ,p_attribute26 in varchar2 default null
295 ,p_attribute27 in varchar2 default null
296 ,p_attribute28 in varchar2 default null
297 ,p_attribute29 in varchar2 default null
298 ,p_attribute30 in varchar2 default null
299 ,p_legal_name in varchar2 default null
300 ,p_passport_number in varchar2 default null
301 ,p_passport_country_of_issue in varchar2 default null
302 ,p_passport_date_issued in date default null
303 ,p_passport_expiry_date in date default null
304 ,p_permit_type in varchar2 default null
305 ,p_permit_number in varchar2 default null
306 ,p_permit_category in varchar2 default null
307 ,p_permit_date_issued in date default null
308 ,p_permit_expiry_date in date default null
309 ,p_permit_date_cancelled in date default null
310 ,p_income_tax_number in varchar2 default null
311 ,p_income_tax_number_spouse in varchar2 default null
312 ,p_cpf_account_number in varchar2 default null
313 ,p_nric_colour in varchar2 default null
314 ,p_religion in varchar2 default null
315 ,p_cpf_category in varchar2 default null
316 ,p_race in varchar2 default null
317 ,p_community_fund_category in varchar2 default null
318 ,p_background_check_status in varchar2 default null
319 ,p_background_date_check in date default null
320 ,p_correspondence_language in varchar2 default null
321 ,p_fte_capacity in number default null
322 ,p_hold_applicant_date_until in date default null
323 ,p_honors in varchar2 default null
324 ,p_mailstop in varchar2 default null
325 ,p_office_number in varchar2 default null
326 ,p_on_military_service in varchar2 default null
327 ,p_pre_name_adjunct in varchar2 default null
328 ,p_projected_start_date in date default null
329 ,p_resume_exists in varchar2 default null
330 ,p_resume_last_updated in date default null
331 ,p_student_status in varchar2 default null
332 ,p_work_schedule in varchar2 default null
333 ,p_suffix in varchar2 default null
334 ,p_date_of_death in date default null
335 ,p_benefit_group_id in number default null
336 ,p_receipt_of_death_cert_date in date default null
337 ,p_coord_ben_med_pln_no in varchar2 default null
338 ,p_coord_ben_no_cvg_flag in varchar2 default 'N'
339 ,p_uses_tobacco_flag in varchar2 default null
340 ,p_dpdnt_adoption_date in date default null
341 ,p_dpdnt_vlntry_svce_flag in varchar2 default 'N'
342 ,p_original_date_of_hire in date default null
343 ,p_town_of_birth in varchar2 default null
344 ,p_region_of_birth in varchar2 default null
345 ,p_country_of_birth in varchar2 default null
346 ,p_global_person_id in varchar2 default null
347 ,p_party_id in number default null/* 6393528 */
348 ,p_vacancy_id in number default null/* 6393528 */
349 ,p_payee_id_type in varchar2 default null
350 ,p_ee_er_rate in varchar2 default null/* 6393528 */
351 ,p_mbf in varchar2 default null/* 6393528,6526444 */
352 ,p_mdk in varchar2 default null/* 6393528,6526444 */
353 ,p_person_id out nocopy number
354 ,p_assignment_id out nocopy number
355 ,p_application_id out nocopy number
356 ,p_per_object_version_number out nocopy number
357 ,p_asg_object_version_number out nocopy number
358 ,p_apl_object_version_number out nocopy number
359 ,p_per_effective_start_date out nocopy date
360 ,p_per_effective_end_date out nocopy date
361 ,p_full_name out nocopy varchar2
362 ,p_per_comment_id out nocopy number
363 ,p_assignment_sequence out nocopy number
364 ,p_name_combination_warning out nocopy boolean
365 ,p_orig_hire_warning out nocopy boolean);
366
367 end hr_sg_applicant_api;
[Home] [Help]