1 Package hr_de_employee_api AUTHID CURRENT_USER as
2 /* $Header: peempdei.pkh 120.1 2005/10/02 02:16:06 aroussel $ */
3 /*#
4 * This package contains employee APIs for Germany.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Employee for Germany
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------------< create_de_employee >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates an employee in a German business group.
17 *
18 * A default primary assignment and a period of service for the employee are
19 * created. The API calls the generic API create_employee, with the parameters
20 * set as appropriate for a German employee. As this API is effectively an
21 * alternative to the API create_employee, see that API for further
22 * 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 * See API create_employee.
29 *
30 * <p><b>Post Success</b><br>
31 * The person, primary assignment and period of service are successfully
32 * inserted.
33 *
34 * <p><b>Post Failure</b><br>
35 * The API does not create the employee, default assignment or period of
36 * service and 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_hire_date Hire Date.
41 * @param p_business_group_id Business group of the person.
42 * @param p_last_name Last name.
43 * @param p_sex Legal gender. Valid values are defined by the SEX lookup type.
44 * @param p_person_type_id Type of employee being created.
45 * @param p_per_comments Person comment text
46 * @param p_date_employee_data_verified The date on which the employee data was
47 * last verified.
48 * @param p_date_of_birth Date of birth.
49 * @param p_email_address Email address.
50 * @param p_employee_number The business group's employee number generation
51 * method determines when the API derives and passes out an employee number or
52 * when the calling program should pass in a value. When the API call completes
53 * if p_validate is false then will be set to the employee number. If
54 * p_validate is true then will be set to the passed value.
55 * @param p_expense_check_send_to_addres Mailing address.
56 * @param p_first_name First name.
57 * @param p_known_as Preferred name.
58 * @param p_marital_status Marital status. Valid values are defined by the
59 * MAR_STATUS lookup type.
60 * @param p_middle_names Middle names.
61 * @param p_nationality Nationality. Valid values are defined by the
62 * NATIONALITY lookup type.
63 * @param p_social_security_number Employee's Social Security Number.
64 * @param p_previous_last_name Previous last name.
65 * @param p_registered_disabled_flag Flag indicating whether the person is
66 * classified as disabled.
67 * @param p_title Title. Valid values are defined by the TITLE lookup type.
68 * @param p_vendor_id Obsolete parameter, do not use.
69 * @param p_work_telephone Obsolete parameter, do not use.
70 * @param p_attribute_category This context value determines which flexfield
71 * structure to use with the descriptive flexfield segments.
72 * @param p_attribute1 Descriptive flexfield segment.
73 * @param p_attribute2 Descriptive flexfield segment.
74 * @param p_attribute3 Descriptive flexfield segment.
75 * @param p_attribute4 Descriptive flexfield segment.
76 * @param p_attribute5 Descriptive flexfield segment.
77 * @param p_attribute6 Descriptive flexfield segment.
78 * @param p_attribute7 Descriptive flexfield segment.
79 * @param p_attribute8 Descriptive flexfield segment.
80 * @param p_attribute9 Descriptive flexfield segment.
81 * @param p_attribute10 Descriptive flexfield segment.
82 * @param p_attribute11 Descriptive flexfield segment.
83 * @param p_attribute12 Descriptive flexfield segment.
84 * @param p_attribute13 Descriptive flexfield segment.
85 * @param p_attribute14 Descriptive flexfield segment.
86 * @param p_attribute15 Descriptive flexfield segment.
87 * @param p_attribute16 Descriptive flexfield segment.
88 * @param p_attribute17 Descriptive flexfield segment.
89 * @param p_attribute18 Descriptive flexfield segment.
90 * @param p_attribute19 Descriptive flexfield segment.
91 * @param p_attribute20 Descriptive flexfield segment.
92 * @param p_attribute21 Descriptive flexfield segment.
93 * @param p_attribute22 Descriptive flexfield segment.
94 * @param p_attribute23 Descriptive flexfield segment.
95 * @param p_attribute24 Descriptive flexfield segment.
96 * @param p_attribute25 Descriptive flexfield segment.
97 * @param p_attribute26 Descriptive flexfield segment.
98 * @param p_attribute27 Descriptive flexfield segment.
99 * @param p_attribute28 Descriptive flexfield segment.
100 * @param p_attribute29 Descriptive flexfield segment.
101 * @param p_attribute30 Descriptive flexfield segment.
102 * @param p_professional_title Professional Title. Valid values exist in the
103 * 'DE_PROF_TITLE' lookup type.
104 * @param p_hereditary_title Hereditary Title. Valid values exist in the
105 * 'DE_HEREDITARY_TITLE' lookup type.
106 * @param p_last_name_at_birth Last name at birth
107 * @param p_hereditary_title_at_birth Hereditary title at birth. Valid values
108 * exist in the 'DE_HEREDITARY_TITLE' lookup type.
109 * @param p_prefix_at_birth Prefix at birth. Valid values exist in the
110 * 'DE_PREFIX' lookup type.
111 * @param p_date_of_death Date of death.
112 * @param p_background_check_status Flag indicating whether the person's
113 * background has been checked.
114 * @param p_background_date_check Date on which the background check was
115 * performed.
116 * @param p_blood_type Blood type.
117 * @param p_correspondence_language Preferred language for correspondence.
118 * @param p_fast_path_employee New parameter, available on the latest version
119 * of this API.
120 * @param p_fte_capacity Obsolete parameter, do not use.
121 * @param p_honors Honors awarded.
122 * @param p_internal_location Internal location of office.
123 * @param p_last_medical_test_by Name of physician who performed the last
124 * medical test.
125 * @param p_last_medical_test_date Date of last medical test.
126 * @param p_mailstop Internal mail location.
127 * @param p_office_number Office number.
128 * @param p_on_military_service Flag indicating whether the person is on
129 * military service.
130 * @param p_pre_name_adjunct First part of the last name.
131 * @param p_projected_start_date Obsolete parameter, do not use.
132 * @param p_resume_exists Flag indicating whether the person's resume is on
133 * file.
134 * @param p_resume_last_updated Date on which the resume was last updated.
135 * @param p_second_passport_exists Flag indicating whether a person has
136 * multiple passports.
137 * @param p_student_status If this employee is a student, this field is used to
138 * capture their status. Valid values are defined by the STUDENT_STATUS lookup
139 * type.
140 * @param p_work_schedule The days on which this person will work.
141 * @param p_suffix Suffix after the person's last name e.g. Sr., Jr., III.
142 * @param p_benefit_group_id Benefit group to which this person will belong.
143 * @param p_receipt_of_death_cert_date Date death certificate was received.
144 * @param p_coord_ben_med_pln_no Secondary medical plan name. Column used for
145 * external processing.
146 * @param p_coord_ben_no_cvg_flag No secondary medical plan coverage. Column
147 * used for external processing.
148 * @param p_uses_tobacco_flag Flag indicating whether the person uses tobacco.
149 * @param p_dpdnt_adoption_date Date on which the dependent was adopted.
150 * @param p_dpdnt_vlntry_svce_flag Flag indicating whether the dependent is on
151 * voluntary service.
152 * @param p_original_date_of_hire Original date of hire.
153 * @param p_adjusted_svc_date New parameter, available on the latest version of
154 * this API.
155 * @param p_town_of_birth Town or city of birth.
156 * @param p_region_of_birth Geographical region of birth.
157 * @param p_country_of_birth Country of birth.
158 * @param p_global_person_id Obsolete parameter, do not use.
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_per_object_version_number If p_validate is false, then set to the
164 * version number of the created person. If p_validate is true, then set to
165 * null.
166 * @param p_asg_object_version_number If p_validate is false, then this
167 * parameter is set to the version number of the assignment created. If
168 * p_validate is true, then this parameter is null.
169 * @param p_per_effective_start_date If p_validate is false, then set to the
170 * earliest effective start date for the created person. If p_validate is true,
171 * then set to null.
172 * @param p_per_effective_end_date If p_validate is false, then set to the
173 * effective end date for the created person. If p_validate is true, then set
174 * to null.
175 * @param p_full_name If p_validate is false, then set to the complete full
176 * name of the person. If p_validate is true, then set to null.
177 * @param p_per_comment_id If p_validate is false and comment text was
178 * provided, then will be set to the identifier of the created person comment
179 * record. If p_validate is true or no comment text was provided, then will be
180 * null.
181 * @param p_assignment_sequence If p_validate is false, then set to the
182 * sequence number of the default assignment. If p_validate is true, then set
183 * to null.
184 * @param p_assignment_number If p_validate is false, then set to the
185 * assignment number of the default assignment. If p_validate is true, then set
186 * to null.
187 * @param p_name_combination_warning If set to true, then the combination of
188 * last name, first name and date of birth existed prior to calling this API.
189 * @param p_assign_payroll_warning If set to true, then the date of birth is
190 * not entered. If set to false, then the date of birth has been entered.
191 * Indicates if it will be possible to set the payroll on any of this person's
192 * assignments.
193 * @param p_orig_hire_warning Set to true if the original hire date is
194 * populated and the person type is not "Employee", "Employee and Applicant",
195 * "Ex-employee" or "Ex-employee and Applicant".
196 * @param p_parental_status New parameter, available on the latest version of
197 * this API.
198 * @rep:displayname Create Employee for Germany
199 * @rep:category BUSINESS_ENTITY PER_EMPLOYEE
200 * @rep:scope public
201 * @rep:lifecycle active
202 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
203 */
204 --
205 -- {End Of Comments}
206 --
207 procedure create_de_employee
208 (p_validate in boolean default false
209 ,p_hire_date in date
210 ,p_business_group_id in number
211 ,p_last_name in varchar2
212 ,p_sex in varchar2
213 ,p_person_type_id in number default null
214 ,p_per_comments in varchar2 default null
215 ,p_date_employee_data_verified in date default null
216 ,p_date_of_birth in date default null
217 ,p_email_address in varchar2 default null
218 ,p_employee_number in out nocopy varchar2
219 ,p_expense_check_send_to_addres in varchar2 default null
220 ,p_first_name in varchar2 default null
221 ,p_known_as in varchar2 default null
222 ,p_marital_status in varchar2 default null
223 ,p_middle_names in varchar2 default null
224 ,p_nationality in varchar2 default null
225 ,p_social_security_number in varchar2 default null
226 ,p_previous_last_name in varchar2 default null
227 ,p_registered_disabled_flag in varchar2 default null
228 ,p_title in varchar2 default null
229 ,p_vendor_id in number default null
230 ,p_work_telephone in varchar2 default null
231 ,p_attribute_category in varchar2 default null
232 ,p_attribute1 in varchar2 default null
233 ,p_attribute2 in varchar2 default null
234 ,p_attribute3 in varchar2 default null
235 ,p_attribute4 in varchar2 default null
236 ,p_attribute5 in varchar2 default null
237 ,p_attribute6 in varchar2 default null
238 ,p_attribute7 in varchar2 default null
239 ,p_attribute8 in varchar2 default null
240 ,p_attribute9 in varchar2 default null
241 ,p_attribute10 in varchar2 default null
242 ,p_attribute11 in varchar2 default null
243 ,p_attribute12 in varchar2 default null
244 ,p_attribute13 in varchar2 default null
245 ,p_attribute14 in varchar2 default null
246 ,p_attribute15 in varchar2 default null
247 ,p_attribute16 in varchar2 default null
248 ,p_attribute17 in varchar2 default null
249 ,p_attribute18 in varchar2 default null
250 ,p_attribute19 in varchar2 default null
251 ,p_attribute20 in varchar2 default null
252 ,p_attribute21 in varchar2 default null
253 ,p_attribute22 in varchar2 default null
254 ,p_attribute23 in varchar2 default null
255 ,p_attribute24 in varchar2 default null
256 ,p_attribute25 in varchar2 default null
257 ,p_attribute26 in varchar2 default null
258 ,p_attribute27 in varchar2 default null
259 ,p_attribute28 in varchar2 default null
260 ,p_attribute29 in varchar2 default null
261 ,p_attribute30 in varchar2 default null
262 ,p_professional_title in varchar2 default null
263 ,p_hereditary_title in varchar2 default null
264 ,p_last_name_at_birth in varchar2 default null
265 ,p_hereditary_title_at_birth in varchar2 default null
266 ,p_prefix_at_birth in varchar2 default null
267 ,p_date_of_death in date default null
268 ,p_background_check_status in varchar2 default null
269 ,p_background_date_check in date default null
270 ,p_blood_type in varchar2 default null
271 ,p_correspondence_language in varchar2 default 'D'
272 ,p_fast_path_employee in varchar2 default null
273 ,p_fte_capacity in number default null
274 ,p_honors in varchar2 default null
275 ,p_internal_location in varchar2 default null
276 ,p_last_medical_test_by in varchar2 default null
277 ,p_last_medical_test_date in date default null
278 ,p_mailstop in varchar2 default null
279 ,p_office_number in varchar2 default null
280 ,p_on_military_service in varchar2 default null
281 ,p_pre_name_adjunct in varchar2 default null
282 ,p_projected_start_date in date default null
283 ,p_resume_exists in varchar2 default null
284 ,p_resume_last_updated in date default null
285 ,p_second_passport_exists in varchar2 default null
286 ,p_student_status in varchar2 default null
287 ,p_work_schedule in varchar2 default null
288 ,p_suffix in varchar2 default null
289 ,p_benefit_group_id in number default null
290 ,p_receipt_of_death_cert_date in date default null
291 ,p_coord_ben_med_pln_no in varchar2 default null
292 ,p_coord_ben_no_cvg_flag in varchar2 default 'N'
293 ,p_uses_tobacco_flag in varchar2 default null
294 ,p_dpdnt_adoption_date in date default null
298 ,p_town_of_birth in varchar2 default null
295 ,p_dpdnt_vlntry_svce_flag in varchar2 default 'N'
296 ,p_original_date_of_hire in date default null
297 ,p_adjusted_svc_date in date default null
299 ,p_region_of_birth in varchar2 default null
300 ,p_country_of_birth in varchar2 default null
301 ,p_global_person_id in varchar2 default null
302 ,p_parental_status in varchar2 default null
303 ,p_person_id out nocopy number
304 ,p_assignment_id out nocopy number
305 ,p_per_object_version_number out nocopy number
306 ,p_asg_object_version_number out nocopy number
307 ,p_per_effective_start_date out nocopy date
308 ,p_per_effective_end_date out nocopy date
309 ,p_full_name out nocopy varchar2
310 ,p_per_comment_id out nocopy number
311 ,p_assignment_sequence out nocopy number
312 ,p_assignment_number out nocopy varchar2
313 ,p_name_combination_warning out nocopy boolean
314 ,p_assign_payroll_warning out nocopy boolean
315 ,p_orig_hire_warning out nocopy boolean
316 );
317 --
318 end hr_de_employee_api;
[Home] [Help]