1 Package hr_fr_applicant_api AUTHID CURRENT_USER as
2 /* $Header: peappfri.pkh 120.1 2005/10/02 02:10:20 aroussel $ */
3 /*#
4 * This package contains an applicant API for France.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Applicant for France
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |---------------------------< create_fr_applicant >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a new applicant for France.
17 *
18 * A default primary assignment and an application for the applicant is
19 * created. The API calls the generic API create_applicant, with the parameters
20 * set as appropriate for the French applicant. Secure user functionality is
21 * not included in this version of the API. For further information see
22 * create_applicant API since this API is an alternative for that API.
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 with a legislation code of FR must be specified.
29 *
30 * <p><b>Post Success</b><br>
31 * The person, primary assignment and application are successfully created in
32 * the database.
33 *
34 * <p><b>Post Failure</b><br>
35 * The API does not create the applicant, default assignment or application and
36 * 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_date_received Date an application was received.
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 applicant being created.
45 * @param p_applicant_number The business group's applicant number generation
46 * method determines when the API derives and passes out an applicant number or
47 * when the calling program should pass in a value. When the API call completes
48 * if p_validate is true then will be set to the applicant number. If
49 * p_validate is true then will be set to the passed value.
50 * @param p_comments Person comment text.
51 * @param p_date_employee_data_verified Date on which the applicant data was
52 * last verified.
53 * @param p_date_of_birth Date of birth.
54 * @param p_email_address Email address.
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_ni_number National Insurance number used to identify an applicant
64 * in the format for France.
65 * @param p_previous_last_name Previous last name.
66 * @param p_registered_disabled_flag Flag indicating whether the person is
67 * classified as disabled.
68 * @param p_title Title. Valid values are defined by the TITLE lookup type.
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_maiden_name Maiden name
103 * @param p_department_of_birth Department of birth. Valid values are defined
104 * by the 'FR_DEPARTMENT' lookup type.
105 * @param p_town_of_birth Town or city of birth.
106 * @param p_country_of_birth Country of birth. Valid values are defined by
107 * values in FND_TERRITORIES.
108 * @param p_number_of_dependents Number of dependents
109 * @param p_military_status Military status. Valid values are defined by the
110 * 'FR_MILITARY_SERVICE_STATUS' lookup type.
111 * @param p_date_last_school_certificate Date of last school certificate
112 * @param p_school_name School name
113 * @param p_level_of_education Level of education. Valid values exist in
114 * PER_QUALIFICATION_TYPES.
115 * @param p_date_first_entry_into_france Date of first entry into France
116 * @param p_cpam_name A valid CPAM organization name defined in your business
117 * group.
118 * @param p_correspondence_language Preferred language for correspondence.
119 * @param p_fte_capacity Obsolete parameter, do not use.
120 * @param p_hold_applicant_date_until Date until when the applicant's
121 * information is to be maintained.
122 * @param p_honors Honors awarded.
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 applicant is a student, this field is used
131 * to capture their status. Valid values are defined by the STUDENT_STATUS
132 * lookup type.
133 * @param p_work_schedule 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_date_of_death Date of death.
136 * @param p_person_id If p_validate is false, then this uniquely identifies the
137 * person created. If p_validate is true, then set to null.
138 * @param p_assignment_id If p_validate is false, then this uniquely identifies
139 * the created assignment. If p_validate is true, then set to null.
140 * @param p_application_id If p_validate is false, then this uniquely
141 * identifies the application created. If p_validate is true, then set to null.
142 * @param p_per_object_version_number If p_validate is false, then set to the
143 * version number of the created person. If p_validate is true, then set to
144 * null.
145 * @param p_asg_object_version_number If p_validate is false, then this
146 * parameter is set to the version number of the assignment created. If
147 * p_validate is true, then this parameter is null.
148 * @param p_apl_object_version_number If p_validate is false, then set to the
149 * version number of the created application. If p_validate is true, then set
150 * to null.
151 * @param p_per_effective_start_date If p_validate is false, then set to the
152 * earliest effective start date for the created person. If p_validate is true,
153 * then set to null.
154 * @param p_per_effective_end_date If p_validate is false, then set to the
155 * effective end date for the created person. If p_validate is true, then set
156 * to null.
157 * @param p_full_name If p_validate is false, then set to the complete full
158 * name of the person. If p_validate is true, then set to null.
159 * @param p_per_comment_id If p_validate is false and comment text was
160 * provided, then will be set to the identifier of the created person comment
161 * record. If p_validate is true or no comment text was provided, then will be
162 * null.
163 * @param p_assignment_sequence If p_validate is false, then set to the
164 * sequence number of the default assignment. If p_validate is true, then set
165 * to null.
166 * @param p_name_combination_warning If set to true, then the combination of
167 * last name, first name and date of birth existed prior to calling this API.
168 * @rep:displayname Create Applicant for France
169 * @rep:category BUSINESS_ENTITY PER_APPLICANT
170 * @rep:scope public
171 * @rep:lifecycle active
172 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
173 */
174 --
175 -- {End Of Comments}
176 --
177 procedure create_fr_applicant
178 (p_validate in boolean default false
179 ,p_date_received in date
180 ,p_business_group_id in number
181 ,p_last_name in varchar2
182 ,p_sex in varchar2 default null
183 ,p_person_type_id in number default null
184 ,p_applicant_number in out nocopy varchar2
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_expense_check_send_to_addres in varchar2 default null
190 ,p_first_name in varchar2 default null
191 ,p_known_as in varchar2 default null
192 ,p_marital_status in varchar2 default null
193 ,p_middle_names in varchar2 default null
194 ,p_nationality in varchar2 default null
195 ,p_ni_number in varchar2 default null
196 ,p_previous_last_name in varchar2 default null
197 ,p_registered_disabled_flag in varchar2 default null
198 ,p_title in varchar2 default null
199 ,p_work_telephone in varchar2 default null
200 ,p_attribute_category in varchar2 default null
201 ,p_attribute1 in varchar2 default null
202 ,p_attribute2 in varchar2 default null
203 ,p_attribute3 in varchar2 default null
204 ,p_attribute4 in varchar2 default null
205 ,p_attribute5 in varchar2 default null
206 ,p_attribute6 in varchar2 default null
207 ,p_attribute7 in varchar2 default null
208 ,p_attribute8 in varchar2 default null
209 ,p_attribute9 in varchar2 default null
210 ,p_attribute10 in varchar2 default null
211 ,p_attribute11 in varchar2 default null
212 ,p_attribute12 in varchar2 default null
213 ,p_attribute13 in varchar2 default null
214 ,p_attribute14 in varchar2 default null
215 ,p_attribute15 in varchar2 default null
216 ,p_attribute16 in varchar2 default null
217 ,p_attribute17 in varchar2 default null
218 ,p_attribute18 in varchar2 default null
219 ,p_attribute19 in varchar2 default null
220 ,p_attribute20 in varchar2 default null
221 ,p_attribute21 in varchar2 default null
222 ,p_attribute22 in varchar2 default null
223 ,p_attribute23 in varchar2 default null
224 ,p_attribute24 in varchar2 default null
225 ,p_attribute25 in varchar2 default null
226 ,p_attribute26 in varchar2 default null
227 ,p_attribute27 in varchar2 default null
228 ,p_attribute28 in varchar2 default null
229 ,p_attribute29 in varchar2 default null
230 ,p_attribute30 in varchar2 default null
231 ,p_maiden_name in varchar2 default null
232 ,p_department_of_birth in varchar2 default null
233 ,p_town_of_birth in varchar2 default null
234 ,p_country_of_birth in varchar2 default null
235 ,p_number_of_dependents in varchar2 default null
236 ,p_military_status in varchar2 default null
237 ,p_date_last_school_certificate in varchar2 default null
238 ,p_school_name in varchar2 default null
239 ,p_level_of_education in varchar2 default null
240 ,p_date_first_entry_into_france in varchar2 default null
241 ,p_cpam_name in varchar2 default null
242 ,p_correspondence_language in varchar2 default null
243 ,p_fte_capacity in number default null
244 ,p_hold_applicant_date_until in date default null
245 ,p_honors in varchar2 default null
246 ,p_mailstop in varchar2 default null
247 ,p_office_number in varchar2 default null
248 ,p_pre_name_adjunct in varchar2 default null
249 ,p_projected_start_date in date default null
250 ,p_resume_exists in varchar2 default null
251 ,p_resume_last_updated in date default null
252 ,p_student_status in varchar2 default null
253 ,p_work_schedule in varchar2 default null
254 ,p_suffix in varchar2 default null
255 ,p_date_of_death in date default null
256 ,p_person_id out nocopy number
257 ,p_assignment_id out nocopy number
258 ,p_application_id out nocopy number
259 ,p_per_object_version_number out nocopy number
260 ,p_asg_object_version_number out nocopy number
261 ,p_apl_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_name_combination_warning out nocopy boolean
268 );
269 --
270 end hr_fr_applicant_api;