1 PACKAGE hr_nz_person_address_api AS
2 /* $Header: hrnzwrpa.pkh 120.3 2005/10/17 07:22:00 rpalli noship $ */
3 /*#
4 * This package contains person address related APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Person Address for New Zealand
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-------------------------< create_nz_person_address >---------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a new address, for a particular person.
17 *
18 * This API calls the generic API create_person_address with the New Zealand
19 * specific value for the address style.
20 *
21 * <p><b>Licensing</b><br>
22 * This API is licensed for use with Human Resources.
23 *
24 * <p><b>Prerequisites</b><br>
25 * A valid person must exist on the start date of the address. The address_type
26 * attribute can only be used after QuickCodes have been defined for the
27 * 'ADDRESS_TYPE' lookup type.
28 *
29 * <p><b>Post Success</b><br>
30 * Inserts a new address for the employee in the New Zealand Address style.
31 *
32 * <p><b>Post Failure</b><br>
33 * The API does not create the address and raises an error.
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_pradd_ovlapval_override Indicates and validates if there is a
40 * primary address overlap.
41 * @param p_validate_county Validate county details in the address. Set to true
42 * by default.
43 * @param p_person_id Identifies the person record to modify.
44 * @param p_primary_flag {@rep:casecolumn PER_ADDRESSES.PRIMARY_FLAG}
45 * @param p_date_from {@rep:casecolumn PER_ADDRESSES.DATE_FROM}
46 * @param p_date_to {@rep:casecolumn PER_ADDRESSES.DATE_TO}
47 * @param p_address_type Indicates the Type of Address. Valid values are
48 * defined by 'ADDRESS_TYPE' lookup type.
49 * @param p_comments Comment text.
50 * @param p_address_line1 {@rep:casecolumn PER_ADDRESSES.ADDRESS_LINE1}
51 * @param p_address_line2 {@rep:casecolumn PER_ADDRESSES.ADDRESS_LINE2}
52 * @param p_address_line3 {@rep:casecolumn PER_ADDRESSES.ADDRESS_LINE3}
53 * @param p_town_or_city {@rep:casecolumn PER_ADDRESSES.TOWN_OR_CITY}
54 * @param p_region_1 Determined by p_style (eg. County for United Kingdom and
55 * United States).
56 * @param p_region_2 Determined by p_style (eg. State for United States).
57 * @param p_region_3 Determined by p_style (eg. PO Box for Saudi Arabia).
58 * @param p_postcode {@rep:casecolumn PER_ADDRESSES.POSTAL_CODE}
59 * @param p_country Indicates which country the person was born. Valid values
60 * as applicable are defined by 'NATIONALITY' lookup type.
61 * @param p_telephone_number_1 {@rep:casecolumn
62 * PER_ADDRESSES.TELEPHONE_NUMBER_1}
63 * @param p_telephone_number_2 {@rep:casecolumn
64 * PER_ADDRESSES.TELEPHONE_NUMBER_2}
65 * @param p_telephone_number_3 {@rep:casecolumn
66 * PER_ADDRESSES.TELEPHONE_NUMBER_3}
67 * @param p_addr_attribute_category This context value determines which
68 * flexfield structure to use with the Person Address descriptive flexfield
69 * segments.
70 * @param p_addr_attribute1 Descriptive flexfield segment.
71 * @param p_addr_attribute2 Descriptive flexfield segment.
72 * @param p_addr_attribute3 Descriptive flexfield segment.
73 * @param p_addr_attribute4 Descriptive flexfield segment.
74 * @param p_addr_attribute5 Descriptive flexfield segment.
75 * @param p_addr_attribute6 Descriptive flexfield segment.
76 * @param p_addr_attribute7 Descriptive flexfield segment.
77 * @param p_addr_attribute8 Descriptive flexfield segment.
78 * @param p_addr_attribute9 Descriptive flexfield segment.
79 * @param p_addr_attribute10 Descriptive flexfield segment.
80 * @param p_addr_attribute11 Descriptive flexfield segment.
81 * @param p_addr_attribute12 Descriptive flexfield segment.
82 * @param p_addr_attribute13 Descriptive flexfield segment.
83 * @param p_addr_attribute14 Descriptive flexfield segment.
84 * @param p_addr_attribute15 Descriptive flexfield segment.
85 * @param p_addr_attribute16 Descriptive flexfield segment.
86 * @param p_addr_attribute17 Descriptive flexfield segment.
87 * @param p_addr_attribute18 Descriptive flexfield segment.
88 * @param p_addr_attribute19 Descriptive flexfield segment.
89 * @param p_addr_attribute20 Descriptive flexfield segment.
90 * @param p_add_information13 Descriptive flexfield segment.
91 * @param p_add_information14 Descriptive flexfield segment.
92 * @param p_add_information15 Descriptive flexfield segment.
93 * @param p_add_information16 Descriptive flexfield segment.
94 * @param p_add_information17 Tax Address State, only applies to United States
95 * address style. Valid values are defined by the 'US_STATE' lookup type.
96 * @param p_add_information18 Tax Address City, only applies to United States
97 * address style.
98 * @param p_add_information19 Tax Address County, only applies to United States
99 * address style.
100 * @param p_add_information20 Tax Address Zip, only applies to United States
101 * address style.
102 * @param p_party_id Party for whom the address (HR/TCA merge) applies.
103 * @param p_address_id If p_validate is false, uniquely identifies the address
104 * created. If p_validate is true, set to null.
105 * @param p_object_version_number If p_validate is false, then set to the
106 * version number of the created person address. If p_validate is true, then
107 * the value will be null.
108 * @rep:displayname Create Person Address for New Zealand
109 * @rep:category BUSINESS_ENTITY PER_PERSON_ADDRESS
110 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
111 * @rep:scope public
112 * @rep:lifecycle active
113 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
114 */
115 --
116 -- {End Of Comments}
117 --
118 PROCEDURE create_nz_person_address
119 (p_validate IN BOOLEAN DEFAULT FALSE
120 ,p_effective_date IN DATE
121 ,p_pradd_ovlapval_override IN BOOLEAN DEFAULT FALSE
122 ,p_validate_county IN BOOLEAN DEFAULT TRUE
123 ,p_person_id IN NUMBER
124 ,p_primary_flag IN VARCHAR2
125 ,p_date_from IN DATE
126 ,p_date_to IN DATE DEFAULT NULL
127 ,p_address_type IN VARCHAR2 DEFAULT NULL
128 ,p_comments IN LONG DEFAULT NULL
129 ,p_address_line1 IN VARCHAR2
130 ,p_address_line2 IN VARCHAR2 DEFAULT NULL
131 ,p_address_line3 IN VARCHAR2 DEFAULT NULL
132 ,p_town_or_city IN VARCHAR2 DEFAULT NULL
133 ,p_region_1 IN VARCHAR2 DEFAULT NULL
134 ,p_region_2 IN VARCHAR2 DEFAULT NULL
135 ,p_region_3 IN VARCHAR2 DEFAULT NULL
136 ,p_postcode IN VARCHAR2 DEFAULT NULL
137 ,p_country IN VARCHAR2
138 ,p_telephone_number_1 IN VARCHAR2 DEFAULT NULL
139 ,p_telephone_number_2 IN VARCHAR2 DEFAULT NULL
140 ,p_telephone_number_3 IN VARCHAR2 DEFAULT NULL
141 ,p_addr_attribute_category IN VARCHAR2 DEFAULT NULL
142 ,p_addr_attribute1 IN VARCHAR2 DEFAULT NULL
143 ,p_addr_attribute2 IN VARCHAR2 DEFAULT NULL
144 ,p_addr_attribute3 IN VARCHAR2 DEFAULT NULL
145 ,p_addr_attribute4 IN VARCHAR2 DEFAULT NULL
146 ,p_addr_attribute5 IN VARCHAR2 DEFAULT NULL
147 ,p_addr_attribute6 IN VARCHAR2 DEFAULT NULL
148 ,p_addr_attribute7 IN VARCHAR2 DEFAULT NULL
149 ,p_addr_attribute8 IN VARCHAR2 DEFAULT NULL
150 ,p_addr_attribute9 IN VARCHAR2 DEFAULT NULL
151 ,p_addr_attribute10 IN VARCHAR2 DEFAULT NULL
152 ,p_addr_attribute11 IN VARCHAR2 DEFAULT NULL
153 ,p_addr_attribute12 IN VARCHAR2 DEFAULT NULL
154 ,p_addr_attribute13 IN VARCHAR2 DEFAULT NULL
155 ,p_addr_attribute14 IN VARCHAR2 DEFAULT NULL
156 ,p_addr_attribute15 IN VARCHAR2 DEFAULT NULL
157 ,p_addr_attribute16 IN VARCHAR2 DEFAULT NULL
158 ,p_addr_attribute17 IN VARCHAR2 DEFAULT NULL
159 ,p_addr_attribute18 IN VARCHAR2 DEFAULT NULL
160 ,p_addr_attribute19 IN VARCHAR2 DEFAULT NULL
161 ,p_addr_attribute20 IN VARCHAR2 DEFAULT NULL
162 ,p_add_information13 IN VARCHAR2 DEFAULT NULL
163 ,p_add_information14 IN VARCHAR2 DEFAULT NULL
164 ,p_add_information15 IN VARCHAR2 DEFAULT NULL
165 ,p_add_information16 IN VARCHAR2 DEFAULT NULL
166 ,p_add_information17 IN VARCHAR2 DEFAULT NULL
167 ,p_add_information18 IN VARCHAR2 DEFAULT NULL
168 ,p_add_information19 IN VARCHAR2 DEFAULT NULL
169 ,p_add_information20 IN VARCHAR2 DEFAULT NULL
170 ,p_party_id IN NUMBER DEFAULT NULL
171 ,p_address_id OUT NOCOPY NUMBER
172 ,p_object_version_number OUT NOCOPY NUMBER
173 );
174 --
175 -- ----------------------------------------------------------------------------
176 -- |-------------------------< update_nz_person_address >---------------------|
177 -- ----------------------------------------------------------------------------
178 --
179 -- {Start Of Comments}
180 /*#
181 * This API updates the details of a persons address for New Zealand.
182 *
183 * This API calls the generic API update_person_address with the New Zealand
184 * specific value for address style.
185 *
186 * <p><b>Licensing</b><br>
187 * This API is licensed for use with Human Resources.
188 *
189 * <p><b>Prerequisites</b><br>
190 * The address to be updated must exist and must be in the correct style.
191 *
192 * <p><b>Post Success</b><br>
193 * Updates the details if the address is valid.
194 *
195 * <p><b>Post Failure</b><br>
196 * The API does not update the address and raises an error.
197 * @param p_validate If true, then validation alone will be performed and the
198 * database will remain unchanged. If false and all validation checks pass,
199 * then the database will be modified.
200 * @param p_effective_date Determines when the DateTrack operation takes
201 * effect.
202 * @param p_validate_county Validate county details in the address. Set to true
203 * by default.
204 * @param p_address_id {@rep:casecolumn PER_ADDRESSES.ADDRESS_ID}
205 * @param p_object_version_number Pass in the current version number of the
206 * person address to be updated. When the API completes if p_validate is false,
207 * will be set to the new version number of the updated person address. If
208 * p_validate is true will be set to the same value which was passed in.
209 * @param p_date_from {@rep:casecolumn PER_ADDRESSES.DATE_FROM}
210 * @param p_date_to {@rep:casecolumn PER_ADDRESSES.DATE_TO}
211 * @param p_primary_flag Flag specifying if this is a primary address. Valid
212 * values are 'Y' or 'N'.
213 * @param p_address_type Indicates the Type of Address. Valid values are
214 * defined by 'ADDRESS_TYPE' lookup type.
215 * @param p_comments Comment text.
216 * @param p_address_line1 {@rep:casecolumn PER_ADDRESSES.ADDRESS_LINE1}
217 * @param p_address_line2 {@rep:casecolumn PER_ADDRESSES.ADDRESS_LINE2}
218 * @param p_address_line3 {@rep:casecolumn PER_ADDRESSES.ADDRESS_LINE3}
219 * @param p_town_or_city {@rep:casecolumn PER_ADDRESSES.TOWN_OR_CITY}
220 * @param p_region_1 Determined by p_style (eg. County for United Kingdom and
221 * United States).
222 * @param p_region_2 Determined by p_style (eg. State for United States).
223 * @param p_region_3 Determined by p_style (eg. PO Box for Saudi Arabia).
224 * @param p_postcode {@rep:casecolumn PER_ADDRESSES.POSTAL_CODE}
225 * @param p_country Indicates which country the person was born. Valid values
226 * as applicable are defined by 'NATIONALITY' lookup type.
227 * @param p_telephone_number_1 {@rep:casecolumn
228 * PER_ADDRESSES.TELEPHONE_NUMBER_1}
229 * @param p_telephone_number_2 {@rep:casecolumn
230 * PER_ADDRESSES.TELEPHONE_NUMBER_2}
231 * @param p_telephone_number_3 {@rep:casecolumn
232 * PER_ADDRESSES.TELEPHONE_NUMBER_3}
233 * @param p_addr_attribute_category This context value determines which
234 * flexfield structure to use with the Person Address descriptive flexfield
235 * segments.
236 * @param p_addr_attribute1 Descriptive flexfield segment.
237 * @param p_addr_attribute2 Descriptive flexfield segment.
238 * @param p_addr_attribute3 Descriptive flexfield segment.
239 * @param p_addr_attribute4 Descriptive flexfield segment.
240 * @param p_addr_attribute5 Descriptive flexfield segment.
241 * @param p_addr_attribute6 Descriptive flexfield segment.
242 * @param p_addr_attribute7 Descriptive flexfield segment.
243 * @param p_addr_attribute8 Descriptive flexfield segment.
244 * @param p_addr_attribute9 Descriptive flexfield segment.
245 * @param p_addr_attribute10 Descriptive flexfield segment.
246 * @param p_addr_attribute11 Descriptive flexfield segment.
247 * @param p_addr_attribute12 Descriptive flexfield segment.
248 * @param p_addr_attribute13 Descriptive flexfield segment.
249 * @param p_addr_attribute14 Descriptive flexfield segment.
250 * @param p_addr_attribute15 Descriptive flexfield segment.
251 * @param p_addr_attribute16 Descriptive flexfield segment.
252 * @param p_addr_attribute17 Descriptive flexfield segment.
253 * @param p_addr_attribute18 Descriptive flexfield segment.
254 * @param p_addr_attribute19 Descriptive flexfield segment.
255 * @param p_addr_attribute20 Descriptive flexfield segment.
256 * @param p_add_information13 Descriptive flexfield segment.
257 * @param p_add_information14 Descriptive flexfield segment.
258 * @param p_add_information15 Descriptive flexfield segment.
259 * @param p_add_information16 Descriptive flexfield segment.
260 * @param p_add_information17 Tax Address State, only applies to United States
261 * address style. Valid values are defined by the 'US_STATE' lookup type.
262 * @param p_add_information18 Tax Address City, only applies to United States
263 * address style.
264 * @param p_add_information19 Tax Address County, only applies to United States
265 * address style.
266 * @param p_add_information20 Tax Address Zip, only applies to United States
267 * address style.
268 * @param p_party_id Party for whom the address (HR/TCA merge) applies.
269 * @rep:displayname Update Person Address for New Zealand
270 * @rep:category BUSINESS_ENTITY PER_PERSON_ADDRESS
271 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
272 * @rep:scope public
273 * @rep:lifecycle active
274 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
275 */
276 --
277 -- {End Of Comments}
278 --
279 PROCEDURE update_nz_person_address
280 (p_validate IN BOOLEAN DEFAULT FALSE
281 ,p_effective_date IN DATE
282 ,p_validate_county IN BOOLEAN DEFAULT TRUE
283 ,p_address_id IN NUMBER
284 ,p_object_version_number IN OUT NOCOPY NUMBER
285 ,p_date_from IN DATE DEFAULT hr_api.g_date
286 ,p_date_to IN DATE DEFAULT hr_api.g_date
287 ,p_primary_flag IN VARCHAR2 DEFAULT hr_api.g_varchar2
288 ,p_address_type IN VARCHAR2 DEFAULT hr_api.g_varchar2
289 ,p_comments IN LONG DEFAULT hr_api.g_varchar2
290 ,p_address_line1 IN VARCHAR2 DEFAULT hr_api.g_varchar2
291 ,p_address_line2 IN VARCHAR2 DEFAULT hr_api.g_varchar2
292 ,p_address_line3 IN VARCHAR2 DEFAULT hr_api.g_varchar2
293 ,p_town_or_city IN VARCHAR2 DEFAULT hr_api.g_varchar2
294 ,p_region_1 IN VARCHAR2 DEFAULT hr_api.g_varchar2
295 ,p_region_2 IN VARCHAR2 DEFAULT hr_api.g_varchar2
296 ,p_region_3 IN VARCHAR2 DEFAULT hr_api.g_varchar2
297 ,p_postcode IN VARCHAR2 DEFAULT hr_api.g_varchar2
298 ,p_country IN VARCHAR2 DEFAULT hr_api.g_varchar2
299 ,p_telephone_number_1 IN VARCHAR2 DEFAULT hr_api.g_varchar2
300 ,p_telephone_number_2 IN VARCHAR2 DEFAULT hr_api.g_varchar2
301 ,p_telephone_number_3 IN VARCHAR2 DEFAULT hr_api.g_varchar2
302 ,p_addr_attribute_category IN VARCHAR2 DEFAULT hr_api.g_varchar2
303 ,p_addr_attribute1 IN VARCHAR2 DEFAULT hr_api.g_varchar2
304 ,p_addr_attribute2 IN VARCHAR2 DEFAULT hr_api.g_varchar2
305 ,p_addr_attribute3 IN VARCHAR2 DEFAULT hr_api.g_varchar2
306 ,p_addr_attribute4 IN VARCHAR2 DEFAULT hr_api.g_varchar2
307 ,p_addr_attribute5 IN VARCHAR2 DEFAULT hr_api.g_varchar2
308 ,p_addr_attribute6 IN VARCHAR2 DEFAULT hr_api.g_varchar2
309 ,p_addr_attribute7 IN VARCHAR2 DEFAULT hr_api.g_varchar2
310 ,p_addr_attribute8 IN VARCHAR2 DEFAULT hr_api.g_varchar2
311 ,p_addr_attribute9 IN VARCHAR2 DEFAULT hr_api.g_varchar2
312 ,p_addr_attribute10 IN VARCHAR2 DEFAULT hr_api.g_varchar2
313 ,p_addr_attribute11 IN VARCHAR2 DEFAULT hr_api.g_varchar2
314 ,p_addr_attribute12 IN VARCHAR2 DEFAULT hr_api.g_varchar2
315 ,p_addr_attribute13 IN VARCHAR2 DEFAULT hr_api.g_varchar2
316 ,p_addr_attribute14 IN VARCHAR2 DEFAULT hr_api.g_varchar2
317 ,p_addr_attribute15 IN VARCHAR2 DEFAULT hr_api.g_varchar2
318 ,p_addr_attribute16 IN VARCHAR2 DEFAULT hr_api.g_varchar2
319 ,p_addr_attribute17 IN VARCHAR2 DEFAULT hr_api.g_varchar2
320 ,p_addr_attribute18 IN VARCHAR2 DEFAULT hr_api.g_varchar2
321 ,p_addr_attribute19 IN VARCHAR2 DEFAULT hr_api.g_varchar2
322 ,p_addr_attribute20 IN VARCHAR2 DEFAULT hr_api.g_varchar2
323 ,p_add_information13 IN VARCHAR2 DEFAULT hr_api.g_varchar2
324 ,p_add_information14 IN VARCHAR2 DEFAULT hr_api.g_varchar2
325 ,p_add_information15 IN VARCHAR2 DEFAULT hr_api.g_varchar2
326 ,p_add_information16 IN VARCHAR2 DEFAULT hr_api.g_varchar2
327 ,p_add_information17 IN VARCHAR2 DEFAULT hr_api.g_varchar2
328 ,p_add_information18 IN VARCHAR2 DEFAULT hr_api.g_varchar2
329 ,p_add_information19 IN VARCHAR2 DEFAULT hr_api.g_varchar2
330 ,p_add_information20 IN VARCHAR2 DEFAULT hr_api.g_varchar2
331 ,p_party_id IN NUMBER DEFAULT hr_api.g_number
332 );
333
334 END hr_nz_person_address_api;
[Home] [Help]