1 package hr_fi_applicant_api as
2 /* $Header: peappfii.pkh 120.5.12010000.1 2008/07/28 04:06:51 appldev ship $ */
3 /*#
4 * This package contains applicant APIs.
5 * @rep:scope public
6 * @rep:product PER
7 * @rep:displayname Applicant for Finland
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |---------------------------< create_fi_applicant >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a new Finnish applicant.
17 *
18 * The API creates the person details, a default applicant assignment, and an
19 * application for the applicant. This API is effectively an alternative to the
20 * API create_applicant. If p_validate is set to false, an applicant is
21 * created.
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 * The business group for Finland legislation must exist on the effective date.
28 * The APL type must be active in the same business group as the applicant you
29 * are creating. If you do not specify a person_type_id, the API uses the
30 * default APL type for the business group.
31 *
32 * <p><b>Post Success</b><br>
33 * The API creates a person, application, and default applicant assignment. If
34 * required, then the API also creates the associated assignment budget values
35 * and a letter request.
36 *
37 * <p><b>Post Failure</b><br>
38 * The API does not create an applicant and raises an error.
39 *
40 * @param p_validate If true, then validation alone will be performed and the
41 * database will remain unchanged. If false and all validation checks pass,
42 * then the database will be modified.
43 * @param p_date_received The date an application was received and thus the
44 * effective start date of the applicant record, application and applicant
45 * assignment.
46 * @param p_business_group_id Identifies the applicant's business group.
47 * @param p_last_name Applicant's last name.
48 * @param p_person_type_id Identifies the person type id. If a person_type_id
49 * is not specified, then the API will use the default 'APL' type for the
50 * business group.
51 * @param p_applicant_number Identifies the applicant's unique number. If the
52 * number generation method is Manual, then this parameter is mandatory. If the
53 * number generation method is Automatic, then the value of this parameter must
54 * be NULL. If p_validate is false and the applicant number generation method
55 * is Automatic, then the parameter value will be set to the generated
56 * applicant number of the person created. If p_validate is false and the
57 * applicant number generation method is Automatic this will be set to the
58 * generated applicant number of the person created. If p_validate is true,
59 * then the parameter value will be set to the same value as passed in.
60 * @param p_comments Applicant comment text.
61 * @param p_date_employee_data_verified The date on which the applicant data
62 * was last verified.
63 * @param p_date_of_birth Date of birth.
64 * @param p_email_address E-mail address.
65 * @param p_expense_check_send_to_addres Address to use as mailing address.
66 * @param p_first_name Applicant's first name.
67 * @param p_known_as Alternative name.
68 * @param p_marital_status Marital status. The lookup type 'MAR_STATUS' defines
69 * the valid values.
70 * @param p_nationality Applicant's nationality. The lookup type 'NATIONALITY'
71 * defines the valid values.
72 * @param p_national_identifier National identifier.
73 * @param p_previous_last_name Previous last name.
74 * @param p_registered_disabled_flag Indicates whether the person is classified
75 * as disabled. The lookup type 'REGISTERED_DISABLED' defines the valid values.
76 * @param p_sex Applicant's sex. The lookup type 'SEX' defines the valid
77 * values.
78 * @param p_title Applicant's title. The lookup type 'TITLE' defines the valid
79 * values.
80 * @param p_work_telephone Work telephone.
81 * @param p_attribute_category This context value determines which flexfield
82 * structure to use with the descriptive flexfield segments.
83 * @param p_attribute1 Descriptive flexfield segment.
84 * @param p_attribute2 Descriptive flexfield segment.
85 * @param p_attribute3 Descriptive flexfield segment.
86 * @param p_attribute4 Descriptive flexfield segment.
87 * @param p_attribute5 Descriptive flexfield segment.
88 * @param p_attribute6 Descriptive flexfield segment.
89 * @param p_attribute7 Descriptive flexfield segment.
90 * @param p_attribute8 Descriptive flexfield segment.
91 * @param p_attribute9 Descriptive flexfield segment.
92 * @param p_attribute10 Descriptive flexfield segment.
93 * @param p_attribute11 Descriptive flexfield segment.
94 * @param p_attribute12 Descriptive flexfield segment.
95 * @param p_attribute13 Descriptive flexfield segment.
96 * @param p_attribute14 Descriptive flexfield segment.
97 * @param p_attribute15 Descriptive flexfield segment.
98 * @param p_attribute16 Descriptive flexfield segment.
99 * @param p_attribute17 Descriptive flexfield segment.
100 * @param p_attribute18 Descriptive flexfield segment.
101 * @param p_attribute19 Descriptive flexfield segment.
102 * @param p_attribute20 Descriptive flexfield segment.
103 * @param p_attribute21 Descriptive flexfield segment.
104 * @param p_attribute22 Descriptive flexfield segment.
105 * @param p_attribute23 Descriptive flexfield segment.
106 * @param p_attribute24 Descriptive flexfield segment.
107 * @param p_attribute25 Descriptive flexfield segment.
108 * @param p_attribute26 Descriptive flexfield segment.
109 * @param p_attribute27 Descriptive flexfield segment.
110 * @param p_attribute28 Descriptive flexfield segment.
111 * @param p_attribute29 Descriptive flexfield segment.
112 * @param p_attribute30 Descriptive flexfield segment.
113 * @param p_place_of_residence Place of residence.
114 * @param p_secondary_email Secondary e-mail address.
115 * @param p_epost_address E-post address.
116 * @param p_speed_dial_number Speed dial number.
117 * @param p_qualification Qualification of the applicant.
118 * @param p_level Qualification level of the applicant. The lookup type
119 * 'FI_QUAL_LEVEL' defines the valid values.
120 * @param p_field Indicates the professional field of qualification. The lookup
121 * type 'FI_QUAL_FIELD' defines the valid values.
122 * @param p_retirement_date Retirement date.
123 * @param p_background_check_status Y/N flag indicates whether background check
124 * has been performed.
125 * @param p_background_date_check Date background check was performed.
126 * @param p_correspondence_language Preferred language for correspondence.
127 * @param p_fte_capacity This parameter is currently not supported.
128 * @param p_hold_applicant_date_until Date up to which applicant's file to be
129 * maintained.
130 * @param p_honors Honors or degrees awarded.
131 * @param p_mailstop Office identifier for internal mail.
132 * @param p_office_number Office Number.
133 * @param p_on_military_service Type of military service.
134 * @param p_projected_start_date This parameter is currently not supported.
135 * @param p_resume_exists Y/N flag indicating whether resume is available.
136 * @param p_resume_last_updated Date resume was last updated.
137 * @param p_student_status Type of student status.The lookup type
138 * 'STUDENT_STATUS' defines the valid values.
139 * @param p_work_schedule Type of work schedule indicating which days the
140 * person works. The lookup type 'WORK_SCHEDULE' defines the valid values.
141 * @param p_date_of_death Date of death of the applicant.
142 * @param p_benefit_group_id Identifies the applicant's benefit group.
143 * @param p_receipt_of_death_cert_date Date when the death certificate was
144 * received.
145 * @param p_coord_ben_med_pln_no Number of the medical plan provided by an
146 * external organization.
147 * @param p_coord_ben_no_cvg_flag Indicates that the person is not covered by
148 * any other benefit plan.
149 * @param p_uses_tobacco_flag Tobacco type used by the applicant. The lookup
150 * type 'TOBACCO_USER' defines the valid values.
151 * @param p_dpdnt_adoption_date Date the dependent was adopted.
152 * @param p_dpdnt_vlntry_svce_flag Indicates whether the dependent is on
153 * voluntary service.
154 * @param p_original_date_of_hire Original hire date of the applicant.
155 * @param p_town_of_birth Town or city of birth of the applicant.
156 * @param p_region_of_birth Geographical region of birth of the applicant.
157 * @param p_country_of_birth Country of birth of the applicant.
158 * @param p_global_person_id Global identification number for the applicant.
159 * @param p_person_id If p_validate is false, then this uniquely identifies the
160 * person created. If p_validate is true, then set to null.
161 * @param p_assignment_id If p_validate is false, then this uniquely identifies
162 * the created assignment. If p_validate is true, then set to null.
163 * @param p_application_id If p_validate is false, then this uniquely
164 * identifies the created application. If p_validate is true, then set to null.
165 * @param p_per_object_version_number If p_validate is false, then set to the
166 * version number of the created person. If p_validate is true, then the value
167 * will be null.
168 * @param p_asg_object_version_number If p_validate is false, then this
169 * parameter is set to the version number of the assignment created. If
170 * p_validate is true, then this parameter is null.
171 * @param p_apl_object_version_number If p_validate is false, then this will be
172 * set to the version number of the created application. If p_validate is true,
173 * then set to null.
174 * @param p_per_effective_start_date If p_validate is false, then this will be
175 * set to the effective start date of the person. If p_validate is true, then
176 * set to null.
177 * @param p_per_effective_end_date If p_validate is false, then this will be
178 * set to the effective end date of the person. If p_validate is true, then set
179 * to null.
180 * @param p_full_name If p_validate is false, then this will be set to the
181 * complete full name of the person. If p_validate is true, then set to null.
182 * @param p_per_comment_id If p_validate is false, then this will be set to the
183 * ID of the corresponding person comment row, if any comment text exists. If
184 * p_validate is true, then set to null.
185 * @param p_assignment_sequence If p_validate is false, then this will be set
186 * to the sequence number of the default assignment. If p_validate is true,
187 * then set to null.
188 * @param p_name_combination_warning If set to true, then the combination of
189 * last name, first name and date of birth existed prior to calling this API.
190 * @param p_orig_hire_warning Set to true, if the original date of hire is not
191 * null and the person type is not Employee, Employee Applicant, Ex-Employee or
192 * Ex- Employee Applicant.
193 * @param p_union_name Name of the Trade Union to which the applicant belongs.
194 * @param p_membership_number Applicant's Trade Union membership number.
195 * @param p_payment_mode Mode of Payment. The lookup type
196 * 'FI_TRADE_UNION_FEE_TYPE' defines the valid values.
197 * @param p_fixed_amount Amount to deducted as Union membership
198 * fees.
199 * @param p_percentage Percentage of gross salary to deducted as Union
200 * membership fees.
201 * @param p_membership_start_date Union membership start date.
202 * @param p_membership_end_date Union membership end date.
203 * @param p_mother_tongue Mother Tongue
204 * @param p_foreign_personal_id Foreign Personal ID
205 * @rep:displayname Create Applicant for Finland
206 * @rep:category BUSINESS_ENTITY PER_APPLICANT
207 * @rep:lifecycle active
208 * @rep:scope public
209 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
210 */
211 --
212 -- {End Of Comments}
213 --
214 PROCEDURE create_fi_applicant
215 (p_validate in boolean default false
216 ,p_date_received in date
217 ,p_business_group_id in number
218 ,p_last_name in varchar2
219 ,p_person_type_id in number default null
220 ,p_applicant_number in out nocopy varchar2
221 ,p_comments in varchar2 default null
222 ,p_date_employee_data_verified in date default null
223 ,p_date_of_birth in date default null
224 ,p_email_address in varchar2 default null
225 ,p_expense_check_send_to_addres in varchar2 default null
226 ,p_first_name in varchar2
227 ,p_known_as in varchar2 default null
228 ,p_marital_status in varchar2 default null
229 ,p_nationality in varchar2
230 ,p_national_identifier in varchar2 default null
231 ,p_previous_last_name in varchar2 default null
232 ,p_registered_disabled_flag in varchar2 default null
233 ,p_sex in varchar2 default null
234 ,p_title in varchar2
235 ,p_work_telephone in varchar2 default null
236 ,p_attribute_category in varchar2 default null
237 ,p_attribute1 in varchar2 default null
238 ,p_attribute2 in varchar2 default null
239 ,p_attribute3 in varchar2 default null
240 ,p_attribute4 in varchar2 default null
241 ,p_attribute5 in varchar2 default null
242 ,p_attribute6 in varchar2 default null
243 ,p_attribute7 in varchar2 default null
244 ,p_attribute8 in varchar2 default null
245 ,p_attribute9 in varchar2 default null
246 ,p_attribute10 in varchar2 default null
247 ,p_attribute11 in varchar2 default null
248 ,p_attribute12 in varchar2 default null
249 ,p_attribute13 in varchar2 default null
250 ,p_attribute14 in varchar2 default null
251 ,p_attribute15 in varchar2 default null
252 ,p_attribute16 in varchar2 default null
253 ,p_attribute17 in varchar2 default null
254 ,p_attribute18 in varchar2 default null
255 ,p_attribute19 in varchar2 default null
256 ,p_attribute20 in varchar2 default null
257 ,p_attribute21 in varchar2 default null
258 ,p_attribute22 in varchar2 default null
259 ,p_attribute23 in varchar2 default null
260 ,p_attribute24 in varchar2 default null
261 ,p_attribute25 in varchar2 default null
262 ,p_attribute26 in varchar2 default null
263 ,p_attribute27 in varchar2 default null
264 ,p_attribute28 in varchar2 default null
265 ,p_attribute29 in varchar2 default null
266 ,p_attribute30 in varchar2 default null
267 ,p_place_of_residence in varchar2 default null
268 ,p_secondary_email in varchar2 default null
269 ,p_epost_address in varchar2 default null
270 ,p_speed_dial_number in varchar2 default null
271 ,p_qualification in varchar2 default null
272 ,p_level in varchar2 default null
273 ,p_field in varchar2 default null
274 ,p_retirement_date in varchar2 default null
275 ,p_union_name in varchar2 default null
276 ,p_membership_number in varchar2 default null
277 ,p_payment_mode in varchar2 default null
278 ,p_fixed_amount in varchar2 default null
279 ,p_percentage in varchar2 default null
280 ,p_membership_start_date in varchar2 default null
281 ,p_membership_end_date in varchar2 default null
282 ,p_mother_tongue in varchar2 default null
283 ,p_foreign_personal_id 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_projected_start_date in date default null
294 ,p_resume_exists in varchar2 default null
295 ,p_resume_last_updated in date default null
296 ,p_student_status in varchar2 default null
297 ,p_work_schedule in varchar2 default null
298 ,p_date_of_death in date default null
299 ,p_benefit_group_id in number default null
300 ,p_receipt_of_death_cert_date in date default null
301 ,p_coord_ben_med_pln_no in varchar2 default null
302 ,p_coord_ben_no_cvg_flag in varchar2 default 'N'
303 ,p_uses_tobacco_flag in varchar2 default null
304 ,p_dpdnt_adoption_date in date default null
305 ,p_dpdnt_vlntry_svce_flag in varchar2 default 'N'
306 ,p_original_date_of_hire in date default null
307 ,p_town_of_birth in varchar2 default null
308 ,p_region_of_birth in varchar2 default null
309 ,p_country_of_birth in varchar2 default null
310 ,p_global_person_id in varchar2 default null
311 ,p_person_id out nocopy number
312 ,p_assignment_id out nocopy number
313 ,p_application_id out nocopy number
314 ,p_per_object_version_number out nocopy number
315 ,p_asg_object_version_number out nocopy number
316 ,p_apl_object_version_number out nocopy number
317 ,p_per_effective_start_date out nocopy date
318 ,p_per_effective_end_date out nocopy date
319 ,p_full_name out nocopy varchar2
320 ,p_per_comment_id out nocopy number
321 ,p_assignment_sequence out nocopy number
322 ,p_name_combination_warning out nocopy boolean
323 ,p_orig_hire_warning out nocopy boolean);
324
325 end hr_fi_applicant_api;
326
[Home] [Help]