DBA Data[Home] [Help]

PACKAGE: APPS.HR_ES_PERSON_API

Source


1 Package hr_es_person_api as
2 /* $Header: peperesi.pkh 120.1 2005/10/02 02:20:48 aroussel $ */
3 /*#
4  * This package contains update person APIs for Spain.
5  * @rep:scope public
6  * @rep:product per
7  * @rep:displayname Update Person for Spain
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-----------------------------< update_es_person >-------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16  * This API updates a person record for Spain.
17  *
18  * The API calls the generic API update_person, with the parameters set as
19  * appropriate for a Spanish employee. See the API update_person for a further
20  * explanation.
21  *
22  * <p><b>Licensing</b><br>
23  * This API is licensed for use with Human Resources.
24  *
25  * <p><b>Prerequisites</b><br>
26  * The person record, identified by p_person_id and p_object_version_number,
27  * must already exist.
28  *
29  * <p><b>Post Success</b><br>
30  * Person's record is updated successfully.
31  *
32  * <p><b>Post Failure</b><br>
33  * Person's record is not updated and an error message is generated.
34  * @param p_validate If true, then validation alone will be performed and the
35  * database will remain unchanged. If false and all validation checks pass,
36  * then the database will be modified.
37  * @param p_effective_date Determines when the DateTrack operation comes into
38  * force.
39  * @param p_datetrack_update_mode Indicates which DateTrack mode to use when
40  * updating the record. You must set to either UPDATE, CORRECTION,
41  * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
42  * particular record depend on the dates of previous record changes and the
43  * effective date of this change.
44  * @param p_person_id Identifies the person record to modify.
45  * @param p_object_version_number Pass in the current version number of the
46  * person to be updated. When the API completes if p_validate is false, will be
47  * set to the new version number of the updated person. If p_validate is true
48  * will be set to the same value which was passed in.
49  * @param p_person_type_id Type of person being updated.
50  * @param p_first_last_name Person's first last name.
51  * @param p_applicant_number The business group's applicant number generation
52  * method determines when the API derives and passes out an applicant number or
53  * when the calling program should pass in a value. When the API call completes
54  * if p_validate is true then will be set to the applicant number. If
55  * p_validate is true then will be set to the passed value.
56  * @param p_comments Comment text.
57  * @param p_date_employee_data_verified The date on which the person data was
58  * last verified.
59  * @param p_date_of_birth Date of birth.
60  * @param p_email_address Email address.
61  * @param p_employee_number The business group's employee number generation
62  * method determines when you can update the employee value. To keep the
63  * existing employee number pass in hr_api.g_varchar2. When the API call
64  * completes if p_validate is false then will be set to the employee number. If
65  * p_validate is true then will be set to the passed value.
66  * @param p_expense_check_send_to_addres Mailing address.
67  * @param p_name First Name
68  * @param p_preferred_name Preferred Name
69  * @param p_marital_status Marital status. Valid values are defined by the
70  * MAR_STATUS lookup type.
71  * @param p_middle_names Middle names.
72  * @param p_nationality Nationality. Valid values are defined by the
73  * NATIONALITY lookup type.
74  * @param p_nif_value National Identifier
75  * @param p_maiden_name Previous last name
76  * @param p_registered_disabled_flag Flag indicating whether the person is
77  * classified as disabled.
78  * @param p_sex Legal gender. Valid values are defined by the SEX lookup type.
79  * @param p_title Title. Valid values are defined by the TITLE lookup type.
80  * @param p_vendor_id Obsolete parameter, do not use.
81  * @param p_work_telephone Obsolete parameter, do not use.
82  * @param p_attribute_category This context value determines which flexfield
83  * structure to use with the descriptive flexfield segments.
84  * @param p_attribute1 Descriptive flexfield segment.
85  * @param p_attribute2 Descriptive flexfield segment.
86  * @param p_attribute3 Descriptive flexfield segment.
87  * @param p_attribute4 Descriptive flexfield segment.
88  * @param p_attribute5 Descriptive flexfield segment.
89  * @param p_attribute6 Descriptive flexfield segment.
90  * @param p_attribute7 Descriptive flexfield segment.
91  * @param p_attribute8 Descriptive flexfield segment.
92  * @param p_attribute9 Descriptive flexfield segment.
93  * @param p_attribute10 Descriptive flexfield segment.
94  * @param p_attribute11 Descriptive flexfield segment.
95  * @param p_attribute12 Descriptive flexfield segment.
96  * @param p_attribute13 Descriptive flexfield segment.
97  * @param p_attribute14 Descriptive flexfield segment.
98  * @param p_attribute15 Descriptive flexfield segment.
99  * @param p_attribute16 Descriptive flexfield segment.
100  * @param p_attribute17 Descriptive flexfield segment.
101  * @param p_attribute18 Descriptive flexfield segment.
102  * @param p_attribute19 Descriptive flexfield segment.
103  * @param p_attribute20 Descriptive flexfield segment.
104  * @param p_attribute21 Descriptive flexfield segment.
105  * @param p_attribute22 Descriptive flexfield segment.
106  * @param p_attribute23 Descriptive flexfield segment.
107  * @param p_attribute24 Descriptive flexfield segment.
108  * @param p_attribute25 Descriptive flexfield segment.
109  * @param p_attribute26 Descriptive flexfield segment.
110  * @param p_attribute27 Descriptive flexfield segment.
111  * @param p_attribute28 Descriptive flexfield segment.
112  * @param p_attribute29 Descriptive flexfield segment.
113  * @param p_attribute30 Descriptive flexfield segment.
114  * @param p_per_information_category Obsolete parameter, do not use.
115  * @param p_second_last_name Second last name
116  * @param p_identifier_type Alternative to National Identifier. Valid values
117  * exist in the 'ES_IDENTIFIER_TYPE' lookup type.
118  * @param p_identifier_value Identifier type value
119  * @param p_overtime_approval Under 18 overtime approval flag. Valid values
120  * exist in the 'YES_NO' lookup type.
121  * @param p_per_information5 Developer descriptive flexfield segment.
122  * @param p_per_information6 Developer descriptive flexfield segment.
123  * @param p_per_information7 Developer descriptive flexfield segment.
124  * @param p_per_information8 Developer descriptive flexfield segment.
125  * @param p_per_information9 Developer descriptive flexfield segment.
126  * @param p_per_information10 Developer descriptive flexfield segment.
127  * @param p_per_information11 Developer descriptive flexfield segment.
128  * @param p_per_information12 Developer descriptive flexfield segment.
129  * @param p_per_information13 Developer descriptive flexfield segment.
130  * @param p_per_information14 Developer descriptive flexfield segment.
131  * @param p_per_information15 Developer descriptive flexfield segment.
132  * @param p_per_information16 Developer descriptive flexfield segment.
133  * @param p_per_information17 Developer descriptive flexfield segment.
134  * @param p_per_information18 Developer descriptive flexfield segment.
135  * @param p_per_information19 Developer descriptive flexfield segment.
136  * @param p_per_information20 Developer descriptive flexfield segment.
137  * @param p_per_information21 Developer descriptive flexfield segment.
138  * @param p_per_information22 Developer descriptive flexfield segment.
139  * @param p_per_information23 Developer descriptive flexfield segment.
140  * @param p_per_information24 Developer descriptive flexfield segment.
141  * @param p_per_information25 Developer descriptive flexfield segment.
142  * @param p_per_information26 Developer descriptive flexfield segment.
143  * @param p_per_information27 Developer descriptive flexfield segment.
144  * @param p_per_information28 Developer descriptive flexfield segment.
145  * @param p_per_information29 Developer descriptive flexfield segment.
146  * @param p_per_information30 Developer descriptive flexfield segment.
147  * @param p_date_of_death Date of death.
148  * @param p_background_check_status Flag indicating whether the person's
149  * background has been checked.
150  * @param p_background_date_check Date on which the background check was
151  * performed.
152  * @param p_blood_type Blood type.
153  * @param p_correspondence_language Preferred language for correspondence.
154  * @param p_fast_path_employee Obsolete parameter, do not use.
155  * @param p_fte_capacity Obsolete parameter, do not use.
156  * @param p_hold_applicant_date_until Date until when the applicant's
157  * information is to be maintained.
158  * @param p_honors Honors awarded.
159  * @param p_internal_location Internal location of office.
160  * @param p_last_medical_test_by Name of physician who performed the last
161  * medical test.
162  * @param p_last_medical_test_date Date of last medical test.
163  * @param p_mailstop Internal mail location.
164  * @param p_office_number Office number.
165  * @param p_on_military_service Flag indicating whether the person is on
166  * military service.
167  * @param p_prefix Person's name prefix.
168  * @param p_projected_start_date Obsolete parameter, do not use.
169  * @param p_rehire_authorizor Obsolete parameter, do not use.
170  * @param p_rehire_recommendation Flag indicating whether this person should be
171  * considered for rehire. Valid values are defined in YES_NO lookup type.
172  * @param p_resume_exists Flag indicating whether the person's resume is on
173  * file.
174  * @param p_resume_last_updated Date on which the resume was last updated.
175  * @param p_second_passport_exists Flag indicating whether a person has
176  * multiple passports.
177  * @param p_student_status If this person is a student, this field is used to
178  * capture their status. Valid values are defined by the STUDENT_STATUS lookup
179  * type.
180  * @param p_work_schedule Days on which this person will work.
181  * @param p_rehire_reason Rehire reason.
182  * @param p_suffix Suffix after the person's last name e.g. Sr., Jr., III.
183  * @param p_benefit_group_id Benefit group to which this person will belong.
184  * @param p_receipt_of_death_cert_date Date death certificate was received.
185  * @param p_coord_ben_med_pln_no Secondary medical plan name. Column used for
186  * external processing.
187  * @param p_coord_ben_no_cvg_flag No secondary medical plan coverage. Column
188  * used for external processing.
189  * @param p_coord_ben_med_ext_er Secondary external medical coverage. Column
190  * used for external processing.
191  * @param p_coord_ben_med_pl_name Secondary medical coverage name. Column used
192  * for external processing.
193  * @param p_coord_ben_med_insr_crr_name Secondary medical coverage insurance
194  * carrier name. Column used for external processing.
195  * @param p_coord_ben_med_insr_crr_ident Secondary medical coverage insurance
196  * carrier identifier. Column used for external processing.
197  * @param p_coord_ben_med_cvg_strt_dt Secondary medical coverage effective
198  * start date. Column used for external processing.
199  * @param p_coord_ben_med_cvg_end_dt Secondary medical coverage effective end
200  * date. Column used for external processing.
201  * @param p_uses_tobacco_flag Flag indicating whether the person uses tobacco.
202  * @param p_dpdnt_adoption_date Date on which the dependent was adopted.
203  * @param p_dpdnt_vlntry_svce_flag Flag indicating whether the dependent is on
204  * voluntary service.
205  * @param p_original_date_of_hire Original date of hire.
206  * @param p_adjusted_svc_date Adjusted service date.
207  * @param p_town_of_birth Town or city of birth.
208  * @param p_region_of_birth Geographical region of birth.
209  * @param p_country_of_birth Country of birth.
210  * @param p_global_person_id Obsolete parameter, do not use.
211  * @param p_party_id TCA party for whom you are modifying the person record.
212  * @param p_npw_number The business group's contingent worker number generation
213  * method determines when the API derives and passes out a contingent worker
214  * number or when the calling program should pass in a value. When the API call
215  * completes if p_validate is true then will be set to the contingent worker
216  * number. If p_validate is true then will be set to the passed value.
217  * @param p_effective_start_date If p_validate is false, then set to the
218  * effective start date on the updated person row which now exists as of the
219  * effective date. If p_validate is true, then set to null.
220  * @param p_effective_end_date If p_validate is false, then set to the
221  * effective end date on the updated person row which now exists as of the
222  * effective date. If p_validate is true, then set to null.
223  * @param p_full_name If p_validate is false, then set to the complete full
224  * name of the person. If p_validate is true, then set to null.
225  * @param p_comment_id Comment text.
226  * @param p_name_combination_warning If set to true, then the combination of
227  * last name, first name and date of birth existed prior to calling this API.
228  * @param p_assign_payroll_warning If set to true, then the date of birth is
229  * not entered. If set to false, then the date of birth has been entered.
230  * Indicates if it will be possible to set the payroll on any of this person's
231  * assignments.
232  * @param p_orig_hire_warning If set to true, an orginal date of hire exists
233  * for a person who has never been an employee.
234  * @rep:displayname Update Person for Spain
235  * @rep:category BUSINESS_ENTITY HR_PERSON
236  * @rep:scope public
237  * @rep:lifecycle active
238  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
239 */
240 --
241 -- {End Of Comments}
242 --
243 procedure update_es_person
244   (p_validate                     in      boolean   default false
245   ,p_effective_date               in      date
246   ,p_datetrack_update_mode        in      varchar2
247   ,p_person_id                    in      number
248   ,p_object_version_number        in out nocopy  number
249   ,p_person_type_id               in      number   default hr_api.g_number
250   ,p_first_last_name              in      varchar2 default hr_api.g_varchar2
251   ,p_applicant_number             in      varchar2 default hr_api.g_varchar2
252   ,p_comments                     in      varchar2 default hr_api.g_varchar2
253   ,p_date_employee_data_verified  in      date     default hr_api.g_date
254   ,p_date_of_birth                in      date     default hr_api.g_date
255   ,p_email_address                in      varchar2 default hr_api.g_varchar2
256   ,p_employee_number              in out nocopy  varchar2
257   ,p_expense_check_send_to_addres in      varchar2 default hr_api.g_varchar2
258   ,p_name                         in      varchar2 default hr_api.g_varchar2
259   ,p_preferred_name               in      varchar2 default hr_api.g_varchar2
260   ,p_marital_status               in      varchar2 default hr_api.g_varchar2
261   ,p_middle_names                 in      varchar2 default hr_api.g_varchar2
262   ,p_nationality                  in      varchar2 default hr_api.g_varchar2
263   ,p_nif_value                    in      varchar2 default hr_api.g_varchar2
264   ,p_maiden_name                  in      varchar2 default hr_api.g_varchar2
265   ,p_registered_disabled_flag     in      varchar2 default hr_api.g_varchar2
266   ,p_sex                          in      varchar2 default hr_api.g_varchar2
267   ,p_title                        in      varchar2 default hr_api.g_varchar2
268   ,p_vendor_id                    in      number   default hr_api.g_number
269   ,p_work_telephone               in      varchar2 default hr_api.g_varchar2
270   ,p_attribute_category           in      varchar2 default hr_api.g_varchar2
271   ,p_attribute1                   in      varchar2 default hr_api.g_varchar2
272   ,p_attribute2                   in      varchar2 default hr_api.g_varchar2
273   ,p_attribute3                   in      varchar2 default hr_api.g_varchar2
274   ,p_attribute4                   in      varchar2 default hr_api.g_varchar2
275   ,p_attribute5                   in      varchar2 default hr_api.g_varchar2
276   ,p_attribute6                   in      varchar2 default hr_api.g_varchar2
277   ,p_attribute7                   in      varchar2 default hr_api.g_varchar2
278   ,p_attribute8                   in      varchar2 default hr_api.g_varchar2
279   ,p_attribute9                   in      varchar2 default hr_api.g_varchar2
280   ,p_attribute10                  in      varchar2 default hr_api.g_varchar2
281   ,p_attribute11                  in      varchar2 default hr_api.g_varchar2
282   ,p_attribute12                  in      varchar2 default hr_api.g_varchar2
283   ,p_attribute13                  in      varchar2 default hr_api.g_varchar2
284   ,p_attribute14                  in      varchar2 default hr_api.g_varchar2
285   ,p_attribute15                  in      varchar2 default hr_api.g_varchar2
286   ,p_attribute16                  in      varchar2 default hr_api.g_varchar2
290   ,p_attribute20                  in      varchar2 default hr_api.g_varchar2
287   ,p_attribute17                  in      varchar2 default hr_api.g_varchar2
288   ,p_attribute18                  in      varchar2 default hr_api.g_varchar2
289   ,p_attribute19                  in      varchar2 default hr_api.g_varchar2
291   ,p_attribute21                  in      varchar2 default hr_api.g_varchar2
292   ,p_attribute22                  in      varchar2 default hr_api.g_varchar2
293   ,p_attribute23                  in      varchar2 default hr_api.g_varchar2
294   ,p_attribute24                  in      varchar2 default hr_api.g_varchar2
295   ,p_attribute25                  in      varchar2 default hr_api.g_varchar2
296   ,p_attribute26                  in      varchar2 default hr_api.g_varchar2
297   ,p_attribute27                  in      varchar2 default hr_api.g_varchar2
298   ,p_attribute28                  in      varchar2 default hr_api.g_varchar2
299   ,p_attribute29                  in      varchar2 default hr_api.g_varchar2
300   ,p_attribute30                  in      varchar2 default hr_api.g_varchar2
301   ,p_per_information_category     in      varchar2 default hr_api.g_varchar2
302   ,p_second_last_name             in      varchar2 default hr_api.g_varchar2
303   ,p_identifier_type              in      varchar2 default hr_api.g_varchar2
304   ,p_identifier_value             in      varchar2 default hr_api.g_varchar2
305   ,p_overtime_approval            in      varchar2 default hr_api.g_varchar2
306   ,p_per_information5             in      varchar2 default hr_api.g_varchar2
307   ,p_per_information6             in      varchar2 default hr_api.g_varchar2
308   ,p_per_information7             in      varchar2 default hr_api.g_varchar2
309   ,p_per_information8             in      varchar2 default hr_api.g_varchar2
310   ,p_per_information9             in      varchar2 default hr_api.g_varchar2
311   ,p_per_information10            in      varchar2 default hr_api.g_varchar2
312   ,p_per_information11            in      varchar2 default hr_api.g_varchar2
313   ,p_per_information12            in      varchar2 default hr_api.g_varchar2
314   ,p_per_information13            in      varchar2 default hr_api.g_varchar2
315   ,p_per_information14            in      varchar2 default hr_api.g_varchar2
316   ,p_per_information15            in      varchar2 default hr_api.g_varchar2
317   ,p_per_information16            in      varchar2 default hr_api.g_varchar2
318   ,p_per_information17            in      varchar2 default hr_api.g_varchar2
319   ,p_per_information18            in      varchar2 default hr_api.g_varchar2
320   ,p_per_information19            in      varchar2 default hr_api.g_varchar2
321   ,p_per_information20            in      varchar2 default hr_api.g_varchar2
322   ,p_per_information21            in      varchar2 default hr_api.g_varchar2
323   ,p_per_information22            in      varchar2 default hr_api.g_varchar2
324   ,p_per_information23            in      varchar2 default hr_api.g_varchar2
325   ,p_per_information24            in      varchar2 default hr_api.g_varchar2
326   ,p_per_information25            in      varchar2 default hr_api.g_varchar2
327   ,p_per_information26            in      varchar2 default hr_api.g_varchar2
328   ,p_per_information27            in      varchar2 default hr_api.g_varchar2
329   ,p_per_information28            in      varchar2 default hr_api.g_varchar2
330   ,p_per_information29            in      varchar2 default hr_api.g_varchar2
331   ,p_per_information30            in      varchar2 default hr_api.g_varchar2
332   ,p_date_of_death                in      date     default hr_api.g_date
333   ,p_background_check_status      in      varchar2 default hr_api.g_varchar2
334   ,p_background_date_check        in      date     default hr_api.g_date
335   ,p_blood_type                   in      varchar2 default hr_api.g_varchar2
336   ,p_correspondence_language      in      varchar2 default hr_api.g_varchar2
337   ,p_fast_path_employee           in      varchar2 default hr_api.g_varchar2
338   ,p_fte_capacity                 in      number   default hr_api.g_number
339   ,p_hold_applicant_date_until    in      date     default hr_api.g_date
340   ,p_honors                       in      varchar2 default hr_api.g_varchar2
341   ,p_internal_location            in      varchar2 default hr_api.g_varchar2
342   ,p_last_medical_test_by         in      varchar2 default hr_api.g_varchar2
343   ,p_last_medical_test_date       in      date     default hr_api.g_date
344   ,p_mailstop                     in      varchar2 default hr_api.g_varchar2
345   ,p_office_number                in      varchar2 default hr_api.g_varchar2
346   ,p_on_military_service          in      varchar2 default hr_api.g_varchar2
347   ,p_prefix                       in      varchar2 default hr_api.g_varchar2
348   ,p_projected_start_date         in      date     default hr_api.g_date
349   ,p_rehire_authorizor            in      varchar2 default hr_api.g_varchar2
350   ,p_rehire_recommendation        in      varchar2 default hr_api.g_varchar2
351   ,p_resume_exists                in      varchar2 default hr_api.g_varchar2
352   ,p_resume_last_updated          in      date     default hr_api.g_date
353   ,p_second_passport_exists       in      varchar2 default hr_api.g_varchar2
354   ,p_student_status               in      varchar2 default hr_api.g_varchar2
355   ,p_work_schedule                in      varchar2 default hr_api.g_varchar2
356   ,p_rehire_reason                in      varchar2 default hr_api.g_varchar2
357   ,p_suffix                       in      varchar2 default hr_api.g_varchar2
358   ,p_benefit_group_id             in      number   default hr_api.g_number
359   ,p_receipt_of_death_cert_date   in      date     default hr_api.g_date
360   ,p_coord_ben_med_pln_no         in      varchar2 default hr_api.g_varchar2
361   ,p_coord_ben_no_cvg_flag        in      varchar2 default hr_api.g_varchar2
364   ,p_coord_ben_med_insr_crr_name  in      varchar2 default hr_api.g_varchar2
365   ,p_coord_ben_med_insr_crr_ident in      varchar2 default hr_api.g_varchar2
366   ,p_coord_ben_med_cvg_strt_dt    in      date     default hr_api.g_date
367   ,p_coord_ben_med_cvg_end_dt     in      date     default hr_api.g_date
368   ,p_uses_tobacco_flag            in      varchar2 default hr_api.g_varchar2
369   ,p_dpdnt_adoption_date          in      date     default hr_api.g_date
370   ,p_dpdnt_vlntry_svce_flag       in      varchar2 default hr_api.g_varchar2
371   ,p_original_date_of_hire        in      date     default hr_api.g_date
372   ,p_adjusted_svc_date            in      date     default hr_api.g_date
373   ,p_town_of_birth                in      varchar2 default hr_api.g_varchar2
374   ,p_region_of_birth              in      varchar2 default hr_api.g_varchar2
375   ,p_country_of_birth             in      varchar2 default hr_api.g_varchar2
376   ,p_global_person_id             in      varchar2 default hr_api.g_varchar2
377   ,p_party_id                     in      number   default hr_api.g_number
378   ,p_npw_number                   in      varchar2 default hr_api.g_varchar2
379   ,p_effective_start_date         out nocopy     date
380   ,p_effective_end_date           out nocopy     date
381   ,p_full_name                    out nocopy     varchar2
382   ,p_comment_id                   out nocopy     number
383   ,p_name_combination_warning     out nocopy     boolean
384   ,p_assign_payroll_warning       out nocopy     boolean
385   ,p_orig_hire_warning            out nocopy     boolean
386   );
387 
388 END hr_es_person_api;
363   ,p_coord_ben_med_pl_name        in      varchar2 default hr_api.g_varchar2
362   ,p_coord_ben_med_ext_er         in      varchar2 default hr_api.g_varchar2