DBA Data[Home] [Help]

PACKAGE: APPS.HR_KW_PERSON_API

Source


1 package hr_kw_person_api as
2 /* $Header: peperkwi.pkh 120.2 2005/10/02 02:44:21 aroussel $ */
3 /*#
4  * This package contains Person APIs for Kuwait.
5  * @rep:scope public
6  * @rep:product PER
7  * @rep:displayname Person for Kuwait
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-----------------------------< update_kw_person >-------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16  * The following procedure updates a Kuwaiti person.
17  *
18  * This API updates the person record as identified by p_person_id and
19  * p_object_version_number. Note: The business group must have the KW
20  * legislation code.
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  * No known prerequisites.
27  *
28  * <p><b>Post Success</b><br>
29  * The person will have been updated.
30  *
31  * <p><b>Post Failure</b><br>
32  * The API does not update the person and raises an error.
33  *
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 The effective date for this change.
38  * @param p_datetrack_update_mode Indicates which DateTrack mode to use when
39  * updating the record. You must set to either UPDATE, CORRECTION,
40  * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
41  * particular record depend on the dates of previous record changes and the
42  * effective date of this change.
43  * @param p_person_id Identifies the person record to modify.
44  * @param p_object_version_number Must already exist to run the procedure. If
45  * p_validate is false, set to the new version number of the updated person
46  * record. If p_validate is true set to the same value you passed in.
47  * @param p_person_type_id Person type ID. Person type changes are separately
48  * maintained in per_person_type_usages_f table. So a composite person type is
49  * not allowed as input unless it is the same as the type the person is holding
50  * on p_effective_date.
51  * @param p_family_name Last name.
52  * @param p_applicant_number Applicant number.
53  * @param p_comments Comment text.
54  * @param p_date_employee_data_verified Date when the employee data was last
55  * verified.
56  * @param p_date_of_birth Date of birth.
57  * @param p_email_address Email address.
58  * @param p_employee_number Employee number.
59  * @param p_expense_check_send_to_addres Mailing address.
60  * @param p_first_name First name.
61  * @param p_known_as Known as.
62  * @param p_marital_status Marital status.
63  * @param p_nationality Nationality.
64  * @param p_national_identifier National identifier.
65  * @param p_previous_last_name Previous last name.
66  * @param p_registered_disabled_flag Registered disabled flag.
67  * @param p_sex Gender.
68  * @param p_title Title.
69  * @param p_vendor_id Foreign key to PO_VENDORS.
70  * @param p_work_telephone Work telephone.
71  * @param p_attribute_category This context value determines which flexfield
72  * structure to use with the descriptive flexfield segments.
73  * @param p_attribute1 Descriptive flexfield segment.
74  * @param p_attribute2 Descriptive flexfield segment.
75  * @param p_attribute3 Descriptive flexfield segment.
76  * @param p_attribute4 Descriptive flexfield segment.
77  * @param p_attribute5 Descriptive flexfield segment.
78  * @param p_attribute6 Descriptive flexfield segment.
79  * @param p_attribute7 Descriptive flexfield segment.
80  * @param p_attribute8 Descriptive flexfield segment.
81  * @param p_attribute9 Descriptive flexfield segment.
82  * @param p_attribute10 Descriptive flexfield segment.
83  * @param p_attribute11 Descriptive flexfield segment.
84  * @param p_attribute12 Descriptive flexfield segment.
85  * @param p_attribute13 Descriptive flexfield segment.
86  * @param p_attribute14 Descriptive flexfield segment.
87  * @param p_attribute15 Descriptive flexfield segment.
88  * @param p_attribute16 Descriptive flexfield segment.
89  * @param p_attribute17 Descriptive flexfield segment.
90  * @param p_attribute18 Descriptive flexfield segment.
91  * @param p_attribute19 Descriptive flexfield segment.
92  * @param p_attribute20 Descriptive flexfield segment.
93  * @param p_attribute21 Descriptive flexfield segment.
94  * @param p_attribute22 Descriptive flexfield segment.
95  * @param p_attribute23 Descriptive flexfield segment.
96  * @param p_attribute24 Descriptive flexfield segment.
97  * @param p_attribute25 Descriptive flexfield segment.
98  * @param p_attribute26 Descriptive flexfield segment.
99  * @param p_attribute27 Descriptive flexfield segment.
100  * @param p_attribute28 Descriptive flexfield segment.
101  * @param p_attribute29 Descriptive flexfield segment.
102  * @param p_attribute30 Descriptive flexfield segment.
103  * @param p_father_name Father's Name.
104  * @param p_grandfather_name Grandfather's Name.
105  * @param p_alt_first_name Alternate first name.
106  * @param p_alt_father_name Father's alternate name.
107  * @param p_alt_grandfather_name Grandfather's alternate name.
108  * @param p_alt_family_name Alternate family name.
109  * @param p_previous_nationality Previous Nationality.
110  * @param p_religion Religion.
111  * @param p_date_of_death Currently unsupported.
112  * @param p_background_check_status Background check status.
113  * @param p_background_date_check Background date check.
114  * @param p_blood_type Blood group.
115  * @param p_correspondence_language Language for correspondence.
116  * @param p_fast_path_employee Currently unsupported.
117  * @param p_fte_capacity Full-time employment capacity.
118  * @param p_hold_applicant_date_until Hold applicant until.
119  * @param p_honors Honors.
120  * @param p_internal_location Internal location.
121  * @param p_last_medical_test_by Last medical test by.
122  * @param p_last_medical_test_date Last medical test date.
123  * @param p_mailstop Internal mail location.
124  * @param p_office_number Office number.
125  * @param p_on_military_service On military service.
126  * @param p_projected_start_date Currently unsupported.
127  * @param p_rehire_authorizor Currently unsupported.
128  * @param p_rehire_recommendation Re-hire recommendation.
129  * @param p_resume_exists Resume exists.
130  * @param p_resume_last_updated Date resume last updated.
131  * @param p_second_passport_exists Second passport available flag.
132  * @param p_student_status Student status.
133  * @param p_work_schedule Work schedule.
134  * @param p_rehire_reason Reason for re-hiring.
135  * @param p_benefit_group_id Id for benefit group.
136  * @param p_receipt_of_death_cert_date Date death certificate was received.
137  * @param p_coord_ben_med_pln_no Number of an externally provided medical plan.
138  * @param p_coord_ben_no_cvg_flag No other coverage flag.
139  * @param p_coord_ben_med_ext_er Secondary medical coverage external employer.
140  * @param p_coord_ben_med_pl_name Secondary medical coverage name.
141  * @param p_coord_ben_med_insr_crr_name Secondary medical coverage insurance
142  * carrier.
143  * @param p_coord_ben_med_insr_crr_ident Secondary medical coverage insurance
144  * carrier id.
145  * @param p_coord_ben_med_cvg_strt_dt Secondary medical coverage effective
146  * start date.
147  * @param p_coord_ben_med_cvg_end_dt Secondary medical coverage effective end
148  * date.
149  * @param p_uses_tobacco_flag Uses tobacco flag.Valid values are defined by
150  * 'TOBACCO_USER' lookup type.
151  * @param p_dpdnt_adoption_date Date dependent was adopted.
152  * @param p_dpdnt_vlntry_svce_flag Dependent on voluntary service flag.
153  * @param p_original_date_of_hire Original date of hire.
154  * @param p_adjusted_svc_date Adjusted service date.
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 Global ID for the person.
159  * @param p_party_id Party ID for the person.
160  * @param p_npw_number Non-payrolled worker number.
161  * @param p_effective_start_date If p_validate is false, set to the effective
162  * start date of the person. If p_validate is true, set to null.
163  * @param p_effective_end_date If p_validate is false, set to the effective end
164  * date of the person. If p_validate is true, set to null.
165  * @param p_full_name If p_validate is false, set to the complete full name of
166  * the person. If p_validate is true, set to null.
167  * @param p_comment_id If p_validate is false and any comment text exists, set
168  * to the id of the corresponding person comment row. If p_validate is true, or
169  * no comment text exists this will be null.
170  * @param p_name_combination_warning If set to true, then the combination of
171  * last name, first name, and date of birth existed prior to calling this API.
172  * @param p_assign_payroll_warning If set to true, then the date of birth is
173  * not entered. If set to false, then the date of birth has been entered.
174  * Indicates if it will be possible to set the payroll on any of this person's
175  * assignments.
176  * @param p_orig_hire_warning Set to true if the original date of hire is not
177  * null and the person type is not EMP,EMP_APL, EX_EMP or EX_EMP_APL.
178  * @rep:displayname Update Person for Kuwait
179  * @rep:category BUSINESS_ENTITY HR_PERSON
180  * @rep:lifecycle active
181  * @rep:scope public
182  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
183 */
184 --
185 -- {End Of Comments}
186 --
187 procedure update_kw_person
188   (p_validate                     in      boolean   default false
189   ,p_effective_date               in      date
190   ,p_datetrack_update_mode        in      varchar2
191   ,p_person_id                    in      number
192   ,p_object_version_number        in out nocopy  number
193   ,p_person_type_id               in      number   default hr_api.g_number
194   ,p_family_name                  in      varchar2 default hr_api.g_varchar2
195   ,p_applicant_number             in      varchar2 default hr_api.g_varchar2
196   ,p_comments                     in      varchar2 default hr_api.g_varchar2
197   ,p_date_employee_data_verified  in      date     default hr_api.g_date
198   ,p_date_of_birth                in      date     default hr_api.g_date
199   ,p_email_address                in      varchar2 default hr_api.g_varchar2
200   ,p_employee_number              in out nocopy  varchar2
201   ,p_expense_check_send_to_addres in      varchar2 default hr_api.g_varchar2
202   ,p_first_name                   in      varchar2 default hr_api.g_varchar2
203   ,p_known_as                     in      varchar2 default hr_api.g_varchar2
204   ,p_marital_status               in      varchar2 default hr_api.g_varchar2
205   ,p_nationality                  in      varchar2 default hr_api.g_varchar2
206   ,p_national_identifier          in      varchar2 default hr_api.g_varchar2
207   ,p_previous_last_name           in      varchar2 default hr_api.g_varchar2
208   ,p_registered_disabled_flag     in      varchar2 default hr_api.g_varchar2
209   ,p_sex                          in      varchar2 default hr_api.g_varchar2
210   ,p_title                        in      varchar2 default hr_api.g_varchar2
211   ,p_vendor_id                    in      number   default hr_api.g_number
212   ,p_work_telephone               in      varchar2 default hr_api.g_varchar2
213   ,p_attribute_category           in      varchar2 default hr_api.g_varchar2
214   ,p_attribute1                   in      varchar2 default hr_api.g_varchar2
215   ,p_attribute2                   in      varchar2 default hr_api.g_varchar2
216   ,p_attribute3                   in      varchar2 default hr_api.g_varchar2
217   ,p_attribute4                   in      varchar2 default hr_api.g_varchar2
218   ,p_attribute5                   in      varchar2 default hr_api.g_varchar2
219   ,p_attribute6                   in      varchar2 default hr_api.g_varchar2
220   ,p_attribute7                   in      varchar2 default hr_api.g_varchar2
221   ,p_attribute8                   in      varchar2 default hr_api.g_varchar2
222   ,p_attribute9                   in      varchar2 default hr_api.g_varchar2
223   ,p_attribute10                  in      varchar2 default hr_api.g_varchar2
224   ,p_attribute11                  in      varchar2 default hr_api.g_varchar2
225   ,p_attribute12                  in      varchar2 default hr_api.g_varchar2
226   ,p_attribute13                  in      varchar2 default hr_api.g_varchar2
227   ,p_attribute14                  in      varchar2 default hr_api.g_varchar2
228   ,p_attribute15                  in      varchar2 default hr_api.g_varchar2
229   ,p_attribute16                  in      varchar2 default hr_api.g_varchar2
230   ,p_attribute17                  in      varchar2 default hr_api.g_varchar2
231   ,p_attribute18                  in      varchar2 default hr_api.g_varchar2
232   ,p_attribute19                  in      varchar2 default hr_api.g_varchar2
233   ,p_attribute20                  in      varchar2 default hr_api.g_varchar2
234   ,p_attribute21                  in      varchar2 default hr_api.g_varchar2
235   ,p_attribute22                  in      varchar2 default hr_api.g_varchar2
236   ,p_attribute23                  in      varchar2 default hr_api.g_varchar2
237   ,p_attribute24                  in      varchar2 default hr_api.g_varchar2
238   ,p_attribute25                  in      varchar2 default hr_api.g_varchar2
239   ,p_attribute26                  in      varchar2 default hr_api.g_varchar2
240   ,p_attribute27                  in      varchar2 default hr_api.g_varchar2
241   ,p_attribute28                  in      varchar2 default hr_api.g_varchar2
242   ,p_attribute29                  in      varchar2 default hr_api.g_varchar2
243   ,p_attribute30                  in      varchar2 default hr_api.g_varchar2
244   ,p_father_name             	  in      varchar2 default hr_api.g_varchar2
245   ,p_grandfather_name             in      varchar2 default hr_api.g_varchar2
246   ,p_alt_first_name               in      varchar2 default hr_api.g_varchar2
247   ,p_alt_father_name              in      varchar2 default hr_api.g_varchar2
248   ,p_alt_grandfather_name         in      varchar2 default hr_api.g_varchar2
249   ,p_alt_family_name           	  in      varchar2 default hr_api.g_varchar2
250   ,p_previous_nationality         in      varchar2 default hr_api.g_varchar2
251   ,p_religion			  in      varchar2 default hr_api.g_varchar2
252   ,p_date_of_death                in      date     default hr_api.g_date
253   ,p_background_check_status      in      varchar2 default hr_api.g_varchar2
254   ,p_background_date_check        in      date     default hr_api.g_date
255   ,p_blood_type                   in      varchar2 default hr_api.g_varchar2
256   ,p_correspondence_language      in      varchar2 default hr_api.g_varchar2
257   ,p_fast_path_employee           in      varchar2 default hr_api.g_varchar2
258   ,p_fte_capacity                 in      number   default hr_api.g_number
259   ,p_hold_applicant_date_until    in      date     default hr_api.g_date
260   ,p_honors                       in      varchar2 default hr_api.g_varchar2
261   ,p_internal_location            in      varchar2 default hr_api.g_varchar2
262   ,p_last_medical_test_by         in      varchar2 default hr_api.g_varchar2
263   ,p_last_medical_test_date       in      date     default hr_api.g_date
264   ,p_mailstop                     in      varchar2 default hr_api.g_varchar2
265   ,p_office_number                in      varchar2 default hr_api.g_varchar2
266   ,p_on_military_service          in      varchar2 default hr_api.g_varchar2
267   ,p_projected_start_date         in      date     default hr_api.g_date
268   ,p_rehire_authorizor            in      varchar2 default hr_api.g_varchar2
269   ,p_rehire_recommendation        in      varchar2 default hr_api.g_varchar2
270   ,p_resume_exists                in      varchar2 default hr_api.g_varchar2
271   ,p_resume_last_updated          in      date     default hr_api.g_date
272   ,p_second_passport_exists       in      varchar2 default hr_api.g_varchar2
273   ,p_student_status               in      varchar2 default hr_api.g_varchar2
274   ,p_work_schedule                in      varchar2 default hr_api.g_varchar2
275   ,p_rehire_reason                in      varchar2 default hr_api.g_varchar2
276   ,p_benefit_group_id             in      number   default hr_api.g_number
277   ,p_receipt_of_death_cert_date   in      date     default hr_api.g_date
278   ,p_coord_ben_med_pln_no         in      varchar2 default hr_api.g_varchar2
279   ,p_coord_ben_no_cvg_flag        in      varchar2 default hr_api.g_varchar2
280   ,p_coord_ben_med_ext_er         in      varchar2 default hr_api.g_varchar2
281   ,p_coord_ben_med_pl_name        in      varchar2 default hr_api.g_varchar2
282   ,p_coord_ben_med_insr_crr_name  in      varchar2 default hr_api.g_varchar2
283   ,p_coord_ben_med_insr_crr_ident in      varchar2 default hr_api.g_varchar2
284   ,p_coord_ben_med_cvg_strt_dt    in      date     default hr_api.g_date
285   ,p_coord_ben_med_cvg_end_dt     in      date     default hr_api.g_date
286   ,p_uses_tobacco_flag            in      varchar2 default hr_api.g_varchar2
287   ,p_dpdnt_adoption_date          in      date     default hr_api.g_date
288   ,p_dpdnt_vlntry_svce_flag       in      varchar2 default hr_api.g_varchar2
289   ,p_original_date_of_hire        in      date     default hr_api.g_date
290   ,p_adjusted_svc_date            in      date     default hr_api.g_date
291   ,p_town_of_birth                in      varchar2 default hr_api.g_varchar2
292   ,p_region_of_birth              in      varchar2 default hr_api.g_varchar2
293   ,p_country_of_birth             in      varchar2 default hr_api.g_varchar2
294   ,p_global_person_id             in      varchar2 default hr_api.g_varchar2
295   ,p_party_id                     in      number   default hr_api.g_number
296   ,p_npw_number                   in      varchar2 default hr_api.g_varchar2
297   ,p_effective_start_date            out nocopy  date
298   ,p_effective_end_date              out nocopy  date
299   ,p_full_name                       out nocopy  varchar2
300   ,p_comment_id                      out nocopy  number
301   ,p_name_combination_warning        out nocopy  boolean
302   ,p_assign_payroll_warning          out nocopy  boolean
303   ,p_orig_hire_warning               out nocopy  boolean
304   );
305 
306 end hr_kw_person_api;