1 PACKAGE hr_cn_person_address_api AS
2 /* $Header: hrcnwrpa.pkh 120.3 2005/11/04 05:36:40 jcolman noship $ */
3 /*#
4 * This package contains APIs for creation of personal addresses for China.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Person Address for China
8 */
9 g_trace boolean:=false;
10 --
11 -- ----------------------------------------------------------------------------
12 -- |-------------------------< create_cn_person_address >---------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates a new address for a person in business groups using the
18 * legislation for China.
19 *
20 * This API calls the generic create_person_address API. It maps certain
21 * columns to 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_address 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 valid person must exist on the start date of the address. The address_type
30 * attribute can only be used after QuickCodes have been defined for the
31 * 'ADDRESS_TYPE' lookup type. The business group of the person must belong to
32 * Chinese legislation. See the corresponding generic API for further details.
33 *
34 * <p><b>Post Success</b><br>
35 * The new address for the employee will be created
36 *
37 * <p><b>Post Failure</b><br>
38 * The API does not create the person's address and raises an error.
39 * @param p_validate If true, then validation alone will be performed and the
40 * database will remain unchanged. If false and all validation checks pass,
41 * then the database will be modified.
42 * @param p_effective_date Determines when the DateTrack operation takes
43 * effect.
44 * @param p_pradd_ovlapval_override Indicates if there is an overlap in the
45 * primary address details.
46 * @param p_validate_county Validates the county details in the address. This
47 * has a default of 'true'.
48 * @param p_person_id Identifies the person for whom you create the Address
49 * record.
50 * @param p_primary_flag Primary Address. Valid values are defined by the
51 * 'YES_NO' lookup type.
52 * @param p_date_from {@rep:casecolumn PER_ADDRESSES.DATE_FROM}
53 * @param p_date_to {@rep:casecolumn PER_ADDRESSES.DATE_TO}
54 * @param p_address_type Address type, for example, home, business, weekend.
55 * Valid values are defined by the 'ADDRESS_TYPE' lookup type.
56 * @param p_comments Address comment text
57 * @param p_address_line1 {@rep:casecolumn PER_ADDRESSES.ADDRESS_LINE1}
58 * @param p_address_line2 {@rep:casecolumn PER_ADDRESSES.ADDRESS_LINE2}
59 * @param p_province_city_sar Province/City/SAR of the person's address. Valid
60 * values are defined by the 'CN_PROVINCE' lookup type.
61 * @param p_postal_code Postal Code. Maximum 6 digits
62 * @param p_country Country details. Valid values are defined by the
63 * 'NATIONALITY' lookup type
64 * @param p_telephone {@rep:casecolumn PER_ADDRESSES.TELEPHONE_NUMBER_1}
65 * @param p_fax {@rep:casecolumn PER_ADDRESSES.TELEPHONE_NUMBER_2}
66 * @param p_addr_attribute_category This context value determines which
67 * flexfield structure to use with the Person Address descriptive flexfield
68 * segments.
69 * @param p_addr_attribute1 Descriptive flexfield segment.
70 * @param p_addr_attribute2 Descriptive flexfield segment.
71 * @param p_addr_attribute3 Descriptive flexfield segment.
72 * @param p_addr_attribute4 Descriptive flexfield segment.
73 * @param p_addr_attribute5 Descriptive flexfield segment.
74 * @param p_addr_attribute6 Descriptive flexfield segment.
75 * @param p_addr_attribute7 Descriptive flexfield segment.
76 * @param p_addr_attribute8 Descriptive flexfield segment.
77 * @param p_addr_attribute9 Descriptive flexfield segment.
78 * @param p_addr_attribute10 Descriptive flexfield segment.
79 * @param p_addr_attribute11 Descriptive flexfield segment.
80 * @param p_addr_attribute12 Descriptive flexfield segment.
81 * @param p_addr_attribute13 Descriptive flexfield segment.
82 * @param p_addr_attribute14 Descriptive flexfield segment.
83 * @param p_addr_attribute15 Descriptive flexfield segment.
84 * @param p_addr_attribute16 Descriptive flexfield segment.
85 * @param p_addr_attribute17 Descriptive flexfield segment.
86 * @param p_addr_attribute18 Descriptive flexfield segment.
87 * @param p_addr_attribute19 Descriptive flexfield segment.
88 * @param p_addr_attribute20 Descriptive flexfield segment.
89 * @param p_add_information13 Obsolete parameter, do not use.
90 * @param p_add_information14 Obsolete parameter, do not use.
91 * @param p_add_information15 Obsolete parameter, do not use.
92 * @param p_add_information16 Obsolete parameter, do not use.
93 * @param p_add_information17 Obsolete parameter, do not use.
94 * @param p_add_information18 Obsolete parameter, do not use.
95 * @param p_add_information19 Obsolete parameter, do not use.
96 * @param p_add_information20 Obsolete parameter, do not use.
97 * @param p_party_id Party for whom the address --HR/TCA merge applies.
98 * @param p_address_id If p_validate is false, this uniquely identifies the
99 * address created. If p_validate is true, this is set to null.
100 * @param p_object_version_number If p_validate is false, then this is set to
101 * the version number of the created address. If p_validate is true, then the
102 * value will be null.
103 * @rep:displayname Create Person Address for China
104 * @rep:category BUSINESS_ENTITY PER_PERSON_ADDRESS
105 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
106 * @rep:scope public
107 * @rep:lifecycle active
108 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
109 */
110 --
111 -- {End Of Comments}
112 --
113 PROCEDURE create_cn_person_address
114 (p_validate IN BOOLEAN DEFAULT false
115 ,p_effective_date IN DATE
116 ,p_pradd_ovlapval_override IN BOOLEAN DEFAULT false
117 ,p_validate_county IN BOOLEAN DEFAULT true
118 ,p_person_id IN NUMBER DEFAULT null
119 ,p_primary_flag IN VARCHAR2
120 ,p_date_from IN DATE
121 ,p_date_to IN DATE DEFAULT null
122 ,p_address_type IN VARCHAR2 DEFAULT null
123 ,p_comments IN LONG DEFAULT null
124 ,p_address_line1 IN VARCHAR2
125 ,p_address_line2 IN VARCHAR2 DEFAULT null
126 ,p_province_city_sar IN VARCHAR2
127 ,p_postal_code IN VARCHAR2 DEFAULT null
128 ,p_country IN VARCHAR2
129 ,p_telephone IN VARCHAR2 DEFAULT null
130 ,p_fax IN VARCHAR2 DEFAULT null
131 ,p_addr_attribute_category IN VARCHAR2 DEFAULT null
132 ,p_addr_attribute1 IN VARCHAR2 DEFAULT null
133 ,p_addr_attribute2 IN VARCHAR2 DEFAULT null
134 ,p_addr_attribute3 IN VARCHAR2 DEFAULT null
135 ,p_addr_attribute4 IN VARCHAR2 DEFAULT null
136 ,p_addr_attribute5 IN VARCHAR2 DEFAULT null
137 ,p_addr_attribute6 IN VARCHAR2 DEFAULT null
138 ,p_addr_attribute7 IN VARCHAR2 DEFAULT null
139 ,p_addr_attribute8 IN VARCHAR2 DEFAULT null
140 ,p_addr_attribute9 IN VARCHAR2 DEFAULT null
141 ,p_addr_attribute10 IN VARCHAR2 DEFAULT null
142 ,p_addr_attribute11 IN VARCHAR2 DEFAULT null
143 ,p_addr_attribute12 IN VARCHAR2 DEFAULT null
144 ,p_addr_attribute13 IN VARCHAR2 DEFAULT null
145 ,p_addr_attribute14 IN VARCHAR2 DEFAULT null
146 ,p_addr_attribute15 IN VARCHAR2 DEFAULT null
147 ,p_addr_attribute16 IN VARCHAR2 DEFAULT null
148 ,p_addr_attribute17 IN VARCHAR2 DEFAULT null
149 ,p_addr_attribute18 IN VARCHAR2 DEFAULT null
150 ,p_addr_attribute19 IN VARCHAR2 DEFAULT null
151 ,p_addr_attribute20 IN VARCHAR2 DEFAULT null
152 ,p_add_information13 IN VARCHAR2 DEFAULT null
153 ,p_add_information14 IN VARCHAR2 DEFAULT null
154 ,p_add_information15 IN VARCHAR2 DEFAULT null
155 ,p_add_information16 IN VARCHAR2 DEFAULT null
156 ,p_add_information17 IN VARCHAR2 DEFAULT null
157 ,p_add_information18 IN VARCHAR2 DEFAULT null
158 ,p_add_information19 IN VARCHAR2 DEFAULT null
159 ,p_add_information20 IN VARCHAR2 DEFAULT null
160 ,p_party_id IN NUMBER DEFAULT null
161 ,p_address_id OUT NOCOPY NUMBER
162 ,p_object_version_number OUT NOCOPY NUMBER );
163 --
164 -- ----------------------------------------------------------------------------
165 -- |-------------------------< update_cn_person_address >---------------------|
166 -- ----------------------------------------------------------------------------
167 --
168 -- {Start Of Comments}
169 /*#
170 * This API updates the address details of a person in business groups using
171 * the legislation for China.
172 *
173 * This API calls the generic update_person_address API. It maps certain
174 * columns to user-friendly names appropriate for China so as to ensure easy
175 * identification.As this API is an alternative API, see the generic
176 * update_person_address API for further explanation.
177 *
178 * <p><b>Licensing</b><br>
179 * This API is licensed for use with Human Resources.
180 *
181 * <p><b>Prerequisites</b><br>
182 * The address to be updated must already exist. The address_type attribute can
183 * only be used after QuickCodes have been defined for the 'ADDRESS_TYPE'
184 * lookup type. The business group of the person must belong to Chinese
185 * legislation. See the corresponding generic API for further details.
186 *
187 * <p><b>Post Success</b><br>
188 * The address details of the person will be updated.
189 *
190 * <p><b>Post Failure</b><br>
191 * The API does not update the person's address and raises an error.
192 * @param p_validate If true, then validation alone will be performed and the
193 * database will remain unchanged. If false and all validation checks pass,
194 * then the database will be modified.
195 * @param p_effective_date Determines when the DateTrack operation takes
196 * effect.
197 * @param p_validate_county Validates the county details in the address. This
198 * has a default value of 'true'.
199 * @param p_address_id {@rep:casecolumn PER_ADDRESSES.ADDRESS_ID}
200 * @param p_object_version_number This parameter passes in the current version
201 * number of the address to be updated. When the API completes, if p_validate
202 * is false, this will be set to the new version number of the updated address.
203 * If p_validate is true, this will be set to the same value which was passed
204 * in.
205 * @param p_date_from {@rep:casecolumn PER_ADDRESSES.DATE_FROM}
206 * @param p_date_to {@rep:casecolumn PER_ADDRESSES.DATE_TO}
207 * @param p_primary_flag The primary address for the person. Valid values are
208 * defined by the 'YES_NO' lookup type.
209 * @param p_address_type Address type, for example, home, business, weekend.
210 * Valid values are defined by the 'ADDRESS_TYPE' lookup type.
211 * @param p_comments Comment Text
212 * @param p_address_line1 Address Line 1
213 * @param p_address_line2 Address Line 2
214 * @param p_province_city_sar Province/City/SAR. Valid values are defined by
215 * the 'CN_PROVINCE' lookup type.
216 * @param p_postal_code Postal Code. Maximum 6 digits
217 * @param p_country Country details. Valid values are defined by the
218 * 'NATIONALITY' lookup type
219 * @param p_telephone Telephone Number
220 * @param p_fax Fax Number
221 * @param p_addr_attribute_category This context value determines which
222 * flexfield structure to use with the Person Address descriptive flexfield
223 * segments.
224 * @param p_addr_attribute1 Descriptive flexfield segment.
225 * @param p_addr_attribute2 Descriptive flexfield segment.
226 * @param p_addr_attribute3 Descriptive flexfield segment.
227 * @param p_addr_attribute4 Descriptive flexfield segment.
228 * @param p_addr_attribute5 Descriptive flexfield segment.
229 * @param p_addr_attribute6 Descriptive flexfield segment.
230 * @param p_addr_attribute7 Descriptive flexfield segment.
231 * @param p_addr_attribute8 Descriptive flexfield segment.
232 * @param p_addr_attribute9 Descriptive flexfield segment.
233 * @param p_addr_attribute10 Descriptive flexfield segment.
234 * @param p_addr_attribute11 Descriptive flexfield segment.
235 * @param p_addr_attribute12 Descriptive flexfield segment.
236 * @param p_addr_attribute13 Descriptive flexfield segment.
237 * @param p_addr_attribute14 Descriptive flexfield segment.
238 * @param p_addr_attribute15 Descriptive flexfield segment.
239 * @param p_addr_attribute16 Descriptive flexfield segment.
240 * @param p_addr_attribute17 Descriptive flexfield segment.
241 * @param p_addr_attribute18 Descriptive flexfield segment.
242 * @param p_addr_attribute19 Descriptive flexfield segment.
243 * @param p_addr_attribute20 Descriptive flexfield segment.
244 * @param p_add_information13 Obsolete parameter, do not use.
245 * @param p_add_information14 Obsolete parameter, do not use.
246 * @param p_add_information15 Obsolete parameter, do not use.
247 * @param p_add_information16 Obsolete parameter, do not use.
248 * @param p_add_information17 Obsolete parameter, do not use.
249 * @param p_add_information18 Obsolete parameter, do not use.
250 * @param p_add_information19 Obsolete parameter, do not use.
251 * @param p_add_information20 Obsolete parameter, do not use.
252 * @param p_party_id Party for whom the address applies.
253 * @rep:displayname Update Person Address for China
254 * @rep:category BUSINESS_ENTITY PER_PERSON_ADDRESS
255 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
256 * @rep:scope public
257 * @rep:lifecycle active
258 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
259 */
260 --
261 -- {End Of Comments}
262 --
263 PROCEDURE update_cn_person_address
264 (p_validate IN BOOLEAN DEFAULT false
265 ,p_effective_date IN DATE
266 ,p_validate_county IN BOOLEAN DEFAULT true
267 ,p_address_id IN NUMBER
268 ,p_object_version_number IN OUT NOCOPY NUMBER
269 ,p_date_from IN DATE DEFAULT hr_api.g_date
270 ,p_date_to IN DATE DEFAULT hr_api.g_date
271 ,p_primary_flag IN VARCHAR2 DEFAULT hr_api.g_varchar2
272 ,p_address_type IN VARCHAR2 DEFAULT hr_api.g_varchar2
273 ,p_comments IN LONG DEFAULT null
274 ,p_address_line1 IN VARCHAR2 DEFAULT hr_api.g_varchar2
275 ,p_address_line2 IN VARCHAR2 DEFAULT hr_api.g_varchar2
276 ,p_province_city_sar IN VARCHAR2 DEFAULT hr_api.g_varchar2
277 ,p_postal_code IN VARCHAR2 DEFAULT hr_api.g_varchar2
278 ,p_country IN VARCHAR2 DEFAULT hr_api.g_varchar2
279 ,p_telephone IN VARCHAR2 DEFAULT hr_api.g_varchar2
280 ,p_fax IN VARCHAR2 DEFAULT hr_api.g_varchar2
281 ,p_addr_attribute_category IN VARCHAR2 DEFAULT hr_api.g_varchar2
282 ,p_addr_attribute1 IN VARCHAR2 DEFAULT hr_api.g_varchar2
283 ,p_addr_attribute2 IN VARCHAR2 DEFAULT hr_api.g_varchar2
284 ,p_addr_attribute3 IN VARCHAR2 DEFAULT hr_api.g_varchar2
285 ,p_addr_attribute4 IN VARCHAR2 DEFAULT hr_api.g_varchar2
286 ,p_addr_attribute5 IN VARCHAR2 DEFAULT hr_api.g_varchar2
287 ,p_addr_attribute6 IN VARCHAR2 DEFAULT hr_api.g_varchar2
288 ,p_addr_attribute7 IN VARCHAR2 DEFAULT hr_api.g_varchar2
289 ,p_addr_attribute8 IN VARCHAR2 DEFAULT hr_api.g_varchar2
290 ,p_addr_attribute9 IN VARCHAR2 DEFAULT hr_api.g_varchar2
291 ,p_addr_attribute10 IN VARCHAR2 DEFAULT hr_api.g_varchar2
292 ,p_addr_attribute11 IN VARCHAR2 DEFAULT hr_api.g_varchar2
293 ,p_addr_attribute12 IN VARCHAR2 DEFAULT hr_api.g_varchar2
294 ,p_addr_attribute13 IN VARCHAR2 DEFAULT hr_api.g_varchar2
295 ,p_addr_attribute14 IN VARCHAR2 DEFAULT hr_api.g_varchar2
296 ,p_addr_attribute15 IN VARCHAR2 DEFAULT hr_api.g_varchar2
297 ,p_addr_attribute16 IN VARCHAR2 DEFAULT hr_api.g_varchar2
298 ,p_addr_attribute17 IN VARCHAR2 DEFAULT hr_api.g_varchar2
299 ,p_addr_attribute18 IN VARCHAR2 DEFAULT hr_api.g_varchar2
300 ,p_addr_attribute19 IN VARCHAR2 DEFAULT hr_api.g_varchar2
301 ,p_addr_attribute20 IN VARCHAR2 DEFAULT hr_api.g_varchar2
302 ,p_add_information13 IN VARCHAR2 DEFAULT hr_api.g_varchar2
303 ,p_add_information14 IN VARCHAR2 DEFAULT hr_api.g_varchar2
304 ,p_add_information15 IN VARCHAR2 DEFAULT hr_api.g_varchar2
305 ,p_add_information16 IN VARCHAR2 DEFAULT hr_api.g_varchar2
306 ,p_add_information17 IN VARCHAR2 DEFAULT hr_api.g_varchar2
307 ,p_add_information18 IN VARCHAR2 DEFAULT hr_api.g_varchar2
308 ,p_add_information19 IN VARCHAR2 DEFAULT hr_api.g_varchar2
309 ,p_add_information20 IN VARCHAR2 DEFAULT hr_api.g_varchar2
310 ,p_party_id IN NUMBER DEFAULT hr_api.g_number);
311
312 END hr_cn_person_address_api;
[Home] [Help]