1 Package hr_ca_applicant_api as
2 /* $Header: peappcai.pkh 120.1 2005/10/02 02:09:56 aroussel $ */
3 /*#
4 * This package contains APIs used while creating Canadian Applicants.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Applicant for Canada
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |---------------------------< create_ca_applicant >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a new Canadian applicant.
17 *
18 * This API creates a new Canadian applicant, including a default primary
19 * assignment and a application for the applicant. The API calls the generic
20 * API create_applicant, with the parameters set as appropriate for a Canadian
21 * applicant. Secure user functionality is not included in this version of the
22 * API. As this API is effectively an alternative to the API create_applicant,
23 * see that API for further explanation.
24 *
25 * <p><b>Licensing</b><br>
26 * This API is licensed for use with Human Resources.
27 *
28 * <p><b>Prerequisites</b><br>
29 * See API create_applicant. - A business group with A legislation of Canada
30 * must be specified.
31 *
32 * <p><b>Post Success</b><br>
33 * A new person, primary assignment and application have been successfully
34 * inserted.
35 *
36 * <p><b>Post Failure</b><br>
37 * The API does not create the applicant, default assignment or application and
38 * raises an error.
39 * @param p_validate If true, then validation alone will be performed and the
40 * database will remain unchanged. If false and all validation checks pass,
41 * then the database will be modified.
42 * @param p_date_received The applicant hire date and thus the effective start
43 * date of the person, primary assignment and application.
44 * @param p_business_group_id The applicant's business group.
45 * @param p_last_name Applicant's last name.
46 * @param p_person_type_id Person type id. If this value is omitted then the
47 * person_type_id of the active default `APL' system person type in the
48 * applicant's business group is used.
49 * @param p_applicant_number If p_validate is false this will be set to the
50 * applicant number of the person created. If p_validate is true this will be
51 * set to the same value as passed in.
52 * @param p_comments Comment text
53 * @param p_date_employee_data_verified The date on which the applicant data
54 * was last verified.
55 * @param p_date_of_birth Date of birth.
56 * @param p_email_address Email address.
57 * @param p_expense_check_send_to_addres Address to use as mailing address.
58 * @param p_first_name Applicant's first name.
59 * @param p_known_as Alternative name.
60 * @param p_marital_status YES_NO flag indicates if the person is married or
61 * not.
62 * @param p_middle_names Applicant's middle name(s).
63 * @param p_nationality Applicant's nationality.
64 * @param p_social_insurance_number Social Insurance Number.
65 * @param p_previous_last_name Previous last name.
66 * @param p_registered_disabled_flag REGISTERED_DISABLED lookup_type indicates
67 * if the applicant is registered as disabled or not.
68 * @param p_sex Applicant sex.
69 * @param p_title Applicant's title.
70 * @param p_work_telephone Work telephone.
71 * @param p_attribute_category This context value determines which flexfield
72 * structure to use with the descriptive flexfield segments.
73 * @param p_attribute1 Descriptive flexfield segment.
74 * @param p_attribute2 Descriptive flexfield segment.
75 * @param p_attribute3 Descriptive flexfield segment.
76 * @param p_attribute4 Descriptive flexfield segment.
77 * @param p_attribute5 Descriptive flexfield segment.
78 * @param p_attribute6 Descriptive flexfield segment.
79 * @param p_attribute7 Descriptive flexfield segment.
80 * @param p_attribute8 Descriptive flexfield segment.
81 * @param p_attribute9 Descriptive flexfield segment.
82 * @param p_attribute10 Descriptive flexfield segment.
83 * @param p_attribute11 Descriptive flexfield segment.
84 * @param p_attribute12 Descriptive flexfield segment.
85 * @param p_attribute13 Descriptive flexfield segment.
86 * @param p_attribute14 Descriptive flexfield segment.
87 * @param p_attribute15 Descriptive flexfield segment.
88 * @param p_attribute16 Descriptive flexfield segment.
89 * @param p_attribute17 Descriptive flexfield segment.
90 * @param p_attribute18 Descriptive flexfield segment.
91 * @param p_attribute19 Descriptive flexfield segment.
92 * @param p_attribute20 Descriptive flexfield segment.
93 * @param p_attribute21 Descriptive flexfield segment.
94 * @param p_attribute22 Descriptive flexfield segment.
95 * @param p_attribute23 Descriptive flexfield segment.
96 * @param p_attribute24 Descriptive flexfield segment.
97 * @param p_attribute25 Descriptive flexfield segment.
98 * @param p_attribute26 Descriptive flexfield segment.
99 * @param p_attribute27 Descriptive flexfield segment.
100 * @param p_attribute28 Descriptive flexfield segment.
101 * @param p_attribute29 Descriptive flexfield segment.
102 * @param p_attribute30 Descriptive flexfield segment.
103 * @param p_work_permit_number Work permit number
104 * @param p_work_permit_status Work permit status
105 * @param p_work_permit_end_date Work permit end date
106 * @param p_woman YES_NO flag indicating if applicant is female
107 * @param p_aboriginal YES_NO flag indicating if applicant is aboriginal
108 * @param p_visible_minority YES_NO flag indicating if applicant is VM
109 * @param p_disabled YES_NO flag indicating if applicant is disabled
110 * @param p_not_provided YES_NO flag indicating if info is disabled
111 * @param p_unknown YES_NO flag indicating info is unknown
112 * @param p_background_check_status YES_NO flag indicates whether background
113 * check has been performed
114 * @param p_background_date_check Date background check was performed
115 * @param p_correspondence_language Preferred language for correspondance
116 * @param p_fte_capacity Currently unsupported
117 * @param p_hold_applicant_date_until Date up to which applicant's file to be
118 * maintained
119 * @param p_honors Honors or degrees awarded
120 * @param p_mailstop Office identifier for internal mail
121 * @param p_office_number Number of office
122 * @param p_on_military_service Type of military service
123 * @param p_pre_name_adjunct First part of surname such as Van or De
124 * @param p_projected_start_date Currently unsupported
125 * @param p_resume_exists YES_NO flag indicating whether resume is on file
126 * @param p_resume_last_updated Date resume last updated
127 * @param p_student_status STUDENT_STATUS lookup type indicates if the
128 * applicant is a full time or a part time student.
129 * @param p_work_schedule Type of work schedule inndicating which days person
130 * works
131 * @param p_suffix Applicant's suffix
132 * @param p_date_of_death Date of death
133 * @param p_benefit_group_id Id for benefit group
134 * @param p_receipt_of_death_cert_date Date death certificate was received
135 * @param p_coord_ben_med_pln_no Number of an externally provided medical plan
136 * @param p_coord_ben_no_cvg_flag No other coverage flag
137 * @param p_uses_tobacco_flag Uses tobacco list of values
138 * @param p_dpdnt_adoption_date Date dependent was adopted
139 * @param p_dpdnt_vlntry_svce_flag Dependent on voluntary service flag
140 * @param p_original_date_of_hire Original date of hire
141 * @param p_city_of_birth City of birth
142 * @param p_province_of_birth Province of birth
143 * @param p_country_of_birth Country of birth
144 * @param p_global_person_id Global ID for the person
145 * @param p_person_id If p_validate is false, then this uniquely identifies the
146 * person created. If p_validate is true, then set to null.
147 * @param p_assignment_id If p_validate is false, then this uniquely identifies
148 * the created assignment. If p_validate is true, then set to null.
149 * @param p_application_id If p_validate is false, this uniquely identifies the
150 * application created. If p_validate is true this parameter will be null.
151 * @param p_per_object_version_number If p_validate is false, then set to the
152 * version number of the created person. If p_validate is true, then the value
153 * will be null.
154 * @param p_asg_object_version_number If p_validate is false, then this
155 * parameter is set to the version number of the assignment created. If
156 * p_validate is true, then this parameter is null.
157 * @param p_apl_object_version_number If p_validate is false, this will be set
158 * to the version number of the application created. If p_validate is true this
159 * parameter will be set to null.
160 * @param p_per_effective_start_date If p_validate is false, this will be set
161 * to the effective start date of the person. If p_validate is true this will
162 * be null.
163 * @param p_per_effective_end_date If p_validate is false, this will be set to
164 * the effective end date of the person. If p_validate is true this will be
165 * null.
166 * @param p_full_name If p_validate is false, this will be set to the complete
167 * full name of the person. If p_validate is true this will be null.
168 * @param p_per_comment_id If p_validate is false this will be set to the id of
169 * the corresponding person comment row, if any comment text exists. If
170 * p_validate is true this will be null.
171 * @param p_assignment_sequence If p_validate is false this will be set to the
172 * sequence number of the primary assignment. If p_validate is true this will
173 * be 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 Set to true if the original date of hire is not
177 * null and the person type is not EMP,EMP_APL, EX_EMP or EX_EMP_APL.
178 * @rep:displayname Create Applicant for Canada
179 * @rep:category BUSINESS_ENTITY PER_APPLICANT
180 * @rep:scope public
181 * @rep:lifecycle active
182 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
183 */
184 --
185 -- {End Of Comments}
186 --
187 procedure create_ca_applicant
188 (p_validate in boolean default false
189 ,p_date_received in date
190 ,p_business_group_id in number
191 ,p_last_name in varchar2
192 ,p_person_type_id in number default null
193 ,p_applicant_number in out nocopy varchar2
194 ,p_comments in varchar2 default null
195 ,p_date_employee_data_verified in date default null
196 ,p_date_of_birth in date default null
197 ,p_email_address in varchar2 default null
198 ,p_expense_check_send_to_addres in varchar2 default null
199 ,p_first_name in varchar2 default null
200 ,p_known_as in varchar2 default null
201 ,p_marital_status in varchar2 default null
202 ,p_middle_names in varchar2 default null
203 ,p_nationality in varchar2 default null
204 ,p_social_insurance_number 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_work_permit_number in varchar2 default null
242 ,p_work_permit_status in varchar2 default null
243 ,p_work_permit_end_date in varchar2 default null
244 ,p_woman in varchar2 default null
245 ,p_aboriginal in varchar2 default null
246 ,p_visible_minority in varchar2 default null
247 ,p_disabled in varchar2 default null
248 ,p_not_provided in varchar2 default null
249 ,p_unknown 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_pre_name_adjunct in varchar2 default null
260 ,p_projected_start_date in date default null
261 ,p_resume_exists in varchar2 default null
262 ,p_resume_last_updated in date default null
263 ,p_student_status in varchar2 default null
264 ,p_work_schedule in varchar2 default null
265 ,p_suffix in varchar2 default null
266 ,p_date_of_death in date default null
267 ,p_benefit_group_id in number default null
268 ,p_receipt_of_death_cert_date in date default null
269 ,p_coord_ben_med_pln_no in varchar2 default null
270 ,p_coord_ben_no_cvg_flag in varchar2 default 'N'
271 ,p_uses_tobacco_flag in varchar2 default null
272 ,p_dpdnt_adoption_date in date default null
273 ,p_dpdnt_vlntry_svce_flag in varchar2 default 'N'
274 ,p_original_date_of_hire in date default null
275 ,p_city_of_birth in varchar2 default null
276 ,p_province_of_birth in varchar2 default null
277 ,p_country_of_birth in varchar2 default null
278 ,p_global_person_id in varchar2 default null
279 ,p_person_id out nocopy number
280 ,p_assignment_id out nocopy number
281 ,p_application_id out nocopy number
282 ,p_per_object_version_number out nocopy number
283 ,p_asg_object_version_number out nocopy number
284 ,p_apl_object_version_number out nocopy number
285 ,p_per_effective_start_date out nocopy date
286 ,p_per_effective_end_date out nocopy date
287 ,p_full_name out nocopy varchar2
288 ,p_per_comment_id out nocopy number
289 ,p_assignment_sequence out nocopy number
290 ,p_name_combination_warning out nocopy boolean
291 ,p_orig_hire_warning out nocopy boolean
292 );
293 --
294 end hr_ca_applicant_api;
[Home] [Help]