1 Package hr_ca_employee_api AUTHID CURRENT_USER as
2 /* $Header: peempcai.pkh 120.1 2005/10/02 02:15:59 aroussel $ */
3 /*#
4 * This package contains Canadian Employee Creation APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Employee for Canada
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------------< create_ca_employee >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates Canadian Employee records.
17 *
18 * This API creates a new CA employee, including a default primary assignment
19 * and a period of service for the employee. The API calls the generic API
20 * create_employee, with the parameters set as appropriate for a CA employee.
21 * Secure user functionality is not included in this version of the API. As
22 * this API is effectively an alternative to the API create_employee, see that
23 * 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_employee.
30 *
31 * <p><b>Post Success</b><br>
32 * When the person, primary assignment and period of service will be
33 * successfully created.
34 *
35 * <p><b>Post Failure</b><br>
36 * The API does not create the employee, default assignment or period of
37 * service and raises an error.
38 * @param p_validate If true, then validation alone will be performed and the
39 * database will remain unchanged. If false and all validation checks pass,
40 * then the database will be modified.
41 * @param p_hire_date The employee hire date and thus the effective start date
42 * of the person, primary assignment and period of service.
43 * @param p_business_group_id The employee's business group.
44 * @param p_last_name Employee's last name.
45 * @param p_sex Employee sex.
46 * @param p_person_type_id Person type id. If this value is omitted then the
47 * person_type_id of the active default `EMP' system person type in the
48 * employee's business group is used.
49 * @param p_comments Comment text for the Person created
50 * @param p_date_employee_data_verified The date on which the employee data was
51 * last verified.
52 * @param p_date_of_birth Date of birth.
53 * @param p_email_address Email address.
54 * @param p_employee_number Employee Number assigned to the Person
55 * @param p_expense_check_send_to_addres Address to use as mailing address.
56 * @param p_first_name Employee's first name.
57 * @param p_known_as Alternative name.
58 * @param p_marital_status YES_NO flag indicates ifthe person is married or
59 * not.
60 * @param p_middle_names Employee's middle name(s).
61 * @param p_nationality Employee's nationality.
62 * @param p_ni_number N.I. Number.
63 * @param p_previous_last_name Previous last name.
64 * @param p_title Employee's title.
65 * @param p_vendor_id Foreign key to PO_VENDORS.
66 * @param p_work_telephone Work telephone.
67 * @param p_attribute_category This context value determines which flexfield
68 * structure to use with the descriptive flexfield segments.
69 * @param p_attribute1 Descriptive flexfield segment.
70 * @param p_attribute2 Descriptive flexfield segment.
71 * @param p_attribute3 Descriptive flexfield segment.
72 * @param p_attribute4 Descriptive flexfield segment.
73 * @param p_attribute5 Descriptive flexfield segment.
74 * @param p_attribute6 Descriptive flexfield segment.
75 * @param p_attribute7 Descriptive flexfield segment.
76 * @param p_attribute8 Descriptive flexfield segment.
77 * @param p_attribute9 Descriptive flexfield segment.
78 * @param p_attribute10 Descriptive flexfield segment.
79 * @param p_attribute11 Descriptive flexfield segment.
80 * @param p_attribute12 Descriptive flexfield segment.
81 * @param p_attribute13 Descriptive flexfield segment.
82 * @param p_attribute14 Descriptive flexfield segment.
83 * @param p_attribute15 Descriptive flexfield segment.
84 * @param p_attribute16 Descriptive flexfield segment.
85 * @param p_attribute17 Descriptive flexfield segment.
86 * @param p_attribute18 Descriptive flexfield segment.
87 * @param p_attribute19 Descriptive flexfield segment.
88 * @param p_attribute20 Descriptive flexfield segment.
89 * @param p_attribute21 Descriptive flexfield segment.
90 * @param p_attribute22 Descriptive flexfield segment.
91 * @param p_attribute23 Descriptive flexfield segment.
92 * @param p_attribute24 Descriptive flexfield segment.
93 * @param p_attribute25 Descriptive flexfield segment.
94 * @param p_attribute26 Descriptive flexfield segment.
95 * @param p_attribute27 Descriptive flexfield segment.
96 * @param p_attribute28 Descriptive flexfield segment.
97 * @param p_attribute29 Descriptive flexfield segment.
98 * @param p_attribute30 Descriptive flexfield segment.
99 * @param p_work_permit_number Work permit number
100 * @param p_work_permit_status Work permit status
101 * @param p_work_permit_end_date Work permit end date
102 * @param p_woman YES_NO flag indidating if applicant is female
103 * @param p_aboriginal YES_NO flag indidating if applicant is aboriginal
104 * @param p_visible_minority YES_NO flag indidating if applicant is VM
105 * @param p_disabled YES_NO flag indidating if applicant is disabled
106 * @param p_not_provided YES_NO flag indidating if info is disabled
107 * @param p_unknown YES_NO flag indidating info is unknown
108 * @param p_date_of_death Date of death
109 * @param p_background_check_status YES_NO flag indicates whether background
110 * check has been performed
111 * @param p_background_date_check Date background check was performed
112 * @param p_blood_type Blood type
113 * @param p_correspondence_language Preferred language for correspondance
114 * @param p_fast_path_employee Currently unsupported
115 * @param p_fte_capacity Full time/part time availability for work
116 * @param p_honors Honors or degrees awarded
117 * @param p_internal_location Internal location of office
118 * @param p_last_medical_test_by Name of physician who performed last medical
119 * test
120 * @param p_last_medical_test_date Date of last medical test
121 * @param p_mailstop Office identifier for internal mail
122 * @param p_office_number Number of office
123 * @param p_on_military_service YES_NO flag indicating whether person is
124 * employed in military service
125 * @param p_pre_name_adjunct First part of surname such as Van or De
126 * @param p_projected_start_date Currently unsupported
127 * @param p_resume_exists YES_NO flag indicating whether resume is on file
128 * @param p_resume_last_updated Date resume last updated
129 * @param p_second_passport_exists YES_NO flag indicaing whether person has
130 * multiple passports
131 * @param p_student_status STUDENT_STATUS lookup type indicates if the
132 * applicant is a full time or a part time student.
133 * @param p_work_schedule Type of work schedule inndicating which days person
134 * works
135 * @param p_suffix Employee's suffix
136 * @param p_benefit_group_id Benefit group id.
137 * @param p_receipt_of_death_cert_date Date the death certificate
138 * @param p_coord_ben_med_pln_no Coordinated benefit medical plan number
139 * @param p_coord_ben_no_cvg_flag Coordinated benefit no other coverage flag
140 * @param p_uses_tobacco_flag Uses tobacco list of values
141 * @param p_dpdnt_adoption_date Dependent's adoption date
142 * @param p_dpdnt_vlntry_svce_flag Dependent's voluntary service flag
143 * @param p_original_date_of_hire Original date of hire
144 * @param p_adjusted_svc_date Adjusted service date
145 * @param p_town_of_birth Town or city of birth
146 * @param p_region_of_birth Geographical region of birth
147 * @param p_country_of_birth Country of birth
148 * @param p_global_person_id Global ID for the person
149 * @param p_person_id Unique ID for the Person created by the API.
150 * @param p_assignment_id Unique ID for the Assignment created for the Person
151 * created by the API.
152 * @param p_per_object_version_number Object Version Number created for the
153 * Person
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_per_effective_start_date If p_validate is false, this will be set
158 * to the effective start date of the person. If p_validate is true this will
159 * be null.
160 * @param p_per_effective_end_date If p_validate is false, this will be set to
161 * the effective end date of the person. If p_validate is true this will be
162 * null.
163 * @param p_full_name If p_validate is false, this will be set to the complete
164 * full name of the person. If p_validate is true this will be null.
165 * @param p_per_comment_id If p_validate is false this will be set to the id of
166 * the corresponding person comment row, if any comment text exists. If
167 * p_validate is true this will be null.
168 * @param p_assignment_sequence If p_validate is false this will be set to the
169 * sequence number of the primary assignment. If p_validate is true this will
170 * be null.
171 * @param p_assignment_number If p_validate is false this will be set to the
172 * assignment 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_assign_payroll_warning If set to true, then the date of birth is
177 * not entered. If set to false, then the date of birth has been entered.
178 * Indicates if it will be possible to set the payroll on any of this person's
179 * assignments.
180 * @param p_orig_hire_warning Set to true if the original date of hire is not
181 * null and the person type is not EMP,EMP_APL, EX_EMP or EX_EMP_APL.
182 * @rep:displayname Create Employee for Canada
183 * @rep:category BUSINESS_ENTITY PER_EMPLOYEE
184 * @rep:scope public
185 * @rep:lifecycle active
186 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
187 */
188 --
189 -- {End Of Comments}
190 --
191 procedure create_ca_employee
192 (p_validate in boolean default false
193 ,p_hire_date in date
194 ,p_business_group_id in number
195 ,p_last_name in varchar2
196 ,p_sex in varchar2
197 ,p_person_type_id in number default null
198 ,p_comments in varchar2 default null
199 ,p_date_employee_data_verified in date default null
200 ,p_date_of_birth in date default null
201 ,p_email_address in varchar2 default null
202 ,p_employee_number in out nocopy varchar2
203 ,p_expense_check_send_to_addres in varchar2 default null
204 ,p_first_name in varchar2 default null
205 ,p_known_as in varchar2 default null
206 ,p_marital_status in varchar2 default null
207 ,p_middle_names in varchar2 default null
208 ,p_nationality in varchar2 default null
209 ,p_ni_number in varchar2 default null
210 ,p_previous_last_name in varchar2 default null
211 ,p_title in varchar2 default null
212 ,p_vendor_id in number default null
213 ,p_work_telephone in varchar2 default null
214 ,p_attribute_category in varchar2 default null
215 ,p_attribute1 in varchar2 default null
216 ,p_attribute2 in varchar2 default null
217 ,p_attribute3 in varchar2 default null
218 ,p_attribute4 in varchar2 default null
219 ,p_attribute5 in varchar2 default null
220 ,p_attribute6 in varchar2 default null
221 ,p_attribute7 in varchar2 default null
222 ,p_attribute8 in varchar2 default null
223 ,p_attribute9 in varchar2 default null
224 ,p_attribute10 in varchar2 default null
225 ,p_attribute11 in varchar2 default null
226 ,p_attribute12 in varchar2 default null
227 ,p_attribute13 in varchar2 default null
228 ,p_attribute14 in varchar2 default null
229 ,p_attribute15 in varchar2 default null
230 ,p_attribute16 in varchar2 default null
231 ,p_attribute17 in varchar2 default null
232 ,p_attribute18 in varchar2 default null
233 ,p_attribute19 in varchar2 default null
234 ,p_attribute20 in varchar2 default null
235 ,p_attribute21 in varchar2 default null
236 ,p_attribute22 in varchar2 default null
237 ,p_attribute23 in varchar2 default null
238 ,p_attribute24 in varchar2 default null
239 ,p_attribute25 in varchar2 default null
240 ,p_attribute26 in varchar2 default null
241 ,p_attribute27 in varchar2 default null
242 ,p_attribute28 in varchar2 default null
243 ,p_attribute29 in varchar2 default null
244 ,p_attribute30 in varchar2 default null
245 ,p_work_permit_number in varchar2 default null
246 ,p_work_permit_status in varchar2 default null
247 ,p_work_permit_end_date in varchar2 default null
248 ,p_woman in varchar2 default null
249 ,p_aboriginal in varchar2 default null
250 ,p_visible_minority in varchar2 default null
251 ,p_disabled in varchar2 default null
252 ,p_not_provided in varchar2 default null
253 ,p_unknown in varchar2 default null
254 ,p_date_of_death in date default null
255 ,p_background_check_status in varchar2 default null
256 ,p_background_date_check in date default null
257 ,p_blood_type in varchar2 default null
258 ,p_correspondence_language in varchar2 default null
259 ,p_fast_path_employee in varchar2 default null
260 ,p_fte_capacity in number default null
261 ,p_honors in varchar2 default null
262 ,p_internal_location in varchar2 default null
263 ,p_last_medical_test_by in varchar2 default null
264 ,p_last_medical_test_date in date default null
265 ,p_mailstop in varchar2 default null
266 ,p_office_number in varchar2 default null
267 ,p_on_military_service in varchar2 default null
268 ,p_pre_name_adjunct in varchar2 default null
269 ,p_projected_start_date in date default null
270 ,p_resume_exists in varchar2 default null
271 ,p_resume_last_updated in date default null
272 ,p_second_passport_exists in varchar2 default null
273 ,p_student_status in varchar2 default null
274 ,p_work_schedule in varchar2 default null
275 ,p_suffix in varchar2 default null
276 ,p_benefit_group_id in number default null
277 ,p_receipt_of_death_cert_date in date default null
278 ,p_coord_ben_med_pln_no in varchar2 default null
279 ,p_coord_ben_no_cvg_flag in varchar2 default 'N'
280 ,p_uses_tobacco_flag in varchar2 default null
281 ,p_dpdnt_adoption_date in date default null
282 ,p_dpdnt_vlntry_svce_flag in varchar2 default 'N'
283 ,p_original_date_of_hire in date default null
284 ,p_adjusted_svc_date in date default null
285 ,p_town_of_birth in varchar2 default null
286 ,p_region_of_birth in varchar2 default null
287 ,p_country_of_birth in varchar2 default null
288 ,p_global_person_id in varchar2 default null
289 ,p_person_id out nocopy number
290 ,p_assignment_id out nocopy number
291 ,p_per_object_version_number out nocopy number
292 ,p_asg_object_version_number out nocopy number
293 ,p_per_effective_start_date out nocopy date
294 ,p_per_effective_end_date out nocopy date
295 ,p_full_name out nocopy varchar2
296 ,p_per_comment_id out nocopy number
297 ,p_assignment_sequence out nocopy number
298 ,p_assignment_number out nocopy varchar2
299 ,p_name_combination_warning out nocopy boolean
300 ,p_assign_payroll_warning out nocopy boolean
301 ,p_orig_hire_warning out nocopy boolean
302 );
303 --
304 end hr_ca_employee_api;
[Home] [Help]