1 PACKAGE hr_location_api AS
2 /* $Header: hrlocapi.pkh 120.2.12010000.2 2008/08/06 08:43:56 ubhat ship $ */
3 /*#
4 * This package contains APIs for maintaining location information.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Location
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |---------------------------< create_location >----------------------------|
12 -- ----------------------------------------------------------------------------
13 -- {Start Of Comments}
14 /*#
15 * This API is used to create locations.
16 *
17 *
18 * <p><b>Licensing</b><br>
19 * This API is licensed for use with Human Resources and HR Foundation.
20 *
21 * <p><b>Prerequisites</b><br>
22 * If a business group is specified it must exist on the effective date.
23 *
24 * <p><b>Post Success</b><br>
25 * The location is created.
26 *
27 * <p><b>Post Failure</b><br>
28 * The location is not created and an error is raised.
29 * @param p_validate If true, then validation alone will be performed and the
30 * database will remain unchanged. If false and all validation checks pass,
31 * then the database will be modified.
32 * @param p_effective_date Reference date for validating lookup values are
33 * applicable during the start to end active date range. This date does not
34 * determine when the changes take effect.
35 * @param p_language_code Specifies to which language the translation values
36 * apply. You can set to the base or any installed language. The default value
37 * of hr_api.userenv_lang is equivalent to the RDBMS userenv('LANG') function
38 * value.
39 * @param p_location_code Unique name of the location
40 * @param p_description Description of the location
41 * @param p_timezone_code Time zone of the location.
42 * @param p_tp_header_id Identifies the inventory header. Used by Oracle EDI
43 * Gateway.
44 * @param p_ece_tp_location_code Identifies the inventory organization. Used by
45 * Oracle EDI Gateway.
46 * @param p_address_line_1 Location Address Developer Descriptive Flexfield
47 * Segment.
48 * @param p_address_line_2 Location Address Developer Descriptive Flexfield
49 * Segment.
50 * @param p_address_line_3 Location Address Developer Descriptive Flexfield
51 * Segment.
52 * @param p_bill_to_site_flag Indicates if this is a billing location
53 * @param p_country Location Address Developer Descriptive Flexfield Segment.
54 * @param p_designated_receiver_id Designated Receiver Person ID. Must be a
55 * valid employee within the scope of the location.
56 * @param p_in_organization_flag Indicates if the organization is an Internal
57 * Organization. Valid values defined in the YES/NO lookup type.
58 * @param p_inactive_date Date on which the location becomes inactive. Must be
59 * greater than or equal to p_effective_date.
60 * @param p_operating_unit_id Identifies the Operating Unit. Used to validate
61 * the parameter p_inventory_organization_id.
62 * @param p_inventory_organization_id Identifies the Inventory Organization for
63 * this location
64 * @param p_office_site_flag Indicates whether this location can be used as an
65 * office site. Valid values are defined in the YES_NO lookup type.
66 * @param p_postal_code Location Address Developer Descriptive Flexfield
67 * Segment.
68 * @param p_receiving_site_flag Indicates whether this location can be used as
69 * a receiving site. Valid values are defined in the YES_NO lookup type.
70 * @param p_region_1 Location Address Developer Descriptive Flexfield Segment.
71 * @param p_region_2 Location Address Developer Descriptive Flexfield Segment.
72 * @param p_region_3 Location Address Developer Descriptive Flexfield Segment.
73 * @param p_ship_to_location_id Identifies the Ship To Location. If it is
74 * passed as null, it will assume the value of the current location identifier.
75 * @param p_ship_to_site_flag Indicates whether items can be shipped to this
76 * location. Valid values are defined in the YES_NO lookup type.
77 * @param p_style This context value determines which Flexfield Structure to
78 * use with the Location Address Developer Descriptive flexfield segments.
79 * @param p_tax_name This parameter is disabled.
80 * @param p_telephone_number_1 Location Address Developer Descriptive Flexfield
81 * Segment.
82 * @param p_telephone_number_2 Location Address Developer Descriptive Flexfield
83 * Segment.
84 * @param p_telephone_number_3 Location Address Developer Descriptive Flexfield
85 * Segment.
86 * @param p_town_or_city Location Address Developer Descriptive Flexfield
87 * Segment.
88 * @param p_loc_information13 Location Address Developer Descriptive Flexfield
89 * Segment.
90 * @param p_loc_information14 Location Address Developer Descriptive Flexfield
91 * Segment.
92 * @param p_loc_information15 Location Address Developer Descriptive Flexfield
93 * Segment.
94 * @param p_loc_information16 Location Address Developer Descriptive Flexfield
95 * Segment.
96 * @param p_loc_information17 Location Address Developer Descriptive Flexfield
97 * Segment.
98 * @param p_loc_information18 Location Address Developer Descriptive Flexfield
99 * Segment.
100 * @param p_loc_information19 Location Address Developer Descriptive Flexfield
101 * Segment.
102 * @param p_loc_information20 Location Address Developer Descriptive Flexfield
103 * Segment.
104 * @param p_attribute_category This context value determines which flexfield
105 * structure to use with the descriptive flexfield segments.
106 * @param p_attribute1 Descriptive flexfield segment.
107 * @param p_attribute2 Descriptive flexfield segment.
108 * @param p_attribute3 Descriptive flexfield segment.
109 * @param p_attribute4 Descriptive flexfield segment.
110 * @param p_attribute5 Descriptive flexfield segment.
111 * @param p_attribute6 Descriptive flexfield segment.
112 * @param p_attribute7 Descriptive flexfield segment.
113 * @param p_attribute8 Descriptive flexfield segment.
114 * @param p_attribute9 Descriptive flexfield segment.
115 * @param p_attribute10 Descriptive flexfield segment.
116 * @param p_attribute11 Descriptive flexfield segment.
117 * @param p_attribute12 Descriptive flexfield segment.
118 * @param p_attribute13 Descriptive flexfield segment.
119 * @param p_attribute14 Descriptive flexfield segment.
120 * @param p_attribute15 Descriptive flexfield segment.
121 * @param p_attribute16 Descriptive flexfield segment.
122 * @param p_attribute17 Descriptive flexfield segment.
123 * @param p_attribute18 Descriptive flexfield segment.
124 * @param p_attribute19 Descriptive flexfield segment.
125 * @param p_attribute20 Descriptive flexfield segment.
126 * @param p_global_attribute_category This context value determines which
127 * Flexfield Structure to use with the JG_HR_LOCATIONS Descriptive flexfield
128 * segments. Used by Oracle Regional Localizations
129 * @param p_global_attribute1 JG_HR_LOCATIONS Descriptive Flexfield Segment.
130 * Used by Oracle Regional Localizations
131 * @param p_global_attribute2 JG_HR_LOCATIONS Descriptive Flexfield Segment.
132 * Used by Oracle Regional Localizations
133 * @param p_global_attribute3 JG_HR_LOCATIONS Descriptive Flexfield Segment.
134 * Used by Oracle Regional Localizations
135 * @param p_global_attribute4 JG_HR_LOCATIONS Descriptive Flexfield Segment.
136 * Used by Oracle Regional Localizations
137 * @param p_global_attribute5 JG_HR_LOCATIONS Descriptive Flexfield Segment.
138 * Used by Oracle Regional Localizations
139 * @param p_global_attribute6 JG_HR_LOCATIONS Descriptive Flexfield Segment.
140 * Used by Oracle Regional Localizations
141 * @param p_global_attribute7 JG_HR_LOCATIONS Descriptive Flexfield Segment.
142 * Used by Oracle Regional Localizations
143 * @param p_global_attribute8 JG_HR_LOCATIONS Descriptive Flexfield Segment.
144 * Used by Oracle Regional Localizations
145 * @param p_global_attribute9 JG_HR_LOCATIONS Descriptive Flexfield Segment.
146 * Used by Oracle Regional Localizations
147 * @param p_global_attribute10 JG_HR_LOCATIONS Descriptive Flexfield Segment.
148 * Used by Oracle Regional Localizations
149 * @param p_global_attribute11 JG_HR_LOCATIONS Descriptive Flexfield Segment.
150 * Used by Oracle Regional Localizations
151 * @param p_global_attribute12 JG_HR_LOCATIONS Descriptive Flexfield Segment.
152 * Used by Oracle Regional Localizations
153 * @param p_global_attribute13 JG_HR_LOCATIONS Descriptive Flexfield Segment.
154 * Used by Oracle Regional Localizations
155 * @param p_global_attribute14 JG_HR_LOCATIONS Descriptive Flexfield Segment.
156 * Used by Oracle Regional Localizations
157 * @param p_global_attribute15 JG_HR_LOCATIONS Descriptive Flexfield Segment.
158 * Used by Oracle Regional Localizations
159 * @param p_global_attribute16 JG_HR_LOCATIONS Descriptive Flexfield Segment.
160 * Used by Oracle Regional Localizations
161 * @param p_global_attribute17 JG_HR_LOCATIONS Descriptive Flexfield Segment.
162 * Used by Oracle Regional Localizations
163 * @param p_global_attribute18 JG_HR_LOCATIONS Descriptive Flexfield Segment.
164 * Used by Oracle Regional Localizations
165 * @param p_global_attribute19 JG_HR_LOCATIONS Descriptive Flexfield Segment.
166 * Used by Oracle Regional Localizations
167 * @param p_global_attribute20 JG_HR_LOCATIONS Descriptive Flexfield Segment.
168 * Used by Oracle Regional Localizations
169 * @param p_business_group_id Business group identifier. No value indicates the
170 * location can be used in any business group. Any other value must indicate a
171 * business group that exists, and restricts the scope of the location to that
172 * business group.
173 * @param p_location_id If p_validate is false, uniquely identifies the
174 * location created. If p_validate is true set to null.
175 * @param p_object_version_number If p_validate is false, then set to the
176 * version number of the created location. If p_validate is true, then the
177 * value will be null.
178 * @rep:displayname Create Location
179 * @rep:category BUSINESS_ENTITY HR_LOCATION
180 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
181 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
182 * @rep:scope public
183 * @rep:lifecycle active
184 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
185 */
186 --
187 -- {End Of Comments}
188 --
189 PROCEDURE create_location
190 ( p_validate IN BOOLEAN DEFAULT false
191 ,p_effective_date IN DATE
192 ,p_language_code IN VARCHAR2 DEFAULT hr_api.userenv_lang
193 ,p_location_code IN VARCHAR2
194 ,p_description IN VARCHAR2 DEFAULT NULL
195 ,p_timezone_code IN VARCHAR2 DEFAULT NULL
196 ,p_tp_header_id IN NUMBER DEFAULT NULL
197 ,p_ece_tp_location_code IN VARCHAR2 DEFAULT NULL
198 ,p_address_line_1 IN VARCHAR2 DEFAULT NULL
199 ,p_address_line_2 IN VARCHAR2 DEFAULT NULL
200 ,p_address_line_3 IN VARCHAR2 DEFAULT NULL
201 ,p_bill_to_site_flag IN VARCHAR2 DEFAULT 'Y'
202 ,p_country IN VARCHAR2 DEFAULT NULL
203 ,p_designated_receiver_id IN NUMBER DEFAULT NULL
204 ,p_in_organization_flag IN VARCHAR2 DEFAULT 'Y'
205 ,p_inactive_date IN DATE DEFAULT NULL
206 ,p_operating_unit_id IN NUMBER DEFAULT NULL
207 ,p_inventory_organization_id IN NUMBER DEFAULT NULL
208 ,p_office_site_flag IN VARCHAR2 DEFAULT 'Y'
209 ,p_postal_code IN VARCHAR2 DEFAULT NULL
210 ,p_receiving_site_flag IN VARCHAR2 DEFAULT 'Y'
211 ,p_region_1 IN VARCHAR2 DEFAULT NULL
212 ,p_region_2 IN VARCHAR2 DEFAULT NULL
213 ,p_region_3 IN VARCHAR2 DEFAULT NULL
214 ,p_ship_to_location_id IN NUMBER DEFAULT NULL
215 ,p_ship_to_site_flag IN VARCHAR2 DEFAULT 'Y'
216 ,p_style IN VARCHAR2 DEFAULT NULL
217 ,p_tax_name IN VARCHAR2 DEFAULT NULL
218 ,p_telephone_number_1 IN VARCHAR2 DEFAULT NULL
219 ,p_telephone_number_2 IN VARCHAR2 DEFAULT NULL
220 ,p_telephone_number_3 IN VARCHAR2 DEFAULT NULL
221 ,p_town_or_city IN VARCHAR2 DEFAULT NULL
222 ,p_loc_information13 IN VARCHAR2 DEFAULT NULL
223 ,p_loc_information14 IN VARCHAR2 DEFAULT NULL
224 ,p_loc_information15 IN VARCHAR2 DEFAULT NULL
225 ,p_loc_information16 IN VARCHAR2 DEFAULT NULL
226 ,p_loc_information17 IN VARCHAR2 DEFAULT NULL
227 ,p_loc_information18 IN VARCHAR2 DEFAULT NULL
228 ,p_loc_information19 IN VARCHAR2 DEFAULT NULL
229 ,p_loc_information20 IN VARCHAR2 DEFAULT NULL
230 ,p_attribute_category IN VARCHAR2 DEFAULT NULL
231 ,p_attribute1 IN VARCHAR2 DEFAULT NULL
232 ,p_attribute2 IN VARCHAR2 DEFAULT NULL
233 ,p_attribute3 IN VARCHAR2 DEFAULT NULL
234 ,p_attribute4 IN VARCHAR2 DEFAULT NULL
235 ,p_attribute5 IN VARCHAR2 DEFAULT NULL
236 ,p_attribute6 IN VARCHAR2 DEFAULT NULL
237 ,p_attribute7 IN VARCHAR2 DEFAULT NULL
238 ,p_attribute8 IN VARCHAR2 DEFAULT NULL
239 ,p_attribute9 IN VARCHAR2 DEFAULT NULL
240 ,p_attribute10 IN VARCHAR2 DEFAULT NULL
241 ,p_attribute11 IN VARCHAR2 DEFAULT NULL
242 ,p_attribute12 IN VARCHAR2 DEFAULT NULL
243 ,p_attribute13 IN VARCHAR2 DEFAULT NULL
244 ,p_attribute14 IN VARCHAR2 DEFAULT NULL
245 ,p_attribute15 IN VARCHAR2 DEFAULT NULL
246 ,p_attribute16 IN VARCHAR2 DEFAULT NULL
247 ,p_attribute17 IN VARCHAR2 DEFAULT NULL
248 ,p_attribute18 IN VARCHAR2 DEFAULT NULL
249 ,p_attribute19 IN VARCHAR2 DEFAULT NULL
250 ,p_attribute20 IN VARCHAR2 DEFAULT NULL
251 ,p_global_attribute_category IN VARCHAR2 DEFAULT NULL
252 ,p_global_attribute1 IN VARCHAR2 DEFAULT NULL
253 ,p_global_attribute2 IN VARCHAR2 DEFAULT NULL
254 ,p_global_attribute3 IN VARCHAR2 DEFAULT NULL
255 ,p_global_attribute4 IN VARCHAR2 DEFAULT NULL
256 ,p_global_attribute5 IN VARCHAR2 DEFAULT NULL
257 ,p_global_attribute6 IN VARCHAR2 DEFAULT NULL
258 ,p_global_attribute7 IN VARCHAR2 DEFAULT NULL
259 ,p_global_attribute8 IN VARCHAR2 DEFAULT NULL
260 ,p_global_attribute9 IN VARCHAR2 DEFAULT NULL
261 ,p_global_attribute10 IN VARCHAR2 DEFAULT NULL
262 ,p_global_attribute11 IN VARCHAR2 DEFAULT NULL
263 ,p_global_attribute12 IN VARCHAR2 DEFAULT NULL
264 ,p_global_attribute13 IN VARCHAR2 DEFAULT NULL
265 ,p_global_attribute14 IN VARCHAR2 DEFAULT NULL
266 ,p_global_attribute15 IN VARCHAR2 DEFAULT NULL
267 ,p_global_attribute16 IN VARCHAR2 DEFAULT NULL
268 ,p_global_attribute17 IN VARCHAR2 DEFAULT NULL
269 ,p_global_attribute18 IN VARCHAR2 DEFAULT NULL
270 ,p_global_attribute19 IN VARCHAR2 DEFAULT NULL
271 ,p_global_attribute20 IN VARCHAR2 DEFAULT NULL
272 ,p_business_group_id IN NUMBER DEFAULT NULL
273 ,p_location_id OUT NOCOPY NUMBER
274 ,p_object_version_number OUT NOCOPY NUMBER
275 );
276 -- ----------------------------------------------------------------------------
277 -- |-------------------------------< update_location >------------------------|
278 -- ----------------------------------------------------------------------------
279 -- {Start Of Comments}
280 /*#
281 * This API updates the details of a location.
282 *
283 *
284 * <p><b>Licensing</b><br>
285 * This API is licensed for use with Human Resources and HR Foundation.
286 *
287 * <p><b>Prerequisites</b><br>
288 * The location must exist.
289 *
290 * <p><b>Post Success</b><br>
291 * The location information is updated with the details supplied.
292 *
293 * <p><b>Post Failure</b><br>
294 * The API does not update the location, and raises an error
295 * @param p_validate If true, then validation alone will be performed and the
296 * database will remain unchanged. If false and all validation checks pass,
297 * then the database will be modified.
298 * @param p_effective_date Reference date for validating lookup values are
299 * applicable during the start to end active date range. This date does not
300 * determine when the changes take effect.
301 * @param p_language_code Specifies to which language the translation values
302 * apply. You can set to the base or any installed language. The default value
303 * of hr_api.userenv_lang is equivalent to the RDBMS userenv('LANG') function
304 * value.
305 * @param p_location_id Uniquely identifies the location to be updated.
306 * @param p_location_code Unique name of the location
307 * @param p_description Description of the location
308 * @param p_timezone_code Time zone of the location.
309 * @param p_tp_header_id Identifies the inventory header. Used by Oracle EDI
310 * Gateway.
311 * @param p_ece_tp_location_code Identifies the inventory organization. Used by
312 * Oracle EDI Gateway.
313 * @param p_address_line_1 Location Address Developer Descriptive Flexfield
314 * Segment.
315 * @param p_address_line_2 Location Address Developer Descriptive Flexfield
316 * Segment.
317 * @param p_address_line_3 Location Address Developer Descriptive Flexfield
318 * Segment.
319 * @param p_bill_to_site_flag Indicates if this is a billing location
320 * @param p_country Location Address Developer Descriptive Flexfield Segment.
321 * @param p_designated_receiver_id Designated Receiver Person ID. Must be a
322 * valid employee within the scope of the location.
323 * @param p_in_organization_flag Indicates if the organization is an Internal
324 * Organization. Valid values defined in the YES/NO lookup type.
325 * @param p_inactive_date Date on which location becomes inactive. Must be
326 * greater than or equal to p_effective_date.
327 * @param p_operating_unit_id Identifies Operating Unit, used to validate the
328 * parameter p_inventory_organization_id.
329 * @param p_inventory_organization_id Identifies the Inventory Organization for
330 * this location
331 * @param p_office_site_flag Indicates whether this location can be used as an
332 * office site. Valid values are defined in the YES_NO lookup type.
333 * @param p_postal_code Location Address Developer Descriptive Flexfield
334 * Segment.
335 * @param p_receiving_site_flag Indicates whether this location can be used as
336 * a receiving site. Valid values are defined in the YES_NO lookup type.
337 * @param p_region_1 Location Address Developer Descriptive Flexfield Segment.
338 * @param p_region_2 Location Address Developer Descriptive Flexfield Segment.
339 * @param p_region_3 Location Address Developer Descriptive Flexfield Segment.
340 * @param p_ship_to_location_id Identifies the Ship To Location. If it is
341 * passed as null, it will assume the value of the current location identifier.
342 * @param p_ship_to_site_flag Indicates whether items can be shipped to this
343 * location. Valid values are defined in the YES_NO lookup type.
344 * @param p_style This context value determines which Flexfield Structure to
345 * use with the Location Address Developer Descriptive flexfield segments.
346 * @param p_tax_name This parameter is disabled.
347 * @param p_telephone_number_1 Location Address Developer Descriptive Flexfield
348 * Segment.
349 * @param p_telephone_number_2 Location Address Developer Descriptive Flexfield
350 * Segment.
351 * @param p_telephone_number_3 Location Address Developer Descriptive Flexfield
352 * Segment.
353 * @param p_town_or_city Location Address Developer Descriptive Flexfield
354 * Segment.
355 * @param p_loc_information13 Location Address Developer Descriptive Flexfield
356 * Segment.
357 * @param p_loc_information14 Location Address Developer Descriptive Flexfield
358 * Segment.
359 * @param p_loc_information15 Location Address Developer Descriptive Flexfield
360 * Segment.
361 * @param p_loc_information16 Location Address Developer Descriptive Flexfield
362 * Segment.
363 * @param p_loc_information17 Location Address Developer Descriptive Flexfield
364 * Segment.
365 * @param p_loc_information18 Location Address Developer Descriptive Flexfield
366 * Segment.
367 * @param p_loc_information19 Location Address Developer Descriptive Flexfield
368 * Segment.
369 * @param p_loc_information20 Location Address Developer Descriptive Flexfield
370 * Segment.
371 * @param p_attribute_category This context value determines which flexfield
372 * structure to use with the descriptive flexfield segments.
373 * @param p_attribute1 Descriptive flexfield segment.
374 * @param p_attribute2 Descriptive flexfield segment.
375 * @param p_attribute3 Descriptive flexfield segment.
376 * @param p_attribute4 Descriptive flexfield segment.
377 * @param p_attribute5 Descriptive flexfield segment.
378 * @param p_attribute6 Descriptive flexfield segment.
379 * @param p_attribute7 Descriptive flexfield segment.
380 * @param p_attribute8 Descriptive flexfield segment.
381 * @param p_attribute9 Descriptive flexfield segment.
382 * @param p_attribute10 Descriptive flexfield segment.
383 * @param p_attribute11 Descriptive flexfield segment.
384 * @param p_attribute12 Descriptive flexfield segment.
385 * @param p_attribute13 Descriptive flexfield segment.
386 * @param p_attribute14 Descriptive flexfield segment.
387 * @param p_attribute15 Descriptive flexfield segment.
388 * @param p_attribute16 Descriptive flexfield segment.
389 * @param p_attribute17 Descriptive flexfield segment.
390 * @param p_attribute18 Descriptive flexfield segment.
391 * @param p_attribute19 Descriptive flexfield segment.
392 * @param p_attribute20 Descriptive flexfield segment.
393 * @param p_global_attribute_category This context value determines which
394 * Flexfield Structure to use with the JG_HR_LOCATIONS Descriptive flexfield
395 * segments. Used by Oracle Regional Localizations
396 * @param p_global_attribute1 JG_HR_LOCATIONS Descriptive Flexfield Segment.
397 * Used by Oracle Regional Localizations
398 * @param p_global_attribute2 JG_HR_LOCATIONS Descriptive Flexfield Segment.
399 * Used by Oracle Regional Localizations
400 * @param p_global_attribute3 JG_HR_LOCATIONS Descriptive Flexfield Segment.
401 * Used by Oracle Regional Localizations
402 * @param p_global_attribute4 JG_HR_LOCATIONS Descriptive Flexfield Segment.
403 * Used by Oracle Regional Localizations
404 * @param p_global_attribute5 JG_HR_LOCATIONS Descriptive Flexfield Segment.
405 * Used by Oracle Regional Localizations
406 * @param p_global_attribute6 JG_HR_LOCATIONS Descriptive Flexfield Segment.
407 * Used by Oracle Regional Localizations
408 * @param p_global_attribute7 JG_HR_LOCATIONS Descriptive Flexfield Segment.
409 * Used by Oracle Regional Localizations
410 * @param p_global_attribute8 JG_HR_LOCATIONS Descriptive Flexfield Segment.
411 * Used by Oracle Regional Localizations
412 * @param p_global_attribute9 JG_HR_LOCATIONS Descriptive Flexfield Segment.
413 * Used by Oracle Regional Localizations
414 * @param p_global_attribute10 JG_HR_LOCATIONS Descriptive Flexfield Segment.
415 * Used by Oracle Regional Localizations
416 * @param p_global_attribute11 JG_HR_LOCATIONS Descriptive Flexfield Segment.
417 * Used by Oracle Regional Localizations
418 * @param p_global_attribute12 JG_HR_LOCATIONS Descriptive Flexfield Segment.
419 * Used by Oracle Regional Localizations
420 * @param p_global_attribute13 JG_HR_LOCATIONS Descriptive Flexfield Segment.
421 * Used by Oracle Regional Localizations
422 * @param p_global_attribute14 JG_HR_LOCATIONS Descriptive Flexfield Segment.
423 * Used by Oracle Regional Localizations
424 * @param p_global_attribute15 JG_HR_LOCATIONS Descriptive Flexfield Segment.
425 * Used by Oracle Regional Localizations
426 * @param p_global_attribute16 JG_HR_LOCATIONS Descriptive Flexfield Segment.
427 * Used by Oracle Regional Localizations
428 * @param p_global_attribute17 JG_HR_LOCATIONS Descriptive Flexfield Segment.
429 * Used by Oracle Regional Localizations
430 * @param p_global_attribute18 JG_HR_LOCATIONS Descriptive Flexfield Segment.
431 * Used by Oracle Regional Localizations
432 * @param p_global_attribute19 JG_HR_LOCATIONS Descriptive Flexfield Segment.
433 * Used by Oracle Regional Localizations
434 * @param p_global_attribute20 JG_HR_LOCATIONS Descriptive Flexfield Segment.
435 * Used by Oracle Regional Localizations
436 * @param p_object_version_number Pass in the current version number of the
437 * location record to be updated. When the API completes if p_validate is
438 * false, will be set to the new version number of the updated location record.
439 * If p_validate is true will be set to the same value which was passed in.
440 * @rep:displayname Update Location
441 * @rep:category BUSINESS_ENTITY HR_LOCATION
442 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
443 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
444 * @rep:scope public
445 * @rep:lifecycle active
446 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
447 */
448 --
449 -- {End Of Comments}
450 --
451 PROCEDURE update_location
452 ( p_validate IN BOOLEAN DEFAULT false
453 ,p_effective_date IN DATE
454 ,p_language_code IN VARCHAR2 DEFAULT hr_api.userenv_lang
455 ,p_location_id IN NUMBER
456 ,p_location_code IN VARCHAR2 DEFAULT hr_api.g_varchar2
457 ,p_description IN VARCHAR2 DEFAULT hr_api.g_varchar2
458 ,p_timezone_code IN VARCHAR2 DEFAULT hr_api.g_varchar2
459 ,p_tp_header_id IN NUMBER DEFAULT hr_api.g_number
460 ,p_ece_tp_location_code IN VARCHAR2 DEFAULT hr_api.g_varchar2
461 ,p_address_line_1 IN VARCHAR2 DEFAULT hr_api.g_varchar2
462 ,p_address_line_2 IN VARCHAR2 DEFAULT hr_api.g_varchar2
463 ,p_address_line_3 IN VARCHAR2 DEFAULT hr_api.g_varchar2
464 ,p_bill_to_site_flag IN VARCHAR2 DEFAULT hr_api.g_varchar2
465 ,p_country IN VARCHAR2 DEFAULT hr_api.g_varchar2
466 ,p_designated_receiver_id IN NUMBER DEFAULT hr_api.g_number
467 ,p_in_organization_flag IN VARCHAR2 DEFAULT hr_api.g_varchar2
468 ,p_inactive_date IN DATE DEFAULT hr_api.g_date
469 ,p_operating_unit_id IN NUMBER DEFAULT NULL
470 ,p_inventory_organization_id IN NUMBER DEFAULT hr_api.g_number
471 ,p_office_site_flag IN VARCHAR2 DEFAULT hr_api.g_varchar2
472 ,p_postal_code IN VARCHAR2 DEFAULT hr_api.g_varchar2
473 ,p_receiving_site_flag IN VARCHAR2 DEFAULT hr_api.g_varchar2
474 ,p_region_1 IN VARCHAR2 DEFAULT hr_api.g_varchar2
475 ,p_region_2 IN VARCHAR2 DEFAULT hr_api.g_varchar2
476 ,p_region_3 IN VARCHAR2 DEFAULT hr_api.g_varchar2
477 ,p_ship_to_location_id IN NUMBER DEFAULT hr_api.g_number
478 ,p_ship_to_site_flag IN VARCHAR2 DEFAULT hr_api.g_varchar2
479 ,p_style IN VARCHAR2 DEFAULT hr_api.g_varchar2
480 ,p_tax_name IN VARCHAR2 DEFAULT hr_api.g_varchar2
481 ,p_telephone_number_1 IN VARCHAR2 DEFAULT hr_api.g_varchar2
482 ,p_telephone_number_2 IN VARCHAR2 DEFAULT hr_api.g_varchar2
483 ,p_telephone_number_3 IN VARCHAR2 DEFAULT hr_api.g_varchar2
484 ,p_town_or_city IN VARCHAR2 DEFAULT hr_api.g_varchar2
485 ,p_loc_information13 IN VARCHAR2 DEFAULT hr_api.g_varchar2
486 ,p_loc_information14 IN VARCHAR2 DEFAULT hr_api.g_varchar2
487 ,p_loc_information15 IN VARCHAR2 DEFAULT hr_api.g_varchar2
488 ,p_loc_information16 IN VARCHAR2 DEFAULT hr_api.g_varchar2
489 ,p_loc_information17 IN VARCHAR2 DEFAULT hr_api.g_varchar2
490 ,p_loc_information18 IN VARCHAR2 DEFAULT hr_api.g_varchar2
491 ,p_loc_information19 IN VARCHAR2 DEFAULT hr_api.g_varchar2
492 ,p_loc_information20 IN VARCHAR2 DEFAULT hr_api.g_varchar2
493 ,p_attribute_category IN VARCHAR2 DEFAULT hr_api.g_varchar2
494 ,p_attribute1 IN VARCHAR2 DEFAULT hr_api.g_varchar2
495 ,p_attribute2 IN VARCHAR2 DEFAULT hr_api.g_varchar2
496 ,p_attribute3 IN VARCHAR2 DEFAULT hr_api.g_varchar2
497 ,p_attribute4 IN VARCHAR2 DEFAULT hr_api.g_varchar2
498 ,p_attribute5 IN VARCHAR2 DEFAULT hr_api.g_varchar2
499 ,p_attribute6 IN VARCHAR2 DEFAULT hr_api.g_varchar2
500 ,p_attribute7 IN VARCHAR2 DEFAULT hr_api.g_varchar2
501 ,p_attribute8 IN VARCHAR2 DEFAULT hr_api.g_varchar2
502 ,p_attribute9 IN VARCHAR2 DEFAULT hr_api.g_varchar2
503 ,p_attribute10 IN VARCHAR2 DEFAULT hr_api.g_varchar2
504 ,p_attribute11 IN VARCHAR2 DEFAULT hr_api.g_varchar2
505 ,p_attribute12 IN VARCHAR2 DEFAULT hr_api.g_varchar2
506 ,p_attribute13 IN VARCHAR2 DEFAULT hr_api.g_varchar2
507 ,p_attribute14 IN VARCHAR2 DEFAULT hr_api.g_varchar2
508 ,p_attribute15 IN VARCHAR2 DEFAULT hr_api.g_varchar2
509 ,p_attribute16 IN VARCHAR2 DEFAULT hr_api.g_varchar2
510 ,p_attribute17 IN VARCHAR2 DEFAULT hr_api.g_varchar2
511 ,p_attribute18 IN VARCHAR2 DEFAULT hr_api.g_varchar2
512 ,p_attribute19 IN VARCHAR2 DEFAULT hr_api.g_varchar2
513 ,p_attribute20 IN VARCHAR2 DEFAULT hr_api.g_varchar2
514 ,p_global_attribute_category IN VARCHAR2 DEFAULT hr_api.g_varchar2
515 ,p_global_attribute1 IN VARCHAR2 DEFAULT hr_api.g_varchar2
516 ,p_global_attribute2 IN VARCHAR2 DEFAULT hr_api.g_varchar2
517 ,p_global_attribute3 IN VARCHAR2 DEFAULT hr_api.g_varchar2
518 ,p_global_attribute4 IN VARCHAR2 DEFAULT hr_api.g_varchar2
519 ,p_global_attribute5 IN VARCHAR2 DEFAULT hr_api.g_varchar2
520 ,p_global_attribute6 IN VARCHAR2 DEFAULT hr_api.g_varchar2
521 ,p_global_attribute7 IN VARCHAR2 DEFAULT hr_api.g_varchar2
522 ,p_global_attribute8 IN VARCHAR2 DEFAULT hr_api.g_varchar2
523 ,p_global_attribute9 IN VARCHAR2 DEFAULT hr_api.g_varchar2
524 ,p_global_attribute10 IN VARCHAR2 DEFAULT hr_api.g_varchar2
525 ,p_global_attribute11 IN VARCHAR2 DEFAULT hr_api.g_varchar2
526 ,p_global_attribute12 IN VARCHAR2 DEFAULT hr_api.g_varchar2
527 ,p_global_attribute13 IN VARCHAR2 DEFAULT hr_api.g_varchar2
528 ,p_global_attribute14 IN VARCHAR2 DEFAULT hr_api.g_varchar2
529 ,p_global_attribute15 IN VARCHAR2 DEFAULT hr_api.g_varchar2
530 ,p_global_attribute16 IN VARCHAR2 DEFAULT hr_api.g_varchar2
531 ,p_global_attribute17 IN VARCHAR2 DEFAULT hr_api.g_varchar2
532 ,p_global_attribute18 IN VARCHAR2 DEFAULT hr_api.g_varchar2
533 ,p_global_attribute19 IN VARCHAR2 DEFAULT hr_api.g_varchar2
534 ,p_global_attribute20 IN VARCHAR2 DEFAULT hr_api.g_varchar2
535 ,p_object_version_number IN OUT NOCOPY NUMBER
536 );
537 --
538 -- ----------------------------------------------------------------------------
539 -- |--------------------------< delete_location >-----------------------------|
540 -- ----------------------------------------------------------------------------
541 -- {Start Of Comments}
542 /*#
543 * This API deletes a location.
544 *
545 *
546 * <p><b>Licensing</b><br>
547 * This API is licensed for use with Human Resources and HR Foundation.
548 *
549 * <p><b>Prerequisites</b><br>
550 * The location must exist
551 *
552 * <p><b>Post Success</b><br>
553 * The API deletes the location.
554 *
555 * <p><b>Post Failure</b><br>
556 * The API does not delete the location, and raises an error
557 * @param p_validate If true, then validation alone will be performed and the
558 * database will remain unchanged. If false and all validation checks pass,
559 * then the database will be modified.
560 * @param p_location_id Uniquely identifies the location to be deleted.
561 * @param p_object_version_number Current version number of the location to be
562 * deleted.
563 * @rep:displayname Delete Location
564 * @rep:category BUSINESS_ENTITY HR_LOCATION
565 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
566 * @rep:scope public
567 * @rep:lifecycle active
568 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
569 */
570 --
571 -- {End Of Comments}
572 --
573 PROCEDURE delete_location
574 ( p_validate IN BOOLEAN DEFAULT false
575 ,p_location_id IN hr_locations.location_id%TYPE
576 ,p_object_version_number IN hr_locations.object_version_number%TYPE
577 );
578 --
579 -- ----------------------------------------------------------------------------
580 -- |-----------------------< create_location_legal_adr >-----------------------|
581 -- ----------------------------------------------------------------------------
582 -- {Start Of Comments}
583 --
584 -- Description:
585 -- This API creates a new location as a legal address.
586 -- The legal address flag will be 'Y' for the location created.
587 --
588 -- A location that has been flagged as a legal address can be used as the legal
589 -- address for a legal entity. This functionality is used by the new financials
590 -- legal entity model which will be available in a future release of the
591 -- eBusiness Suite.
592 --
593 -- The API is MLS enabled, and there are two translated
594 -- columns: LOCATION_CODE and DESCRIPTION.
595 --
596 --
597 -- Locations are stored on the HR_LOCATIONS_ALL table. The translated
598 -- columns are stored on the HR_LOCATIONS_ALL_TL table.
599 --
600 -- The business_group_id of a location determines its scope:
601 --
602 -- If the business_group_id is NULL, the location's scope is global.
603 -- This means the location is visible to/can reference any entity
604 -- (within the scope of the current security group).
605 --
606 -- If the business_group_id is set, the location's scope is local.
607 -- This means the location is visible to/can reference any entity
608 -- within the same business_group or whose scope is global (within
609 -- the scope of the current security group).
610 --
611 --
612 -- Prerequisites:
613 --
614 -- None.
615 --
616 -- In Parameters:
617 -- Name Reqd Type Description
618 --
619 -- p_validate No Boolean If true, the database
620 -- remains unchanged. If false
621 -- then the location will be
622 -- created on the database.
623 -- p_effective_date Yes Date Used for date_track
624 -- validation.
625 -- p_language_code No Varchar2 The language used for the
626 -- initial translation values
627 -- p_location_code Yes Varchar2 Location name (Translated)
628 -- p_description No Varchar2 Location description (Translated)
629 -- p_timezone_code No Varchar2 Timezone of Location
630 -- p_address_line_1 No Varchar2 Address Flexfield
631 -- p_address_line_2 No Varchar2 Address Flexfield
632 -- p_address_line_3 No Varchar2 Address Flexfield
633 -- p_country No Varchar2 Address Flexfield
634 -- p_inactive_date No Date Date on which location becomes
635 -- p_postal_code No Varchar2 Address Flexfield
636 -- p_region_1 No Varchar2 Address Flexfield
637 -- p_region_2 No Varchar2 Address Flexfield
638 -- p_region_3 No Varchar2 Address Flexfield
639 --
640 -- p_style No Varchar2 Address Flexfield
641 -- p_town_or_city No Varchar2 Address Flexfield
642 -- p_attribute_category No Varchar2 Flexfield Category
643 -- p_attribute1 No Varchar2 Flexfield
644 -- ..
645 -- p_attribute20 No Varchar2 Flexfield
646 -- p_business_group_id No Number Business group ID. A
647 -- NULL value indicates global
648 -- scope. Any other value must
649 -- index a valid business group
650 -- and sets the scope of the
651 -- location to local.
652 --
653 -- Post Success:
654 -- When the location has been successfully inserted, the following OUT
655 -- parameters are set:
656 --
657 -- Name Type Description
658 --
659 -- p_location_id Number If p_validate is false, this
660 -- contains the ID assigned to
661 -- the location (otherwise
662 -- contains NULL)
663 -- p_object_version_number Number If p_validate is false, this
664 -- contains the Object Version
665 -- Number of the newly created
666 -- row (otherwise contains NULL)
667 --
668 -- Post Failure:
669 -- The API does not create the location, and raises an error
670 --
671 -- Access Status:
672 -- Internal Development Use Only.
673 --
674 -- Special Notes:
675 -- N/A
676 -- {End Of Comments}
677 --
678 PROCEDURE create_location_legal_adr
679 ( p_validate IN BOOLEAN DEFAULT false
680 ,p_effective_date IN DATE
681 ,p_language_code IN VARCHAR2 DEFAULT hr_api.userenv_lang
682 ,p_location_code IN VARCHAR2
683 ,p_description IN VARCHAR2 DEFAULT NULL
684 ,p_timezone_code IN VARCHAR2 DEFAULT NULL
685 ,p_address_line_1 IN VARCHAR2 DEFAULT NULL
686 ,p_address_line_2 IN VARCHAR2 DEFAULT NULL
687 ,p_address_line_3 IN VARCHAR2 DEFAULT NULL
688 ,p_country IN VARCHAR2 DEFAULT NULL
689 ,p_inactive_date IN DATE DEFAULT NULL
690 ,p_postal_code IN VARCHAR2 DEFAULT NULL
691 ,p_region_1 IN VARCHAR2 DEFAULT NULL
692 ,p_region_2 IN VARCHAR2 DEFAULT NULL
693 ,p_region_3 IN VARCHAR2 DEFAULT NULL
694 ,p_style IN VARCHAR2 DEFAULT NULL
695 ,p_town_or_city IN VARCHAR2 DEFAULT NULL
696 ,p_attribute_category IN VARCHAR2 DEFAULT NULL
697 ,p_attribute1 IN VARCHAR2 DEFAULT NULL
698 ,p_attribute2 IN VARCHAR2 DEFAULT NULL
699 ,p_attribute3 IN VARCHAR2 DEFAULT NULL
700 ,p_attribute4 IN VARCHAR2 DEFAULT NULL
701 ,p_attribute5 IN VARCHAR2 DEFAULT NULL
702 ,p_attribute6 IN VARCHAR2 DEFAULT NULL
703 ,p_attribute7 IN VARCHAR2 DEFAULT NULL
704 ,p_attribute8 IN VARCHAR2 DEFAULT NULL
705 ,p_attribute9 IN VARCHAR2 DEFAULT NULL
706 ,p_attribute10 IN VARCHAR2 DEFAULT NULL
707 ,p_attribute11 IN VARCHAR2 DEFAULT NULL
708 ,p_attribute12 IN VARCHAR2 DEFAULT NULL
709 ,p_attribute13 IN VARCHAR2 DEFAULT NULL
710 ,p_attribute14 IN VARCHAR2 DEFAULT NULL
711 ,p_attribute15 IN VARCHAR2 DEFAULT NULL
712 ,p_attribute16 IN VARCHAR2 DEFAULT NULL
713 ,p_attribute17 IN VARCHAR2 DEFAULT NULL
714 ,p_attribute18 IN VARCHAR2 DEFAULT NULL
715 ,p_attribute19 IN VARCHAR2 DEFAULT NULL
716 ,p_attribute20 IN VARCHAR2 DEFAULT NULL
717 ,p_business_group_id IN NUMBER DEFAULT NULL
718 ,p_location_id OUT NOCOPY NUMBER
719 ,p_object_version_number OUT NOCOPY NUMBER
720 );
721 -- ----------------------------------------------------------------------------
722 -- |-----------------------< update_location_legal_adr >-----------------------|
723 -- ----------------------------------------------------------------------------
724 -- {Start Of Comments}
725 --
726 -- Description:
727 -- This API updates an existing location which has been created as a
728 -- legal adress.
729 --
730 -- A location that has been flagged as a legal address can be used as the legal
731 -- address for a legal entity. This functionality is used by the new financials
732 -- legal entity model which will be available in a future release of the
733 -- eBusiness Suite.
734 --
735 -- The API is MLS enabled, and there are two translated
736 -- columns: LOCATION_CODE and DESCRIPTION.
737 --
738 -- Locations are stored on the HR_LOCATIONS_ALL table. The translated
739 -- columns are stored on the HR_LOCATIONS_ALL_TL table. This API will call
740 -- hr_location_internal API, which is an internal API, which can not be
741 -- accessed by users.
742 --
743 -- The business_group_id of a location determines its scope:
744 --
745 -- If the business_group_id is NULL, the location's scope is global.
746 -- This means the location is visible to/can reference any entity
747 -- (within the scope of the current security group).
748 --
749 -- If the business_group_id is set, the location's scope is local.
750 -- This means the location is visible to/can reference any entity
751 -- within the same business_group or whose scope is global (within
752 -- the scope of the current security group).
753 --
754 --
755 -- Prerequisites:
756 --
757 -- None.
758 --
759 -- In Parameters:
760 -- Name Reqd Type Description
761 --
762 -- p_validate No Boolean If true, the database
763 -- remains unchanged. If false
764 -- then the location will be
765 -- created on the database.
766 -- p_effective_date Yes Date Used for date_track
767 -- validation.
768 -- p_language_code No Varchar2 Determines which translation(s)
769 -- are updated.
770 -- p_location_id Yes Number Primary Key
771 -- p_location_code No Varchar2 Location name (Translated)
772 -- p_description No Varchar2 Location description (Translated)
773 -- p_timezone_code No Varchar2 Timezone of Location
774 -- p_address_line_1 No Varchar2 Address Flexfield
775 -- p_address_line_2 No Varchar2 Address Flexfield
776 -- p_address_line_3 No Varchar2 Address Flexfield
777 -- p_country No Varchar2 Address Flexfield
778 -- p_inactive_date No Date Date on which location becomes
779 -- p_postal_code No Varchar2 Address Flexfield
780 -- p_region_1 No Varchar2 Address Flexfield
781 -- p_region_2 No Varchar2 Address Flexfield
782 -- p_region_3 No Varchar2 Address Flexfield
783 -- p_style No Varchar2 Address Flexfield
784 -- p_town_or_city No Varchar2 Address Flexfield
785 -- p_attribute_category No Varchar2 Flexfield Category
786 -- p_attribute1 No Varchar2 Flexfield
787 -- ..
788 -- p_attribute20 No Varchar2 Flexfield
789 -- p_object_version_number Yes Number Object Version Number
790 --
791 -- Post Success:
792 -- When the location has been successfully updated, the following OUT
793 -- parameters are set:
794 --
795 -- Name Type Description
796 --
797 -- p_object_version_number Number If p_validate is false, this
798 -- contains the new Object
799 -- Version Number assigned to
800 -- the row (otherwise it is
801 -- left unchanged).
802 -- Post Failure:
803 -- The API does not update the location, and raises an error
804 --
805 -- Access Status:
806 -- Internal Development Use Only.
807 --
808 --
809 -- Special Notes:
810 -- N/A
811 --
812 -- {End Of Comments}
813 --
814 PROCEDURE update_location_legal_adr
815 ( p_validate IN BOOLEAN DEFAULT false
816 ,p_effective_date IN DATE
817 ,p_location_id IN NUMBER
818 ,p_description IN VARCHAR2 DEFAULT hr_api.g_varchar2
819 ,p_timezone_code IN VARCHAR2 DEFAULT hr_api.g_varchar2
820 ,p_address_line_1 IN VARCHAR2 DEFAULT hr_api.g_varchar2
821 ,p_address_line_2 IN VARCHAR2 DEFAULT hr_api.g_varchar2
822 ,p_address_line_3 IN VARCHAR2 DEFAULT hr_api.g_varchar2
823 ,p_inactive_date IN DATE DEFAULT hr_api.g_date
824 ,p_postal_code IN VARCHAR2 DEFAULT hr_api.g_varchar2
825 ,p_region_1 IN VARCHAR2 DEFAULT hr_api.g_varchar2
826 ,p_region_2 IN VARCHAR2 DEFAULT hr_api.g_varchar2
827 ,p_region_3 IN VARCHAR2 DEFAULT hr_api.g_varchar2
828 ,p_style IN VARCHAR2 DEFAULT hr_api.g_varchar2
829 ,p_town_or_city IN VARCHAR2 DEFAULT hr_api.g_varchar2
830 ,p_attribute_category IN VARCHAR2 DEFAULT hr_api.g_varchar2
831 ,p_attribute1 IN VARCHAR2 DEFAULT hr_api.g_varchar2
832 ,p_attribute2 IN VARCHAR2 DEFAULT hr_api.g_varchar2
833 ,p_attribute3 IN VARCHAR2 DEFAULT hr_api.g_varchar2
834 ,p_attribute4 IN VARCHAR2 DEFAULT hr_api.g_varchar2
835 ,p_attribute5 IN VARCHAR2 DEFAULT hr_api.g_varchar2
836 ,p_attribute6 IN VARCHAR2 DEFAULT hr_api.g_varchar2
837 ,p_attribute7 IN VARCHAR2 DEFAULT hr_api.g_varchar2
838 ,p_attribute8 IN VARCHAR2 DEFAULT hr_api.g_varchar2
839 ,p_attribute9 IN VARCHAR2 DEFAULT hr_api.g_varchar2
840 ,p_attribute10 IN VARCHAR2 DEFAULT hr_api.g_varchar2
841 ,p_attribute11 IN VARCHAR2 DEFAULT hr_api.g_varchar2
842 ,p_attribute12 IN VARCHAR2 DEFAULT hr_api.g_varchar2
843 ,p_attribute13 IN VARCHAR2 DEFAULT hr_api.g_varchar2
844 ,p_attribute14 IN VARCHAR2 DEFAULT hr_api.g_varchar2
845 ,p_attribute15 IN VARCHAR2 DEFAULT hr_api.g_varchar2
846 ,p_attribute16 IN VARCHAR2 DEFAULT hr_api.g_varchar2
847 ,p_attribute17 IN VARCHAR2 DEFAULT hr_api.g_varchar2
848 ,p_attribute18 IN VARCHAR2 DEFAULT hr_api.g_varchar2
849 ,p_attribute19 IN VARCHAR2 DEFAULT hr_api.g_varchar2
850 ,p_attribute20 IN VARCHAR2 DEFAULT hr_api.g_varchar2
851 ,p_object_version_number IN OUT NOCOPY NUMBER
852 );
853 --
854 --------------------------------------------------------------------------------
855 PROCEDURE set_translation_globals(p_business_group_id IN NUMBER,
856 p_legislation_code IN VARCHAR2);
857 --------------------------------------------------------------------------------
858 -- ----------------------------------------------------------------------------
859 -- |-----------------------< enable_location_legal_adr >-----------------------|
860 -- ----------------------------------------------------------------------------
861 -- {Start Of Comments}
862 --
863 -- Description:
864 -- This API enables the location identified by p_location_id as a legal
865 -- address.The legal address flag will be updated to 'Y' for this location.
866 --
867 -- A location that has been flagged as a legal address can be used as the legal
868 -- address for a legal entity. This functionality is used by the new financials
869 -- legal entity model which will be available in a future release of the
870 -- eBusiness Suite.
871 --
872 -- Prerequisites:
873 --
874 -- None.
875 --
876 -- In Parameters:
877 -- Name Reqd Type Description
878 --
879 -- p_validate No Boolean If true, the database
880 -- remains unchanged. If false
881 -- then the location will be
882 -- created on the database.
883 -- p_effective_date Yes Date Used for date_track
884 -- validation.
885 -- p_location_id Yes Number Primary Key
886 -- p_object_version_number Yes Number Object Version Number
887 --
888 -- Post Success:
889 -- When the location has been successfully enabled as a legal address loaction,
890 -- the following OUT parameters are set:
891 --
892 -- Name Type Description
893 --
894 -- p_object_version_number Number If p_validate is false, this
895 -- contains the new Object
896 -- Version Number assigned to
897 -- the row (otherwise it is
898 -- left unchanged).
899 -- Post Failure:
900 -- The API does not enable the location as legal address location, and
901 -- raises an error
902 --
903 -- Access Status:
904 -- Internal Development Use Only.
905 --
906 --
907 -- Special Notes:
908 -- N/A
909 --
910 -- {End Of Comments}
911 --
912 PROCEDURE enable_location_legal_adr
913 ( p_validate IN BOOLEAN DEFAULT false
914 ,p_effective_date IN DATE
915 ,p_location_id IN NUMBER
916 ,p_object_version_number IN OUT NOCOPY NUMBER
917 );
918 --
919
920 --------------------------------------------------------------------------------
921 -- ----------------------------------------------------------------------------
922 -- |-----------------------< disable_location_legal_adr >-----------------------|
923 -- ----------------------------------------------------------------------------
924 -- {Start Of Comments}
925 --
926 -- Description:
927 -- This API disables the location identified by p_location_id as a legal
928 -- address.The legal address flag will be updated to NULL for this location.
929 --
930 -- A location that has been flagged as a legal address can be used as the legal
931 -- address for a legal entity. This functionality is used by the new financials
932 -- legal entity model which will be available in a future release of the
933 -- eBusiness Suite.
934 --
935 -- Prerequisites:
936 --
937 -- None.
938 --
939 -- In Parameters:
940 -- Name Reqd Type Description
941 --
942 -- p_validate No Boolean If true, the database
943 -- remains unchanged. If false
944 -- then the location will be
945 -- created on the database.
946 -- p_effective_date Yes Date Used for date_track
947 -- validation.
948 -- p_location_id Yes Number Primary Key
949 -- p_object_version_number Yes Number Object Version Number
950 --
951 -- Post Success:
952 -- When the location has been successfully enabled as a legal address loaction,
953 -- the following OUT parameters are set:
954 --
955 -- Name Type Description
956 --
957 -- p_object_version_number Number If p_validate is false, this
958 -- contains the new Object
959 -- Version Number assigned to
960 -- the row (otherwise it is
961 -- left unchanged).
962 -- Post Failure:
963 -- The API does not disable the legal address location, and raises an error
964 --
965 -- Access Status:
966 -- Internal Development Use Only.
967 --
968 --
969 -- Special Notes:
970 -- N/A
971 --
972 -- {End Of Comments}
973 --
974 PROCEDURE disable_location_legal_adr
975 ( p_validate IN BOOLEAN DEFAULT false
976 ,p_effective_date IN DATE
977 ,p_location_id IN NUMBER
978 ,p_object_version_number IN OUT NOCOPY NUMBER
979 );
980 --
981
982 END hr_location_api;
983 --
[Home] [Help]