1 PACKAGE hr_hk_applicant_api AS
2 /* $Header: hrhkwraa.pkh 120.1 2005/10/02 02:02:07 aroussel $ */
3 /*#
4 * This package contains applicant related APIs for Hong Kong.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Applicant for Hong Kong
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |---------------------------< create_hk_applicant >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This procedure creates a new applicant for Hong Kong.
17 *
18 * This API creates a new Hong Kong applicant, including a DEFAULT primary
19 * assignment and an application for the applicant. The API calls the generic
20 * API create_applicant, with the parameters set as appropriate for a Hong Kong
21 * applicant. As this API is effectively an alternative to the API
22 * create_applicant, see that API for further explanation.
23 *
24 * <p><b>Licensing</b><br>
25 * This API is licensed for use with Human Resources.
26 *
27 * <p><b>Prerequisites</b><br>
28 * A business group for Hong Kong legislation must be specified.
29 *
30 * <p><b>Post Success</b><br>
31 * The API successfully inserts a person, primary assignment and application in
32 * the database.
33 *
34 * <p><b>Post Failure</b><br>
35 * The API does not create the applicant, DEFAULT assignment or application and
36 * raises an error.
37 * @param p_validate If true, then validation alone will be performed and the
38 * database will remain unchanged. If false and all validation checks pass,
39 * then the database will be modified.
40 * @param p_date_received Indicates the applicant hire DATE and thus the
41 * effective start DATE of the person, primary assignment and application.
42 * @param p_business_group_id {@rep:casecolumn
43 * PER_ALL_PEOPLE_F.BUSINESS_GROUP_ID}
44 * @param p_last_name {@rep:casecolumn PER_ALL_PEOPLE_F.LAST_NAME}
45 * @param p_sex Applicant's Legal gender. Valid values are defined by 'SEX'
46 * lookup type.
47 * @param p_person_type_id {@rep:casecolumn PER_ALL_PEOPLE_F.PERSON_TYPE_ID}
48 * @param p_applicant_number If the number generation method is Manual, then
49 * this parameter is mandatory. If the number generation method is Automatic,
50 * then the value of this parameter must be NULL. When the API completes, if
51 * p_validate is false and the applicant number generation method is Automatic,
52 * then set the applicant number to the generated applicant number of the
53 * person created. If p_validate is false and the applicant number generation
54 * method is manual or if p_validate is true, then set the applicant number to
55 * the same value that was passed.
56 * @param p_comments Comment text.
57 * @param p_date_employee_data_verified {@rep:casecolumn
58 * PER_ALL_PEOPLE_F.DATE_EMPLOYEE_DATA_VERIFIED}
59 * @param p_date_of_birth {@rep:casecolumn PER_ALL_PEOPLE_F.DATE_OF_BIRTH}
60 * @param p_email_address {@rep:casecolumn PER_ALL_PEOPLE_F.EMAIL_ADDRESS}
61 * @param p_expense_check_send_to_addres Indicates the Applicant's Address to
62 * which the expense should be sent. Valid values are determined by
63 * 'HOME_OFFICE' lookup type.
64 * @param p_first_name {@rep:casecolumn PER_ALL_PEOPLE_F.FIRST_NAME}
65 * @param p_known_as {@rep:casecolumn PER_ALL_PEOPLE_F.KNOWN_AS}
66 * @param p_marital_status Indicates the Applicant's Marital status. Valid
67 * values are defined by 'MAR_STATUS' lookup type.
68 * @param p_middle_names {@rep:casecolumn PER_ALL_PEOPLE_F.MIDDLE_NAMES}
69 * @param p_nationality Indicates the Applicant' s Nationality. Valid values
70 * are defined by 'NATIONALITY' lookup type.
71 * @param p_hkid_number {@rep:casecolumn PER_ALL_PEOPLE_F.NATIONAL_IDENTIFIER}
72 * @param p_previous_last_name {@rep:casecolumn
73 * PER_ALL_PEOPLE_F.PREVIOUS_LAST_NAME}
74 * @param p_registered_disabled_flag Indicates whether an Applicant is
75 * classified as disabled. Valid values are defined by 'REGISTERED_DISABLED'
76 * lookup type.
77 * @param p_title Applicant's Title e.g. Mr, Mrs, Dr. Valid values are defined
78 * by 'TITLE' 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_passport_number Applicant's Passport Number.
113 * @param p_country_of_issue Country where Passport was issued.
114 * @param p_work_permit_number Applicant's Work Permit Number.
115 * @param p_work_permit_expiry_date Date Work Permit expires.
116 * @param p_chinese_name Applicant's Name in Chinese
117 * @param p_hk_full_name Applicant's Full Name from Hong Kong ID Card or
118 * Passport.
119 * @param p_previous_employer_name Name of Previous Employer.
120 * @param p_previous_employer_address Address of Previous Employer.
121 * @param p_employee_tax_file_number Applicant's Tax File Number
122 * @param p_background_check_status Applicant's Background check status,valid
123 * values as applicable are defined by 'YES_NO' lookup type.
124 * @param p_background_date_check {@rep:casecolumn
125 * PER_ALL_PEOPLE_F.BACKGROUND_DATE_CHECK}
126 * @param p_correspondence_language {@rep:casecolumn
127 * PER_ALL_PEOPLE_F.CORRESPONDENCE_LANGUAGE}
128 * @param p_fte_capacity {@rep:casecolumn PER_ALL_PEOPLE_F.FTE_CAPACITY}
129 * @param p_hold_applicant_date_until {@rep:casecolumn
130 * PER_ALL_PEOPLE_F.HOLD_APPLICANT_DATE_UNTIL}
131 * @param p_honors {@rep:casecolumn PER_ALL_PEOPLE_F.HONORS}
132 * @param p_mailstop {@rep:casecolumn PER_ALL_PEOPLE_F.MAILSTOP}
133 * @param p_office_number {@rep:casecolumn PER_ALL_PEOPLE_F.OFFICE_NUMBER}
134 * @param p_on_military_service Indicates whether the applicant was in the
135 * military service. Valid values as applicable are defined by 'YES_NO' lookup
136 * type.
137 * @param p_pre_name_adjunct {@rep:casecolumn
138 * PER_ALL_PEOPLE_F.PRE_NAME_ADJUNCT}
139 * @param p_projected_start_date {@rep:casecolumn
140 * PER_ALL_PEOPLE_F.PROJECTED_START_DATE}
141 * @param p_resume_exists Indicates whether the Applicant's Resume alreay
142 * exists in the database. Valid values as applicable are defined by 'YES_NO'
143 * lookup type.
144 * @param p_resume_last_updated {@rep:casecolumn
145 * PER_ALL_PEOPLE_F.RESUME_LAST_UPDATED}
146 * @param p_student_status Student Status. Valid values are defined by the
147 * 'STUDENT_STATUS' lookup type.
148 * @param p_work_schedule Indicates the Applicant's Work schedule. Valid values
149 * are defined by 'WORK_SCHEDULE' lookup type.
150 * @param p_suffix {@rep:casecolumn PER_ALL_PEOPLE_F.SUFFIX}
151 * @param p_date_of_death {@rep:casecolumn PER_ALL_PEOPLE_F.DATE_OF_DEATH}
152 * @param p_benefit_group_id {@rep:casecolumn
153 * PER_ALL_PEOPLE_F.BENEFIT_GROUP_ID}
154 * @param p_receipt_of_death_cert_date {@rep:casecolumn
155 * PER_ALL_PEOPLE_F.RECEIPT_OF_DEATH_CERT_DATE}
156 * @param p_coord_ben_med_pln_no {@rep:casecolumn
157 * PER_ALL_PEOPLE_F.COORD_BEN_MED_PLN_NO}
158 * @param p_coord_ben_no_cvg_flag Indicates whether the Applicant has any
159 * coverage other than the Coordination of benefits. Valid values as applicable
160 * are defined by 'YES_NO' lookup type.
161 * @param p_uses_tobacco_flag Indicates whether the Applicant uses tabacco.
162 * Valid values as applicable are defined by 'YES_NO' lookup type.
163 * @param p_dpdnt_adoption_date {@rep:casecolumn
164 * PER_ALL_PEOPLE_F.DPDNT_ADOPTION_DATE}
165 * @param p_dpdnt_vlntry_svce_flag Indicates whether the applicant was in the
166 * dependent voluntary service. Valid values are defined by 'YES_NO' lookup
167 * type.
168 * @param p_original_date_of_hire {@rep:casecolumn
169 * PER_ALL_PEOPLE_F.ORIGINAL_DATE_OF_HIRE}
170 * @param p_person_id If p_validate is false, then this uniquely identifies the
171 * person created. If p_validate is true, then set to null.
172 * @param p_assignment_id If p_validate is false, then this uniquely identifies
173 * the created assignment. If p_validate is true, then set to null.
174 * @param p_application_id If p_validate is false, this uniquely identifies the
175 * application created. If p_validate is true this parameter will be null.
176 * @param p_per_object_version_number If p_validate is false, then set to the
177 * version number of the created person. If p_validate is true, then the value
178 * will be null.
179 * @param p_asg_object_version_number If p_validate is false, then this
180 * parameter is set to the version number of the assignment created. If
181 * p_validate is true, then this parameter is null.
182 * @param p_apl_object_version_number If p_validate is false, this will be set
183 * to the version number of the application created. If p_validate is true this
184 * parameter will be set to null.
185 * @param p_per_effective_start_date If p_validate is false, this will be set
186 * to the effective start date of the person. If p_validate is true this will
187 * be null.
188 * @param p_per_effective_end_date If p_validate is false, this will be set to
189 * the effective end date of the person. If p_validate is true this will be
190 * null.
191 * @param p_full_name If p_validate is false, then set to the full name of the
192 * person. If p_validate is true, then set to null.
193 * @param p_per_comment_id If p_validate is false and new or existing comment
194 * text exists, then will be set to the identifier of the applicant comment
195 * record. If p_validate is true or no comment text exists, then will be null.
196 * @param p_assignment_sequence If p_validate is false, this will be set to the
197 * sequence number of the default assignment. If p_validate is true this will
198 * be null.
199 * @param p_name_combination_warning If set to true, then the combination of
200 * last name, first name and date of birth existed prior to calling this API.
201 * @param p_orig_hire_warning If p_validate is false, the original date of hire
202 * is provided and the person type is not
203 * Employee,Employee-Applicant,Ex-Employee or Ex-Employee Applicant, then set
204 * to true.
205 * @rep:displayname Create Applicant for Hong Kong
206 * @rep:category BUSINESS_ENTITY PER_APPLICANT
207 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
208 * @rep:scope public
209 * @rep:lifecycle active
210 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
211 */
212 --
213 -- {End Of Comments}
214 --
215 PROCEDURE create_hk_applicant
216 (p_validate IN BOOLEAN DEFAULT FALSE
217 ,p_date_received IN DATE
218 ,p_business_group_id IN NUMBER
219 ,p_last_name IN VARCHAR2
220 ,p_sex IN VARCHAR2 DEFAULT NULL
221 ,p_person_type_id IN NUMBER DEFAULT NULL
222 ,p_applicant_number IN OUT NOCOPY VARCHAR2
223 ,p_comments IN VARCHAR2 DEFAULT NULL
224 ,p_date_employee_data_verified IN DATE DEFAULT NULL
225 ,p_date_of_birth IN DATE DEFAULT NULL
226 ,p_email_address IN VARCHAR2 DEFAULT NULL
227 ,p_expense_check_send_to_addres IN VARCHAR2 DEFAULT NULL
228 ,p_first_name IN VARCHAR2 DEFAULT NULL
229 ,p_known_as IN VARCHAR2 DEFAULT NULL
230 ,p_marital_status IN VARCHAR2 DEFAULT NULL
231 ,p_middle_names IN VARCHAR2 DEFAULT NULL
232 ,p_nationality IN VARCHAR2 DEFAULT NULL
233 ,p_hkid_number IN VARCHAR2 DEFAULT NULL
234 ,p_previous_last_name IN VARCHAR2 DEFAULT NULL
235 ,p_registered_disabled_flag IN VARCHAR2 DEFAULT NULL
236 ,p_title IN VARCHAR2 DEFAULT NULL
237 ,p_work_telephone IN VARCHAR2 DEFAULT NULL
238 ,p_attribute_category IN VARCHAR2 DEFAULT NULL
239 ,p_attribute1 IN VARCHAR2 DEFAULT NULL
240 ,p_attribute2 IN VARCHAR2 DEFAULT NULL
241 ,p_attribute3 IN VARCHAR2 DEFAULT NULL
242 ,p_attribute4 IN VARCHAR2 DEFAULT NULL
243 ,p_attribute5 IN VARCHAR2 DEFAULT NULL
244 ,p_attribute6 IN VARCHAR2 DEFAULT NULL
245 ,p_attribute7 IN VARCHAR2 DEFAULT NULL
246 ,p_attribute8 IN VARCHAR2 DEFAULT NULL
247 ,p_attribute9 IN VARCHAR2 DEFAULT NULL
248 ,p_attribute10 IN VARCHAR2 DEFAULT NULL
249 ,p_attribute11 IN VARCHAR2 DEFAULT NULL
250 ,p_attribute12 IN VARCHAR2 DEFAULT NULL
251 ,p_attribute13 IN VARCHAR2 DEFAULT NULL
252 ,p_attribute14 IN VARCHAR2 DEFAULT NULL
253 ,p_attribute15 IN VARCHAR2 DEFAULT NULL
254 ,p_attribute16 IN VARCHAR2 DEFAULT NULL
255 ,p_attribute17 IN VARCHAR2 DEFAULT NULL
256 ,p_attribute18 IN VARCHAR2 DEFAULT NULL
257 ,p_attribute19 IN VARCHAR2 DEFAULT NULL
258 ,p_attribute20 IN VARCHAR2 DEFAULT NULL
259 ,p_attribute21 IN VARCHAR2 DEFAULT NULL
260 ,p_attribute22 IN VARCHAR2 DEFAULT NULL
261 ,p_attribute23 IN VARCHAR2 DEFAULT NULL
262 ,p_attribute24 IN VARCHAR2 DEFAULT NULL
263 ,p_attribute25 IN VARCHAR2 DEFAULT NULL
264 ,p_attribute26 IN VARCHAR2 DEFAULT NULL
265 ,p_attribute27 IN VARCHAR2 DEFAULT NULL
266 ,p_attribute28 IN VARCHAR2 DEFAULT NULL
267 ,p_attribute29 IN VARCHAR2 DEFAULT NULL
268 ,p_attribute30 IN VARCHAR2 DEFAULT NULL
269 ,p_passport_number IN VARCHAR2 DEFAULT NULL
270 ,p_country_of_issue IN VARCHAR2 DEFAULT NULL
271 ,p_work_permit_number IN VARCHAR2 DEFAULT NULL
272 ,p_work_permit_expiry_date IN VARCHAR2 DEFAULT NULL
273 ,p_chinese_name IN VARCHAR2 DEFAULT NULL
274 ,p_hk_full_name IN VARCHAR2
275 ,p_previous_employer_name IN VARCHAR2 DEFAULT NULL
276 ,p_previous_employer_address IN VARCHAR2 DEFAULT NULL
277 ,p_employee_tax_file_number IN VARCHAR2 DEFAULT NULL
278 ,p_background_check_status IN VARCHAR2 DEFAULT NULL
279 ,p_background_date_check IN DATE DEFAULT NULL
280 ,p_correspondence_language IN VARCHAR2 DEFAULT NULL
281 ,p_fte_capacity IN NUMBER DEFAULT NULL
282 ,p_hold_applicant_date_until IN DATE DEFAULT NULL
283 ,p_honors IN VARCHAR2 DEFAULT NULL
284 ,p_mailstop IN VARCHAR2 DEFAULT NULL
285 ,p_office_number IN VARCHAR2 DEFAULT NULL
286 ,p_on_military_service IN VARCHAR2 DEFAULT NULL
287 ,p_pre_name_adjunct IN VARCHAR2 DEFAULT NULL
288 ,p_projected_start_date IN DATE DEFAULT NULL
289 ,p_resume_exists IN VARCHAR2 DEFAULT NULL
290 ,p_resume_last_updated IN DATE DEFAULT NULL
294 ,p_date_of_death IN DATE DEFAULT NULL
291 ,p_student_status IN VARCHAR2 DEFAULT NULL
292 ,p_work_schedule IN VARCHAR2 DEFAULT NULL
293 ,p_suffix IN VARCHAR2 DEFAULT NULL
295 ,p_benefit_group_id IN NUMBER DEFAULT NULL
296 ,p_receipt_of_death_cert_date IN DATE DEFAULT NULL
297 ,p_coord_ben_med_pln_no IN VARCHAR2 DEFAULT NULL
298 ,p_coord_ben_no_cvg_flag IN VARCHAR2 DEFAULT 'N'
299 ,p_uses_tobacco_flag IN VARCHAR2 DEFAULT NULL
300 ,p_dpdnt_adoption_date IN DATE DEFAULT NULL
301 ,p_dpdnt_vlntry_svce_flag IN VARCHAR2 DEFAULT 'N'
302 ,p_original_date_of_hire IN DATE DEFAULT NULL
303 ,p_person_id OUT NOCOPY NUMBER
304 ,p_assignment_id OUT NOCOPY NUMBER
305 ,p_application_id OUT NOCOPY NUMBER
306 ,p_per_object_version_number OUT NOCOPY NUMBER
307 ,p_asg_object_version_number OUT NOCOPY NUMBER
308 ,p_apl_object_version_number OUT NOCOPY NUMBER
309 ,p_per_effective_start_date OUT NOCOPY DATE
310 ,p_per_effective_end_date OUT NOCOPY DATE
311 ,p_full_name OUT NOCOPY VARCHAR2
312 ,p_per_comment_id OUT NOCOPY NUMBER
313 ,p_assignment_sequence OUT NOCOPY NUMBER
314 ,p_name_combination_warning OUT NOCOPY BOOLEAN
315 ,p_orig_hire_warning OUT NOCOPY BOOLEAN
316 );
317
318 END hr_hk_applicant_api;
[Home] [Help]