1 Package hr_jp_person_api as
2 /* $Header: pejppapi.pkh 120.1 2005/10/02 02:18:33 aroussel $ */
3 /*#
4 * This package contains the person APIs for Japan.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Person for Japan
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-----------------------------< update_jp_person >-------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API updates the person record for Japan as identified by p_person_id
17 * and p_object_version_number.
18 *
19 * This API is an alternative to the update_person API. See that API for
20 * further explanation.
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. The business group must have the JP legislation code.
28 *
29 * <p><b>Post Success</b><br>
30 * The person will be updated.
31 *
32 * <p><b>Post Failure</b><br>
33 * The person will not be updated and an error will be raised.
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 takes
38 * effect.
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, this
47 * will be set to the new version number of the updated person. If p_validate
48 * is true, this 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_kana Last name (Kana).
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 this will be set to the employee
62 * number. If p_validate is true then this will be set to the passed value.
63 * @param p_expense_check_send_to_addres {@rep:casecolumn
64 * PER_ALL_PEOPLE_F.EXPENSE_CHECK_SEND_TO_ADDRESS}
65 * @param p_first_name_kana First name (Kana).
66 * @param p_known_as {@rep:casecolumn PER_ALL_PEOPLE_F.KNOWN_AS}
67 * @param p_marital_status {@rep:casecolumn PER_ALL_PEOPLE_F.MARITAL_STATUS}
68 * @param p_middle_names {@rep:casecolumn PER_ALL_PEOPLE_F.MIDDLE_NAMES}
69 * @param p_nationality {@rep:casecolumn PER_ALL_PEOPLE_F.NATIONALITY}
70 * @param p_national_identifier {@rep:casecolumn
71 * PER_ALL_PEOPLE_F.NATIONAL_IDENTIFIER}
72 * @param p_previous_last_name_kana Previous last name (Kana).
73 * @param p_registered_disabled_flag {@rep:casecolumn
74 * PER_ALL_PEOPLE_F.REGISTERED_DISABLED_FLAG}
75 * @param p_sex {@rep:casecolumn PER_ALL_PEOPLE_F.SEX}
76 * @param p_title {@rep:casecolumn PER_ALL_PEOPLE_F.TITLE}
77 * @param p_vendor_id {@rep:casecolumn PER_ALL_PEOPLE_F.VENDOR_ID}
78 * @param p_work_telephone {@rep:casecolumn PER_ALL_PEOPLE_F.WORK_TELEPHONE}
79 * @param p_attribute_category This context value determines which flexfield
80 * structure to use with the descriptive flexfield segments.
81 * @param p_attribute1 Descriptive flexfield segment.
82 * @param p_attribute2 Descriptive flexfield segment.
83 * @param p_attribute3 Descriptive flexfield segment.
84 * @param p_attribute4 Descriptive flexfield segment.
85 * @param p_attribute5 Descriptive flexfield segment.
86 * @param p_attribute6 Descriptive flexfield segment.
87 * @param p_attribute7 Descriptive flexfield segment.
88 * @param p_attribute8 Descriptive flexfield segment.
89 * @param p_attribute9 Descriptive flexfield segment.
90 * @param p_attribute10 Descriptive flexfield segment.
91 * @param p_attribute11 Descriptive flexfield segment.
92 * @param p_attribute12 Descriptive flexfield segment.
93 * @param p_attribute13 Descriptive flexfield segment.
94 * @param p_attribute14 Descriptive flexfield segment.
95 * @param p_attribute15 Descriptive flexfield segment.
96 * @param p_attribute16 Descriptive flexfield segment.
97 * @param p_attribute17 Descriptive flexfield segment.
98 * @param p_attribute18 Descriptive flexfield segment.
99 * @param p_attribute19 Descriptive flexfield segment.
100 * @param p_attribute20 Descriptive flexfield segment.
101 * @param p_attribute21 Descriptive flexfield segment.
102 * @param p_attribute22 Descriptive flexfield segment.
103 * @param p_attribute23 Descriptive flexfield segment.
104 * @param p_attribute24 Descriptive flexfield segment.
105 * @param p_attribute25 Descriptive flexfield segment.
106 * @param p_attribute26 Descriptive flexfield segment.
107 * @param p_attribute27 Descriptive flexfield segment.
108 * @param p_attribute28 Descriptive flexfield segment.
109 * @param p_attribute29 Descriptive flexfield segment.
110 * @param p_attribute30 Descriptive flexfield segment.
111 * @param p_last_name Last name (Kanji).
112 * @param p_first_name First name (Kanji).
113 * @param p_previous_last_name Previous last name (Kanji).
114 * @param p_suffix {@rep:casecolumn PER_ALL_PEOPLE_F.SUFFIX}
115 * @param p_effective_start_date If p_validate is false, then set to the
116 * effective start date on the updated person row which now exists as of the
117 * effective date. If p_validate is true, then set to null.
118 * @param p_effective_end_date If p_validate is false, then set to the
119 * effective end date on the updated person row which now exists as of the
120 * effective date. If p_validate is true, then set to null.
121 * @param p_full_name If p_validate is false, set to the complete full name of
122 * the person. If p_validate is true, set to null.
123 * @param p_comment_id If p_validate is false and new or existing comment text
124 * exists, then this will be set to the identifier of the person comment
125 * record. If p_validate is true or no comment text exists, then this will be
126 * null.
127 * @param p_name_combination_warning If set to true, then the combination of
128 * last name, first name and date of birth existed prior to calling this API.
129 * @param p_assign_payroll_warning If set to true, then the date of birth is
130 * not entered. If set to false, then the date of birth has been entered.
131 * Indicates if it will be possible to set the payroll on any of this person's
132 * assignments.
133 * @param p_orig_hire_warning This is set to true if the original date of hire
134 * is not null and the person type is not EMP,EMP_APL, EX_EMP or EX_EMP_APL.
135 * @rep:displayname Update Person for Japan
136 * @rep:category BUSINESS_ENTITY HR_PERSON
137 * @rep:scope public
138 * @rep:lifecycle active
139 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
140 */
141 --
142 -- {End Of Comments}
143 --
144 procedure update_jp_person
145 (p_validate in boolean default false
146 ,p_effective_date in date
147 ,p_datetrack_update_mode in varchar2
148 ,p_person_id in number
149 ,p_object_version_number in out nocopy number
150 ,p_person_type_id in number default hr_api.g_number
151 ,p_last_name_kana in varchar2 default hr_api.g_varchar2
152 ,p_applicant_number in varchar2 default hr_api.g_varchar2
153 ,p_comments in varchar2 default hr_api.g_varchar2
154 ,p_date_employee_data_verified in date default hr_api.g_date
155 ,p_date_of_birth in date default hr_api.g_date
156 ,p_email_address in varchar2 default hr_api.g_varchar2
157 ,p_employee_number in out nocopy varchar2
158 ,p_expense_check_send_to_addres in varchar2 default hr_api.g_varchar2
159 ,p_first_name_kana in varchar2 default hr_api.g_varchar2
160 ,p_known_as in varchar2 default hr_api.g_varchar2
161 ,p_marital_status in varchar2 default hr_api.g_varchar2
162 ,p_middle_names in varchar2 default hr_api.g_varchar2
163 ,p_nationality in varchar2 default hr_api.g_varchar2
164 ,p_national_identifier in varchar2 default hr_api.g_varchar2
165 ,p_previous_last_name_kana in varchar2 default hr_api.g_varchar2
166 ,p_registered_disabled_flag in varchar2 default hr_api.g_varchar2
167 ,p_sex in varchar2 default hr_api.g_varchar2
168 ,p_title in varchar2 default hr_api.g_varchar2
169 ,p_vendor_id in number default hr_api.g_number
170 ,p_work_telephone in varchar2 default hr_api.g_varchar2
171 ,p_attribute_category in varchar2 default hr_api.g_varchar2
172 ,p_attribute1 in varchar2 default hr_api.g_varchar2
173 ,p_attribute2 in varchar2 default hr_api.g_varchar2
174 ,p_attribute3 in varchar2 default hr_api.g_varchar2
175 ,p_attribute4 in varchar2 default hr_api.g_varchar2
176 ,p_attribute5 in varchar2 default hr_api.g_varchar2
177 ,p_attribute6 in varchar2 default hr_api.g_varchar2
178 ,p_attribute7 in varchar2 default hr_api.g_varchar2
179 ,p_attribute8 in varchar2 default hr_api.g_varchar2
180 ,p_attribute9 in varchar2 default hr_api.g_varchar2
181 ,p_attribute10 in varchar2 default hr_api.g_varchar2
182 ,p_attribute11 in varchar2 default hr_api.g_varchar2
183 ,p_attribute12 in varchar2 default hr_api.g_varchar2
184 ,p_attribute13 in varchar2 default hr_api.g_varchar2
185 ,p_attribute14 in varchar2 default hr_api.g_varchar2
186 ,p_attribute15 in varchar2 default hr_api.g_varchar2
187 ,p_attribute16 in varchar2 default hr_api.g_varchar2
188 ,p_attribute17 in varchar2 default hr_api.g_varchar2
189 ,p_attribute18 in varchar2 default hr_api.g_varchar2
190 ,p_attribute19 in varchar2 default hr_api.g_varchar2
191 ,p_attribute20 in varchar2 default hr_api.g_varchar2
192 ,p_attribute21 in varchar2 default hr_api.g_varchar2
193 ,p_attribute22 in varchar2 default hr_api.g_varchar2
194 ,p_attribute23 in varchar2 default hr_api.g_varchar2
195 ,p_attribute24 in varchar2 default hr_api.g_varchar2
196 ,p_attribute25 in varchar2 default hr_api.g_varchar2
197 ,p_attribute26 in varchar2 default hr_api.g_varchar2
198 ,p_attribute27 in varchar2 default hr_api.g_varchar2
199 ,p_attribute28 in varchar2 default hr_api.g_varchar2
200 ,p_attribute29 in varchar2 default hr_api.g_varchar2
201 ,p_attribute30 in varchar2 default hr_api.g_varchar2
202 ,p_last_name in varchar2 default hr_api.g_varchar2
203 ,p_first_name in varchar2 default hr_api.g_varchar2
204 ,p_previous_last_name in varchar2 default hr_api.g_varchar2
205 ,p_suffix in varchar2 default hr_api.g_varchar2
206 ,p_effective_start_date out nocopy date
207 ,p_effective_end_date out nocopy date
208 ,p_full_name out nocopy varchar2
209 ,p_comment_id out nocopy number
210 ,p_name_combination_warning out nocopy boolean
211 ,p_assign_payroll_warning out nocopy boolean
212 ,p_orig_hire_warning out nocopy boolean
213 );
214 --
215 end hr_jp_person_api;