1 PACKAGE hr_hk_person_api AS
2 /* $Header: hrhkwrpe.pkh 120.1 2005/10/02 02:02:40 aroussel $ */
3 /*#
4 * This package contains API for updation of Person details.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Person for Hong Kong
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-----------------------------< update_hk_person >-------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API updates the person record for Hong Kong.
17 *
18 * The details of the person for whom the details have to be updated is
19 * identified by using the person_id and object_version_number for the record.
20 *
21 * <p><b>Licensing</b><br>
22 * This API is licensed for use with Human Resources.
23 *
24 * <p><b>Prerequisites</b><br>
25 * The person record and object version number should already exist.
26 *
27 * <p><b>Post Success</b><br>
28 * Successfully updates the details of the person.
29 *
30 * <p><b>Post Failure</b><br>
31 * The API will not update the person and raises an error.
32 * @param p_validate If true, then validation alone will be performed and the
33 * database will remain unchanged. If false and all validation checks pass,
34 * then the database will be modified.
35 * @param p_effective_date Determines when the DateTrack operation takes
36 * effect.
37 * @param p_datetrack_update_mode Indicates which DateTrack mode to use when
38 * updating the record. You must set to either UPDATE, CORRECTION,
39 * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
40 * particular record depend on the dates of previous record changes and the
41 * effective date of this change.
42 * @param p_person_id Identifies the person record to modify.
43 * @param p_object_version_number Pass in the current version number of the
44 * Person to be updated. When the API completes if p_validate is false, will be
45 * set to the new version number of the updated Person . If p_validate is true
46 * will be set to the same value which was passed in.
47 * @param p_person_type_id {@rep:casecolumn PER_ALL_PEOPLE_F.PERSON_TYPE_ID}
48 * @param p_last_name {@rep:casecolumn PER_ALL_PEOPLE_F.LAST_NAME}
49 * @param p_applicant_number {@rep:casecolumn
50 * PER_ALL_PEOPLE_F.APPLICANT_NUMBER}
51 * @param p_comments Comment text.
52 * @param p_date_employee_data_verified {@rep:casecolumn
53 * PER_ALL_PEOPLE_F.DATE_EMPLOYEE_DATA_VERIFIED}
54 * @param p_date_of_birth {@rep:casecolumn PER_ALL_PEOPLE_F.DATE_OF_BIRTH}
55 * @param p_email_address {@rep:casecolumn PER_ALL_PEOPLE_F.EMAIL_ADDRESS}
56 * @param p_employee_number The business group's employee number generation
57 * method determines when you can update the employee value. To keep the
58 * existing employee number pass in hr_api.g_varchar2. When the API call
59 * completes if p_validate is false >then will be set to the employee number.
60 * If p_validate is true then will be set to the passed value.
61 * @param p_expense_check_send_to_addres Person's Address to which the expense
62 * should be sent. Valid values are determined by 'HOME_OFFICE' lookup type.
63 * @param p_first_name {@rep:casecolumn PER_ALL_PEOPLE_F.FIRST_NAME}
64 * @param p_known_as {@rep:casecolumn PER_ALL_PEOPLE_F.KNOWN_AS}
65 * @param p_marital_status Indicates the Person's Marital status. Valid values
66 * are defined by 'MAR_STATUS' lookup type.
67 * @param p_middle_names {@rep:casecolumn PER_ALL_PEOPLE_F.MIDDLE_NAMES}
68 * @param p_nationality Indicates the Person's Nationality. Valid values are
69 * defined by 'NATIONALITY' lookup type.
70 * @param p_hkid_number {@rep:casecolumn PER_ALL_PEOPLE_F.NATIONAL_IDENTIFIER}
71 * @param p_previous_last_name {@rep:casecolumn
72 * PER_ALL_PEOPLE_F.PREVIOUS_LAST_NAME}
73 * @param p_registered_disabled_flag Indicates whether person is classified as
74 * disabled. Valid values are defined by 'REGISTERED_DISABLED' lookup type.
75 * @param p_sex Indicates the Person's Legal gender. Valid values are defined
76 * by 'SEX' lookup type.
77 * @param p_title Person's Title e.g. Mr, Mrs, Dr. Valid values are defined by
78 * 'TITLE' lookup type.
79 * @param p_vendor_id {@rep:casecolumn PER_ALL_PEOPLE_F.VENDOR_ID}
80 * @param p_work_telephone {@rep:casecolumn PER_ALL_PEOPLE_F.WORK_TELEPHONE}
81 * @param p_attribute_category This context value determines which flexfield
82 * structure to use with the descriptive flexfield segments.
83 * @param p_attribute1 Descriptive flexfield segment.
84 * @param p_attribute2 Descriptive flexfield segment.
85 * @param p_attribute3 Descriptive flexfield segment.
86 * @param p_attribute4 Descriptive flexfield segment.
87 * @param p_attribute5 Descriptive flexfield segment.
88 * @param p_attribute6 Descriptive flexfield segment.
89 * @param p_attribute7 Descriptive flexfield segment.
90 * @param p_attribute8 Descriptive flexfield segment.
91 * @param p_attribute9 Descriptive flexfield segment.
92 * @param p_attribute10 Descriptive flexfield segment.
93 * @param p_attribute11 Descriptive flexfield segment.
94 * @param p_attribute12 Descriptive flexfield segment.
95 * @param p_attribute13 Descriptive flexfield segment.
96 * @param p_attribute14 Descriptive flexfield segment.
97 * @param p_attribute15 Descriptive flexfield segment.
98 * @param p_attribute16 Descriptive flexfield segment.
99 * @param p_attribute17 Descriptive flexfield segment.
100 * @param p_attribute18 Descriptive flexfield segment.
101 * @param p_attribute19 Descriptive flexfield segment.
102 * @param p_attribute20 Descriptive flexfield segment.
103 * @param p_attribute21 Descriptive flexfield segment.
104 * @param p_attribute22 Descriptive flexfield segment.
105 * @param p_attribute23 Descriptive flexfield segment.
106 * @param p_attribute24 Descriptive flexfield segment.
107 * @param p_attribute25 Descriptive flexfield segment.
108 * @param p_attribute26 Descriptive flexfield segment.
109 * @param p_attribute27 Descriptive flexfield segment.
110 * @param p_attribute28 Descriptive flexfield segment.
111 * @param p_attribute29 Descriptive flexfield segment.
112 * @param p_attribute30 Descriptive flexfield segment.
113 * @param p_passport_number identifies the person with the passport number.
114 * @param p_country_of_issue Indicates the country where Passport was issued.
115 * @param p_work_permit_number Identifies the person by the work permit number
116 * @param p_work_permit_expiry_date Indicates the Person's work permit expiry
117 * date
118 * @param p_chinese_name Indicates the person's name in Chinese.
119 * @param p_hk_full_name Indicates the person's Full Name from Hong Kong ID
120 * Card or Passport.
121 * @param p_previous_employer_name Indicates the Name of Previous Employer.
122 * @param p_previous_employer_address Indicates the Address of Previous
123 * Employer.
124 * @param p_employee_tax_file_number Indicates the person's Tax File Number.
125 * @param p_date_of_death {@rep:casecolumn PER_ALL_PEOPLE_F.DATE_OF_DEATH}
126 * @param p_background_check_status Indicates the Background check status of
127 * the person. Valid values as applicable are defined by 'YES_NO' lookup type.
128 * @param p_background_date_check {@rep:casecolumn
129 * PER_ALL_PEOPLE_F.BACKGROUND_DATE_CHECK}
130 * @param p_blood_type Identifies the person's Blood Group. Valid values are
131 * defined by 'BLOOD_TYPE' lookup type.
132 * @param p_correspondence_language {@rep:casecolumn
133 * PER_ALL_PEOPLE_F.CORRESPONDENCE_LANGUAGE}
134 * @param p_fast_path_employee {@rep:casecolumn
135 * PER_ALL_PEOPLE_F.FAST_PATH_EMPLOYEE}
136 * @param p_fte_capacity {@rep:casecolumn PER_ALL_PEOPLE_F.FTE_CAPACITY}
137 * @param p_hold_applicant_date_until {@rep:casecolumn
138 * PER_ALL_PEOPLE_F.HOLD_APPLICANT_DATE_UNTIL}
139 * @param p_honors {@rep:casecolumn PER_ALL_PEOPLE_F.HONORS}
140 * @param p_internal_location {@rep:casecolumn
141 * PER_ALL_PEOPLE_F.INTERNAL_LOCATION}
142 * @param p_last_medical_test_by {@rep:casecolumn
143 * PER_ALL_PEOPLE_F.LAST_MEDICAL_TEST_BY}
144 * @param p_last_medical_test_date {@rep:casecolumn
145 * PER_ALL_PEOPLE_F.LAST_MEDICAL_TEST_DATE}
146 * @param p_mailstop {@rep:casecolumn PER_ALL_PEOPLE_F.MAILSTOP}
147 * @param p_office_number {@rep:casecolumn PER_ALL_PEOPLE_F.OFFICE_NUMBER}
148 * @param p_on_military_service Indicates whether the person was in the
149 * military service. Valid values as applicable are defined by 'YES_NO' lookup
150 * type.
151 * @param p_pre_name_adjunct {@rep:casecolumn
152 * PER_ALL_PEOPLE_F.PRE_NAME_ADJUNCT}
153 * @param p_projected_start_date {@rep:casecolumn
154 * PER_ALL_PEOPLE_F.PROJECTED_START_DATE}
155 * @param p_rehire_authorizor {@rep:casecolumn
156 * PER_ALL_PEOPLE_F.REHIRE_AUTHORIZOR}
157 * @param p_rehire_recommendation Indicates the person's Re-hire recommendation
158 * details. Valid values as applicable are defined by 'YES_NO' lookup type.
159 * @param p_resume_exists Indicates whether the person's Resume already exists
160 * in the database. Valid values as applicable are defined by 'YES_NO' lookup
161 * type.
162 * @param p_resume_last_updated {@rep:casecolumn
163 * PER_ALL_PEOPLE_F.RESUME_LAST_UPDATED}
164 * @param p_second_passport_exists Indicates the availability of the Person's
165 * Second passport. Valid values as applicable are defined by 'YES_NO' lookup
166 * type.
167 * @param p_student_status Student Status. Valid values are defined by the
168 * 'STUDENT_STATUS' lookup type.
169 * @param p_work_schedule Indicates the person's Work schedule. Valid values
170 * are defined by 'WORK_SCHEDULE' lookup type.
171 * @param p_rehire_reason {@rep:casecolumn PER_ALL_PEOPLE_F.REHIRE_REASON}
172 * @param p_suffix {@rep:casecolumn PER_ALL_PEOPLE_F.SUFFIX}
173 * @param p_benefit_group_id {@rep:casecolumn
174 * PER_ALL_PEOPLE_F.BENEFIT_GROUP_ID}
175 * @param p_receipt_of_death_cert_date {@rep:casecolumn
176 * PER_ALL_PEOPLE_F.RECEIPT_OF_DEATH_CERT_DATE}
177 * @param p_coord_ben_med_pln_no {@rep:casecolumn
178 * PER_ALL_PEOPLE_F.COORD_BEN_MED_PLN_NO}
179 * @param p_coord_ben_no_cvg_flag Indicates whether the person has any coverage
180 * other than the Coordination of benefits. Valid values as applicable are
181 * defined by 'YES_NO' lookup type.
182 * @param p_uses_tobacco_flag Indicates whether the person uses tabacco. Valid
183 * values as applicable are defined by 'YES_NO' lookup type.
184 * @param p_dpdnt_adoption_date {@rep:casecolumn
185 * PER_ALL_PEOPLE_F.DPDNT_ADOPTION_DATE}
186 * @param p_dpdnt_vlntry_svce_flag Indicates whether the person was in the
187 * dependent voluntary service. Valid values are defined by 'YES_NO' lookup
188 * type.
189 * @param p_original_date_of_hire {@rep:casecolumn
190 * PER_ALL_PEOPLE_F.ORIGINAL_DATE_OF_HIRE}
191 * @param p_adjusted_svc_date {@rep:casecolumn
192 * PER_PERIODS_OF_SERVICE.ADJUSTED_SVC_DATE}
193 * @param p_effective_start_date If p_validate is false, then set to the
194 * effective start date on the updated Person row which now exists as of the
195 * effective date. If p_validate is true, then set to null.
196 * @param p_effective_end_date If p_validate is false, then set to the
197 * effective end date for the created Person. If p_validate is true, then set
198 * to null.
199 * @param p_full_name If p_validate is false, set to the complete full name of
200 * the person. If p_validate is true, set to null.
201 * @param p_comment_id If p_validate is false and new or existing comment text
202 * exists, then will be set to the identifier of the Person comment record. If
203 * p_validate is true or no comment text exists, then will be null.
204 * @param p_name_combination_warning If set to true, then the combination of
205 * last name, first name and date of birth existed prior to calling this API.
206 * @param p_assign_payroll_warning If set to true, then the date of birth is
207 * not entered. If set to false, then the date of birth has been entered.
208 * Indicates if it will be possible to set the payroll on any of this person's
209 * assignments.
210 * @param p_orig_hire_warning If p_validate is false, the original date of hire
211 * is provided and the person type is not
212 * Employee,Employee-Applicant,Ex-Employee or Ex-Employee Applicant, then set
213 * to true.
214 * @rep:displayname Update Person for Hong Kong
215 * @rep:category BUSINESS_ENTITY HR_PERSON
216 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
217 * @rep:scope public
218 * @rep:lifecycle active
219 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
220 */
221 --
222 -- {End Of Comments}
223 --
224 PROCEDURE update_hk_person
225 (p_validate IN BOOLEAN DEFAULT FALSE
226 ,p_effective_date IN DATE
227 ,p_datetrack_update_mode IN VARCHAR2
228 ,p_person_id IN NUMBER
229 ,p_object_version_number IN OUT NOCOPY NUMBER
230 ,p_person_type_id IN NUMBER DEFAULT hr_api.g_number
231 ,p_last_name IN VARCHAR2 DEFAULT hr_api.g_varchar2
232 ,p_applicant_number IN VARCHAR2 DEFAULT hr_api.g_varchar2
233 ,p_comments IN VARCHAR2 DEFAULT hr_api.g_varchar2
234 ,p_date_employee_data_verified IN DATE DEFAULT hr_api.g_date
235 ,p_date_of_birth IN DATE DEFAULT hr_api.g_date
236 ,p_email_address IN VARCHAR2 DEFAULT hr_api.g_varchar2
237 ,p_employee_number IN OUT NOCOPY VARCHAR2
238 ,p_expense_check_send_to_addres IN VARCHAR2 DEFAULT hr_api.g_varchar2
239 ,p_first_name IN VARCHAR2 DEFAULT hr_api.g_varchar2
240 ,p_known_as IN VARCHAR2 DEFAULT hr_api.g_varchar2
241 ,p_marital_status IN VARCHAR2 DEFAULT hr_api.g_varchar2
242 ,p_middle_names IN VARCHAR2 DEFAULT hr_api.g_varchar2
243 ,p_nationality IN VARCHAR2 DEFAULT hr_api.g_varchar2
244 ,p_hkid_number IN VARCHAR2 DEFAULT hr_api.g_varchar2
245 ,p_previous_last_name IN VARCHAR2 DEFAULT hr_api.g_varchar2
246 ,p_registered_disabled_flag IN VARCHAR2 DEFAULT hr_api.g_varchar2
247 ,p_sex IN VARCHAR2 DEFAULT hr_api.g_varchar2
248 ,p_title IN VARCHAR2 DEFAULT hr_api.g_varchar2
249 ,p_vendor_id IN NUMBER DEFAULT hr_api.g_number
250 ,p_work_telephone IN VARCHAR2 DEFAULT hr_api.g_varchar2
251 ,p_attribute_category IN VARCHAR2 DEFAULT hr_api.g_varchar2
252 ,p_attribute1 IN VARCHAR2 DEFAULT hr_api.g_varchar2
253 ,p_attribute2 IN VARCHAR2 DEFAULT hr_api.g_varchar2
254 ,p_attribute3 IN VARCHAR2 DEFAULT hr_api.g_varchar2
255 ,p_attribute4 IN VARCHAR2 DEFAULT hr_api.g_varchar2
256 ,p_attribute5 IN VARCHAR2 DEFAULT hr_api.g_varchar2
257 ,p_attribute6 IN VARCHAR2 DEFAULT hr_api.g_varchar2
258 ,p_attribute7 IN VARCHAR2 DEFAULT hr_api.g_varchar2
259 ,p_attribute8 IN VARCHAR2 DEFAULT hr_api.g_varchar2
260 ,p_attribute9 IN VARCHAR2 DEFAULT hr_api.g_varchar2
261 ,p_attribute10 IN VARCHAR2 DEFAULT hr_api.g_varchar2
262 ,p_attribute11 IN VARCHAR2 DEFAULT hr_api.g_varchar2
263 ,p_attribute12 IN VARCHAR2 DEFAULT hr_api.g_varchar2
264 ,p_attribute13 IN VARCHAR2 DEFAULT hr_api.g_varchar2
265 ,p_attribute14 IN VARCHAR2 DEFAULT hr_api.g_varchar2
266 ,p_attribute15 IN VARCHAR2 DEFAULT hr_api.g_varchar2
267 ,p_attribute16 IN VARCHAR2 DEFAULT hr_api.g_varchar2
268 ,p_attribute17 IN VARCHAR2 DEFAULT hr_api.g_varchar2
269 ,p_attribute18 IN VARCHAR2 DEFAULT hr_api.g_varchar2
270 ,p_attribute19 IN VARCHAR2 DEFAULT hr_api.g_varchar2
271 ,p_attribute20 IN VARCHAR2 DEFAULT hr_api.g_varchar2
272 ,p_attribute21 IN VARCHAR2 DEFAULT hr_api.g_varchar2
273 ,p_attribute22 IN VARCHAR2 DEFAULT hr_api.g_varchar2
274 ,p_attribute23 IN VARCHAR2 DEFAULT hr_api.g_varchar2
275 ,p_attribute24 IN VARCHAR2 DEFAULT hr_api.g_varchar2
276 ,p_attribute25 IN VARCHAR2 DEFAULT hr_api.g_varchar2
277 ,p_attribute26 IN VARCHAR2 DEFAULT hr_api.g_varchar2
278 ,p_attribute27 IN VARCHAR2 DEFAULT hr_api.g_varchar2
279 ,p_attribute28 IN VARCHAR2 DEFAULT hr_api.g_varchar2
280 ,p_attribute29 IN VARCHAR2 DEFAULT hr_api.g_varchar2
281 ,p_attribute30 IN VARCHAR2 DEFAULT hr_api.g_varchar2
282 ,p_passport_number IN VARCHAR2 DEFAULT hr_api.g_varchar2
283 ,p_country_of_issue IN VARCHAR2 DEFAULT hr_api.g_varchar2
284 ,p_work_permit_number IN VARCHAR2 DEFAULT hr_api.g_varchar2
285 ,p_work_permit_expiry_date IN VARCHAR2 DEFAULT hr_api.g_varchar2
286 ,p_chinese_name IN VARCHAR2 DEFAULT hr_api.g_varchar2
287 ,p_hk_full_name IN VARCHAR2 DEFAULT hr_api.g_varchar2
288 ,p_previous_employer_name IN VARCHAR2 DEFAULT hr_api.g_varchar2
289 ,p_previous_employer_address IN VARCHAR2 DEFAULT hr_api.g_varchar2
290 ,p_employee_tax_file_number IN VARCHAR2 DEFAULT hr_api.g_varchar2
291 ,p_date_of_death IN DATE DEFAULT hr_api.g_date
292 ,p_background_check_status IN VARCHAR2 DEFAULT hr_api.g_varchar2
296 ,p_fast_path_employee IN VARCHAR2 DEFAULT hr_api.g_varchar2
293 ,p_background_date_check IN DATE DEFAULT hr_api.g_date
294 ,p_blood_type IN VARCHAR2 DEFAULT hr_api.g_varchar2
295 ,p_correspondence_language IN VARCHAR2 DEFAULT hr_api.g_varchar2
297 ,p_fte_capacity IN NUMBER DEFAULT hr_api.g_number
298 ,p_hold_applicant_date_until IN DATE DEFAULT hr_api.g_date
299 ,p_honors IN VARCHAR2 DEFAULT hr_api.g_varchar2
300 ,p_internal_location IN VARCHAR2 DEFAULT hr_api.g_varchar2
301 ,p_last_medical_test_by IN VARCHAR2 DEFAULT hr_api.g_varchar2
302 ,p_last_medical_test_date IN DATE DEFAULT hr_api.g_date
303 ,p_mailstop IN VARCHAR2 DEFAULT hr_api.g_varchar2
304 ,p_office_number IN VARCHAR2 DEFAULT hr_api.g_varchar2
305 ,p_on_military_service IN VARCHAR2 DEFAULT hr_api.g_varchar2
306 ,p_pre_name_adjunct IN VARCHAR2 DEFAULT hr_api.g_varchar2
307 ,p_projected_start_date IN DATE DEFAULT hr_api.g_date
308 ,p_rehire_authorizor IN VARCHAR2 DEFAULT hr_api.g_varchar2
309 ,p_rehire_recommendation IN VARCHAR2 DEFAULT hr_api.g_varchar2
310 ,p_resume_exists IN VARCHAR2 DEFAULT hr_api.g_varchar2
311 ,p_resume_last_updated IN DATE DEFAULT hr_api.g_date
312 ,p_second_passport_exists IN VARCHAR2 DEFAULT hr_api.g_varchar2
313 ,p_student_status IN VARCHAR2 DEFAULT hr_api.g_varchar2
314 ,p_work_schedule IN VARCHAR2 DEFAULT hr_api.g_varchar2
315 ,p_rehire_reason IN VARCHAR2 DEFAULT hr_api.g_varchar2
316 ,p_suffix IN VARCHAR2 DEFAULT hr_api.g_varchar2
317 ,p_benefit_group_id in number default hr_api.g_number
318 ,p_receipt_of_death_cert_date in date default hr_api.g_date
319 ,p_coord_ben_med_pln_no in VARCHAR2 DEFAULT hr_api.g_varchar2
320 ,p_coord_ben_no_cvg_flag in varchar2 default hr_api.g_varchar2
321 ,p_uses_tobacco_flag in varchar2 default hr_api.g_varchar2
322 ,p_dpdnt_adoption_date in date default hr_api.g_date
323 ,p_dpdnt_vlntry_svce_flag in varchar2 default hr_api.g_varchar2
324 ,p_original_date_of_hire in date default hr_api.g_date
328 ,p_full_name OUT NOCOPY VARCHAR2
325 ,p_adjusted_svc_date in date default hr_api.g_date
326 ,p_effective_start_date OUT NOCOPY DATE
327 ,p_effective_end_date OUT NOCOPY DATE
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 --
336 END hr_hk_person_api;
[Home] [Help]