1 Package hr_fr_employee_api as
2 /* $Header: peempfri.pkh 120.1 2005/10/02 02:16:17 aroussel $ */
3 /*#
4 * This package contains an API to maintain employees for France.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Employee for France
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------------< create_fr_employee >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates an employee in a business group for France.
17 *
18 * This API creates a new French employee, including a default primary
19 * assignment and a period of service for the employee. The API calls the
20 * generic API create_employee, with the parameters set as appropriate for a
21 * French employee. Secure user functionality is not included in this version
22 * of the API. See create_employee API for further details.
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 * A business group must be specified for France.
29 *
30 * <p><b>Post Success</b><br>
31 * The record is successfully added into the database.
32 *
33 * <p><b>Post Failure</b><br>
34 * The API does not create the employee, default assignment or period of
35 * service and 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_hire_date Hire Date.
40 * @param p_business_group_id Business group of the person.
41 * @param p_last_name Last name.
42 * @param p_sex Legal gender. Valid values are defined by the SEX lookup type.
43 * @param p_person_type_id Type of employee being created.
44 * @param p_comments Person comment text.
45 * @param p_date_employee_data_verified The date on which the employee data was
46 * last verified.
47 * @param p_date_of_birth Date of birth.
48 * @param p_email_address Email address.
49 * @param p_employee_number The business group's employee number generation
50 * method determines when the API derives and passes out an employee number or
51 * when the calling program should pass in a value. When the API call completes
52 * if p_validate is false then will be set to the employee number. If
53 * p_validate is true then will be set to the passed value.
54 * @param p_expense_check_send_to_addres Mailing address.
55 * @param p_first_name First name.
56 * @param p_known_as Preferred name.
57 * @param p_marital_status Marital status. Valid values are defined by the
58 * MAR_STATUS lookup type.
59 * @param p_middle_names Middle names.
60 * @param p_nationality Nationality. Valid values are defined by the
61 * NATIONALITY lookup type.
62 * @param p_ni_number National Insurance number used to identify an employee in
63 * the format France.
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_date_of_death Date of death.
103 * @param p_maiden_name Maiden name
104 * @param p_department_of_birth Department of birth. Valid values exist in the
105 * 'FR_DEPARTMENT' lookup type.
106 * @param p_town_of_birth Town or city of birth.
107 * @param p_country_of_birth Country of birth.
108 * @param p_military_status Military status. Valid values are defined by the
109 * 'FR_MILITARY_SERVICE_STATUS' lookup type.
110 * @param p_date_last_school_certificate Date of last school certificate
111 * @param p_school_name School name
112 * @param p_level_of_education Level of education. Valid values exist in
113 * PER_QUALIFICATION_TYPES.
114 * @param p_date_first_entry_into_france Date of first entry into France
115 * @param p_cpam_name A valid CPAM organization name defined in your business
116 * group.
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_mailstop Internal mail location.
124 * @param p_office_number Office number.
125 * @param p_pre_name_adjunct First part of the last name.
126 * @param p_projected_start_date Obsolete parameter, do not use.
127 * @param p_resume_exists Flag indicating whether the person's resume is on
128 * file.
129 * @param p_resume_last_updated Date on which the resume was last updated.
130 * @param p_student_status If this employee is a student, this field is used to
131 * capture their status. Valid values are defined by the STUDENT_STATUS lookup
132 * type.
133 * @param p_work_schedule The days on which this person will work.
134 * @param p_suffix Suffix after the person's last name e.g. Sr., Jr., III.
135 * @param p_person_id If p_validate is false, then this uniquely identifies the
136 * person created. If p_validate is true, then set to null.
137 * @param p_assignment_id If p_validate is false, then this uniquely identifies
138 * the created assignment. If p_validate is true, then set to null.
139 * @param p_per_object_version_number If p_validate is false, then set to the
140 * version number of the created person. If p_validate is true, then set to
141 * null.
142 * @param p_asg_object_version_number If p_validate is false, then this
143 * parameter is set to the version number of the assignment created. If
144 * p_validate is true, then this parameter is null.
145 * @param p_per_effective_start_date If p_validate is false, then set to the
146 * earliest effective start date for the created person. If p_validate is true,
147 * then set to null.
148 * @param p_per_effective_end_date If p_validate is false, then set to the
149 * effective end date for the created person. If p_validate is true, then set
150 * to null.
151 * @param p_full_name If p_validate is false, then set to the complete full
152 * name of the person. If p_validate is true, then set to null.
153 * @param p_per_comment_id If p_validate is false and comment text was
154 * provided, then will be set to the identifier of the created person comment
155 * record. If p_validate is true or no comment text was provided, then will be
156 * null.
157 * @param p_assignment_sequence If p_validate is false, then set to the
158 * sequence number of the default assignment. If p_validate is true, then set
159 * to null.
160 * @param p_assignment_number If p_validate is false, then set to the
161 * assignment number of the default assignment. If p_validate is true, then set
162 * to null.
163 * @param p_name_combination_warning If set to true, then the combination of
164 * last name, first name and date of birth existed prior to calling this API.
165 * @param p_assign_payroll_warning If set to true, then the date of birth is
166 * not entered. If set to false, then the date of birth has been entered.
167 * Indicates if it will be possible to set the payroll on any of this person's
168 * assignments.
169 * @rep:displayname Create Employee for France
170 * @rep:category BUSINESS_ENTITY PER_EMPLOYEE
171 * @rep:scope public
172 * @rep:lifecycle active
173 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
174 */
175 --
176 -- {End Of Comments}
177 --
178 procedure create_fr_employee
179 (p_validate in boolean default false
180 ,p_hire_date in date
181 ,p_business_group_id in number
182 ,p_last_name in varchar2
183 ,p_sex in varchar2
184 ,p_person_type_id in number default null
185 ,p_comments in varchar2 default null
186 ,p_date_employee_data_verified in date default null
187 ,p_date_of_birth in date default null
188 ,p_email_address in varchar2 default null
189 ,p_employee_number in out nocopy varchar2
190 ,p_expense_check_send_to_addres in varchar2 default null
191 ,p_first_name in varchar2 default null
192 ,p_known_as in varchar2 default null
193 ,p_marital_status in varchar2 default null
194 ,p_middle_names in varchar2 default null
195 ,p_nationality in varchar2 default null
196 ,p_ni_number in varchar2 default null
197 ,p_previous_last_name in varchar2 default null
198 ,p_registered_disabled_flag in varchar2 default null
199 ,p_title in varchar2 default null
200 ,p_vendor_id in number default null
201 ,p_work_telephone in varchar2 default null
202 ,p_attribute_category in varchar2 default null
203 ,p_attribute1 in varchar2 default null
204 ,p_attribute2 in varchar2 default null
205 ,p_attribute3 in varchar2 default null
206 ,p_attribute4 in varchar2 default null
207 ,p_attribute5 in varchar2 default null
208 ,p_attribute6 in varchar2 default null
209 ,p_attribute7 in varchar2 default null
210 ,p_attribute8 in varchar2 default null
211 ,p_attribute9 in varchar2 default null
212 ,p_attribute10 in varchar2 default null
213 ,p_attribute11 in varchar2 default null
214 ,p_attribute12 in varchar2 default null
215 ,p_attribute13 in varchar2 default null
216 ,p_attribute14 in varchar2 default null
217 ,p_attribute15 in varchar2 default null
218 ,p_attribute16 in varchar2 default null
219 ,p_attribute17 in varchar2 default null
220 ,p_attribute18 in varchar2 default null
221 ,p_attribute19 in varchar2 default null
222 ,p_attribute20 in varchar2 default null
223 ,p_attribute21 in varchar2 default null
224 ,p_attribute22 in varchar2 default null
225 ,p_attribute23 in varchar2 default null
226 ,p_attribute24 in varchar2 default null
227 ,p_attribute25 in varchar2 default null
228 ,p_attribute26 in varchar2 default null
229 ,p_attribute27 in varchar2 default null
230 ,p_attribute28 in varchar2 default null
231 ,p_attribute29 in varchar2 default null
232 ,p_attribute30 in varchar2 default null
233 ,p_date_of_death in date default null
234 ,p_maiden_name in varchar2 default null
235 ,p_department_of_birth in varchar2 default null
236 ,p_town_of_birth in varchar2 default null
237 ,p_country_of_birth in varchar2 default null
238 ,p_military_status in varchar2 default null
239 ,p_date_last_school_certificate in varchar2 default null
240 ,p_school_name in varchar2 default null
241 ,p_level_of_education in varchar2 default null
242 ,p_date_first_entry_into_france in varchar2 default null
243 ,p_cpam_name in varchar2 default null
244 ,p_correspondence_language in varchar2 default null
245 ,p_fast_path_employee in varchar2 default null
246 ,p_fte_capacity in number default null
247 ,p_honors in varchar2 default null
248 ,p_internal_location in varchar2 default null
249 ,p_mailstop in varchar2 default null
250 ,p_office_number in varchar2 default null
251 ,p_pre_name_adjunct in varchar2 default null
252 ,p_projected_start_date in date default null
253 ,p_resume_exists in varchar2 default null
254 ,p_resume_last_updated in date default null
255 ,p_student_status in varchar2 default null
256 ,p_work_schedule in varchar2 default null
257 ,p_suffix in varchar2 default null
258 ,p_person_id out nocopy number
259 ,p_assignment_id out nocopy number
260 ,p_per_object_version_number out nocopy number
261 ,p_asg_object_version_number out nocopy number
262 ,p_per_effective_start_date out nocopy date
263 ,p_per_effective_end_date out nocopy date
264 ,p_full_name out nocopy varchar2
265 ,p_per_comment_id out nocopy number
266 ,p_assignment_sequence out nocopy number
267 ,p_assignment_number out nocopy varchar2
268 ,p_name_combination_warning out nocopy boolean
269 ,p_assign_payroll_warning out nocopy boolean
270 );
271 --
272 end hr_fr_employee_api;
[Home] [Help]