DBA Data[Home] [Help]

PACKAGE: APPS.HR_MX_PERSON_API

Source


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