1 package hr_sg_person_api as
2 /* $Header: hrsgwrpe.pkh 120.4 2007/10/26 00:04:46 jalin ship $ */
3 /*#
4 * This API updates the Person details.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Person for Singapore
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-----------------------------< update_sg_person >-------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API updates the person record for Singapore.
17 *
18 * This API updates the SG person record as identified by p_person_id and
19 * p_object_version_number. Note: The business group must have the SG
20 * legislation code. This API is an alternative to the update_person API. See
21 * that API for further explanation.
22 *
23 * <p><b>Licensing</b><br>
24 *
25 * This API is licensed for use with Human Resources.
26 * <p><b>Prerequisites</b><br>
27 * The person record, identified by p_person_id and p_object_version_number,
28 * must already exist.
29 *
30 * <p><b>Post Success</b><br>
31 * Successfully updates the details of the person.
32 *
33 * <p><b>Post Failure</b><br>
34 * The API will not update the person and raises an error.
35 * @param p_validate If true, then validation alone will be performed and the
36 * database will remain unchanged. If false and all validation checks pass,
37 * then the database will be modified.
38 * @param p_effective_date Determines when the DateTrack operation takes
39 * effect.
40 * @param p_datetrack_update_mode Indicates which DateTrack mode to use when
41 * updating the record. You must set to either UPDATE, CORRECTION,
42 * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
43 * particular record depend on the dates of previous record changes and the
44 * effective date of this change.
45 * @param p_person_id Identifies the person record to modify.
46 * @param p_object_version_number Pass in the current version number of the
47 * person to be updated. When the API completes if p_validate is false, will be
48 * set to the new version number of the updated person. If p_validate is true
49 * will be set to the same value which was passed in.
50 * @param p_person_type_id Indicates the person's ID.
51 * @param p_last_name Indicates the last name of the person.
52 * @param p_applicant_number Indicates the applicant number of the person.
53 * @param p_comments Comment text.
54 * @param p_date_employee_data_verified Indicates the DATE on which the
55 * employee data was last verified.
56 * @param p_date_of_birth Indicates the date of birth of the person.
57 * @param p_email_address Indicates the Email address of the person.
58 * @param p_employee_number {@rep:casecolumn PER_ALL_PEOPLE_F.EMPLOYEE_NUMBER}
59 * @param p_expense_check_send_to_addres Indicates the mailing address of the
60 * person.
61 * @param p_first_name Indicates the first name of the person.
62 * @param p_known_as Indicates what the person is also known as.
63 * @param p_marital_status Indicates the marital status of the person. Valid
64 * values are defined by the 'MAR_STATUS' lookup type.
65 * @param p_middle_names Indicates the middle name of the person.
66 * @param p_nationality Indicates the person's nationality. Valid values are
67 * defined by the 'NATIONALITY' lookup type.
68 * @param p_national_identifier Indicates the person's national identifier.
69 * @param p_previous_last_name Indicates the person's previous last name.
70 * @param p_registered_disabled_flag Indicates whether person is classified as
71 * disabled.
72 * @param p_sex Indicates the gender of the person. Valid values are
73 * Male,Female,Unknown Gender.
74 * @param p_title Indicates the person's title. Valid values are defined by the
75 * 'TITLE' lookup type.
76 * @param p_vendor_id Foreign key to PO_VENDORS
77 * @param p_work_telephone Indicates the work telephone number of the person.
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_legal_name {@rep:casecolumn PER_ALL_PEOPLE_F.PER_INFORMATION1}
111 * @param p_passport_number {@rep:casecolumn PER_ALL_PEOPLE_F.PER_INFORMATION2}
112 * @param p_passport_country_of_issue {@rep:casecolumn
113 * PER_ALL_PEOPLE_F.PER_INFORMATION3}
114 * @param p_passport_date_issued {@rep:casecolumn
115 * PER_ALL_PEOPLE_F.PER_INFORMATION4}
116 * @param p_passport_expiry_date {@rep:casecolumn
117 * PER_ALL_PEOPLE_F.PER_INFORMATION5}
118 * @param p_permit_type {@rep:casecolumn PER_ALL_PEOPLE_F.PER_INFORMATION6}
119 * @param p_permit_number {@rep:casecolumn PER_ALL_PEOPLE_F.PER_INFORMATION7}
120 * @param p_permit_category {@rep:casecolumn PER_ALL_PEOPLE_F.PER_INFORMATION8}
121 * @param p_permit_date_issued {@rep:casecolumn
122 * PER_ALL_PEOPLE_F.PER_INFORMATION9}
123 * @param p_permit_expiry_date {@rep:casecolumn
124 * PER_ALL_PEOPLE_F.PER_INFORMATION10}
125 * @param p_permit_date_cancelled {@rep:casecolumn
126 * PER_ALL_PEOPLE_F.PER_INFORMATION11}
127 * @param p_income_tax_number {@rep:casecolumn
128 * PER_ALL_PEOPLE_F.PER_INFORMATION12}
129 * @param p_income_tax_number_spouse {@rep:casecolumn
130 * PER_ALL_PEOPLE_F.PER_INFORMATION13}
131 * @param p_cpf_account_number {@rep:casecolumn
132 * PER_ALL_PEOPLE_F.PER_INFORMATION14}
133 * @param p_nric_colour {@rep:casecolumn PER_ALL_PEOPLE_F.PER_INFORMATION15}
134 * @param p_religion {@rep:casecolumn PER_ALL_PEOPLE_F.PER_INFORMATION16}
135 * @param p_cpf_category {@rep:casecolumn PER_ALL_PEOPLE_F.PER_INFORMATION17}
136 * @param p_race {@rep:casecolumn PER_ALL_PEOPLE_F.PER_INFORMATION18}
137 * @param p_community_fund_category {@rep:casecolumn
138 * PER_ALL_PEOPLE_F.PER_INFORMATION19}
139 * @param p_date_of_death {@rep:casecolumn PER_ALL_PEOPLE_F.DATE_OF_DEATH}
140 * @param p_background_check_status Indicates the Background check status of
141 * the person. Valid values as applicable are defined by 'YES_NO' lookup type.
142 * @param p_background_date_check {@rep:casecolumn
143 * PER_ALL_PEOPLE_F.BACKGROUND_DATE_CHECK}
144 * @param p_blood_type Blood Type. Valid values are defined by the 'BLOOD_TYPE'
145 * lookup type.
146 * @param p_correspondence_language {@rep:casecolumn
147 * PER_ALL_PEOPLE_F.CORRESPONDENCE_LANGUAGE}
148 * @param p_fast_path_employee {@rep:casecolumn
149 * PER_ALL_PEOPLE_F.FAST_PATH_EMPLOYEE}
150 * @param p_fte_capacity {@rep:casecolumn PER_ALL_PEOPLE_F.FTE_CAPACITY}
151 * @param p_hold_applicant_date_until {@rep:casecolumn
152 * PER_ALL_PEOPLE_F.HOLD_APPLICANT_DATE_UNTIL}
153 * @param p_honors {@rep:casecolumn PER_ALL_PEOPLE_F.HONORS}
154 * @param p_internal_location {@rep:casecolumn
155 * PER_ALL_PEOPLE_F.INTERNAL_LOCATION}
156 * @param p_last_medical_test_by {@rep:casecolumn
157 * PER_ALL_PEOPLE_F.LAST_MEDICAL_TEST_BY}
158 * @param p_last_medical_test_date {@rep:casecolumn
159 * PER_ALL_PEOPLE_F.LAST_MEDICAL_TEST_DATE}
160 * @param p_mailstop {@rep:casecolumn PER_ALL_PEOPLE_F.MAILSTOP}
161 * @param p_office_number {@rep:casecolumn PER_ALL_PEOPLE_F.OFFICE_NUMBER}
162 * @param p_on_military_service Indicates whether the person was in the
163 * military service. Valid values as applicable are defined by 'YES_NO' lookup
164 * type.
165 * @param p_pre_name_adjunct {@rep:casecolumn
166 * PER_ALL_PEOPLE_F.PRE_NAME_ADJUNCT}
167 * @param p_projected_start_date {@rep:casecolumn
168 * PER_ALL_PEOPLE_F.PROJECTED_START_DATE}
169 * @param p_rehire_authorizor {@rep:casecolumn
170 * PER_ALL_PEOPLE_F.REHIRE_AUTHORIZOR}
171 * @param p_rehire_recommendation {@rep:casecolumn
172 * PER_ALL_PEOPLE_F.REHIRE_RECOMMENDATION}
173 * @param p_resume_exists {@rep:casecolumn PER_ALL_PEOPLE_F.RESUME_EXISTS}
174 * @param p_resume_last_updated {@rep:casecolumn
175 * PER_ALL_PEOPLE_F.RESUME_LAST_UPDATED}
176 * @param p_second_passport_exists Indicates whether the person's second
177 * passport is available. Valid values are defined by 'YES_NO' lookup type.
178 * @param p_student_status Student Status. Valid values are defined by the
179 * 'STUDENT_STATUS' lookup type.
180 * @param p_work_schedule Indicates the person's Work schedule. Valid values
181 * are defined by 'WORK_SCHEDULE' lookup type.
182 * @param p_rehire_reason {@rep:casecolumn PER_ALL_PEOPLE_F.REHIRE_REASON}
183 * @param p_suffix {@rep:casecolumn PER_ALL_PEOPLE_F.SUFFIX}
184 * @param p_benefit_group_id {@rep:casecolumn
185 * PER_ALL_PEOPLE_F.BENEFIT_GROUP_ID}
186 * @param p_receipt_of_death_cert_date {@rep:casecolumn
187 * PER_ALL_PEOPLE_F.RECEIPT_OF_DEATH_CERT_DATE}
188 * @param p_coord_ben_med_pln_no {@rep:casecolumn
189 * PER_ALL_PEOPLE_F.COORD_BEN_MED_PLN_NO}
190 * @param p_coord_ben_no_cvg_flag Indicates whether the person has any coverage
191 * other than the Coordination of benefits. Valid values as applicable are
192 * defined by 'YES_NO' lookup type.
193 * @param p_uses_tobacco_flag Indicates whether the person uses tabacco. Valid
194 * values as applicable are defined by 'YES_NO' lookup type.
195 * @param p_dpdnt_adoption_date {@rep:casecolumn
196 * PER_ALL_PEOPLE_F.DPDNT_ADOPTION_DATE}
197 * @param p_dpdnt_vlntry_svce_flag Indicates whether the person was in the
198 * dependent voluntary service. Valid values are defined by 'YES_NO' lookup
199 * type.
200 * @param p_original_date_of_hire {@rep:casecolumn
201 * PER_ALL_PEOPLE_F.ORIGINAL_DATE_OF_HIRE}
202 * @param p_adjusted_svc_date {@rep:casecolumn
203 * PER_PERIODS_OF_SERVICE.ADJUSTED_SVC_DATE}
204 * @param p_town_of_birth {@rep:casecolumn PER_ALL_PEOPLE_F.TOWN_OF_BIRTH}
205 * @param p_region_of_birth {@rep:casecolumn PER_ALL_PEOPLE_F.REGION_OF_BIRTH}
206 * @param p_country_of_birth {@rep:casecolumn
207 * PER_ALL_PEOPLE_F.COUNTRY_OF_BIRTH}
208 * @param p_global_person_id {@rep:casecolumn
209 * PER_ALL_PEOPLE_F.GLOBAL_PERSON_ID}
210 * @param p_party_id TCA party for whom you are modifying the person record.
211 * @param p_npw_number The business group's contingent worker number generation
212 * method determines when the API derives and passes out a contingent worker
213 * number or when the calling program should pass in a value. When the API call
214 * completes if p_validate is true then will be set to the contingent worker
215 * number. If p_validate is true then will be set to the passed value.
216 * @param p_payee_id_type {@rep:casecolumn PER_ALL_PEOPLE_F.PER_INFORMATION23}
217 * @param p_ee_er_rate {@rep:casecolumn PER_ALL_PEOPLE_F.PER_INFORMATION20}
218 * @param p_mbf {@rep:casecolumn PER_ALL_PEOPLE_F.PER_INFORMATION21}
219 * @param p_mdk {@rep:casecolumn PER_ALL_PEOPLE_F.PER_INFORMATION22}
220 * @param p_effective_start_date If p_validate is false, then set to the
221 * effective start 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_effective_end_date If p_validate is false, then set to the
224 * effective end date on the updated person row which now exists as of the
225 * effective date. If p_validate is true, then set to null.
226 * @param p_full_name If p_validate is false, then set to the full name of the
227 * person. If p_validate is true, then set to null.
228 * @param p_comment_id If p_validate is false and new or existing comment text
229 * exists, then will be set to the identifier of the person comment record. If
230 * p_validate is true or no comment text exists, then will be null.
231 * @param p_name_combination_warning If set to true, then the combination of
232 * last name, first name and date of birth existed prior to calling this API.
233 * @param p_assign_payroll_warning If set to true, then the date of birth is
234 * not entered. If set to false, then the date of birth has been entered.
235 * Indicates if it will be possible to set the payroll on any of this person's
236 * assignments.
237 * @param p_orig_hire_warning If p_validate is false, this will be set if an
238 * warnings exists. If p_validate is true this will be null.
239 * @rep:displayname Update Person for Singapore
240 * @rep:category BUSINESS_ENTITY HR_PERSON
241 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
242 * @rep:scope public
243 * @rep:lifecycle active
244 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
245 */
246 --
247 -- {End Of Comments}
248 --
249 procedure update_sg_person
250 ( p_validate in boolean default false
251 ,p_effective_date in date
252 ,p_datetrack_update_mode in varchar2
253 ,p_person_id in number
254 ,p_object_version_number in out nocopy number
255 ,p_person_type_id in number default hr_api.g_number
256 ,p_last_name in varchar2 default hr_api.g_varchar2
257 ,p_applicant_number in varchar2 default hr_api.g_varchar2
258 ,p_comments in varchar2 default hr_api.g_varchar2
259 ,p_date_employee_data_verified in date default hr_api.g_date
260 ,p_date_of_birth in date default hr_api.g_date
261 ,p_email_address in varchar2 default hr_api.g_varchar2
262 ,p_employee_number in out nocopy varchar2
263 ,p_expense_check_send_to_addres in varchar2 default hr_api.g_varchar2
264 ,p_first_name in varchar2 default hr_api.g_varchar2
265 ,p_known_as in varchar2 default hr_api.g_varchar2
266 ,p_marital_status in varchar2 default hr_api.g_varchar2
267 ,p_middle_names in varchar2 default hr_api.g_varchar2
268 ,p_nationality in varchar2 default hr_api.g_varchar2
269 ,p_national_identifier in varchar2 default hr_api.g_varchar2
270 ,p_previous_last_name in varchar2 default hr_api.g_varchar2
271 ,p_registered_disabled_flag in varchar2 default hr_api.g_varchar2
272 ,p_sex in varchar2 default hr_api.g_varchar2
273 ,p_title in varchar2 default hr_api.g_varchar2
274 ,p_vendor_id in number default hr_api.g_number
275 ,p_work_telephone in varchar2 default hr_api.g_varchar2
276 ,p_attribute_category in varchar2 default hr_api.g_varchar2
277 ,p_attribute1 in varchar2 default hr_api.g_varchar2
278 ,p_attribute2 in varchar2 default hr_api.g_varchar2
279 ,p_attribute3 in varchar2 default hr_api.g_varchar2
280 ,p_attribute4 in varchar2 default hr_api.g_varchar2
281 ,p_attribute5 in varchar2 default hr_api.g_varchar2
282 ,p_attribute6 in varchar2 default hr_api.g_varchar2
283 ,p_attribute7 in varchar2 default hr_api.g_varchar2
284 ,p_attribute8 in varchar2 default hr_api.g_varchar2
285 ,p_attribute9 in varchar2 default hr_api.g_varchar2
286 ,p_attribute10 in varchar2 default hr_api.g_varchar2
287 ,p_attribute11 in varchar2 default hr_api.g_varchar2
288 ,p_attribute12 in varchar2 default hr_api.g_varchar2
289 ,p_attribute13 in varchar2 default hr_api.g_varchar2
290 ,p_attribute14 in varchar2 default hr_api.g_varchar2
291 ,p_attribute15 in varchar2 default hr_api.g_varchar2
292 ,p_attribute16 in varchar2 default hr_api.g_varchar2
293 ,p_attribute17 in varchar2 default hr_api.g_varchar2
294 ,p_attribute18 in varchar2 default hr_api.g_varchar2
295 ,p_attribute19 in varchar2 default hr_api.g_varchar2
296 ,p_attribute20 in varchar2 default hr_api.g_varchar2
297 ,p_attribute21 in varchar2 default hr_api.g_varchar2
298 ,p_attribute22 in varchar2 default hr_api.g_varchar2
299 ,p_attribute23 in varchar2 default hr_api.g_varchar2
300 ,p_attribute24 in varchar2 default hr_api.g_varchar2
301 ,p_attribute25 in varchar2 default hr_api.g_varchar2
302 ,p_attribute26 in varchar2 default hr_api.g_varchar2
303 ,p_attribute27 in varchar2 default hr_api.g_varchar2
304 ,p_attribute28 in varchar2 default hr_api.g_varchar2
305 ,p_attribute29 in varchar2 default hr_api.g_varchar2
306 ,p_attribute30 in varchar2 default hr_api.g_varchar2
307 ,p_legal_name in varchar2 default hr_api.g_varchar2
308 ,p_passport_number in varchar2 default hr_api.g_varchar2
309 ,p_passport_country_of_issue in varchar2 default hr_api.g_varchar2
310 ,p_passport_date_issued in date default hr_api.g_date
311 ,p_passport_expiry_date in date default hr_api.g_date
312 ,p_permit_type in varchar2 default hr_api.g_varchar2
313 ,p_permit_number in varchar2 default hr_api.g_varchar2
314 ,p_permit_category in varchar2 default hr_api.g_varchar2
315 ,p_permit_date_issued in date default hr_api.g_date
316 ,p_permit_expiry_date in date default hr_api.g_date
317 ,p_permit_date_cancelled in date default hr_api.g_date
318 ,p_income_tax_number in varchar2 default hr_api.g_varchar2
319 ,p_income_tax_number_spouse in varchar2 default hr_api.g_varchar2
320 ,p_cpf_account_number in varchar2 default hr_api.g_varchar2
321 ,p_nric_colour in varchar2 default hr_api.g_varchar2
322 ,p_religion in varchar2 default hr_api.g_varchar2
323 ,p_cpf_category in varchar2 default hr_api.g_varchar2
324 ,p_race in varchar2 default hr_api.g_varchar2
325 ,p_community_fund_category in varchar2 default hr_api.g_varchar2
326 ,p_date_of_death in date default hr_api.g_date
327 ,p_background_check_status in varchar2 default hr_api.g_varchar2
328 ,p_background_date_check in date default hr_api.g_date
329 ,p_blood_type in varchar2 default hr_api.g_varchar2
330 ,p_correspondence_language in varchar2 default hr_api.g_varchar2
331 ,p_fast_path_employee in varchar2 default hr_api.g_varchar2
332 ,p_fte_capacity in number default hr_api.g_number
333 ,p_hold_applicant_date_until in date default hr_api.g_date
334 ,p_honors in varchar2 default hr_api.g_varchar2
335 ,p_internal_location in varchar2 default hr_api.g_varchar2
336 ,p_last_medical_test_by in varchar2 default hr_api.g_varchar2
337 ,p_last_medical_test_date in date default hr_api.g_date
338 ,p_mailstop in varchar2 default hr_api.g_varchar2
339 ,p_office_number in varchar2 default hr_api.g_varchar2
340 ,p_on_military_service in varchar2 default hr_api.g_varchar2
341 ,p_pre_name_adjunct in varchar2 default hr_api.g_varchar2
342 ,p_projected_start_date in date default hr_api.g_date
343 ,p_rehire_authorizor in varchar2 default hr_api.g_varchar2
344 ,p_rehire_recommendation in varchar2 default hr_api.g_varchar2
345 ,p_resume_exists in varchar2 default hr_api.g_varchar2
346 ,p_resume_last_updated in date default hr_api.g_date
347 ,p_second_passport_exists in varchar2 default hr_api.g_varchar2
348 ,p_student_status in varchar2 default hr_api.g_varchar2
349 ,p_work_schedule in varchar2 default hr_api.g_varchar2
350 ,p_rehire_reason in varchar2 default hr_api.g_varchar2
351 ,p_suffix in varchar2 default hr_api.g_varchar2
352 ,p_benefit_group_id in number default hr_api.g_number
353 ,p_receipt_of_death_cert_date in date default hr_api.g_date
354 ,p_coord_ben_med_pln_no in number default hr_api.g_number
355 ,p_coord_ben_no_cvg_flag in varchar2 default hr_api.g_varchar2
356 ,p_uses_tobacco_flag in varchar2 default hr_api.g_varchar2
357 ,p_dpdnt_adoption_date in date default hr_api.g_date
358 ,p_dpdnt_vlntry_svce_flag in varchar2 default hr_api.g_varchar2
359 ,p_original_date_of_hire in date default hr_api.g_date
360 ,p_adjusted_svc_date in date default hr_api.g_date
361 ,p_town_of_birth in varchar2 default hr_api.g_varchar2
362 ,p_region_of_birth in varchar2 default hr_api.g_varchar2
363 ,p_country_of_birth in varchar2 default hr_api.g_varchar2
364 ,p_global_person_id in varchar2 default hr_api.g_varchar2
365 ,p_party_id in number default hr_api.g_number /* 6393528 */
366 ,p_npw_number in varchar2 default hr_api.g_varchar2 /* 6393528 */
367 ,p_payee_id_type in varchar2 default hr_api.g_varchar2 /* 6393528 */
368 ,p_ee_er_rate in varchar2 default hr_api.g_varchar2 /* 6393528 */
369 ,p_mbf in varchar2 default hr_api.g_varchar2 /* 6393528, 6526444 */
370 ,p_mdk in varchar2 default hr_api.g_varchar2 /* 6393528, 6526444 */
371 ,p_effective_start_date out nocopy date
372 ,p_effective_end_date out nocopy date
373 ,p_full_name out nocopy varchar2
374 ,p_comment_id out nocopy number
375 ,p_name_combination_warning out nocopy boolean
376 ,p_assign_payroll_warning out nocopy boolean
377 ,p_orig_hire_warning out nocopy boolean);
378 --
379 end hr_sg_person_api;