1 PACKAGE hr_cn_contact_api AUTHID CURRENT_USER AS
2 /* $Header: hrcnwrcc.pkh 120.4 2011/12/20 11:46:11 jmarupil ship $ */
3 /*#
4 * This package contains the contact APIs for China.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Personal Contact for China
8 */
9 g_trace boolean := FALSE;
10 --
11 -- ----------------------------------------------------------------------------
12 -- |-----------------------------< create_cn_person >-------------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates a person for business groups using the legislation for
18 * China.
19 *
20 * This API calls the generic create_person API. It maps certain columns to
21 * user-friendly names appropriate for China so as to ensure easy
22 * identification. As this API is an alternative API, see the generic
23 * create_person API for further explanation.
24 *
25 * <p><b>Licensing</b><br>
26 * This API is licensed for use with Human Resources.
27 *
28 * <p><b>Prerequisites</b><br>
29 * A business group for the China legislation must be present as on the
30 * effective date. See the corresponding generic API for further details.
31 *
32 * <p><b>Post Success</b><br>
33 * The person will be created.
34 *
35 * <p><b>Post Failure</b><br>
36 * The API does not create the person and raises an error.
37 * @param p_validate If true, then validation alone will be performed and the
38 * database will remain unchanged. If false and all validation checks pass,
39 * then the database will be modified.
40 * @param p_start_date The date from which the person is assumed to be present
41 * in the records.
42 * @param p_business_group_id {@rep:casecolumn
43 * PER_ALL_PEOPLE_F.BUSINESS_GROUP_ID}
44 * @param p_family_or_last_name {@rep:casecolumn PER_ALL_PEOPLE_F.LAST_NAME}
45 * @param p_sex Legal gender. Valid values are defined by the 'SEX' lookup
46 * type.
47 * @param p_person_type_id {@rep:casecolumn PER_ALL_PEOPLE_F.PERSON_TYPE_ID}
48 * @param p_comments Person comment text.
49 * @param p_date_employee_data_verified {@rep:casecolumn
50 * PER_ALL_PEOPLE_F.DATE_EMPLOYEE_DATA_VERIFIED}
51 * @param p_date_of_birth {@rep:casecolumn PER_ALL_PEOPLE_F.DATE_OF_BIRTH}
52 * @param p_email_address {@rep:casecolumn PER_ALL_PEOPLE_F.EMAIL_ADDRESS}
53 * @param p_expense_check_send_to_addres Mailing address. Valid values are
54 * defined by the 'HOME_OFFICE' lookup type.
55 * @param p_given_or_first_name {@rep:casecolumn PER_ALL_PEOPLE_F.FIRST_NAME}
56 * @param p_known_as {@rep:casecolumn PER_ALL_PEOPLE_F.KNOWN_AS}
57 * @param p_marital_status Marital status. Valid values are defined by the
58 * 'MAR_STATUS' lookup type.
59 * @param p_middle_names {@rep:casecolumn PER_ALL_PEOPLE_F.MIDDLE_NAMES}
60 * @param p_nationality Nationality. Valid values are defined by the
61 * 'NATIONALITY' lookup type.
62 * @param p_citizen_identification_num {@rep:casecolumn
63 * PER_ALL_PEOPLE_F.NATIONAL_IDENTIFIER}
64 * @param p_registered_disabled_flag This indicates whether the person is
65 * classified as disabled. Valid values are defined by the
66 * 'REGISTERED_DISABLED' lookup type.
67 * @param p_title Title e.g. Mr, Mrs, Dr. Valid values are defined by the
68 * 'TITLE' lookup type.
69 * @param p_vendor_id {@rep:casecolumn PER_ALL_PEOPLE_F.VENDOR_ID}
70 * @param p_work_telephone {@rep:casecolumn PER_ALL_PEOPLE_F.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_hukou_type Hukou Type. Valid values are defined by the
104 * 'CN_HUKOU_TYPE' lookup type.
105 * @param p_hukou_location Hukou Location. Valid values are defined by the
106 * 'CN_HUKOU_LOCN' lookup type.
107 * @param p_highest_education_level Highest education level. Valid values are
108 * defined by the 'CN_HIGH_EDU_LEVEL' lookup type.
109 * @param p_number_of_children Number of children. This fields stores the
110 * number of children of the person. Valid values are whole numbers.
111 * @param p_expatriate_indicator Expatriate indicator. Valid values are defined
112 * by the 'YES_NO' lookup type.
113 * @param p_health_status Health status. Valid values are defined by the
114 * 'CN_HEALTH_STATUS' lookup type.
115 * @param p_tax_exemption_indicator Tax exempt indicator.Valid values are
116 * defined by the 'YES_NO' lookup type.
117 * @param p_percentage Tax exemption percentage. Determines the percentage of
118 * Special Tax Exemption based on the Tax Exemption Indicator. If left blank
119 * this defaults to a global value defined by MOLSS as per the current tax
120 * regulations
121 * @param p_family_han_yu_pin_yin_name Han Yu Pin Yin Last Name as specified on
122 * the Passport for Chinese residents.
123 * @param p_given_han_yu_pin_yin_name Han Yu Pin Yin First Name as specified on
124 * the Passport for Chinese residents.
125 * @param p_previous_name Previous Name of the person in case of change in
126 * name.
127 * @param p_race_ethnic_orgin Race ethnic origin. Valid values are defined by
128 * the 'CN_RACE' lookup type.
129 * @param p_social_security_ic_number Social Security Identification Number.
130 * @param p_correspondence_language {@rep:casecolumn
131 * PER_ALL_PEOPLE_F.CORRESPONDENCE_LANGUAGE}
132 * @param p_honors {@rep:casecolumn PER_ALL_PEOPLE_F.HONORS}
133 * @param p_benefit_group_id {@rep:casecolumn
134 * PER_ALL_PEOPLE_F.BENEFIT_GROUP_ID}
135 * @param p_on_military_service Indicates if the person is on military service.
136 * Valid values are defined by the 'YES_NO' lookup type.
137 * @param p_student_status Indicates the student status of the applicant. Valid
138 * values are defined by the 'STUDENT_STATUS' lookup type.
139 * @param p_uses_tobacco_flag Indicates if the person uses tabacco. Valid
140 * values are defined by the 'YES_NO' lookup type.
141 * @param p_coord_ben_no_cvg_flag Coordination of benefits no other coverage
142 * flag. Valid values are defined by 'YES_NO' lookup type.
143 * @param p_pre_name_adjunct Prefix for the person name
144 * @param p_suffix Suffix for the person name
145 * @param p_place_of_birth Indicates town of birth
146 * @param p_original_hometown Indicates region of birth
147 * @param p_country_of_birth Indicates the country of birth of Person. Valid
148 * values are defined by the view FND_TERRITORIES_VL
149 * @param p_global_person_id Global Person Id
150 * @param p_person_id If p_validate is false, then this uniquely identifies the
151 * person created. If p_validate is true, then set to null.
152 * @param p_object_version_number If p_validate is false, then set to the
153 * version number of the created Person. If p_validate is true, then the value
154 * will be null.
155 * @param p_effective_start_date If p_validate is false, then set to the
156 * earliest effective start date for the created person. If p_validate is true,
157 * then set to null.
158 * @param p_effective_end_date If p_validate is false, then set to the
159 * effective end date for the created person. If p_validate is true, then set
160 * to null.
161 * @param p_full_name If p_validate is false, this will be set to the complete
162 * full name of the person. If p_validate is true this will be null.
163 * @param p_comment_id If p_validate is false and comment text was provided,
164 * then will be set to the identifier of the created person comment record. If
165 * p_validate is true or no comment text was provided, then will be null.
166 * @param p_name_combination_warning If set to true, then the combination of
167 * last name, first name and date of birth existed prior to calling this API.
168 * @param p_orig_hire_warning If p_validate is false, this will be set if an
169 * warnings exists. If p_validate is true this will be null.
170 * @rep:displayname Create Contact Person for China
171 * @rep:category BUSINESS_ENTITY PER_PERSONAL_CONTACT
172 * @rep:scope public
173 * @rep:lifecycle active
174 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
175 */
176 --
177 -- {End Of Comments}
178 --
179 PROCEDURE create_cn_person
180 (p_validate in boolean default false
181 ,p_start_date in date
182 ,p_business_group_id in number
183 ,p_family_or_last_name in varchar2
184 ,p_sex in varchar2
185 ,p_person_type_id in number default null
186 ,p_comments in hr_comments.comment_text%TYPE default null
187 ,p_date_employee_data_verified in date default null
188 ,p_date_of_birth in date default null
189 ,p_email_address in varchar2 default null
190 ,p_expense_check_send_to_addres in varchar2 default null
191 ,p_given_or_first_name in varchar2 default null
192 ,p_known_as in varchar2 default null
193 ,p_marital_status in varchar2 default null
194 ,p_middle_names in varchar2 default null
195 ,p_nationality in varchar2 default null
196 ,p_citizen_identification_num in varchar2 default null
197 ,p_registered_disabled_flag in varchar2 default null
198 ,p_title in varchar2 default null
199 ,p_vendor_id in number default null
200 ,p_work_telephone in varchar2 default null
201 ,p_attribute_category in varchar2 default null
202 ,p_attribute1 in varchar2 default null
203 ,p_attribute2 in varchar2 default null
204 ,p_attribute3 in varchar2 default null
205 ,p_attribute4 in varchar2 default null
206 ,p_attribute5 in varchar2 default null
207 ,p_attribute6 in varchar2 default null
208 ,p_attribute7 in varchar2 default null
209 ,p_attribute8 in varchar2 default null
210 ,p_attribute9 in varchar2 default null
211 ,p_attribute10 in varchar2 default null
212 ,p_attribute11 in varchar2 default null
213 ,p_attribute12 in varchar2 default null
214 ,p_attribute13 in varchar2 default null
215 ,p_attribute14 in varchar2 default null
216 ,p_attribute15 in varchar2 default null
217 ,p_attribute16 in varchar2 default null
218 ,p_attribute17 in varchar2 default null
219 ,p_attribute18 in varchar2 default null
220 ,p_attribute19 in varchar2 default null
221 ,p_attribute20 in varchar2 default null
222 ,p_attribute21 in varchar2 default null
223 ,p_attribute22 in varchar2 default null
224 ,p_attribute23 in varchar2 default null
225 ,p_attribute24 in varchar2 default null
226 ,p_attribute25 in varchar2 default null
227 ,p_attribute26 in varchar2 default null
228 ,p_attribute27 in varchar2 default null
229 ,p_attribute28 in varchar2 default null
230 ,p_attribute29 in varchar2 default null
231 ,p_attribute30 in varchar2 default null
232 ,p_hukou_type in varchar2 default null
233 ,p_hukou_location in varchar2 default null
234 ,p_highest_education_level in varchar2 default null
235 ,p_number_of_children in varchar2 default null
236 ,p_expatriate_indicator in varchar2 default 'N' -- Bug 2782045
237 ,p_health_status in varchar2 default null
238 ,p_tax_exemption_indicator in varchar2 default null
239 ,p_percentage in varchar2 default null
240 ,p_family_han_yu_pin_yin_name in varchar2 default null
241 ,p_given_han_yu_pin_yin_name in varchar2 default null
242 ,p_previous_name in varchar2 default null
243 ,p_race_ethnic_orgin in varchar2 default null
244 ,p_social_security_ic_number in varchar2 default null
245 ,p_correspondence_language in varchar2 default null
246 ,p_honors in varchar2 default null
247 ,p_benefit_group_id in number default null
248 ,p_on_military_service in varchar2 default null
249 ,p_student_status in varchar2 default null
250 ,p_uses_tobacco_flag in varchar2 default null
251 ,p_coord_ben_no_cvg_flag in varchar2 default null
252 ,p_pre_name_adjunct in varchar2 default null
253 ,p_suffix in varchar2 default null
254 ,p_place_of_birth in varchar2 default null
255 ,p_original_hometown in varchar2 default null
256 ,p_country_of_birth in varchar2 default null
257 ,p_global_person_id in varchar2 default null
258 --
259 ,p_person_id out nocopy number
260 ,p_object_version_number out nocopy number
261 ,p_effective_start_date out nocopy date
262 ,p_effective_end_date out nocopy date
263 ,p_full_name out nocopy varchar2
264 ,p_comment_id out nocopy number
265 ,p_name_combination_warning out nocopy boolean
266 ,p_orig_hire_warning out nocopy boolean
267 );
268 --
269 END hr_cn_contact_api;
[Home] [Help]