1 Package hr_fr_person_address_api as
2 /* $Header: peaddfri.pkh 120.1 2005/10/02 02:09:30 aroussel $ */
3 /*#
4 * This package contains address APIs for France.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Person Address for France
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-------------------------< create_fr_person_address >---------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates an address for a person with an address style for France.
17 *
18 * As this API is effectively an alternative to the API create_person_address,
19 * see create_person_address API for further details.
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 * The person (p_person_id) must exist.
26 *
27 * <p><b>Post Success</b><br>
28 * The address is successfully created in the database.
29 *
30 * <p><b>Post Failure</b><br>
31 * The API does not create the address and raises an error.
32 * @param p_validate If true, then validation alone will be performed and the
33 * database will remain unchanged. If false and all validation checks pass,
34 * then the database will be modified.
35 * @param p_effective_date Reference date for validating lookup values are
36 * applicable during the start to end active date range. This date does not
37 * determine when the changes take effect.
38 * @param p_person_id Identifies the person for whom you create the address
39 * record.
40 * @param p_primary_flag Flag specifying if this is a primary address. Valid
41 * values are 'Y' or 'N'.
42 * @param p_date_from The date from which the address applies.
43 * @param p_date_to The date on which the address no longer applies.
44 * @param p_address_type The type of address. Valid values are defined by the
45 * 'ADDRESS_TYPE' lookup type.
46 * @param p_comments Comment text.
47 * @param p_address_line1 The first line of the address.
48 * @param p_address_line2 The second line of the address.
49 * @param p_address_line3 The third line of the address.
50 * @param p_insee_code INSEE code
51 * @param p_small_town Small town
52 * @param p_postal_code Postal code
53 * @param p_city City
54 * @param p_department Department. Valid values exist in the 'FR_DEPARTMENT'
55 * lookup type.
56 * @param p_country Name of the country.
57 * @param p_telephone First telephone number of the person.
58 * @param p_telephone2 Second telephone number of the person.
59 * @param p_telephone3 Third telephone number of the person.
60 * @param p_addr_attribute_category This context value determines which
61 * flexfield structure to use with the Person Address descriptive flexfield
62 * segments.
63 * @param p_addr_attribute1 Descriptive flexfield segment.
64 * @param p_addr_attribute2 Descriptive flexfield segment.
65 * @param p_addr_attribute3 Descriptive flexfield segment.
66 * @param p_addr_attribute4 Descriptive flexfield segment.
67 * @param p_addr_attribute5 Descriptive flexfield segment.
68 * @param p_addr_attribute6 Descriptive flexfield segment.
69 * @param p_addr_attribute7 Descriptive flexfield segment.
70 * @param p_addr_attribute8 Descriptive flexfield segment.
71 * @param p_addr_attribute9 Descriptive flexfield segment.
72 * @param p_addr_attribute10 Descriptive flexfield segment.
73 * @param p_addr_attribute11 Descriptive flexfield segment.
74 * @param p_addr_attribute12 Descriptive flexfield segment.
75 * @param p_addr_attribute13 Descriptive flexfield segment.
76 * @param p_addr_attribute14 Descriptive flexfield segment.
77 * @param p_addr_attribute15 Descriptive flexfield segment.
78 * @param p_addr_attribute16 Descriptive flexfield segment.
79 * @param p_addr_attribute17 Descriptive flexfield segment.
80 * @param p_addr_attribute18 Descriptive flexfield segment.
81 * @param p_addr_attribute19 Descriptive flexfield segment.
82 * @param p_addr_attribute20 Descriptive flexfield segment.
83 * @param p_address_id If p_validate is false, then this uniquely identifies
84 * the address created. If p_validate is true, then set to null.
85 * @param p_object_version_number If p_validate is false, then set to the
86 * version number of the created address. If p_validate is true, then the value
87 * will be null.
88 * @rep:displayname Create Person Address for France
89 * @rep:category BUSINESS_ENTITY PER_PERSON_ADDRESS
90 * @rep:scope public
91 * @rep:lifecycle active
92 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
93 */
94 --
95 -- {End Of Comments}
96 --
97 procedure create_fr_person_address
98 (p_validate in boolean default false
99 ,p_effective_date in date
100 ,p_person_id in number
101 ,p_primary_flag in varchar2
102 ,p_date_from in date
103 ,p_date_to in date default null
104 ,p_address_type in varchar2 default null
105 ,p_comments in long default null
106 ,p_address_line1 in varchar2
107 ,p_address_line2 in varchar2 default null
108 ,p_address_line3 in varchar2 default null
109 ,p_insee_code in varchar2 default null
110 ,p_small_town in varchar2 default null
111 ,p_postal_code in varchar2 default null
112 ,p_city in varchar2 default null
113 ,p_department in varchar2 default null
114 ,p_country in varchar2 default null
115 ,p_telephone in varchar2 default null
116 ,p_telephone2 in varchar2 default null
117 ,p_telephone3 in varchar2 default null
118 ,p_addr_attribute_category in varchar2 default null
119 ,p_addr_attribute1 in varchar2 default null
120 ,p_addr_attribute2 in varchar2 default null
121 ,p_addr_attribute3 in varchar2 default null
122 ,p_addr_attribute4 in varchar2 default null
123 ,p_addr_attribute5 in varchar2 default null
124 ,p_addr_attribute6 in varchar2 default null
125 ,p_addr_attribute7 in varchar2 default null
126 ,p_addr_attribute8 in varchar2 default null
127 ,p_addr_attribute9 in varchar2 default null
128 ,p_addr_attribute10 in varchar2 default null
129 ,p_addr_attribute11 in varchar2 default null
130 ,p_addr_attribute12 in varchar2 default null
131 ,p_addr_attribute13 in varchar2 default null
132 ,p_addr_attribute14 in varchar2 default null
133 ,p_addr_attribute15 in varchar2 default null
134 ,p_addr_attribute16 in varchar2 default null
135 ,p_addr_attribute17 in varchar2 default null
136 ,p_addr_attribute18 in varchar2 default null
137 ,p_addr_attribute19 in varchar2 default null
138 ,p_addr_attribute20 in varchar2 default null
139 ,p_address_id out nocopy number
140 ,p_object_version_number out nocopy number
141 );
142 --
143 -- ----------------------------------------------------------------------------
144 -- |-------------------------< update_fr_person_address >---------------------|
145 -- ----------------------------------------------------------------------------
146 --
147 -- {Start Of Comments}
148 /*#
149 * This API updates a person's address record for France.
150 *
151 * This API updates the addresses of people as identified by the in parameter
152 * p_address_id and the in out parameter p_object_version_number, using the
153 * French style. This API calls the generic API update_person_address with the
154 * applicable parameters for a particular address style.
155 *
156 * <p><b>Licensing</b><br>
157 * This API is licensed for use with Human Resources.
158 *
159 * <p><b>Prerequisites</b><br>
160 * The address to be updated must exist and is in the correct style. The
161 * address_type attribute can only be used after QuickCodes have been defined
162 * for the 'ADDRESS_TYPE' lookup type.
163 *
164 * <p><b>Post Success</b><br>
165 * The address is successfully updated in the database.
166 *
167 * <p><b>Post Failure</b><br>
168 * The API does not update the address and raises an error.
169 * @param p_validate If true, then validation alone will be performed and the
170 * database will remain unchanged. If false and all validation checks pass,
171 * then the database will be modified.
172 * @param p_effective_date Reference date for validating lookup values are
173 * applicable during the start to end active date range. This date does not
174 * determine when the changes take effect.
175 * @param p_address_id This uniquely identifies the address.
176 * @param p_object_version_number Pass in the current version number of the
177 * address to be updated. When the API completes if p_validate is false, will
178 * be set to the new version number of the updated address. If p_validate is
179 * true will be set to the same value which was passed in.
180 * @param p_date_from The date from which the address applies.
181 * @param p_date_to The date on which the address no longer applies.
182 * @param p_address_type The type of address. Valid values are defined by the
183 * 'ADDRESS_TYPE' lookup type.
184 * @param p_comments Comment text.
185 * @param p_address_line1 The first line of the address.
186 * @param p_address_line2 The second line of the address.
187 * @param p_address_line3 The third line of the address.
188 * @param p_insee_code INSEE code
189 * @param p_small_town Small town
190 * @param p_postal_code Postal code
191 * @param p_department Department. Valid values exist in the 'FR_DEPARTMENT'
192 * lookup type.
193 * @param p_city City
194 * @param p_country Name of the country.
195 * @param p_telephone First telephone number of the person.
196 * @param p_telephone2 Second telephone number of the person.
197 * @param p_telephone3 Third telephone number of the person.
198 * @param p_addr_attribute_category This context value determines which
199 * flexfield structure to use with the Person Address descriptive flexfield
200 * segments.
201 * @param p_addr_attribute1 Descriptive flexfield segment.
202 * @param p_addr_attribute2 Descriptive flexfield segment.
203 * @param p_addr_attribute3 Descriptive flexfield segment.
204 * @param p_addr_attribute4 Descriptive flexfield segment.
205 * @param p_addr_attribute5 Descriptive flexfield segment.
206 * @param p_addr_attribute6 Descriptive flexfield segment.
207 * @param p_addr_attribute7 Descriptive flexfield segment.
208 * @param p_addr_attribute8 Descriptive flexfield segment.
209 * @param p_addr_attribute9 Descriptive flexfield segment.
210 * @param p_addr_attribute10 Descriptive flexfield segment.
211 * @param p_addr_attribute11 Descriptive flexfield segment.
212 * @param p_addr_attribute12 Descriptive flexfield segment.
213 * @param p_addr_attribute13 Descriptive flexfield segment.
214 * @param p_addr_attribute14 Descriptive flexfield segment.
215 * @param p_addr_attribute15 Descriptive flexfield segment.
216 * @param p_addr_attribute16 Descriptive flexfield segment.
217 * @param p_addr_attribute17 Descriptive flexfield segment.
218 * @param p_addr_attribute18 Descriptive flexfield segment.
219 * @param p_addr_attribute19 Descriptive flexfield segment.
220 * @param p_addr_attribute20 Descriptive flexfield segment.
221 * @rep:displayname Update Person Address for France
222 * @rep:category BUSINESS_ENTITY PER_PERSON_ADDRESS
223 * @rep:scope public
224 * @rep:lifecycle active
225 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
226 */
227 --
228 -- {End Of Comments}
229 --
230 procedure update_fr_person_address
231 (p_validate in boolean default false
232 ,p_effective_date in date
233 ,p_address_id in number
234 ,p_object_version_number in out nocopy number
235 ,p_date_from in date default hr_api.g_date
236 ,p_date_to in date default hr_api.g_date
237 ,p_address_type in varchar2 default hr_api.g_varchar2
238 ,p_comments in long default hr_api.g_varchar2
239 ,p_address_line1 in varchar2
240 ,p_address_line2 in varchar2 default hr_api.g_varchar2
241 ,p_address_line3 in varchar2 default hr_api.g_varchar2
242 ,p_insee_code in varchar2 default hr_api.g_varchar2
243 ,p_small_town in varchar2 default hr_api.g_varchar2
244 ,p_postal_code in varchar2 default hr_api.g_varchar2
245 ,p_department in varchar2 default hr_api.g_varchar2
246 ,p_city in varchar2 default hr_api.g_varchar2
247 ,p_country in varchar2 default hr_api.g_varchar2
248 ,p_telephone in varchar2 default hr_api.g_varchar2
249 ,p_telephone2 in varchar2 default hr_api.g_varchar2
250 ,p_telephone3 in varchar2 default hr_api.g_varchar2
251 ,p_addr_attribute_category in varchar2 default hr_api.g_varchar2
252 ,p_addr_attribute1 in varchar2 default hr_api.g_varchar2
253 ,p_addr_attribute2 in varchar2 default hr_api.g_varchar2
254 ,p_addr_attribute3 in varchar2 default hr_api.g_varchar2
255 ,p_addr_attribute4 in varchar2 default hr_api.g_varchar2
256 ,p_addr_attribute5 in varchar2 default hr_api.g_varchar2
257 ,p_addr_attribute6 in varchar2 default hr_api.g_varchar2
258 ,p_addr_attribute7 in varchar2 default hr_api.g_varchar2
259 ,p_addr_attribute8 in varchar2 default hr_api.g_varchar2
260 ,p_addr_attribute9 in varchar2 default hr_api.g_varchar2
261 ,p_addr_attribute10 in varchar2 default hr_api.g_varchar2
262 ,p_addr_attribute11 in varchar2 default hr_api.g_varchar2
263 ,p_addr_attribute12 in varchar2 default hr_api.g_varchar2
264 ,p_addr_attribute13 in varchar2 default hr_api.g_varchar2
265 ,p_addr_attribute14 in varchar2 default hr_api.g_varchar2
266 ,p_addr_attribute15 in varchar2 default hr_api.g_varchar2
267 ,p_addr_attribute16 in varchar2 default hr_api.g_varchar2
268 ,p_addr_attribute17 in varchar2 default hr_api.g_varchar2
269 ,p_addr_attribute18 in varchar2 default hr_api.g_varchar2
270 ,p_addr_attribute19 in varchar2 default hr_api.g_varchar2
271 ,p_addr_attribute20 in varchar2 default hr_api.g_varchar2
272 );
273 --
274 end hr_fr_person_address_api;
[Home] [Help]