1 Package ghr_person_address_api AUTHID CURRENT_USER as
2 /* $Header: ghaddapi.pkh 120.2 2005/10/02 01:56:09 aroussel $ */
3 /*#
4 * This package contains person address APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Person Address
8 */
9 --
10 -- Package Variables
11 --
12 --
13 --
14 -- ----------------------------------------------------------------------------
15 -- |-----------------------< create_us_person_address >-----------------------|
16 -- ----------------------------------------------------------------------------
17 --
18 -- Description
19 -- Wrapper to hr_person_address_api.create_us_person_address. Sets the session variables
20 -- so that the ghr_pa_history table can then be populated to maintain history of the
21 -- address record
22 --
23 procedure create_us_person_address
24 (p_validate in boolean default false
25 ,p_effective_date in date
26 ,p_person_id in number
27 ,p_primary_flag in varchar2
28 ,p_date_from in date
29 ,p_date_to in date default null
30 ,p_address_type in varchar2 default null
31 ,p_comments in long default null
32 ,p_address_line1 in varchar2
33 ,p_address_line2 in varchar2 default null
34 ,p_address_line3 in varchar2 default null
35 ,p_city in varchar2 default null
36 ,p_state in varchar2 default null
37 ,p_zip_code in varchar2 default null
38 ,p_county in varchar2 default null
39 ,p_country in varchar2
40 ,p_telephone_number_1 in varchar2 default null
41 ,p_telephone_number_2 in varchar2 default null
42 ,p_addr_attribute_category in varchar2 default null
43 ,p_addr_attribute1 in varchar2 default null
44 ,p_addr_attribute2 in varchar2 default null
45 ,p_addr_attribute3 in varchar2 default null
46 ,p_addr_attribute4 in varchar2 default null
47 ,p_addr_attribute5 in varchar2 default null
48 ,p_addr_attribute6 in varchar2 default null
49 ,p_addr_attribute7 in varchar2 default null
50 ,p_addr_attribute8 in varchar2 default null
51 ,p_addr_attribute9 in varchar2 default null
52 ,p_addr_attribute10 in varchar2 default null
53 ,p_addr_attribute11 in varchar2 default null
54 ,p_addr_attribute12 in varchar2 default null
55 ,p_addr_attribute13 in varchar2 default null
56 ,p_addr_attribute14 in varchar2 default null
57 ,p_addr_attribute15 in varchar2 default null
58 ,p_addr_attribute16 in varchar2 default null
59 ,p_addr_attribute17 in varchar2 default null
60 ,p_addr_attribute18 in varchar2 default null
61 ,p_addr_attribute19 in varchar2 default null
62 ,p_addr_attribute20 in varchar2 default null
63 ,p_address_id out nocopy number
64 ,p_object_version_number out nocopy number
65 ) ;
66 --
67 -- ----------------------------------------------------------------------------
68 -- |-----------------------< create_us_int_person_address >-------------------|
69 -- ----------------------------------------------------------------------------
70 --
71 -- {Start Of Comments}
72 /*#
73 * This API creates the Address for a person.
74 *
75 * This API creates the United States International Address record in the
76 * PER_ADDRESSES table. City, State and Zip Code values are not validated in
77 * this address style.
78 *
79 * <p><b>Licensing</b><br>
80 * This API is licensed for use with Human Resources.
81 *
82 * <p><b>Prerequisites</b><br>
83 * The person must exist on the effective date.
84 *
85 * <p><b>Post Success</b><br>
86 * The address is successfully created.
87 *
88 * <p><b>Post Failure</b><br>
92 * then the database will be modified.
89 * The address is not created and an error is raised.
90 * @param p_validate If true, then validation alone will be performed and the
91 * database will remain unchanged. If false and all validation checks pass,
93 * @param p_effective_date Reference date for validating lookup values are
94 * applicable during the start to end active date range. This date does not
95 * determine when the changes take effect.
96 * @param p_pradd_ovlapval_override Override overlapping primary address
97 * validation. Valid values 'TRUE' or 'FALSE'
98 * @param p_validate_county Validate the County information
99 * @param p_person_id {@rep:casecolumn PER_ALL_PEOPLE_F.PERSON_ID}
100 * @param p_primary_flag {@rep:casecolumn PER_ADDRESSES.PRIMARY_FLAG}
101 * @param p_date_from Start date of the address
102 * @param p_date_to End date of the address
103 * @param p_address_type Type of Address. Valid Values are defined by
104 * 'ADDRESS_TYPE' Lookup Type.
105 * @param p_comments Comment text
106 * @param p_address_line1 The first line of address
107 * @param p_address_line2 The second line of address
108 * @param p_address_line3 The third line of address
109 * @param p_city City Name
110 * @param p_state State Code
111 * @param p_zip_code Zip code to identify a specific address in the country
112 * @param p_county County
113 * @param p_country Country
114 * @param p_telephone_number_1 Telephone number for the address
115 * @param p_telephone_number_2 Second telephone number for the address
116 * @param p_addr_attribute_category Determines context of the Address
117 * Descriptive Flexfield in parameters.
118 * @param p_addr_attribute1 Descriptive flexfield
119 * @param p_addr_attribute2 Descriptive flexfield
120 * @param p_addr_attribute3 Descriptive flexfield
121 * @param p_addr_attribute4 Descriptive flexfield
122 * @param p_addr_attribute5 Descriptive flexfield
123 * @param p_addr_attribute6 Descriptive flexfield
124 * @param p_addr_attribute7 Descriptive flexfield
125 * @param p_addr_attribute8 Descriptive flexfield
126 * @param p_addr_attribute9 Descriptive flexfield
127 * @param p_addr_attribute10 Descriptive flexfield
128 * @param p_addr_attribute11 Descriptive flexfield
129 * @param p_addr_attribute12 Descriptive flexfield
130 * @param p_addr_attribute13 Descriptive flexfield
131 * @param p_addr_attribute14 Descriptive flexfield
132 * @param p_addr_attribute15 Descriptive flexfield
133 * @param p_addr_attribute16 Descriptive flexfield
134 * @param p_addr_attribute17 Descriptive flexfield
135 * @param p_addr_attribute18 Descriptive flexfield
136 * @param p_addr_attribute19 Descriptive flexfield
137 * @param p_addr_attribute20 Descriptive flexfield
138 * @param p_add_information13 Developer Descriptive flexfield segment.
139 * @param p_add_information14 Developer Descriptive flexfield segment.
140 * @param p_add_information15 Developer Descriptive flexfield segment.
141 * @param p_add_information16 Developer Descriptive flexfield segment.
142 * @param p_add_information17 Developer Descriptive flexfield segment.
143 * @param p_add_information18 Developer Descriptive flexfield segment.
144 * @param p_add_information19 Developer Descriptive flexfield segment.
145 * @param p_add_information20 Developer Descriptive flexfield segment.
146 * @param p_party_id Developer Descriptive flexfield segment.
147 * @param p_address_id System-generated primary key column
148 * @param p_object_version_number If p_validate is false, then set to the
149 * version number of the created Address. If p_validate is true, then the value
150 * will be null.
151 * @rep:displayname Create United States International Person Address
152 * @rep:category BUSINESS_ENTITY PER_PERSON_ADDRESS
153 * @rep:scope public
154 * @rep:lifecycle active
155 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
156 */
157 --
158 -- {End Of Comments}
159 --
160 procedure create_us_int_person_address
161 (p_validate in boolean default false
162 ,p_effective_date in date
163 ,p_pradd_ovlapval_override in boolean default FALSE
164 ,p_validate_county in boolean default true
165 ,p_person_id in number
166 ,p_primary_flag in varchar2
167 ,p_date_from in date
168 ,p_date_to in date default null
169 ,p_address_type in varchar2 default null
170 ,p_comments in long default null
171 ,p_address_line1 in varchar2
172 ,p_address_line2 in varchar2 default null
173 ,p_address_line3 in varchar2 default null
174 ,p_city in varchar2 default null
175 ,p_state in varchar2 default null
176 ,p_zip_code in varchar2 default null
177 ,p_county in varchar2 default null
178 ,p_country in varchar2
179 ,p_telephone_number_1 in varchar2 default null
180 ,p_telephone_number_2 in varchar2 default null
181 ,p_addr_attribute_category in varchar2 default null
182 ,p_addr_attribute1 in varchar2 default null
183 ,p_addr_attribute2 in varchar2 default null
184 ,p_addr_attribute3 in varchar2 default null
185 ,p_addr_attribute4 in varchar2 default null
186 ,p_addr_attribute5 in varchar2 default null
187 ,p_addr_attribute6 in varchar2 default null
188 ,p_addr_attribute7 in varchar2 default null
189 ,p_addr_attribute8 in varchar2 default null
190 ,p_addr_attribute9 in varchar2 default null
191 ,p_addr_attribute10 in varchar2 default null
192 ,p_addr_attribute11 in varchar2 default null
196 ,p_addr_attribute15 in varchar2 default null
193 ,p_addr_attribute12 in varchar2 default null
194 ,p_addr_attribute13 in varchar2 default null
195 ,p_addr_attribute14 in varchar2 default null
197 ,p_addr_attribute16 in varchar2 default null
198 ,p_addr_attribute17 in varchar2 default null
199 ,p_addr_attribute18 in varchar2 default null
200 ,p_addr_attribute19 in varchar2 default null
201 ,p_addr_attribute20 in varchar2 default null
202 ,p_add_information13 in varchar2 default null
203 ,p_add_information14 in varchar2 default null
204 ,p_add_information15 in varchar2 default null
205 ,p_add_information16 in varchar2 default null
206 ,p_add_information17 in varchar2 default null
207 ,p_add_information18 in varchar2 default null
208 ,p_add_information19 in varchar2 default null
209 ,p_add_information20 in varchar2 default null
210 ,p_party_id in number default null -- HR/TCA merge
211 ,p_address_id out nocopy number
212 ,p_object_version_number out nocopy number
213 );
214 --
215
216 --
217 -- ----------------------------------------------------------------------------
218 -- |-----------------------< update_us_person_address >-----------------------|
219 -- ----------------------------------------------------------------------------
220 --
221 -- Description
222 -- Wrapper to hr_person_address_api.update_us_person_address. Sets the session variables
223 -- so that the ghr_pa_history table can then be populated to maintain history of the
224 -- address record
225
226 procedure update_us_person_address
227 (p_validate in boolean default false
228 ,p_effective_date in date
229 ,p_address_id in number
230 ,p_object_version_number in out nocopy number
231 ,p_date_from in date default hr_api.g_date
232 ,p_date_to in date default hr_api.g_date
233 ,p_address_type in varchar2 default hr_api.g_varchar2
234 ,p_comments in long default hr_api.g_varchar2
235 ,p_address_line1 in varchar2 default hr_api.g_varchar2
236 ,p_address_line2 in varchar2 default hr_api.g_varchar2
237 ,p_address_line3 in varchar2 default hr_api.g_varchar2
238 ,p_city in varchar2 default hr_api.g_varchar2
239 ,p_state in varchar2 default hr_api.g_varchar2
240 ,p_zip_code in varchar2 default hr_api.g_varchar2
241 ,p_county in varchar2 default hr_api.g_varchar2
242 ,p_country in varchar2 default hr_api.g_varchar2
243 ,p_telephone_number_1 in varchar2 default hr_api.g_varchar2
244 ,p_telephone_number_2 in varchar2 default hr_api.g_varchar2
245 ,p_addr_attribute_category in varchar2 default hr_api.g_varchar2
246 ,p_addr_attribute1 in varchar2 default hr_api.g_varchar2
247 ,p_addr_attribute2 in varchar2 default hr_api.g_varchar2
248 ,p_addr_attribute3 in varchar2 default hr_api.g_varchar2
249 ,p_addr_attribute4 in varchar2 default hr_api.g_varchar2
250 ,p_addr_attribute5 in varchar2 default hr_api.g_varchar2
251 ,p_addr_attribute6 in varchar2 default hr_api.g_varchar2
252 ,p_addr_attribute7 in varchar2 default hr_api.g_varchar2
253 ,p_addr_attribute8 in varchar2 default hr_api.g_varchar2
254 ,p_addr_attribute9 in varchar2 default hr_api.g_varchar2
255 ,p_addr_attribute10 in varchar2 default hr_api.g_varchar2
256 ,p_addr_attribute11 in varchar2 default hr_api.g_varchar2
257 ,p_addr_attribute12 in varchar2 default hr_api.g_varchar2
258 ,p_addr_attribute13 in varchar2 default hr_api.g_varchar2
259 ,p_addr_attribute14 in varchar2 default hr_api.g_varchar2
260 ,p_addr_attribute15 in varchar2 default hr_api.g_varchar2
261 ,p_addr_attribute16 in varchar2 default hr_api.g_varchar2
262 ,p_addr_attribute17 in varchar2 default hr_api.g_varchar2
263 ,p_addr_attribute18 in varchar2 default hr_api.g_varchar2
264 ,p_addr_attribute19 in varchar2 default hr_api.g_varchar2
265 ,p_addr_attribute20 in varchar2 default hr_api.g_varchar2
266 ) ;
267 --
268 -- ----------------------------------------------------------------------------
269 -- |-----------------------< update_us_int_person_address >-------------------|
270 -- ----------------------------------------------------------------------------
271 --
272 -- {Start Of Comments}
273 /*#
274 * This API updates the address for a person.
275 *
276 * This API updates the United States International Address record in the
277 * PER_ADDRESSES table. City, State and Zip Code values are not validated in
278 * this address style.
279 *
280 * <p><b>Licensing</b><br>
281 * This API is licensed for use with Human Resources.
282 *
283 * <p><b>Prerequisites</b><br>
284 * The person and address must exist on the effective date,
285 *
286 * <p><b>Post Success</b><br>
287 * The address will be successfully updated
288 *
289 * <p><b>Post Failure</b><br>
290 * The address will not be updated and an error is raised.
291 * @param p_validate If true, then validation alone will be performed and the
292 * database will remain unchanged. If false and all validation checks pass,
293 * then the database will be modified.
297 * @param p_validate_county Validate the County information
294 * @param p_effective_date Reference date for validating lookup values are
295 * applicable during the start to end active date range. This date does not
296 * determine when the changes take effect.
298 * @param p_address_id {@rep:casecolumn PER_ALL_PEOPLE_F.PERSON_ID}
299 * @param p_object_version_number Pass in the current version number of the
300 * Address to be updated. When the API completes if p_validate is false, will
301 * be set to the new version number of the updated Address. If p_validate is
302 * true will be set to the same value which was passed in.
303 * @param p_date_from Start date at the address
304 * @param p_date_to End date at the address
305 * @param p_address_type Type of Address. Valid Values are defined by
306 * 'ADDRESS_TYPE' Lookup Type.
307 * @param p_comments Comment text.
308 * @param p_address_line1 The first line of address
309 * @param p_address_line2 The second line of address
310 * @param p_address_line3 The third line of address
311 * @param p_city City Name
312 * @param p_state State Code
313 * @param p_zip_code Zip code to identify a specific address in the country
314 * @param p_county County
315 * @param p_country Country
316 * @param p_telephone_number_1 Telephone number for the address
317 * @param p_telephone_number_2 Second telephone number for the address
318 * @param p_addr_attribute_category Determines context of the Address
319 * Descriptive Flexfield in parameters.
320 * @param p_addr_attribute1 Descriptive flexfield
321 * @param p_addr_attribute2 Descriptive flexfield
322 * @param p_addr_attribute3 Descriptive flexfield
323 * @param p_addr_attribute4 Descriptive flexfield
324 * @param p_addr_attribute5 Descriptive flexfield
325 * @param p_addr_attribute6 Descriptive flexfield
326 * @param p_addr_attribute7 Descriptive flexfield
327 * @param p_addr_attribute8 Descriptive flexfield
328 * @param p_addr_attribute9 Descriptive flexfield
329 * @param p_addr_attribute10 Descriptive flexfield
330 * @param p_addr_attribute11 Descriptive flexfield
331 * @param p_addr_attribute12 Descriptive flexfield
332 * @param p_addr_attribute13 Descriptive flexfield
333 * @param p_addr_attribute14 Descriptive flexfield
334 * @param p_addr_attribute15 Descriptive flexfield
335 * @param p_addr_attribute16 Descriptive flexfield
336 * @param p_addr_attribute17 Descriptive flexfield
337 * @param p_addr_attribute18 Descriptive flexfield
338 * @param p_addr_attribute19 Descriptive flexfield
339 * @param p_addr_attribute20 Descriptive flexfield
340 * @param p_add_information13 Developer Descriptive flexfield segment.
341 * @param p_add_information14 Developer Descriptive flexfield segment.
342 * @param p_add_information15 Developer Descriptive flexfield segment.
343 * @param p_add_information16 Developer Descriptive flexfield segment.
344 * @param p_add_information17 Developer Descriptive flexfield segment.
345 * @param p_add_information18 Developer Descriptive flexfield segment.
346 * @param p_add_information19 Developer Descriptive flexfield segment.
347 * @param p_add_information20 Developer Descriptive flexfield segment.
348 * @rep:displayname Update United States International Person Address
349 * @rep:category BUSINESS_ENTITY PER_PERSON_ADDRESS
350 * @rep:scope public
351 * @rep:lifecycle active
352 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
353 */
354 --
355 -- {End Of Comments}
356 --
357 procedure update_us_int_person_address
358 (p_validate in boolean default false
359 ,p_effective_date in date
360 ,p_validate_county in boolean default true
361 ,p_address_id in number
362 ,p_object_version_number in out nocopy number
363 ,p_date_from in date default hr_api.g_date
364 ,p_date_to in date default hr_api.g_date
365 ,p_address_type in varchar2 default hr_api.g_varchar2
366 ,p_comments in long default hr_api.g_varchar2
367 ,p_address_line1 in varchar2 default hr_api.g_varchar2
368 ,p_address_line2 in varchar2 default hr_api.g_varchar2
369 ,p_address_line3 in varchar2 default hr_api.g_varchar2
370 ,p_city in varchar2 default hr_api.g_varchar2
371 ,p_state in varchar2 default hr_api.g_varchar2
372 ,p_zip_code in varchar2 default hr_api.g_varchar2
373 ,p_county in varchar2 default hr_api.g_varchar2
374 ,p_country in varchar2 default hr_api.g_varchar2
375 ,p_telephone_number_1 in varchar2 default hr_api.g_varchar2
376 ,p_telephone_number_2 in varchar2 default hr_api.g_varchar2
377 ,p_addr_attribute_category in varchar2 default hr_api.g_varchar2
378 ,p_addr_attribute1 in varchar2 default hr_api.g_varchar2
379 ,p_addr_attribute2 in varchar2 default hr_api.g_varchar2
380 ,p_addr_attribute3 in varchar2 default hr_api.g_varchar2
381 ,p_addr_attribute4 in varchar2 default hr_api.g_varchar2
382 ,p_addr_attribute5 in varchar2 default hr_api.g_varchar2
383 ,p_addr_attribute6 in varchar2 default hr_api.g_varchar2
384 ,p_addr_attribute7 in varchar2 default hr_api.g_varchar2
385 ,p_addr_attribute8 in varchar2 default hr_api.g_varchar2
386 ,p_addr_attribute9 in varchar2 default hr_api.g_varchar2
387 ,p_addr_attribute10 in varchar2 default hr_api.g_varchar2
388 ,p_addr_attribute11 in varchar2 default hr_api.g_varchar2
389 ,p_addr_attribute12 in varchar2 default hr_api.g_varchar2
390 ,p_addr_attribute13 in varchar2 default hr_api.g_varchar2
391 ,p_addr_attribute14 in varchar2 default hr_api.g_varchar2
392 ,p_addr_attribute15 in varchar2 default hr_api.g_varchar2
393 ,p_addr_attribute16 in varchar2 default hr_api.g_varchar2
394 ,p_addr_attribute17 in varchar2 default hr_api.g_varchar2
395 ,p_addr_attribute18 in varchar2 default hr_api.g_varchar2
396 ,p_addr_attribute19 in varchar2 default hr_api.g_varchar2
397 ,p_addr_attribute20 in varchar2 default hr_api.g_varchar2
398 ,p_add_information13 in varchar2 default hr_api.g_varchar2
399 ,p_add_information14 in varchar2 default hr_api.g_varchar2
400 ,p_add_information15 in varchar2 default hr_api.g_varchar2
401 ,p_add_information16 in varchar2 default hr_api.g_varchar2
402 ,p_add_information17 in varchar2 default hr_api.g_varchar2
403 ,p_add_information18 in varchar2 default hr_api.g_varchar2
404 ,p_add_information19 in varchar2 default hr_api.g_varchar2
405 ,p_add_information20 in varchar2 default hr_api.g_varchar2
406 );
407 end ghr_person_address_api;
[Home] [Help]