1 PACKAGE hr_nz_applicant_api AS
2 /* $Header: hrnzwrap.pkh 120.4 2005/10/31 03:18:52 rpalli noship $ */
3 /*#
4 * This package contains applicant related APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Applicant for New Zealand
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |---------------------------< create_nz_applicant >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This procedure creates a new applicant for New Zealand.
17 *
18 * This API calls the generic create_applicant API, with the parameters set as
19 * appropriate for New Zealand 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 * A business group for New Zealand 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 an 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 Identifies the applicant's business group.
42 * @param p_last_name {@rep:casecolumn PER_ALL_PEOPLE_F.LAST_NAME}
43 * @param p_sex Applicant's Legal gender. Valid values are defined by 'SEX'
44 * lookup type.
45 * @param p_person_type_id Identifies the person type id.If a person_type_id is
46 * not specified, then the API will use the default 'APL' type for the business group.
47 * @param p_applicant_number If the number generation method is Manual, then
48 * this parameter is mandatory. If the number generation method is Automatic,
49 * then the value of this parameter must be NULL. When the API completes, if
50 * p_validate is false and the applicant number generation method is Automatic,
51 * then set the applicant number to the generated applicant number of the
52 * person created. If p_validate is false and the applicant number generation
53 * method is manual or if p_validate is true, then set the applicant number to
54 * the same value that was passed.
55 * @param p_comments Comment text.
56 * @param p_date_employee_data_verified {@rep:casecolumn
57 * PER_ALL_PEOPLE_F.DATE_EMPLOYEE_DATA_VERIFIED}
58 * @param p_date_of_birth {@rep:casecolumn PER_ALL_PEOPLE_F.DATE_OF_BIRTH}
59 * @param p_email_address {@rep:casecolumn PER_ALL_PEOPLE_F.EMAIL_ADDRESS}
60 * @param p_expense_check_send_to_addres Indicates the Applicant's Address to
61 * which the expense should be sent. Valid values are determined by
62 * 'HOME_OFFICE' lookup type.
63 * @param p_first_name {@rep:casecolumn PER_ALL_PEOPLE_F.FIRST_NAME}
64 * @param p_known_as {@rep:casecolumn PER_ALL_PEOPLE_F.KNOWN_AS}
65 * @param p_marital_status Indicates the Applicant's Marital status. Valid
66 * values are defined by 'MAR_STATUS' lookup type.
67 * @param p_middle_names {@rep:casecolumn PER_ALL_PEOPLE_F.MIDDLE_NAMES}
68 * @param p_nationality Indicates the Applicant' s Nationality. Valid values
69 * are defined by 'NATIONALITY' lookup type.
70 * @param p_ird_number {@rep:casecolumn PER_ALL_PEOPLE_F.NATIONAL_IDENTIFIER}
71 * @param p_previous_last_name {@rep:casecolumn
72 * PER_ALL_PEOPLE_F.PREVIOUS_LAST_NAME}
73 * @param p_registered_disabled_flag Indicates whether an Applicant is
74 * classified as disabled. Valid values are defined by 'REGISTERED_DISABLED'
75 * lookup type.
76 * @param p_title Applicant's Title e.g. Mr, Mrs, Dr. Valid values are defined
77 * by 'TITLE' lookup type.
78 * @param p_work_telephone {@rep:casecolumn PER_ALL_PEOPLE_F.WORK_TELEPHONE}
79 * @param p_attribute_category This context value determines which flexfield
80 * structure to use with the descriptive flexfield segments.
81 * @param p_attribute1 Descriptive flexfield segment.
82 * @param p_attribute2 Descriptive flexfield segment.
83 * @param p_attribute3 Descriptive flexfield segment.
84 * @param p_attribute4 Descriptive flexfield segment.
85 * @param p_attribute5 Descriptive flexfield segment.
86 * @param p_attribute6 Descriptive flexfield segment.
87 * @param p_attribute7 Descriptive flexfield segment.
88 * @param p_attribute8 Descriptive flexfield segment.
89 * @param p_attribute9 Descriptive flexfield segment.
90 * @param p_attribute10 Descriptive flexfield segment.
91 * @param p_attribute11 Descriptive flexfield segment.
92 * @param p_attribute12 Descriptive flexfield segment.
93 * @param p_attribute13 Descriptive flexfield segment.
94 * @param p_attribute14 Descriptive flexfield segment.
95 * @param p_attribute15 Descriptive flexfield segment.
96 * @param p_attribute16 Descriptive flexfield segment.
97 * @param p_attribute17 Descriptive flexfield segment.
98 * @param p_attribute18 Descriptive flexfield segment.
99 * @param p_attribute19 Descriptive flexfield segment.
100 * @param p_attribute20 Descriptive flexfield segment.
101 * @param p_attribute21 Descriptive flexfield segment.
102 * @param p_attribute22 Descriptive flexfield segment.
103 * @param p_attribute23 Descriptive flexfield segment.
104 * @param p_attribute24 Descriptive flexfield segment.
105 * @param p_attribute25 Descriptive flexfield segment.
106 * @param p_attribute26 Descriptive flexfield segment.
107 * @param p_attribute27 Descriptive flexfield segment.
108 * @param p_attribute28 Descriptive flexfield segment.
109 * @param p_attribute29 Descriptive flexfield segment.
110 * @param p_attribute30 Descriptive flexfield segment.
111 * @param p_country_born Indicates the country of birth of applicant. Valid
112 * values are defined by the view FND_TERRITORIES_VL
113 * @param p_work_permit_number {@rep:casecolumn
114 * PER_ALL_PEOPLE_F.PER_INFORMATION2}
115 * @param p_work_permit_expiry_date {@rep:casecolumn
116 * PER_ALL_PEOPLE_F.PER_INFORMATION3}
117 * @param p_ethnic_origin {@rep:casecolumn PER_ALL_PEOPLE_F.PER_INFORMATION4}
118 * @param p_tribal_group {@rep:casecolumn PER_ALL_PEOPLE_F.PER_INFORMATION5}
119 * @param p_district_of_origin {@rep:casecolumn
120 * PER_ALL_PEOPLE_F.PER_INFORMATION6}
121 * @param p_employment_category {@rep:casecolumn
122 * PER_ALL_PEOPLE_F.PER_INFORMATION7}
123 * @param p_working_time {@rep:casecolumn PER_ALL_PEOPLE_F.PER_INFORMATION8}
124 * @param p_background_check_status Applicant's Background check status,valid
125 * values as applicable are defined by 'YES_NO' lookup type.
126 * @param p_background_date_check {@rep:casecolumn
127 * PER_ALL_PEOPLE_F.BACKGROUND_DATE_CHECK}
128 * @param p_correspondence_language {@rep:casecolumn
129 * PER_ALL_PEOPLE_F.CORRESPONDENCE_LANGUAGE}
130 * @param p_fte_capacity {@rep:casecolumn PER_ALL_PEOPLE_F.FTE_CAPACITY}
131 * @param p_hold_applicant_date_until {@rep:casecolumn
132 * PER_ALL_PEOPLE_F.HOLD_APPLICANT_DATE_UNTIL}
133 * @param p_honors {@rep:casecolumn PER_ALL_PEOPLE_F.HONORS}
134 * @param p_mailstop {@rep:casecolumn PER_ALL_PEOPLE_F.MAILSTOP}
135 * @param p_office_number {@rep:casecolumn PER_ALL_PEOPLE_F.OFFICE_NUMBER}
136 * @param p_on_military_service Indicates whether the applicant was in the
137 * military service. Valid values as applicable are defined by 'YES_NO' lookup
138 * type.
139 * @param p_pre_name_adjunct {@rep:casecolumn
140 * PER_ALL_PEOPLE_F.PRE_NAME_ADJUNCT}
141 * @param p_projected_start_date {@rep:casecolumn
142 * PER_ALL_PEOPLE_F.PROJECTED_START_DATE}
143 * @param p_resume_exists Indicates whether the Applicant's Resume alreay
144 * exists in the database. Valid values as applicable are defined by 'YES_NO'
145 * lookup type.
146 * @param p_resume_last_updated {@rep:casecolumn
147 * PER_ALL_PEOPLE_F.RESUME_LAST_UPDATED}
148 * @param p_student_status Indicates the student status of the applicant. Valid
149 * values as applicable are defined by 'STUDENT_STATUS' lookup type.
150 * @param p_work_schedule Indicates the Applicant's Work schedule. Valid values
151 * are defined by 'WORK_SCHEDULE' lookup type.
152 * @param p_suffix {@rep:casecolumn PER_ALL_PEOPLE_F.SUFFIX}
153 * @param p_date_of_death {@rep:casecolumn PER_ALL_PEOPLE_F.DATE_OF_DEATH}
154 * @param p_benefit_group_id Identifies the applicant's benefit group.
155 * @param p_receipt_of_death_cert_date {@rep:casecolumn
156 * PER_ALL_PEOPLE_F.RECEIPT_OF_DEATH_CERT_DATE}
157 * @param p_coord_ben_med_pln_no {@rep:casecolumn
158 * PER_ALL_PEOPLE_F.COORD_BEN_MED_PLN_NO}
159 * @param p_coord_ben_no_cvg_flag Indicates whether the Applicant has any
160 * coverage other than the Coordination of benefits. Valid values as applicable
161 * are defined by 'YES_NO' lookup type.
162 * @param p_uses_tobacco_flag Indicates whether the Applicant uses tabacco.
163 * Valid values as applicable are defined by 'YES_NO' lookup type.
164 * @param p_dpdnt_adoption_date {@rep:casecolumn
165 * PER_ALL_PEOPLE_F.DPDNT_ADOPTION_DATE}
166 * @param p_dpdnt_vlntry_svce_flag Indicates whether the applicant was in the
167 * dependent voluntary service. Valid values are defined by 'YES_NO' lookup
168 * type.
169 * @param p_original_date_of_hire {@rep:casecolumn
170 * PER_ALL_PEOPLE_F.ORIGINAL_DATE_OF_HIRE}
171 * @param p_town_of_birth Town or city of birth.
172 * @param p_region_of_birth Geographical region of birth.
173 * @param p_country_of_birth Country of birth.
174 * @param p_global_person_id Global ID for the person.
175 * @param p_party_id TCA party for whom you create the person record.
176 * @param p_vacancy_id Vacancy_id for which this applicant is applying for.
177 * @param p_person_id If p_validate is false, then this uniquely identifies the
178 * person created. If p_validate is true, then set to null.
179 * @param p_assignment_id If p_validate is false, then this uniquely identifies
180 * the created assignment. If p_validate is true, then set to null.
181 * @param p_application_id If p_validate is FALSE, this uniquely identifies the
182 * application created. If p_validate is true this parameter will be NULL.
183 * @param p_per_object_version_number If p_validate is false, then set to the
184 * version number of the created person. If p_validate is true, then the value
185 * will be null.
186 * @param p_asg_object_version_number If p_validate is false, then set to the
187 * version number of the created assignment. If p_validate is true, then the
188 * value will be null.
189 * @param p_apl_object_version_number If p_validate is false, this will be set
190 * to the version number of the application created. If p_validate is true this
191 * parameter will be set to null.
192 * @param p_per_effective_start_date If p_validate is false, this will be set
193 * to the effective start date of the person. If p_validate is true this will
194 * be null.
195 * @param p_per_effective_end_date If p_validate is false, this will be set to
196 * the effective end date of the person. If p_validate is true this will be
197 * null.
198 * @param p_full_name If p_validate is false, then set to the full name of the
199 * person. If p_validate is true, then set to null.
200 * @param p_per_comment_id If p_validate is false and new or existing comment
201 * text exists, then will be set to the identifier of the applicant comment
202 * record. If p_validate is true or no comment text exists, then will be null.
203 * @param p_assignment_sequence If p_validate is false, this will be set to the
204 * sequence number of the default assignment. If p_validate is true this will
205 * be null.
206 * @param p_name_combination_warning If set to true, then the combination of
207 * last name, first name and date of birth existed prior to calling this API.
208 * @param p_orig_hire_warning Set to true, if the original date of hire is
209 * provided and the person type is not Employee,Employee-Applicant,Ex-Employee
210 * or Ex-Employee Applicant.
211 * @rep:displayname Create Applicant for New Zealand
212 * @rep:category BUSINESS_ENTITY PER_APPLICANT
213 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
214 * @rep:scope public
215 * @rep:lifecycle active
216 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
217 */
218 --
219 -- {End Of Comments}
220 --
221
222 PROCEDURE create_nz_applicant
223 (p_validate IN BOOLEAN DEFAULT FALSE
224 ,p_date_received IN DATE
225 ,p_business_group_id IN NUMBER
226 ,p_last_name IN VARCHAR2
227 ,p_sex IN VARCHAR2 DEFAULT NULL
228 ,p_person_type_id IN NUMBER DEFAULT NULL
229 ,p_applicant_number IN OUT NOCOPY VARCHAR2
230 ,p_comments IN VARCHAR2 DEFAULT NULL
231 ,p_date_employee_data_verified IN DATE DEFAULT NULL
232 ,p_date_of_birth IN DATE DEFAULT NULL
233 ,p_email_address IN VARCHAR2 DEFAULT NULL
234 ,p_expense_check_send_to_addres IN VARCHAR2 DEFAULT NULL
235 ,p_first_name IN VARCHAR2 DEFAULT NULL
236 ,p_known_as IN VARCHAR2 DEFAULT NULL
237 ,p_marital_status IN VARCHAR2 DEFAULT NULL
238 ,p_middle_names IN VARCHAR2 DEFAULT NULL
239 ,p_nationality IN VARCHAR2 DEFAULT NULL
240 ,p_ird_number IN VARCHAR2 DEFAULT NULL
241 ,p_previous_last_name IN VARCHAR2 DEFAULT NULL
242 ,p_registered_disabled_flag IN VARCHAR2 DEFAULT NULL
243 ,p_title IN VARCHAR2 DEFAULT NULL
244 ,p_work_telephone IN VARCHAR2 DEFAULT NULL
245 ,p_attribute_category IN VARCHAR2 DEFAULT NULL
246 ,p_attribute1 IN VARCHAR2 DEFAULT NULL
247 ,p_attribute2 IN VARCHAR2 DEFAULT NULL
248 ,p_attribute3 IN VARCHAR2 DEFAULT NULL
249 ,p_attribute4 IN VARCHAR2 DEFAULT NULL
250 ,p_attribute5 IN VARCHAR2 DEFAULT NULL
251 ,p_attribute6 IN VARCHAR2 DEFAULT NULL
252 ,p_attribute7 IN VARCHAR2 DEFAULT NULL
253 ,p_attribute8 IN VARCHAR2 DEFAULT NULL
254 ,p_attribute9 IN VARCHAR2 DEFAULT NULL
255 ,p_attribute10 IN VARCHAR2 DEFAULT NULL
256 ,p_attribute11 IN VARCHAR2 DEFAULT NULL
257 ,p_attribute12 IN VARCHAR2 DEFAULT NULL
258 ,p_attribute13 IN VARCHAR2 DEFAULT NULL
259 ,p_attribute14 IN VARCHAR2 DEFAULT NULL
260 ,p_attribute15 IN VARCHAR2 DEFAULT NULL
261 ,p_attribute16 IN VARCHAR2 DEFAULT NULL
262 ,p_attribute17 IN VARCHAR2 DEFAULT NULL
263 ,p_attribute18 IN VARCHAR2 DEFAULT NULL
264 ,p_attribute19 IN VARCHAR2 DEFAULT NULL
265 ,p_attribute20 IN VARCHAR2 DEFAULT NULL
266 ,p_attribute21 IN VARCHAR2 DEFAULT NULL
267 ,p_attribute22 IN VARCHAR2 DEFAULT NULL
268 ,p_attribute23 IN VARCHAR2 DEFAULT NULL
269 ,p_attribute24 IN VARCHAR2 DEFAULT NULL
270 ,p_attribute25 IN VARCHAR2 DEFAULT NULL
271 ,p_attribute26 IN VARCHAR2 DEFAULT NULL
272 ,p_attribute27 IN VARCHAR2 DEFAULT NULL
273 ,p_attribute28 IN VARCHAR2 DEFAULT NULL
274 ,p_attribute29 IN VARCHAR2 DEFAULT NULL
275 ,p_attribute30 IN VARCHAR2 DEFAULT NULL
276 ,p_country_born IN VARCHAR2 DEFAULT NULL
277 ,p_work_permit_number IN VARCHAR2 DEFAULT NULL
278 ,p_work_permit_expiry_date IN VARCHAR2 DEFAULT NULL
279 ,p_ethnic_origin IN VARCHAR2 DEFAULT NULL
280 ,p_tribal_group IN VARCHAR2 DEFAULT NULL
281 ,p_district_of_origin IN VARCHAR2 DEFAULT NULL
282 ,p_employment_category IN VARCHAR2 DEFAULT NULL
283 ,p_working_time IN VARCHAR2 DEFAULT NULL
284 ,p_background_check_status IN VARCHAR2 DEFAULT NULL
285 ,p_background_date_check IN DATE DEFAULT NULL
286 ,p_correspondence_language IN VARCHAR2 DEFAULT NULL
287 ,p_fte_capacity IN NUMBER DEFAULT NULL
288 ,p_hold_applicant_date_until IN DATE DEFAULT NULL
289 ,p_honors IN VARCHAR2 DEFAULT NULL
290 ,p_mailstop IN VARCHAR2 DEFAULT NULL
291 ,p_office_number IN VARCHAR2 DEFAULT NULL
292 ,p_on_military_service IN VARCHAR2 DEFAULT NULL
293 ,p_pre_name_adjunct IN VARCHAR2 DEFAULT NULL
294 ,p_projected_start_date IN DATE DEFAULT NULL
295 ,p_resume_exists IN VARCHAR2 DEFAULT NULL
296 ,p_resume_last_updated IN DATE DEFAULT NULL
297 ,p_student_status IN VARCHAR2 DEFAULT NULL
298 ,p_work_schedule IN VARCHAR2 DEFAULT NULL
299 ,p_suffix IN VARCHAR2 DEFAULT NULL
300 ,p_date_of_death IN DATE DEFAULT NULL
301 ,p_benefit_group_id IN NUMBER DEFAULT NULL
302 ,p_receipt_of_death_cert_date IN DATE DEFAULT NULL
303 ,p_coord_ben_med_pln_no IN VARCHAR2 DEFAULT NULL
304 ,p_coord_ben_no_cvg_flag IN VARCHAR2 DEFAULT 'N'
305 ,p_uses_tobacco_flag IN VARCHAR2 DEFAULT NULL
306 ,p_dpdnt_adoption_date IN DATE DEFAULT NULL
307 ,p_dpdnt_vlntry_svce_flag IN VARCHAR2 DEFAULT 'N'
308 ,p_original_date_of_hire IN DATE DEFAULT NULL
309 ,p_town_of_birth IN VARCHAR2 DEFAULT NULL
310 ,p_region_of_birth IN VARCHAR2 DEFAULT NULL
311 ,p_country_of_birth IN VARCHAR2 DEFAULT NULL
312 ,p_global_person_id IN VARCHAR2 DEFAULT NULL
313 ,p_party_id IN NUMBER DEFAULT NULL
314 ,p_vacancy_id IN NUMBER DEFAULT NULL
315 ,p_person_id OUT NOCOPY NUMBER
316 ,p_assignment_id OUT NOCOPY NUMBER
317 ,p_application_id OUT NOCOPY NUMBER
318 ,p_per_object_version_number OUT NOCOPY NUMBER
319 ,p_asg_object_version_number OUT NOCOPY NUMBER
320 ,p_apl_object_version_number OUT NOCOPY NUMBER
321 ,p_per_effective_start_date OUT NOCOPY DATE
322 ,p_per_effective_end_date OUT NOCOPY DATE
323 ,p_full_name OUT NOCOPY VARCHAR2
324 ,p_per_comment_id OUT NOCOPY NUMBER
325 ,p_assignment_sequence OUT NOCOPY NUMBER
326 ,p_name_combination_warning OUT NOCOPY BOOLEAN
327 ,p_orig_hire_warning OUT NOCOPY BOOLEAN
328 );
329 END hr_nz_applicant_api;
[Home] [Help]