1 PACKAGE hr_au_person_api AS
2 /* $Header: hrauwrpe.pkh 120.1 2005/10/02 01:59:14 aroussel $ */
3 /*#
4 * This package contains person API for Australia.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Person for Australia
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-----------------------------< update_au_person >-------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API updates person details for the Australian localization.
17 *
18 * This API updates the person record as identified by p_person_id and
19 * p_object_version_number. This API is a wrapper over update_person API for
20 * Australia.
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 * The person record will have been updated.
31 *
32 * <p><b>Post Failure</b><br>
33 * The API will not update the person and raises an error.
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 Passes in the current version number of the
46 * person to be updated. When the API completes if p_validate is false, it will
47 * be set to the new version number of the updated person. If p_validate is
48 * true it will be set to the same value which was passed in.
49 * @param p_person_type_id {@rep:casecolumn PER_ALL_PEOPLE_F.PERSON_TYPE_ID}
50 * @param p_last_name {@rep:casecolumn PER_ALL_PEOPLE_F.LAST_NAME}
51 * @param p_applicant_number {@rep:casecolumn
52 * PER_ALL_PEOPLE_F.APPLICANT_NUMBER}
53 * @param p_comments Comment text.
54 * @param p_date_employee_data_verified {@rep:casecolumn
55 * PER_ALL_PEOPLE_F.DATE_EMPLOYEE_DATA_VERIFIED}
56 * @param p_date_of_birth {@rep:casecolumn PER_ALL_PEOPLE_F.DATE_OF_BIRTH}
57 * @param p_email_address {@rep:casecolumn PER_ALL_PEOPLE_F.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 it will be set to the employee number.
62 * If p_validate is true then jt will be set to the passed value.
63 * @param p_expense_check_send_to_addres The person's address to which the
64 * expense should be sent. Valid values are determined by the 'HOME_OFFICE'
65 * lookup type.
66 * @param p_first_name {@rep:casecolumn PER_ALL_PEOPLE_F.FIRST_NAME}
67 * @param p_known_as {@rep:casecolumn PER_ALL_PEOPLE_F.KNOWN_AS}
68 * @param p_marital_status The person's marital status. Valid values are
69 * defined by the 'MAR_STATUS' lookup type.
70 * @param p_middle_names {@rep:casecolumn PER_ALL_PEOPLE_F.MIDDLE_NAMES}
71 * @param p_nationality The person's nationality. Valid values are defined by
72 * the 'NATIONALITY' lookup type.
73 * @param p_national_identifier {@rep:casecolumn
74 * PER_ALL_PEOPLE_F.NATIONAL_IDENTIFIER}
75 * @param p_previous_last_name {@rep:casecolumn
76 * PER_ALL_PEOPLE_F.PREVIOUS_LAST_NAME}
77 * @param p_registered_disabled_flag This flag indicates whether a person is
78 * classified as disabled. Valid values are defined by the
79 * 'REGISTERED_DISABLED' lookup type.
80 * @param p_sex The person's legal gender. Valid values are defined by the
81 * 'SEX' lookup type.
82 * @param p_title The person's title e.g. Mr, Mrs, Dr. Valid values are defined
83 * by the 'TITLE' lookup type.
84 * @param p_vendor_id {@rep:casecolumn PER_ALL_PEOPLE_F.VENDOR_ID}
85 * @param p_work_telephone {@rep:casecolumn PER_ALL_PEOPLE_F.WORK_TELEPHONE}
86 * @param p_attribute_category This context value determines which flexfield
87 * structure to use with the descriptive flexfield segments.
88 * @param p_attribute1 Descriptive flexfield segment.
89 * @param p_attribute2 Descriptive flexfield segment.
90 * @param p_attribute3 Descriptive flexfield segment.
91 * @param p_attribute4 Descriptive flexfield segment.
92 * @param p_attribute5 Descriptive flexfield segment.
93 * @param p_attribute6 Descriptive flexfield segment.
94 * @param p_attribute7 Descriptive flexfield segment.
95 * @param p_attribute8 Descriptive flexfield segment.
96 * @param p_attribute9 Descriptive flexfield segment.
97 * @param p_attribute10 Descriptive flexfield segment.
98 * @param p_attribute11 Descriptive flexfield segment.
99 * @param p_attribute12 Descriptive flexfield segment.
100 * @param p_attribute13 Descriptive flexfield segment.
101 * @param p_attribute14 Descriptive flexfield segment.
102 * @param p_attribute15 Descriptive flexfield segment.
103 * @param p_attribute16 Descriptive flexfield segment.
104 * @param p_attribute17 Descriptive flexfield segment.
105 * @param p_attribute18 Descriptive flexfield segment.
106 * @param p_attribute19 Descriptive flexfield segment.
107 * @param p_attribute20 Descriptive flexfield segment.
108 * @param p_attribute21 Descriptive flexfield segment.
109 * @param p_attribute22 Descriptive flexfield segment.
110 * @param p_attribute23 Descriptive flexfield segment.
111 * @param p_attribute24 Descriptive flexfield segment.
112 * @param p_attribute25 Descriptive flexfield segment.
113 * @param p_attribute26 Descriptive flexfield segment.
114 * @param p_attribute27 Descriptive flexfield segment.
115 * @param p_attribute28 Descriptive flexfield segment.
116 * @param p_attribute29 Descriptive flexfield segment.
117 * @param p_attribute30 Descriptive flexfield segment.
118 * @param p_country_of_birth {@rep:casecolumn
119 * PER_ALL_PEOPLE_F.COUNTRY_OF_BIRTH}
120 * @param p_date_of_death {@rep:casecolumn PER_ALL_PEOPLE_F.DATE_OF_DEATH}
121 * @param p_background_check_status Refers to a person's background check
122 * status. Valid values are defined by the 'YES_NO' lookup type.
123 * @param p_background_date_check {@rep:casecolumn
124 * PER_ALL_PEOPLE_F.BACKGROUND_DATE_CHECK}
125 * @param p_blood_type The person's blood group. Valid values are defined by
126 * the 'BLOOD_TYPE' lookup type.
127 * @param p_correspondence_language {@rep:casecolumn
128 * PER_ALL_PEOPLE_F.CORRESPONDENCE_LANGUAGE}
129 * @param p_fast_path_employee {@rep:casecolumn
130 * PER_ALL_PEOPLE_F.FAST_PATH_EMPLOYEE}
131 * @param p_fte_capacity {@rep:casecolumn PER_ALL_PEOPLE_F.FTE_CAPACITY}
132 * @param p_hold_applicant_date_until {@rep:casecolumn
133 * PER_ALL_PEOPLE_F.HOLD_APPLICANT_DATE_UNTIL}
134 * @param p_honors {@rep:casecolumn PER_ALL_PEOPLE_F.HONORS}
135 * @param p_internal_location {@rep:casecolumn
136 * PER_ALL_PEOPLE_F.INTERNAL_LOCATION}
137 * @param p_last_medical_test_by {@rep:casecolumn
138 * PER_ALL_PEOPLE_F.LAST_MEDICAL_TEST_BY}
139 * @param p_last_medical_test_date {@rep:casecolumn
140 * PER_ALL_PEOPLE_F.LAST_MEDICAL_TEST_DATE}
141 * @param p_mailstop {@rep:casecolumn PER_ALL_PEOPLE_F.MAILSTOP}
142 * @param p_office_number {@rep:casecolumn PER_ALL_PEOPLE_F.OFFICE_NUMBER}
143 * @param p_on_military_service Indicates if the person is on military service.
144 * Valid values are defined by the 'YES_NO' lookup type.
145 * @param p_pre_name_adjunct {@rep:casecolumn
146 * PER_ALL_PEOPLE_F.PRE_NAME_ADJUNCT}
147 * @param p_projected_start_date {@rep:casecolumn
148 * PER_ALL_PEOPLE_F.PROJECTED_START_DATE}
149 * @param p_rehire_authorizor {@rep:casecolumn
150 * PER_ALL_PEOPLE_F.REHIRE_AUTHORIZOR}
151 * @param p_rehire_recommendation Indicates a person's re-hire recommendation.
152 * Valid values are defined by the 'YES_NO' lookup type.
153 * @param p_resume_exists Indicates if the person's resume exists. Valid values
154 * are defined by the 'YES_NO' lookup type.
155 * @param p_resume_last_updated {@rep:casecolumn
156 * PER_ALL_PEOPLE_F.RESUME_LAST_UPDATED}
157 * @param p_second_passport_exists Indicates if the person's second passport is
158 * available. Valid values are defined by the 'YES_NO' lookup type.
159 * @param p_student_status Student status. Valid values are defined by the
160 * 'STUDENT_STATUS' lookup type.
161 * @param p_work_schedule Determines the work schedule. Valid values are
162 * defined by the 'WORK_SCHEDULE' lookup type.
163 * @param p_rehire_reason {@rep:casecolumn PER_ALL_PEOPLE_F.REHIRE_REASON}
164 * @param p_suffix {@rep:casecolumn PER_ALL_PEOPLE_F.SUFFIX}
165 * @param p_benefit_group_id {@rep:casecolumn
166 * PER_ALL_PEOPLE_F.BENEFIT_GROUP_ID}
167 * @param p_receipt_of_death_cert_date {@rep:casecolumn
168 * PER_ALL_PEOPLE_F.RECEIPT_OF_DEATH_CERT_DATE}
169 * @param p_coord_ben_med_pln_no {@rep:casecolumn
170 * PER_ALL_PEOPLE_F.COORD_BEN_MED_PLN_NO}
171 * @param p_coord_ben_no_cvg_flag Person's Coordination of benefits no other
172 * coverage, valid values as applicable are defined by 'YES_NO' lookup type.
173 * @param p_uses_tobacco_flag Indicates if the Person uses tabacco. Valid
174 * values are defined by the 'YES_NO' lookup type.
175 * @param p_dpdnt_adoption_date {@rep:casecolumn
176 * PER_ALL_PEOPLE_F.DPDNT_ADOPTION_DATE}
177 * @param p_dpdnt_vlntry_svce_flag Indicates if the person's dependant is in
178 * voluntary service. Valid values are defined by the 'YES_NO' lookup type.
179 * @param p_original_date_of_hire {@rep:casecolumn
180 * PER_ALL_PEOPLE_F.ORIGINAL_DATE_OF_HIRE}
181 * @param p_adjusted_svc_date {@rep:casecolumn
182 * PER_PERIODS_OF_SERVICE.ADJUSTED_SVC_DATE}
183 * @param p_effective_start_date If p_validate is false, then set to the
184 * effective start date on the updated person row which now exists as of the
185 * effective date. If p_validate is true, then set to null.
186 * @param p_effective_end_date If p_validate is false, then set to the
187 * effective end date on the updated person row which now exists as of the
188 * effective date. If p_validate is true, then set to null.
189 * @param p_full_name If p_validate is FALSE, set to the complete full name of
190 * the person. If p_validate is true, set to null.
191 * @param p_comment_id If p_validate is false and new or existing comment text
192 * exists, then will be set to the identifier of the person comment record. If
193 * p_validate is true or no comment text exists, then will be null.
194 * @param p_name_combination_warning If set to true, then the combination of
195 * last name, first name and date of birth existed prior to calling this API.
196 * @param p_assign_payroll_warning If set to true, then the date of birth is
197 * not entered. If set to false, then the date of birth has been entered.
198 * Indicates if it will be possible to set the payroll on any of this person's
199 * assignments.
200 * @param p_orig_hire_warning If p_validate is false, the original date of hire
201 * is provided and the person type is not
202 * Employee,Employee-Applicant,Ex-Employee or Ex-Employee Applicant, then set
203 * to true.
204 * @rep:displayname Update Person for Australia
205 * @rep:category BUSINESS_ENTITY HR_PERSON
206 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
207 * @rep:scope public
208 * @rep:lifecycle active
209 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
210 */
211 --
212 -- {End Of Comments}
213 --
214 PROCEDURE update_au_person
215 (p_validate IN BOOLEAN DEFAULT FALSE
216 ,p_effective_date IN DATE
217 ,p_datetrack_update_mode IN VARCHAR2
218 ,p_person_id IN NUMBER
219 ,p_object_version_number IN OUT NOCOPY NUMBER
220 ,p_person_type_id IN NUMBER DEFAULT hr_api.g_number
221 ,p_last_name IN VARCHAR2 DEFAULT hr_api.g_varchar2
222 ,p_applicant_number IN VARCHAR2 DEFAULT hr_api.g_varchar2
223 ,p_comments IN VARCHAR2 DEFAULT hr_api.g_varchar2
224 ,p_date_employee_data_verified IN DATE DEFAULT hr_api.g_date
225 ,p_date_of_birth IN DATE DEFAULT hr_api.g_date
226 ,p_email_address IN VARCHAR2 DEFAULT hr_api.g_varchar2
227 ,p_employee_number IN OUT NOCOPY VARCHAR2
228 ,p_expense_check_send_to_addres IN VARCHAR2 DEFAULT hr_api.g_varchar2
229 ,p_first_name IN VARCHAR2 DEFAULT hr_api.g_varchar2
230 ,p_known_as IN VARCHAR2 DEFAULT hr_api.g_varchar2
231 ,p_marital_status IN VARCHAR2 DEFAULT hr_api.g_varchar2
232 ,p_middle_names IN VARCHAR2 DEFAULT hr_api.g_varchar2
233 ,p_nationality IN VARCHAR2 DEFAULT hr_api.g_varchar2
234 ,p_national_identifier IN VARCHAR2 DEFAULT hr_api.g_varchar2
235 ,p_previous_last_name IN VARCHAR2 DEFAULT hr_api.g_varchar2
236 ,p_registered_disabled_flag IN VARCHAR2 DEFAULT hr_api.g_varchar2
237 ,p_sex IN VARCHAR2 DEFAULT hr_api.g_varchar2
238 ,p_title IN VARCHAR2 DEFAULT hr_api.g_varchar2
239 ,p_vendor_id IN NUMBER DEFAULT hr_api.g_number
240 ,p_work_telephone IN VARCHAR2 DEFAULT hr_api.g_varchar2
241 ,p_attribute_category IN VARCHAR2 DEFAULT hr_api.g_varchar2
242 ,p_attribute1 IN VARCHAR2 DEFAULT hr_api.g_varchar2
243 ,p_attribute2 IN VARCHAR2 DEFAULT hr_api.g_varchar2
244 ,p_attribute3 IN VARCHAR2 DEFAULT hr_api.g_varchar2
245 ,p_attribute4 IN VARCHAR2 DEFAULT hr_api.g_varchar2
246 ,p_attribute5 IN VARCHAR2 DEFAULT hr_api.g_varchar2
247 ,p_attribute6 IN VARCHAR2 DEFAULT hr_api.g_varchar2
248 ,p_attribute7 IN VARCHAR2 DEFAULT hr_api.g_varchar2
249 ,p_attribute8 IN VARCHAR2 DEFAULT hr_api.g_varchar2
250 ,p_attribute9 IN VARCHAR2 DEFAULT hr_api.g_varchar2
251 ,p_attribute10 IN VARCHAR2 DEFAULT hr_api.g_varchar2
252 ,p_attribute11 IN VARCHAR2 DEFAULT hr_api.g_varchar2
253 ,p_attribute12 IN VARCHAR2 DEFAULT hr_api.g_varchar2
254 ,p_attribute13 IN VARCHAR2 DEFAULT hr_api.g_varchar2
255 ,p_attribute14 IN VARCHAR2 DEFAULT hr_api.g_varchar2
256 ,p_attribute15 IN VARCHAR2 DEFAULT hr_api.g_varchar2
257 ,p_attribute16 IN VARCHAR2 DEFAULT hr_api.g_varchar2
258 ,p_attribute17 IN VARCHAR2 DEFAULT hr_api.g_varchar2
259 ,p_attribute18 IN VARCHAR2 DEFAULT hr_api.g_varchar2
260 ,p_attribute19 IN VARCHAR2 DEFAULT hr_api.g_varchar2
261 ,p_attribute20 IN VARCHAR2 DEFAULT hr_api.g_varchar2
262 ,p_attribute21 IN VARCHAR2 DEFAULT hr_api.g_varchar2
263 ,p_attribute22 IN VARCHAR2 DEFAULT hr_api.g_varchar2
264 ,p_attribute23 IN VARCHAR2 DEFAULT hr_api.g_varchar2
265 ,p_attribute24 IN VARCHAR2 DEFAULT hr_api.g_varchar2
266 ,p_attribute25 IN VARCHAR2 DEFAULT hr_api.g_varchar2
267 ,p_attribute26 IN VARCHAR2 DEFAULT hr_api.g_varchar2
268 ,p_attribute27 IN VARCHAR2 DEFAULT hr_api.g_varchar2
269 ,p_attribute28 IN VARCHAR2 DEFAULT hr_api.g_varchar2
270 ,p_attribute29 IN VARCHAR2 DEFAULT hr_api.g_varchar2
271 ,p_attribute30 IN VARCHAR2 DEFAULT hr_api.g_varchar2
272 ,p_country_of_birth IN VARCHAR2 DEFAULT hr_api.g_varchar2
273 ,p_date_of_death IN DATE DEFAULT hr_api.g_date
274 ,p_background_check_status IN VARCHAR2 DEFAULT hr_api.g_varchar2
275 ,p_background_date_check IN DATE DEFAULT hr_api.g_date
276 ,p_blood_type IN VARCHAR2 DEFAULT hr_api.g_varchar2
277 ,p_correspondence_language IN VARCHAR2 DEFAULT hr_api.g_varchar2
278 ,p_fast_path_employee IN VARCHAR2 DEFAULT hr_api.g_varchar2
279 ,p_fte_capacity IN NUMBER DEFAULT hr_api.g_number
280 ,p_hold_applicant_date_until IN DATE DEFAULT hr_api.g_date
281 ,p_honors IN VARCHAR2 DEFAULT hr_api.g_varchar2
282 ,p_internal_location IN VARCHAR2 DEFAULT hr_api.g_varchar2
283 ,p_last_medical_test_by IN VARCHAR2 DEFAULT hr_api.g_varchar2
284 ,p_last_medical_test_date IN DATE DEFAULT hr_api.g_date
285 ,p_mailstop IN VARCHAR2 DEFAULT hr_api.g_varchar2
286 ,p_office_number IN VARCHAR2 DEFAULT hr_api.g_varchar2
287 ,p_on_military_service IN VARCHAR2 DEFAULT hr_api.g_varchar2
288 ,p_pre_name_adjunct IN VARCHAR2 DEFAULT hr_api.g_varchar2
289 ,p_projected_start_date IN DATE DEFAULT hr_api.g_date
290 ,p_rehire_authorizor IN VARCHAR2 DEFAULT hr_api.g_varchar2
291 ,p_rehire_recommendation IN VARCHAR2 DEFAULT hr_api.g_varchar2
292 ,p_resume_exists IN VARCHAR2 DEFAULT hr_api.g_varchar2
293 ,p_resume_last_updated IN DATE DEFAULT hr_api.g_date
294 ,p_second_passport_exists IN VARCHAR2 DEFAULT hr_api.g_varchar2
295 ,p_student_status IN VARCHAR2 DEFAULT hr_api.g_varchar2
296 ,p_work_schedule IN VARCHAR2 DEFAULT hr_api.g_varchar2
297 ,p_rehire_reason IN VARCHAR2 DEFAULT hr_api.g_varchar2
298 ,p_suffix IN VARCHAR2 DEFAULT hr_api.g_varchar2
299 ,p_benefit_group_id in number default hr_api.g_number
300 ,p_receipt_of_death_cert_date in date default hr_api.g_date
301 ,p_coord_ben_med_pln_no in VARCHAR2 DEFAULT hr_api.g_varchar2
302 ,p_coord_ben_no_cvg_flag in varchar2 default hr_api.g_varchar2
303 ,p_uses_tobacco_flag in varchar2 default hr_api.g_varchar2
304 ,p_dpdnt_adoption_date in date default hr_api.g_date
305 ,p_dpdnt_vlntry_svce_flag in varchar2 default hr_api.g_varchar2
306 ,p_original_date_of_hire in date default hr_api.g_date
307 ,p_adjusted_svc_date in date default hr_api.g_date
308 ,p_effective_start_date OUT NOCOPY DATE
309 ,p_effective_end_date OUT NOCOPY DATE
310 ,p_full_name OUT NOCOPY VARCHAR2
311 ,p_comment_id OUT NOCOPY NUMBER
312 ,p_name_combination_warning OUT NOCOPY BOOLEAN
313 ,p_assign_payroll_warning OUT NOCOPY BOOLEAN
314 ,p_orig_hire_warning OUT NOCOPY BOOLEAN
315 );
316
317 --
318 END hr_au_person_api;
[Home] [Help]