1 Package per_ca_person_address_api AUTHID CURRENT_USER as
2 /* $Header: peaddcai.pkh 120.2 2011/11/17 15:49:07 emunisek ship $ */
3 /*#
4 * This package contains person address APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Person Address for Canada
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-------------------------< create_ca_person_address >---------------------|
15 /*#
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
16 * This API creates the address for the person.
17 *
18 * The person is identified by the in parameter p_person_id. This API calls the
19 * generic API create_person_address, with the parameters set as appropriate
20 * for a Canada style address. As this API is effectively an alternative to the
21 * API create_person_address, see that API for further explanation.
22 *
23 * <p><b>Licensing</b><br>
24 * This API is licensed for use with Human Resources.
25 *
26 * <p><b>Prerequisites</b><br>
27 * See API create_person_address.
28 *
29 * <p><b>Post Success</b><br>
30 * The Canada style address will be created for the person.
31 *
32 * <p><b>Post Failure</b><br>
33 * The API will 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 Reference date for validating lookup values are
38 * applicable during the start to end active date range. This date does not
39 * determine when the changes take effect.
40 * @param p_pradd_ovlapval_override If true, the previous primary address will
41 * have the end date populated. If false, primary address can have overlap
42 * dates.
43 * @param p_person_id Identifies the person for whom you create the address
44 * record.
45 * @param p_primary_flag {@rep:casecolumn PER_ADDRESSES.PRIMARY_FLAG}
46 * @param p_date_from {@rep:casecolumn PER_ADDRESSES.DATE_FROM}
47 * @param p_date_to {@rep:casecolumn PER_ADDRESSES.DATE_TO}
48 * @param p_address_type {@rep:casecolumn PER_ADDRESSES.ADDRESS_TYPE}
49 * @param p_comments {@rep:casecolumn PER_ADDRESSES.COMMENTS}
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_city {@rep:casecolumn PER_ADDRESSES.TOWN_OR_CITY}
54 * @param p_province Province or Territory.
55 * @param p_postal_code Postal Code.
56 * @param p_country {@rep:casecolumn PER_ADDRESSES.COUNTRY}
57 * @param p_telephone_number_1 {@rep:casecolumn
58 * PER_ADDRESSES.TELEPHONE_NUMBER_1}
59 * @param p_telephone_number_2 {@rep:casecolumn
60 * PER_ADDRESSES.TELEPHONE_NUMBER_2}
61 * @param p_cma Census Metropolitan Area.
62 * @param p_addr_attribute_category This context value determines which
63 * flexfield structure to use with the Person Address descriptive flexfield
64 * segments.
65 * @param p_addr_attribute1 Descriptive flexfield segment.
66 * @param p_addr_attribute2 Descriptive flexfield segment.
67 * @param p_addr_attribute3 Descriptive flexfield segment.
68 * @param p_addr_attribute4 Descriptive flexfield segment.
69 * @param p_addr_attribute5 Descriptive flexfield segment.
70 * @param p_addr_attribute6 Descriptive flexfield segment.
71 * @param p_addr_attribute7 Descriptive flexfield segment.
72 * @param p_addr_attribute8 Descriptive flexfield segment.
73 * @param p_addr_attribute9 Descriptive flexfield segment.
74 * @param p_addr_attribute10 Descriptive flexfield segment.
75 * @param p_addr_attribute11 Descriptive flexfield segment.
76 * @param p_addr_attribute12 Descriptive flexfield segment.
77 * @param p_addr_attribute13 Descriptive flexfield segment.
78 * @param p_addr_attribute14 Descriptive flexfield segment.
79 * @param p_addr_attribute15 Descriptive flexfield segment.
80 * @param p_addr_attribute16 Descriptive flexfield segment.
81 * @param p_addr_attribute17 Descriptive flexfield segment.
82 * @param p_addr_attribute18 Descriptive flexfield segment.
83 * @param p_addr_attribute19 Descriptive flexfield segment.
84 * @param p_addr_attribute20 Descriptive flexfield segment.
85 * @param p_add_information17 Tax Address State.
86 * @param p_add_information18 Tax Address City.
87 * @param p_add_information19 Tax Address County.
88 * @param p_add_information20 Tax Address Zip.
89 * @param p_address_id If p_validate is false, uniquely identifies the address
90 * created. If p_validate is true, set to null.
91 * @param p_object_version_number If p_validate is false, then set to the
92 * version number of the created address. If p_validate is true, then the value
93 * will be null.
94 * @rep:displayname Create Person Address for Canada
95 * @rep:category BUSINESS_ENTITY PER_PERSON_ADDRESS
96 * @rep:scope public
97 * @rep:lifecycle active
98 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
99 */
100 --
101 -- {End Of Comments}
102 --
103 procedure create_ca_person_address
104 (p_validate in boolean default false
105 ,p_effective_date in date
106 ,p_pradd_ovlapval_override in boolean default FALSE
107 ,p_person_id in number
108 ,p_primary_flag in varchar2
109 ,p_date_from in date
110 ,p_date_to in date default null
111 ,p_address_type in varchar2 default null
112 ,p_comments in per_addresses.comments%TYPE default null
113 ,p_address_line1 in varchar2
114 ,p_address_line2 in varchar2 default null
115 ,p_address_line3 in varchar2 default null
116 ,p_city in varchar2 default null
117 ,p_province in varchar2 default null
118 ,p_postal_code in varchar2 default null
122 ,p_cma in varchar2 default null
119 ,p_country in varchar2
120 ,p_telephone_number_1 in varchar2 default null
121 ,p_telephone_number_2 in varchar2 default null
123 ,p_addr_attribute_category in varchar2 default null
124 ,p_addr_attribute1 in varchar2 default null
125 ,p_addr_attribute2 in varchar2 default null
126 ,p_addr_attribute3 in varchar2 default null
127 ,p_addr_attribute4 in varchar2 default null
128 ,p_addr_attribute5 in varchar2 default null
129 ,p_addr_attribute6 in varchar2 default null
130 ,p_addr_attribute7 in varchar2 default null
131 ,p_addr_attribute8 in varchar2 default null
132 ,p_addr_attribute9 in varchar2 default null
133 ,p_addr_attribute10 in varchar2 default null
134 ,p_addr_attribute11 in varchar2 default null
135 ,p_addr_attribute12 in varchar2 default null
136 ,p_addr_attribute13 in varchar2 default null
137 ,p_addr_attribute14 in varchar2 default null
138 ,p_addr_attribute15 in varchar2 default null
139 ,p_addr_attribute16 in varchar2 default null
140 ,p_addr_attribute17 in varchar2 default null
141 ,p_addr_attribute18 in varchar2 default null
142 ,p_addr_attribute19 in varchar2 default null
143 ,p_addr_attribute20 in varchar2 default null
144 ,p_add_information17 in varchar2 default null
145 ,p_add_information18 in varchar2 default null
146 ,p_add_information19 in varchar2 default null
147 ,p_add_information20 in varchar2 default null
148 ,p_address_id out nocopy number
149 ,p_object_version_number out nocopy number
150 );
151 --
152 -- ----------------------------------------------------------------------------
153 -- |-------------------------< update_ca_person_address >---------------------|
154 -- ----------------------------------------------------------------------------
155 --
156 -- {Start Of Comments}
157 /*#
158 * This API updates the address.
159 *
160 * The address is identified by the in parameter p_address_id and the in out
161 * parameter p_object_version_number. This API calls the generic API
162 * update_person_address, with the parameters set as appropriate for a Canada
163 * style address. As this API is effectively an alternative to the API
164 * update_person_address, see that API for further explanation.
165 *
166 * <p><b>Licensing</b><br>
167 * This API is licensed for use with Human Resources.
168 *
169 * <p><b>Prerequisites</b><br>
170 * The address to be updated must be in Canada style address. See API
171 * update_person_address for further details.
172 *
173 * <p><b>Post Success</b><br>
174 * The API will update the Canada style address.
175 *
176 * <p><b>Post Failure</b><br>
177 * The API does not update the address and raises an error.
178 * @param p_validate If true, then validation alone will be performed and the
179 * database will remain unchanged. If false and all validation checks pass,
180 * then the database will be modified.
181 * @param p_effective_date Reference date for validating lookup values are
182 * applicable during the start to end active date range. This date does not
183 * determine when the changes take effect.
184 * @param p_address_id The primary key of the address.
185 * @param p_object_version_number Pass in the current version number of the
186 * address to be updated. When the API completes if p_validate is false, will
187 * be set to the new version number of the updated address. If p_validate is
188 * true will be set to the same value which was passed in.
189 * @param p_date_from {@rep:casecolumn PER_ADDRESSES.DATE_FROM}
190 * @param p_date_to {@rep:casecolumn PER_ADDRESSES.DATE_TO}
191 * @param p_address_type {@rep:casecolumn PER_ADDRESSES.ADDRESS_TYPE}
192 * @param p_comments {@rep:casecolumn PER_ADDRESSES.COMMENTS}
193 * @param p_address_line1 {@rep:casecolumn PER_ADDRESSES.ADDRESS_LINE1}
194 * @param p_address_line2 {@rep:casecolumn PER_ADDRESSES.ADDRESS_LINE2}
195 * @param p_address_line3 {@rep:casecolumn PER_ADDRESSES.ADDRESS_LINE3}
196 * @param p_city {@rep:casecolumn PER_ADDRESSES.TOWN_OR_CITY}
197 * @param p_province Province or Territory.
198 * @param p_postal_code Postal Code.
199 * @param p_country {@rep:casecolumn PER_ADDRESSES.COUNTRY}
200 * @param p_telephone_number_1 {@rep:casecolumn
201 * PER_ADDRESSES.TELEPHONE_NUMBER_1}
202 * @param p_telephone_number_2 {@rep:casecolumn
203 * PER_ADDRESSES.TELEPHONE_NUMBER_2}
204 * @param p_cma Census Metropolitan Area.
205 * @param p_addr_attribute_category This context value determines which
206 * flexfield structure to use with the Person Address descriptive flexfield
207 * segments.
208 * @param p_addr_attribute1 Descriptive flexfield segment.
209 * @param p_addr_attribute2 Descriptive flexfield segment.
210 * @param p_addr_attribute3 Descriptive flexfield segment.
211 * @param p_addr_attribute4 Descriptive flexfield segment.
212 * @param p_addr_attribute5 Descriptive flexfield segment.
213 * @param p_addr_attribute6 Descriptive flexfield segment.
214 * @param p_addr_attribute7 Descriptive flexfield segment.
215 * @param p_addr_attribute8 Descriptive flexfield segment.
216 * @param p_addr_attribute9 Descriptive flexfield segment.
217 * @param p_addr_attribute10 Descriptive flexfield segment.
218 * @param p_addr_attribute11 Descriptive flexfield segment.
219 * @param p_addr_attribute12 Descriptive flexfield segment.
220 * @param p_addr_attribute13 Descriptive flexfield segment.
224 * @param p_addr_attribute17 Descriptive flexfield segment.
221 * @param p_addr_attribute14 Descriptive flexfield segment.
222 * @param p_addr_attribute15 Descriptive flexfield segment.
223 * @param p_addr_attribute16 Descriptive flexfield segment.
225 * @param p_addr_attribute18 Descriptive flexfield segment.
226 * @param p_addr_attribute19 Descriptive flexfield segment.
227 * @param p_addr_attribute20 Descriptive flexfield segment.
228 * @param p_add_information17 Tax Address State.
229 * @param p_add_information18 Tax Address City.
230 * @param p_add_information19 Tax Address County.
231 * @param p_add_information20 Tax Address Zip.
232 * @rep:displayname Update Person Address for Canada
233 * @rep:category BUSINESS_ENTITY PER_PERSON_ADDRESS
234 * @rep:scope public
235 * @rep:lifecycle active
236 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
237 */
238 --
239 -- {End Of Comments}
240 --
241 procedure update_ca_person_address
242 (p_validate in boolean default false
243 ,p_effective_date in date
244 ,p_address_id in number
245 ,p_object_version_number in out nocopy number
246 ,p_date_from in date default hr_api.g_date
247 ,p_date_to in date default hr_api.g_date
248 ,p_address_type in varchar2 default hr_api.g_varchar2
249 ,p_comments in per_addresses.comments%TYPE default hr_api.g_varchar2
250 ,p_address_line1 in varchar2 default hr_api.g_varchar2
251 ,p_address_line2 in varchar2 default hr_api.g_varchar2
252 ,p_address_line3 in varchar2 default hr_api.g_varchar2
253 ,p_city in varchar2 default hr_api.g_varchar2
254 ,p_province in varchar2 default hr_api.g_varchar2
255 ,p_postal_code in varchar2 default hr_api.g_varchar2
256 ,p_country in varchar2 default hr_api.g_varchar2
257 ,p_telephone_number_1 in varchar2 default hr_api.g_varchar2
258 ,p_telephone_number_2 in varchar2 default hr_api.g_varchar2
259 ,p_cma in varchar2 default hr_api.g_varchar2
260 ,p_addr_attribute_category in varchar2 default hr_api.g_varchar2
261 ,p_addr_attribute1 in varchar2 default hr_api.g_varchar2
262 ,p_addr_attribute2 in varchar2 default hr_api.g_varchar2
263 ,p_addr_attribute3 in varchar2 default hr_api.g_varchar2
264 ,p_addr_attribute4 in varchar2 default hr_api.g_varchar2
265 ,p_addr_attribute5 in varchar2 default hr_api.g_varchar2
266 ,p_addr_attribute6 in varchar2 default hr_api.g_varchar2
267 ,p_addr_attribute7 in varchar2 default hr_api.g_varchar2
268 ,p_addr_attribute8 in varchar2 default hr_api.g_varchar2
269 ,p_addr_attribute9 in varchar2 default hr_api.g_varchar2
270 ,p_addr_attribute10 in varchar2 default hr_api.g_varchar2
271 ,p_addr_attribute11 in varchar2 default hr_api.g_varchar2
272 ,p_addr_attribute12 in varchar2 default hr_api.g_varchar2
273 ,p_addr_attribute13 in varchar2 default hr_api.g_varchar2
274 ,p_addr_attribute14 in varchar2 default hr_api.g_varchar2
275 ,p_addr_attribute15 in varchar2 default hr_api.g_varchar2
276 ,p_addr_attribute16 in varchar2 default hr_api.g_varchar2
277 ,p_addr_attribute17 in varchar2 default hr_api.g_varchar2
278 ,p_addr_attribute18 in varchar2 default hr_api.g_varchar2
279 ,p_addr_attribute19 in varchar2 default hr_api.g_varchar2
280 ,p_addr_attribute20 in varchar2 default hr_api.g_varchar2
281 ,p_add_information17 in varchar2 default hr_api.g_varchar2
282 ,p_add_information18 in varchar2 default hr_api.g_varchar2
283 ,p_add_information19 in varchar2 default hr_api.g_varchar2
284 ,p_add_information20 in varchar2 default hr_api.g_varchar2
285 );
286 --
287 end per_ca_person_address_api;
[Home] [Help]