1 Package hr_kiosk_address_api AUTHID CURRENT_USER as
2 /* $Header: pekadapi.pkh 115.1 2003/02/11 10:48:26 pkakar ship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |------------------------< create_person_address >-------------------------|
6 -- ----------------------------------------------------------------------------
7 -- {Start Of Comments}
8 --
9 -- Description:
10 -- This API creates a new address, for a particular person.
11 --
12 -- If creating the first address for the specified person, then it must be
13 -- the primary address. As one and only one primary address can exist at
14 -- any given time for a person, any subsequent addresses must not be
15 -- primary.
16 --
17 -- Currently only GB, US and GENERIC address styles are supported by this API.
18 --
19 -- Prerequisites:
20 -- A valid person (p_person_id) must exist on the start date (p_date_from)
21 -- of the address.
22 --
23 -- The address_type attribute can only be used after QuickCodes have been
24 -- defined for the 'ADDRESS_TYPE' lookup type.
25 --
26 -- In Parameters:
27 -- Name Reqd Type Description
28 -- p_validate boolean If true, the database
29 -- remains unchanged. If false,
30 -- the address is created.
31 -- p_effective_date Yes date Effective date.
32 -- p_person_id Yes number Person for whom the address
33 -- applies.
34 -- p_primary_flag Yes varchar2 Identifies the primary
35 -- address.
36 -- p_style Yes varchar2 Identifies the style of
37 -- address (eg.'GB').
38 -- p_date_from Yes date The date from which the
39 -- address applies.
40 -- p_date_to date The date on which the
41 -- address no longer applies.
42 -- p_address_type varchar2 Type of address.
43 -- p_comments long Comments.
44 -- p_address_line1 varchar2 Line 1 of address.
45 -- p_address_line2 varchar2 Line 2 of address.
46 -- p_address_line3 varchar2 Line 3 of address.
47 -- p_town_or_city varchar2 Town/city.
48 -- p_region_1 varchar2 Determined by p_style
49 -- (eg. County for GB and US).
50 -- p_region_2 varchar2 Determined by p_style
51 -- (eg. State for US)
52 -- p_region_3 varchar2 Determined by p_style.
53 -- p_postal_code varchar2 Determined by p_style
54 -- (eg. Postcode for GB or
55 -- Zip code for US).
56 -- p_country varchar2 Country.
57 -- p_telephone_number_1 varchar2 Telephone number.
58 -- p_telephone_number_2 varchar2 Telephone number.
59 -- p_telephone_number_3 varchar2 Not currently implemented.
60 -- p_addr_attribute_category varchar2 Determines context of the
61 -- addr_attribute Descriptive
62 -- flexfield in parameters.
63 -- p_addr_attribute1 varchar2 Descriptive flexfield.
64 -- p_addr_attribute2 varchar2 Descriptive flexfield.
65 -- p_addr_attribute3 varchar2 Descriptive flexfield.
66 -- p_addr_attribute4 varchar2 Descriptive flexfield.
67 -- p_addr_attribute5 varchar2 Descriptive flexfield.
68 -- p_addr_attribute6 varchar2 Descriptive flexfield.
69 -- p_addr_attribute7 varchar2 Descriptive flexfield.
70 -- p_addr_attribute8 varchar2 Descriptive flexfield.
71 -- p_addr_attribute9 varchar2 Descriptive flexfield.
72 -- p_addr_attribute10 varchar2 Descriptive flexfield.
73 -- p_addr_attribute11 varchar2 Descriptive flexfield.
74 -- p_addr_attribute12 varchar2 Descriptive flexfield.
75 -- p_addr_attribute13 varchar2 Descriptive flexfield.
76 -- p_addr_attribute14 varchar2 Descriptive flexfield.
77 -- p_addr_attribute15 varchar2 Descriptive flexfield.
78 -- p_addr_attribute16 varchar2 Descriptive flexfield.
79 -- p_addr_attribute17 varchar2 Descriptive flexfield.
80 -- p_addr_attribute18 varchar2 Descriptive flexfield.
81 -- p_addr_attribute19 varchar2 Descriptive flexfield.
82 -- p_addr_attribute20 varchar2 Descriptive flexfield.
83 --
84 -- Post Success:
85 -- When the address is valid, the API sets the following out parameters.
86 --
87 -- Name Type Description
88 -- p_address_id number If p_validate is false, uniquely
89 -- identifies the address created.
90 -- If p_validate is true, set to
91 -- null.
92 -- p_object_version_number number If p_validate is false, set to
93 -- the version number of this
94 -- address. If p_validate is true,
95 -- set to null.
96 --
97 -- Post Failure:
98 -- The API does not create the address and raises an error.
99 --
100 -- Access Status:
101 -- Public.
102 --
103 -- {End Of Comments}
104 --
105 procedure create_person_address
106 (p_validate in boolean default false
107 ,p_effective_date in date
108 ,p_person_id in number
109 ,p_primary_flag in varchar2
110 ,p_style in varchar2
111 ,p_date_from in date
112 ,p_date_to in date default null
113 ,p_address_type in varchar2 default null
114 ,p_comments in long default null
115 ,p_address_line1 in varchar2 default null
116 ,p_address_line2 in varchar2 default null
117 ,p_address_line3 in varchar2 default null
118 ,p_town_or_city in varchar2 default null
119 ,p_region_1 in varchar2 default null
120 ,p_region_2 in varchar2 default null
121 ,p_region_3 in varchar2 default null
122 ,p_postal_code in varchar2 default null
123 ,p_country in varchar2 default null
124 ,p_telephone_number_1 in varchar2 default null
125 ,p_telephone_number_2 in varchar2 default null
126 ,p_telephone_number_3 in varchar2 default null
127 ,p_addr_attribute_category in varchar2 default null
128 ,p_addr_attribute1 in varchar2 default null
129 ,p_addr_attribute2 in varchar2 default null
130 ,p_addr_attribute3 in varchar2 default null
131 ,p_addr_attribute4 in varchar2 default null
132 ,p_addr_attribute5 in varchar2 default null
133 ,p_addr_attribute6 in varchar2 default null
134 ,p_addr_attribute7 in varchar2 default null
135 ,p_addr_attribute8 in varchar2 default null
136 ,p_addr_attribute9 in varchar2 default null
137 ,p_addr_attribute10 in varchar2 default null
138 ,p_addr_attribute11 in varchar2 default null
139 ,p_addr_attribute12 in varchar2 default null
140 ,p_addr_attribute13 in varchar2 default null
141 ,p_addr_attribute14 in varchar2 default null
142 ,p_addr_attribute15 in varchar2 default null
143 ,p_addr_attribute16 in varchar2 default null
144 ,p_addr_attribute17 in varchar2 default null
145 ,p_addr_attribute18 in varchar2 default null
146 ,p_addr_attribute19 in varchar2 default null
147 ,p_addr_attribute20 in varchar2 default null
148 ,p_address_id out nocopy number
149 ,p_object_version_number out nocopy number
150 );
151 --
152 -- ----------------------------------------------------------------------------
153 -- |-----------------------< create_gb_person_address >-----------------------|
154 -- ----------------------------------------------------------------------------
155 -- {Start Of Comments}
156 --
157 -- Description:
158 -- This API creates the GB style address as specified, for the person
159 -- identified by the in parameter p_person_id. This API calls the generic
160 -- API create_person_address, with the parameters set as
161 -- appropriate for a GB style address.
162 --
163 -- As this API is effectively an alternative to the API
164 -- create_person_address, see that API for further explanation.
165 --
166 -- Prerequisites:
167 -- See API create_person_address.
168 --
169 -- In Parameters:
170 -- Name Reqd Type Description
171 -- p_validate boolean If true, the database remains
172 -- unchanged. If false a valid
173 -- address will be created in
174 -- the database.
175 -- p_effective_date Yes date Effective date.
176 -- p_person_id Yes number Person for which the address
177 -- applies.
178 -- p_primary_flag Yes varchar2 Indicates if this is a
179 -- primary or non-primary
180 -- address. Y or N.
181 -- p_date_from Yes date The date from which this
182 -- address applies.
183 -- p_date_to date The date on which the
184 -- address no longer applies.
185 -- p_address_type varchar2 Type of address.
186 -- p_comments long Comments.
187 -- p_address_line1 Yes varchar2 Line 1 of address.
188 -- p_address_line2 varchar2 Line 2 of address.
189 -- p_address_line3 varchar2 Line 3 of address.
190 -- p_town varchar2 Town.
191 -- p_county varchar2 County.
192 -- p_postcode varchar2 Postcode.
193 -- p_country Yes varchar2 Country.
194 -- p_telephone_number varchar2 Telephone number.
195 -- p_addr_attribute_category varchar2 Determines context of the
196 -- addr_attribute Descriptive
197 -- flexfield in parameters.
198 -- p_addr_attribute1 varchar2 Descriptive flexfield.
199 -- p_addr_attribute2 varchar2 Descriptive flexfield.
200 -- p_addr_attribute3 varchar2 Descriptive flexfield.
201 -- p_addr_attribute4 varchar2 Descriptive flexfield.
202 -- p_addr_attribute5 varchar2 Descriptive flexfield.
203 -- p_addr_attribute6 varchar2 Descriptive flexfield.
204 -- p_addr_attribute7 varchar2 Descriptive flexfield.
205 -- p_addr_attribute8 varchar2 Descriptive flexfield.
206 -- p_addr_attribute9 varchar2 Descriptive flexfield.
207 -- p_addr_attribute10 varchar2 Descriptive flexfield.
208 -- p_addr_attribute11 varchar2 Descriptive flexfield.
209 -- p_addr_attribute12 varchar2 Descriptive flexfield.
210 -- p_addr_attribute13 varchar2 Descriptive flexfield.
211 -- p_addr_attribute14 varchar2 Descriptive flexfield.
212 -- p_addr_attribute15 varchar2 Descriptive flexfield.
213 -- p_addr_attribute16 varchar2 Descriptive flexfield.
214 -- p_addr_attribute17 varchar2 Descriptive flexfield.
215 -- p_addr_attribute18 varchar2 Descriptive flexfield.
216 -- p_addr_attribute19 varchar2 Descriptive flexfield.
217 -- p_addr_attribute20 varchar2 Descriptive flexfield.
218
219 -- Post Success:
220 -- When the address is valid the following out parameters are set.
221 --
222 -- Name Type Description
223 -- p_address_id number If p_validate is false, uniquely
224 -- identifies the address created.
225 -- If p_validate is true, set to
226 -- null.
227 -- p_object_version_number number If p_validate is false, set to
228 -- the version number of this
229 -- address. If p_validate is true,
230 -- set to null.
231 --
232 -- Post Failure:
233 -- The API does not create the address and raises an error.
234 --
235 -- Access Status:
236 -- Public.
237 --
238 -- {End Of Comments}
239 --
240 procedure create_gb_person_address
241 (p_validate in boolean default false
242 ,p_effective_date in date
243 ,p_person_id in number
244 ,p_primary_flag in varchar2
245 ,p_date_from in date
246 ,p_date_to in date default null
247 ,p_address_type in varchar2 default null
248 ,p_comments in long default null
249 ,p_address_line1 in varchar2
250 ,p_address_line2 in varchar2 default null
251 ,p_address_line3 in varchar2 default null
252 ,p_town in varchar2 default null
253 ,p_county in varchar2 default null
254 ,p_postcode in varchar2 default null
255 ,p_country in varchar2
256 ,p_telephone_number in varchar2 default null
257 ,p_addr_attribute_category in varchar2 default null
258 ,p_addr_attribute1 in varchar2 default null
259 ,p_addr_attribute2 in varchar2 default null
260 ,p_addr_attribute3 in varchar2 default null
261 ,p_addr_attribute4 in varchar2 default null
262 ,p_addr_attribute5 in varchar2 default null
263 ,p_addr_attribute6 in varchar2 default null
264 ,p_addr_attribute7 in varchar2 default null
265 ,p_addr_attribute8 in varchar2 default null
266 ,p_addr_attribute9 in varchar2 default null
267 ,p_addr_attribute10 in varchar2 default null
268 ,p_addr_attribute11 in varchar2 default null
269 ,p_addr_attribute12 in varchar2 default null
270 ,p_addr_attribute13 in varchar2 default null
271 ,p_addr_attribute14 in varchar2 default null
272 ,p_addr_attribute15 in varchar2 default null
273 ,p_addr_attribute16 in varchar2 default null
274 ,p_addr_attribute17 in varchar2 default null
275 ,p_addr_attribute18 in varchar2 default null
276 ,p_addr_attribute19 in varchar2 default null
277 ,p_addr_attribute20 in varchar2 default null
278 ,p_address_id out nocopy number
279 ,p_object_version_number out nocopy number
280 );
281 --
282 -- ----------------------------------------------------------------------------
283 -- |-----------------------< create_us_person_address >-----------------------|
284 -- ----------------------------------------------------------------------------
285 -- {Start Of Comments}
286 --
287 -- Description:
288 -- This API creates a US style address a person. This API calls the generic
289 -- API create_person_address with the applicable parameters for a US address
290 -- style.
291 --
292 -- Prerequisites:
293 -- A valid person (p_person_id) must exist on the start date (p_date_from)
294 -- of the address.
295 --
296 -- The address_type attribute can only be used after QuickCodes have been
297 -- defined for the 'ADDRESS_TYPE' lookup type.
298 --
299 --
300 -- In Parameters:
301 -- Name Reqd Type Description
302 -- p_validate boolean If true, the database remains
303 -- unchanged. If false a valid
304 -- address will be created in
305 -- the database.
306 -- p_effective_date Yes date Effective date.
307 -- p_person_id Yes number Person for which the address
308 -- applies.
309 -- p_primary_flag Yes varchar2 Indicates if this is a
310 -- primary or non-primary
311 -- address. Y or N.
312 -- p_date_from Yes date The date from which this
313 -- address applies.
314 -- p_date_to date The date on which the
315 -- address no longer applies.
316 -- p_address_type varchar2 Type of address.
317 -- p_comments long Comments.
318 -- p_address_line1 Yes varchar2 Line 1 of address.
319 -- p_address_line2 varchar2 Line 2 of address.
320 -- p_address_line3 varchar2 Line 3 of address.
321 -- p_city varchar2 City. The city is mandatory
322 -- if payroll is installed under
323 -- US legislation.
324 -- p_state varchar2 State. The state is mandatory
325 -- if payroll is installed under
326 -- US legislation.
327 -- p_zip_code varchar2 Zip code. The zip code is
328 -- mandatory if payroll is
329 -- installed under US
330 -- legislation.
331 -- p_county varchar2 County. The county is
332 -- mandatory if payroll is
333 -- installed under US
334 -- legislation.
335 -- p_country Yes varchar2 Country.
336 -- p_telephone_number_1 varchar2 Telephone number 1.
337 -- p_telephone_number_2 varchar2 Telephone number 2.
338 -- p_addr_attribute_category varchar2 Determines context of the
339 -- addr_attribute Descriptive
340 -- flexfield in parameters.
341 -- p_addr_attribute1 varchar2 Descriptive flexfield.
342 -- p_addr_attribute2 varchar2 Descriptive flexfield.
343 -- p_addr_attribute3 varchar2 Descriptive flexfield.
344 -- p_addr_attribute4 varchar2 Descriptive flexfield.
345 -- p_addr_attribute5 varchar2 Descriptive flexfield.
346 -- p_addr_attribute6 varchar2 Descriptive flexfield.
347 -- p_addr_attribute7 varchar2 Descriptive flexfield.
348 -- p_addr_attribute8 varchar2 Descriptive flexfield.
349 -- p_addr_attribute9 varchar2 Descriptive flexfield.
350 -- p_addr_attribute10 varchar2 Descriptive flexfield.
351 -- p_addr_attribute11 varchar2 Descriptive flexfield.
352 -- p_addr_attribute12 varchar2 Descriptive flexfield.
353 -- p_addr_attribute13 varchar2 Descriptive flexfield.
354 -- p_addr_attribute14 varchar2 Descriptive flexfield.
355 -- p_addr_attribute15 varchar2 Descriptive flexfield.
356 -- p_addr_attribute16 varchar2 Descriptive flexfield.
357 -- p_addr_attribute17 varchar2 Descriptive flexfield.
358 -- p_addr_attribute18 varchar2 Descriptive flexfield.
359 -- p_addr_attribute19 varchar2 Descriptive flexfield.
360 -- p_addr_attribute20 varchar2 Descriptive flexfield.
361 --
362 -- Post Success:
363 -- When the address is valid the following out parameters are set.
364 --
365 -- Name Type Description
366 -- p_address_id number If p_validate is false, uniquely
367 -- identifies the address created.
368 -- If p_validate is true, set to
369 -- null.
370 -- p_object_version_number number If p_validate is false, set to
371 -- the version number of this
372 -- address. If p_validate is true,
373 -- set to null.
374 --
375 -- Post Failure:
376 -- The API does not create the address and raises an error.
377 --
378 -- Access Status:
379 -- Public.
380 --
381 -- {End Of Comments}
382 --
383 procedure create_us_person_address
384 (p_validate in boolean default false
385 ,p_effective_date in date
386 ,p_person_id in number
387 ,p_primary_flag in varchar2
388 ,p_date_from in date
389 ,p_date_to in date default null
390 ,p_address_type in varchar2 default null
391 ,p_comments in long default null
392 ,p_address_line1 in varchar2
393 ,p_address_line2 in varchar2 default null
394 ,p_address_line3 in varchar2 default null
395 ,p_city in varchar2 default null
396 ,p_state in varchar2 default null
397 ,p_zip_code in varchar2 default null
398 ,p_county in varchar2 default null
399 ,p_country in varchar2
400 ,p_telephone_number_1 in varchar2 default null
401 ,p_telephone_number_2 in varchar2 default null
402 ,p_addr_attribute_category in varchar2 default null
403 ,p_addr_attribute1 in varchar2 default null
404 ,p_addr_attribute2 in varchar2 default null
405 ,p_addr_attribute3 in varchar2 default null
406 ,p_addr_attribute4 in varchar2 default null
407 ,p_addr_attribute5 in varchar2 default null
408 ,p_addr_attribute6 in varchar2 default null
409 ,p_addr_attribute7 in varchar2 default null
410 ,p_addr_attribute8 in varchar2 default null
411 ,p_addr_attribute9 in varchar2 default null
412 ,p_addr_attribute10 in varchar2 default null
413 ,p_addr_attribute11 in varchar2 default null
414 ,p_addr_attribute12 in varchar2 default null
415 ,p_addr_attribute13 in varchar2 default null
416 ,p_addr_attribute14 in varchar2 default null
417 ,p_addr_attribute15 in varchar2 default null
418 ,p_addr_attribute16 in varchar2 default null
419 ,p_addr_attribute17 in varchar2 default null
420 ,p_addr_attribute18 in varchar2 default null
421 ,p_addr_attribute19 in varchar2 default null
422 ,p_addr_attribute20 in varchar2 default null
423 ,p_address_id out nocopy number
424 ,p_object_version_number out nocopy number
425 );
426 --
427 -- ----------------------------------------------------------------------------
428 -- |------------------------< update_person_address >-------------------------|
429 -- ----------------------------------------------------------------------------
430 -- {Start Of Comments}
431 --
432 -- Description:
433 -- This API updates the address as identified by the in
434 -- parameter p_address_id and the in out parameter p_object_version_number.
435 --
436 -- Currently only GB, US and GENERIC address styles are supported by this API.
437 --
438 -- Prerequisites:
439 -- The address as identified by the in parameter p_address_id and the in out
440 -- parameter p_object_version_number must already exist.
441 --
442 -- The address_type attribute can only be used after QuickCodes have been
443 -- defined for the 'ADDRESS_TYPE' lookup type.
444 --
445 -- In Parameters:
446 -- Name Reqd Type Description
447 -- p_validate boolean If true, the database
448 -- remains unchanged. If false,
449 -- the address is updated.
450 -- p_effective_date Yes date Effective date.
451 -- p_address_id Yes number The primary key of the
452 -- address.
453 -- p_object_version_number Yes number The current version of the
454 -- address to be updated.
455 -- p_date_from Yes date The date from which the
456 -- address applies.
457 -- p_date_to date The date on which the
458 -- address no longer applies.
459 -- p_person_id Yes number Person for whom the address
460 -- applies.
461 -- p_address_type varchar2 Type of address.
462 -- p_comments long Comments.
463 -- p_address_line1 varchar2 Line 1 of address.
464 -- p_address_line2 varchar2 Line 2 of address.
465 -- p_address_line3 varchar2 Line 3 of address.
466 -- p_town_or_city varchar2 Town/city.
467 -- p_region_1 varchar2 Determined by p_style
468 -- (eg. County for GB and US).
469 -- p_region_2 varchar2 Determined by p_style
470 -- (eg. State for US).
471 -- p_region_3 varchar2 Determined by p_style.
472 -- p_postal_code varchar2 Determined by p_style
473 -- (eg. Postcode for GB or
474 -- zip code for US).
475 -- p_country varchar2 Country.
476 -- p_telephone_number_1 varchar2 Telephone number.
477 -- p_telephone_number_2 varchar2 Telephone number.
478 -- p_addr_attribute1 varchar2 Descriptive flexfield.
479 -- p_addr_attribute2 varchar2 Descriptive flexfield.
480 -- p_addr_attribute3 varchar2 Descriptive flexfield.
481 -- p_addr_attribute4 varchar2 Descriptive flexfield.
482 -- p_addr_attribute5 varchar2 Descriptive flexfield.
483 -- p_addr_attribute6 varchar2 Descriptive flexfield.
484 -- p_addr_attribute7 varchar2 Descriptive flexfield.
485 -- p_addr_attribute8 varchar2 Descriptive flexfield.
486 -- p_addr_attribute9 varchar2 Descriptive flexfield.
487 -- p_addr_attribute10 varchar2 Descriptive flexfield.
488 -- p_addr_attribute11 varchar2 Descriptive flexfield.
489 -- p_addr_attribute12 varchar2 Descriptive flexfield.
490 -- p_addr_attribute13 varchar2 Descriptive flexfield.
491 -- p_addr_attribute14 varchar2 Descriptive flexfield.
492 -- p_addr_attribute15 varchar2 Descriptive flexfield.
493 -- p_addr_attribute16 varchar2 Descriptive flexfield.
494 -- p_addr_attribute17 varchar2 Descriptive flexfield.
495 -- p_addr_attribute18 varchar2 Descriptive flexfield.
496 -- p_addr_attribute19 varchar2 Descriptive flexfield.
497 -- p_addr_attribute20 varchar2 Descriptive flexfield.
498 --
499 -- Post Success:
500 -- When the address is valid, the API sets the following out parameters.
501 --
502 -- Name Type Description
503 -- p_object_version_number number If p_validate is false, set to
504 -- the version number of this
505 -- address. If p_validate is true,
506 -- set to null.
507 --
508 -- Post Failure:
509 -- The API does not update the address and raises an error.
510 --
511 -- Access Status:
512 -- Public.
513 --
514 -- {End Of Comments}
515 --
516 procedure update_person_address
517 (p_validate in boolean default false
518 ,p_effective_date in date
519 ,p_address_id in number
520 ,p_object_version_number in out nocopy number
521 ,p_date_from in date default hr_api.g_date
522 ,p_date_to in date default hr_api.g_date
523 ,p_address_type in varchar2 default hr_api.g_varchar2
524 ,p_comments in long default hr_api.g_varchar2
525 ,p_address_line1 in varchar2 default hr_api.g_varchar2
526 ,p_address_line2 in varchar2 default hr_api.g_varchar2
527 ,p_address_line3 in varchar2 default hr_api.g_varchar2
528 ,p_town_or_city in varchar2 default hr_api.g_varchar2
529 ,p_region_1 in varchar2 default hr_api.g_varchar2
530 ,p_region_2 in varchar2 default hr_api.g_varchar2
531 ,p_region_3 in varchar2 default hr_api.g_varchar2
532 ,p_postal_code in varchar2 default hr_api.g_varchar2
533 ,p_country in varchar2 default hr_api.g_varchar2
534 ,p_telephone_number_1 in varchar2 default hr_api.g_varchar2
535 ,p_telephone_number_2 in varchar2 default hr_api.g_varchar2
536 ,p_telephone_number_3 in varchar2 default hr_api.g_varchar2
537 ,p_addr_attribute_category in varchar2 default hr_api.g_varchar2
538 ,p_addr_attribute1 in varchar2 default hr_api.g_varchar2
539 ,p_addr_attribute2 in varchar2 default hr_api.g_varchar2
540 ,p_addr_attribute3 in varchar2 default hr_api.g_varchar2
541 ,p_addr_attribute4 in varchar2 default hr_api.g_varchar2
542 ,p_addr_attribute5 in varchar2 default hr_api.g_varchar2
543 ,p_addr_attribute6 in varchar2 default hr_api.g_varchar2
544 ,p_addr_attribute7 in varchar2 default hr_api.g_varchar2
545 ,p_addr_attribute8 in varchar2 default hr_api.g_varchar2
546 ,p_addr_attribute9 in varchar2 default hr_api.g_varchar2
547 ,p_addr_attribute10 in varchar2 default hr_api.g_varchar2
548 ,p_addr_attribute11 in varchar2 default hr_api.g_varchar2
549 ,p_addr_attribute12 in varchar2 default hr_api.g_varchar2
550 ,p_addr_attribute13 in varchar2 default hr_api.g_varchar2
551 ,p_addr_attribute14 in varchar2 default hr_api.g_varchar2
552 ,p_addr_attribute15 in varchar2 default hr_api.g_varchar2
553 ,p_addr_attribute16 in varchar2 default hr_api.g_varchar2
554 ,p_addr_attribute17 in varchar2 default hr_api.g_varchar2
555 ,p_addr_attribute18 in varchar2 default hr_api.g_varchar2
556 ,p_addr_attribute19 in varchar2 default hr_api.g_varchar2
557 ,p_addr_attribute20 in varchar2 default hr_api.g_varchar2
558 );
559 --
560 -- ----------------------------------------------------------------------------
561 -- |-----------------------< update_gb_person_address >-----------------------|
562 -- ----------------------------------------------------------------------------
563 -- {Start Of Comments}
564 --
565 -- Description:
566 -- This API updates the GB style address as identified by the in
567 -- parameter p_address_id and the in out parameter p_object_version_number.
568 -- This API calls the generic API update_person_address,
569 -- with the parameters set as appropriate for a GB style address.
570 --
571 -- As this API is effectively an alternative to the API
572 -- update_person_address, see that API for further explanation.
573 --
574 -- Prerequisites:
575 -- The address to be updated must be in GB style. See API
576 -- update_person_address for further details.
577 --
578 -- In Parameters:
579 -- Name Reqd Type Description
580 -- p_validate boolean If true, the database
581 -- remains unchanged. If false,
582 -- the address is updated.
583 -- p_effective_date Yes date Effective date.
584 -- p_address_id Yes number The primary key of the
585 -- address.
586 -- p_object_version_number Yes number The current version of the
587 -- address to be updated.
588 -- p_date_from date The date from which the
589 -- address applies.
590 -- p_date_to date The date on which the
591 -- address no longer applies.
592 -- p_address_type varchar2 Type of address.
593 -- p_comments long Comments.
594 -- p_address_line1 varchar2 Line 1 of address.
595 -- p_address_line2 varchar2 Line 2 of address.
596 -- p_address_line3 varchar2 Line 3 of address.
597 -- p_town varchar2 Town.
598 -- p_county varchar2 County.
599 -- p_postcode varchar2 Postcode.
600 -- p_country varchar2 Country.
601 -- p_telephone_number varchar2 Telephone number.
602 -- p_addr_attribute1 varchar2 Descriptive flexfield.
603 -- p_addr_attribute2 varchar2 Descriptive flexfield.
604 -- p_addr_attribute3 varchar2 Descriptive flexfield.
605 -- p_addr_attribute4 varchar2 Descriptive flexfield.
606 -- p_addr_attribute5 varchar2 Descriptive flexfield.
607 -- p_addr_attribute6 varchar2 Descriptive flexfield.
608 -- p_addr_attribute7 varchar2 Descriptive flexfield.
609 -- p_addr_attribute8 varchar2 Descriptive flexfield.
610 -- p_addr_attribute9 varchar2 Descriptive flexfield.
611 -- p_addr_attribute10 varchar2 Descriptive flexfield.
612 -- p_addr_attribute11 varchar2 Descriptive flexfield.
613 -- p_addr_attribute12 varchar2 Descriptive flexfield.
614 -- p_addr_attribute13 varchar2 Descriptive flexfield.
615 -- p_addr_attribute14 varchar2 Descriptive flexfield.
616 -- p_addr_attribute15 varchar2 Descriptive flexfield.
617 -- p_addr_attribute16 varchar2 Descriptive flexfield.
618 -- p_addr_attribute17 varchar2 Descriptive flexfield.
619 -- p_addr_attribute18 varchar2 Descriptive flexfield.
620 -- p_addr_attribute19 varchar2 Descriptive flexfield.
621 -- p_addr_attribute20 varchar2 Descriptive flexfield.
622 --
623 -- Post Success:
624 -- When the address is valid, the API sets the following out parameters.
625 --
626 -- Name Type Description
627 -- p_object_version_number number If p_validate is false, set to
628 -- the version number of this
629 -- address. If p_validate is true,
630 -- set to null.
631 --
632 -- Post Failure:
633 -- The API does not update the address and raises an error.
634 --
635 -- Access Status:
636 -- Public.
637 --
638 -- {End Of Comments}
639 --
640 procedure update_gb_person_address
641 (p_validate in boolean default false
642 ,p_effective_date in date
643 ,p_address_id in number
644 ,p_object_version_number in out nocopy number
645 ,p_date_from in date default hr_api.g_date
646 ,p_date_to in date default hr_api.g_date
647 ,p_address_type in varchar2 default hr_api.g_varchar2
648 ,p_comments in long default hr_api.g_varchar2
649 ,p_address_line1 in varchar2 default hr_api.g_varchar2
650 ,p_address_line2 in varchar2 default hr_api.g_varchar2
651 ,p_address_line3 in varchar2 default hr_api.g_varchar2
652 ,p_town in varchar2 default hr_api.g_varchar2
653 ,p_county in varchar2 default hr_api.g_varchar2
654 ,p_postcode in varchar2 default hr_api.g_varchar2
655 ,p_country in varchar2 default hr_api.g_varchar2
656 ,p_telephone_number in varchar2 default hr_api.g_varchar2
657 ,p_addr_attribute_category in varchar2 default hr_api.g_varchar2
658 ,p_addr_attribute1 in varchar2 default hr_api.g_varchar2
659 ,p_addr_attribute2 in varchar2 default hr_api.g_varchar2
660 ,p_addr_attribute3 in varchar2 default hr_api.g_varchar2
661 ,p_addr_attribute4 in varchar2 default hr_api.g_varchar2
662 ,p_addr_attribute5 in varchar2 default hr_api.g_varchar2
663 ,p_addr_attribute6 in varchar2 default hr_api.g_varchar2
664 ,p_addr_attribute7 in varchar2 default hr_api.g_varchar2
665 ,p_addr_attribute8 in varchar2 default hr_api.g_varchar2
666 ,p_addr_attribute9 in varchar2 default hr_api.g_varchar2
667 ,p_addr_attribute10 in varchar2 default hr_api.g_varchar2
668 ,p_addr_attribute11 in varchar2 default hr_api.g_varchar2
669 ,p_addr_attribute12 in varchar2 default hr_api.g_varchar2
670 ,p_addr_attribute13 in varchar2 default hr_api.g_varchar2
671 ,p_addr_attribute14 in varchar2 default hr_api.g_varchar2
672 ,p_addr_attribute15 in varchar2 default hr_api.g_varchar2
673 ,p_addr_attribute16 in varchar2 default hr_api.g_varchar2
674 ,p_addr_attribute17 in varchar2 default hr_api.g_varchar2
675 ,p_addr_attribute18 in varchar2 default hr_api.g_varchar2
676 ,p_addr_attribute19 in varchar2 default hr_api.g_varchar2
677 ,p_addr_attribute20 in varchar2 default hr_api.g_varchar2
678 );
679 --
680 -- ----------------------------------------------------------------------------
681 -- |-----------------------< update_us_person_address >-----------------------|
682 -- ----------------------------------------------------------------------------
683 -- {Start Of Comments}
684 --
685 -- Description:
686 -- This API updates the US style address as identified by the in
687 -- parameter p_address_id and the in out parameter p_object_version_number.
688 -- This API calls the generic API update_person_address with the
689 -- applicable parameters for a US address style.
690 --
691 -- Prerequisites:
692 -- The address to be updated must exist and is US style.
693 --
694 -- The address_type attribute can only be used after QuickCodes have been
695 -- defined for the 'ADDRESS_TYPE' lookup type.
696 --
697 -- In Parameters:
698 -- Name Reqd Type Description
699 -- p_validate boolean If true, the database
700 -- remains unchanged. If false,
701 -- the address is updated.
702 -- p_effective_date Yes date Effective date.
703 -- p_address_id Yes number The primary key of the
704 -- address.
705 -- p_object_version_number Yes number The current version of the
706 -- address to be updated.
707 -- p_date_from date The date from which the
708 -- address applies.
709 -- p_date_to date The date on which the
710 -- address no longer applies.
711 -- p_address_type varchar2 Type of address.
712 -- p_comments long Comments.
713 -- p_address_line1 varchar2 Line 1 of address.
714 -- p_address_line2 varchar2 Line 2 of address.
715 -- p_address_line3 varchar2 Line 3 of address.
716 -- p_city varchar2 City. The city is mandatory
717 -- if payroll is installed under
718 -- US legislation.
719 -- p_state varchar2 State. The state is mandatory
720 -- if payroll is installed under
721 -- US legislation.
722 -- p_zip_code varchar2 Zip code. The zip code is
723 -- mandatory if payroll is
724 -- installed under US
725 -- legislation.
726 -- p_county varchar2 County. The county is
727 -- mandatory if payroll is
728 -- installed under US
729 -- legislation.
730 -- p_country varchar2 Country.
731 -- p_telephone_number_1 varchar2 Telephone number 1.
732 -- p_telephone_number_2 varchar2 Telephone number 2.
733 -- p_addr_attribute1 varchar2 Descriptive flexfield.
734 -- p_addr_attribute2 varchar2 Descriptive flexfield.
735 -- p_addr_attribute3 varchar2 Descriptive flexfield.
736 -- p_addr_attribute4 varchar2 Descriptive flexfield.
737 -- p_addr_attribute5 varchar2 Descriptive flexfield.
738 -- p_addr_attribute6 varchar2 Descriptive flexfield.
739 -- p_addr_attribute7 varchar2 Descriptive flexfield.
740 -- p_addr_attribute8 varchar2 Descriptive flexfield.
741 -- p_addr_attribute9 varchar2 Descriptive flexfield.
742 -- p_addr_attribute10 varchar2 Descriptive flexfield.
743 -- p_addr_attribute11 varchar2 Descriptive flexfield.
744 -- p_addr_attribute12 varchar2 Descriptive flexfield.
745 -- p_addr_attribute13 varchar2 Descriptive flexfield.
746 -- p_addr_attribute14 varchar2 Descriptive flexfield.
747 -- p_addr_attribute15 varchar2 Descriptive flexfield.
748 -- p_addr_attribute16 varchar2 Descriptive flexfield.
749 -- p_addr_attribute17 varchar2 Descriptive flexfield.
750 -- p_addr_attribute18 varchar2 Descriptive flexfield.
751 -- p_addr_attribute19 varchar2 Descriptive flexfield.
752 -- p_addr_attribute20 varchar2 Descriptive flexfield.
753 --
754 -- Post Success:
755 -- If the address is valid, the API sets the following out parameters.
756 --
757 -- Name Type Description
758 -- p_object_version_number number If p_validate is false, set to
759 -- the version number of this
760 -- address. If p_validate is true,
761 -- set to null.
762 --
763 -- Post Failure:
764 -- The API does not update the address and raises an error.
765 --
766 -- Access Status:
767 -- Public.
768 --
769 -- {End Of Comments}
770 --
771 procedure update_us_person_address
772 (p_validate in boolean default false
773 ,p_effective_date in date
774 ,p_address_id in number
775 ,p_object_version_number in out nocopy number
776 ,p_date_from in date default hr_api.g_date
777 ,p_date_to in date default hr_api.g_date
778 ,p_address_type in varchar2 default hr_api.g_varchar2
779 ,p_comments in long default hr_api.g_varchar2
780 ,p_address_line1 in varchar2 default hr_api.g_varchar2
781 ,p_address_line2 in varchar2 default hr_api.g_varchar2
782 ,p_address_line3 in varchar2 default hr_api.g_varchar2
783 ,p_city in varchar2 default hr_api.g_varchar2
784 ,p_state in varchar2 default hr_api.g_varchar2
785 ,p_zip_code in varchar2 default hr_api.g_varchar2
786 ,p_county in varchar2 default hr_api.g_varchar2
787 ,p_country in varchar2 default hr_api.g_varchar2
788 ,p_telephone_number_1 in varchar2 default hr_api.g_varchar2
789 ,p_telephone_number_2 in varchar2 default hr_api.g_varchar2
790 ,p_addr_attribute_category in varchar2 default hr_api.g_varchar2
791 ,p_addr_attribute1 in varchar2 default hr_api.g_varchar2
792 ,p_addr_attribute2 in varchar2 default hr_api.g_varchar2
793 ,p_addr_attribute3 in varchar2 default hr_api.g_varchar2
794 ,p_addr_attribute4 in varchar2 default hr_api.g_varchar2
795 ,p_addr_attribute5 in varchar2 default hr_api.g_varchar2
796 ,p_addr_attribute6 in varchar2 default hr_api.g_varchar2
797 ,p_addr_attribute7 in varchar2 default hr_api.g_varchar2
798 ,p_addr_attribute8 in varchar2 default hr_api.g_varchar2
799 ,p_addr_attribute9 in varchar2 default hr_api.g_varchar2
800 ,p_addr_attribute10 in varchar2 default hr_api.g_varchar2
801 ,p_addr_attribute11 in varchar2 default hr_api.g_varchar2
802 ,p_addr_attribute12 in varchar2 default hr_api.g_varchar2
803 ,p_addr_attribute13 in varchar2 default hr_api.g_varchar2
804 ,p_addr_attribute14 in varchar2 default hr_api.g_varchar2
805 ,p_addr_attribute15 in varchar2 default hr_api.g_varchar2
806 ,p_addr_attribute16 in varchar2 default hr_api.g_varchar2
807 ,p_addr_attribute17 in varchar2 default hr_api.g_varchar2
808 ,p_addr_attribute18 in varchar2 default hr_api.g_varchar2
809 ,p_addr_attribute19 in varchar2 default hr_api.g_varchar2
810 ,p_addr_attribute20 in varchar2 default hr_api.g_varchar2
811 );
812 --
813 end hr_kiosk_address_api;
[Home] [Help]