[Home] [Help]
PACKAGE: APPS.HR_LOCATION_EXTRA_INFO_API
Source
1 Package hr_location_extra_info_api as
2 /* $Header: hrleiapi.pkh 120.1 2005/10/02 02:03:25 aroussel $ */
3 /*#
4 * This package contains APIs to maintain location extra information records.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Location Extra Information
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |------------------------< create_location_extra_info >--------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a location extra information record.
17 *
18 *
19 * <p><b>Licensing</b><br>
20 * This API is licensed for use with Human Resources.
21 *
22 * <p><b>Prerequisites</b><br>
23 * The location must exist. The location extra information type must exist.
24 *
25 * <p><b>Post Success</b><br>
26 * The location extra information is created.
27 *
28 * <p><b>Post Failure</b><br>
29 * The API does not create the location extra information record and raises an
30 * error.
31 * @param p_validate If true, then validation alone will be performed and the
32 * database will remain unchanged. If false and all validation checks pass,
33 * then the database will be modified.
34 * @param p_location_id Uniquely identifies the location with which to
35 * associate the extra information record.
36 * @param p_information_type Location extra information type.
37 * @param p_lei_attribute_category This context value determines which
38 * Flexfield Structure to use with the Descriptive flexfield segments.
39 * @param p_lei_attribute1 Descriptive flexfield segment.
40 * @param p_lei_attribute2 Descriptive flexfield segment.
41 * @param p_lei_attribute3 Descriptive flexfield segment.
42 * @param p_lei_attribute4 Descriptive flexfield segment.
43 * @param p_lei_attribute5 Descriptive flexfield segment.
44 * @param p_lei_attribute6 Descriptive flexfield segment.
45 * @param p_lei_attribute7 Descriptive flexfield segment.
46 * @param p_lei_attribute8 Descriptive flexfield segment.
47 * @param p_lei_attribute9 Descriptive flexfield segment.
48 * @param p_lei_attribute10 Descriptive flexfield segment.
49 * @param p_lei_attribute11 Descriptive flexfield segment.
50 * @param p_lei_attribute12 Descriptive flexfield segment.
51 * @param p_lei_attribute13 Descriptive flexfield segment.
52 * @param p_lei_attribute14 Descriptive flexfield segment.
53 * @param p_lei_attribute15 Descriptive flexfield segment.
54 * @param p_lei_attribute16 Descriptive flexfield segment.
55 * @param p_lei_attribute17 Descriptive flexfield segment.
56 * @param p_lei_attribute18 Descriptive flexfield segment.
57 * @param p_lei_attribute19 Descriptive flexfield segment.
58 * @param p_lei_attribute20 Descriptive flexfield segment.
59 * @param p_lei_information_category This context value determines which
60 * Flexfield Structure to use with the Developer Descriptive flexfield
61 * segments.
62 * @param p_lei_information1 Developer descriptive flexfield segment.
63 * @param p_lei_information2 Developer descriptive flexfield segment.
64 * @param p_lei_information3 Developer descriptive flexfield segment.
65 * @param p_lei_information4 Developer descriptive flexfield segment.
66 * @param p_lei_information5 Developer descriptive flexfield segment.
67 * @param p_lei_information6 Developer descriptive flexfield segment.
68 * @param p_lei_information7 Developer descriptive flexfield segment.
69 * @param p_lei_information8 Developer descriptive flexfield segment.
70 * @param p_lei_information9 Developer descriptive flexfield segment.
71 * @param p_lei_information10 Developer descriptive flexfield segment.
72 * @param p_lei_information11 Developer descriptive flexfield segment.
73 * @param p_lei_information12 Developer descriptive flexfield segment.
74 * @param p_lei_information13 Developer descriptive flexfield segment.
75 * @param p_lei_information14 Developer descriptive flexfield segment.
76 * @param p_lei_information15 Developer descriptive flexfield segment.
77 * @param p_lei_information16 Developer descriptive flexfield segment.
78 * @param p_lei_information17 Developer descriptive flexfield segment.
79 * @param p_lei_information18 Developer descriptive flexfield segment.
80 * @param p_lei_information19 Developer descriptive flexfield segment.
81 * @param p_lei_information20 Developer descriptive flexfield segment.
82 * @param p_lei_information21 Developer descriptive flexfield segment.
83 * @param p_lei_information22 Developer descriptive flexfield segment.
84 * @param p_lei_information23 Developer descriptive flexfield segment.
85 * @param p_lei_information24 Developer descriptive flexfield segment.
86 * @param p_lei_information25 Developer descriptive flexfield segment.
87 * @param p_lei_information26 Developer descriptive flexfield segment.
88 * @param p_lei_information27 Developer descriptive flexfield segment.
89 * @param p_lei_information28 Developer descriptive flexfield segment.
90 * @param p_lei_information29 Developer descriptive flexfield segment.
91 * @param p_lei_information30 Developer descriptive flexfield segment.
92 * @param p_location_extra_info_id If p_validate is false, uniquely identifies
93 * the location extra information record created. If p_validate is true, set to
94 * null.
95 * @param p_object_version_number If p_validate is false, then set to the
96 * version number of the created location extra information record. If
97 * p_validate is true, then the value will be null.
98 * @rep:displayname Create Location Extra Information
99 * @rep:category BUSINESS_ENTITY HR_LOCATION
100 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
101 * @rep:scope public
102 * @rep:lifecycle active
103 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
104 */
105 --
106 -- {End Of Comments}
107 --
108 procedure create_location_extra_info
109 (p_validate in boolean default false
110 ,p_location_id in number
111 ,p_information_type in varchar2
112 ,p_lei_attribute_category in varchar2 default null
113 ,p_lei_attribute1 in varchar2 default null
114 ,p_lei_attribute2 in varchar2 default null
115 ,p_lei_attribute3 in varchar2 default null
116 ,p_lei_attribute4 in varchar2 default null
117 ,p_lei_attribute5 in varchar2 default null
118 ,p_lei_attribute6 in varchar2 default null
119 ,p_lei_attribute7 in varchar2 default null
120 ,p_lei_attribute8 in varchar2 default null
121 ,p_lei_attribute9 in varchar2 default null
122 ,p_lei_attribute10 in varchar2 default null
123 ,p_lei_attribute11 in varchar2 default null
124 ,p_lei_attribute12 in varchar2 default null
125 ,p_lei_attribute13 in varchar2 default null
126 ,p_lei_attribute14 in varchar2 default null
127 ,p_lei_attribute15 in varchar2 default null
128 ,p_lei_attribute16 in varchar2 default null
129 ,p_lei_attribute17 in varchar2 default null
130 ,p_lei_attribute18 in varchar2 default null
131 ,p_lei_attribute19 in varchar2 default null
132 ,p_lei_attribute20 in varchar2 default null
133 ,p_lei_information_category in varchar2 default null
134 ,p_lei_information1 in varchar2 default null
135 ,p_lei_information2 in varchar2 default null
136 ,p_lei_information3 in varchar2 default null
137 ,p_lei_information4 in varchar2 default null
138 ,p_lei_information5 in varchar2 default null
139 ,p_lei_information6 in varchar2 default null
140 ,p_lei_information7 in varchar2 default null
141 ,p_lei_information8 in varchar2 default null
142 ,p_lei_information9 in varchar2 default null
143 ,p_lei_information10 in varchar2 default null
144 ,p_lei_information11 in varchar2 default null
145 ,p_lei_information12 in varchar2 default null
146 ,p_lei_information13 in varchar2 default null
147 ,p_lei_information14 in varchar2 default null
148 ,p_lei_information15 in varchar2 default null
149 ,p_lei_information16 in varchar2 default null
150 ,p_lei_information17 in varchar2 default null
151 ,p_lei_information18 in varchar2 default null
152 ,p_lei_information19 in varchar2 default null
153 ,p_lei_information20 in varchar2 default null
154 ,p_lei_information21 in varchar2 default null
155 ,p_lei_information22 in varchar2 default null
156 ,p_lei_information23 in varchar2 default null
157 ,p_lei_information24 in varchar2 default null
158 ,p_lei_information25 in varchar2 default null
159 ,p_lei_information26 in varchar2 default null
160 ,p_lei_information27 in varchar2 default null
161 ,p_lei_information28 in varchar2 default null
162 ,p_lei_information29 in varchar2 default null
163 ,p_lei_information30 in varchar2 default null
164 ,p_location_extra_info_id out nocopy number
165 ,p_object_version_number out nocopy number
166 );
167 --
168 -- ----------------------------------------------------------------------------
169 -- |------------------------< update_location_extra_info >--------------------|
170 -- ----------------------------------------------------------------------------
171 --
172 -- {Start Of Comments}
173 /*#
174 * This API updates location extra information associated with a location.
175 *
176 *
177 * <p><b>Licensing</b><br>
178 * This API is licensed for use with Human Resources.
179 *
180 * <p><b>Prerequisites</b><br>
181 * The location extra information record must exist.
182 *
183 * <p><b>Post Success</b><br>
184 * The location extra information record is updated.
185 *
186 * <p><b>Post Failure</b><br>
187 * The API does not update the location extra information record and raises an
188 * error.
189 * @param p_validate If true, then validation alone will be performed and the
190 * database will remain unchanged. If false and all validation checks pass,
191 * then the database will be modified.
192 * @param p_location_extra_info_id Identifies the location extra information
193 * record to update.
194 * @param p_object_version_number Pass in the current version number of the
195 * location extra information record to be updated. When the API completes if
196 * p_validate is false, will be set to the new version number of the updated
197 * location extra information record. If p_validate is true will be set to the
198 * same value which was passed in.
199 * @param p_lei_attribute_category This context value determines which
200 * Flexfield Structure to use with the Descriptive flexfield segments.
201 * @param p_lei_attribute1 Descriptive flexfield segment.
202 * @param p_lei_attribute2 Descriptive flexfield segment.
203 * @param p_lei_attribute3 Descriptive flexfield segment.
204 * @param p_lei_attribute4 Descriptive flexfield segment.
205 * @param p_lei_attribute5 Descriptive flexfield segment.
206 * @param p_lei_attribute6 Descriptive flexfield segment.
207 * @param p_lei_attribute7 Descriptive flexfield segment.
208 * @param p_lei_attribute8 Descriptive flexfield segment.
209 * @param p_lei_attribute9 Descriptive flexfield segment.
210 * @param p_lei_attribute10 Descriptive flexfield segment.
211 * @param p_lei_attribute11 Descriptive flexfield segment.
212 * @param p_lei_attribute12 Descriptive flexfield segment.
213 * @param p_lei_attribute13 Descriptive flexfield segment.
214 * @param p_lei_attribute14 Descriptive flexfield segment.
215 * @param p_lei_attribute15 Descriptive flexfield segment.
216 * @param p_lei_attribute16 Descriptive flexfield segment.
217 * @param p_lei_attribute17 Descriptive flexfield segment.
218 * @param p_lei_attribute18 Descriptive flexfield segment.
219 * @param p_lei_attribute19 Descriptive flexfield segment.
220 * @param p_lei_attribute20 Descriptive flexfield segment.
221 * @param p_lei_information_category This context value determines which
222 * Flexfield Structure to use with the Developer Descriptive flexfield
223 * segments.
224 * @param p_lei_information1 Developer descriptive flexfield segment.
225 * @param p_lei_information2 Developer descriptive flexfield segment.
226 * @param p_lei_information3 Developer descriptive flexfield segment.
227 * @param p_lei_information4 Developer descriptive flexfield segment.
228 * @param p_lei_information5 Developer descriptive flexfield segment.
229 * @param p_lei_information6 Developer descriptive flexfield segment.
230 * @param p_lei_information7 Developer descriptive flexfield segment.
231 * @param p_lei_information8 Developer descriptive flexfield segment.
232 * @param p_lei_information9 Developer descriptive flexfield segment.
233 * @param p_lei_information10 Developer descriptive flexfield segment.
234 * @param p_lei_information11 Developer descriptive flexfield segment.
235 * @param p_lei_information12 Developer descriptive flexfield segment.
236 * @param p_lei_information13 Developer descriptive flexfield segment.
237 * @param p_lei_information14 Developer descriptive flexfield segment.
238 * @param p_lei_information15 Developer descriptive flexfield segment.
239 * @param p_lei_information16 Developer descriptive flexfield segment.
240 * @param p_lei_information17 Developer descriptive flexfield segment.
241 * @param p_lei_information18 Developer descriptive flexfield segment.
242 * @param p_lei_information19 Developer descriptive flexfield segment.
243 * @param p_lei_information20 Developer descriptive flexfield segment.
244 * @param p_lei_information21 Developer descriptive flexfield segment.
245 * @param p_lei_information22 Developer descriptive flexfield segment.
246 * @param p_lei_information23 Developer descriptive flexfield segment.
247 * @param p_lei_information24 Developer descriptive flexfield segment.
248 * @param p_lei_information25 Developer descriptive flexfield segment.
249 * @param p_lei_information26 Developer descriptive flexfield segment.
250 * @param p_lei_information27 Developer descriptive flexfield segment.
251 * @param p_lei_information28 Developer descriptive flexfield segment.
252 * @param p_lei_information29 Developer descriptive flexfield segment.
253 * @param p_lei_information30 Developer descriptive flexfield segment.
254 * @rep:displayname Update Location Extra Information
255 * @rep:category BUSINESS_ENTITY HR_LOCATION
256 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
257 * @rep:scope public
258 * @rep:lifecycle active
259 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
260 */
261 --
262 -- {End Of Comments}
263 --
264 procedure update_location_extra_info
265 (p_validate in boolean default false
266 ,p_location_extra_info_id in number
267 ,p_object_version_number in out nocopy number
268 ,p_lei_attribute_category in varchar2 default hr_api.g_varchar2
269 ,p_lei_attribute1 in varchar2 default hr_api.g_varchar2
270 ,p_lei_attribute2 in varchar2 default hr_api.g_varchar2
271 ,p_lei_attribute3 in varchar2 default hr_api.g_varchar2
272 ,p_lei_attribute4 in varchar2 default hr_api.g_varchar2
273 ,p_lei_attribute5 in varchar2 default hr_api.g_varchar2
274 ,p_lei_attribute6 in varchar2 default hr_api.g_varchar2
275 ,p_lei_attribute7 in varchar2 default hr_api.g_varchar2
276 ,p_lei_attribute8 in varchar2 default hr_api.g_varchar2
277 ,p_lei_attribute9 in varchar2 default hr_api.g_varchar2
278 ,p_lei_attribute10 in varchar2 default hr_api.g_varchar2
279 ,p_lei_attribute11 in varchar2 default hr_api.g_varchar2
280 ,p_lei_attribute12 in varchar2 default hr_api.g_varchar2
281 ,p_lei_attribute13 in varchar2 default hr_api.g_varchar2
282 ,p_lei_attribute14 in varchar2 default hr_api.g_varchar2
283 ,p_lei_attribute15 in varchar2 default hr_api.g_varchar2
284 ,p_lei_attribute16 in varchar2 default hr_api.g_varchar2
285 ,p_lei_attribute17 in varchar2 default hr_api.g_varchar2
286 ,p_lei_attribute18 in varchar2 default hr_api.g_varchar2
287 ,p_lei_attribute19 in varchar2 default hr_api.g_varchar2
288 ,p_lei_attribute20 in varchar2 default hr_api.g_varchar2
289 ,p_lei_information_category in varchar2 default hr_api.g_varchar2
293 ,p_lei_information4 in varchar2 default hr_api.g_varchar2
290 ,p_lei_information1 in varchar2 default hr_api.g_varchar2
291 ,p_lei_information2 in varchar2 default hr_api.g_varchar2
292 ,p_lei_information3 in varchar2 default hr_api.g_varchar2
294 ,p_lei_information5 in varchar2 default hr_api.g_varchar2
295 ,p_lei_information6 in varchar2 default hr_api.g_varchar2
296 ,p_lei_information7 in varchar2 default hr_api.g_varchar2
297 ,p_lei_information8 in varchar2 default hr_api.g_varchar2
298 ,p_lei_information9 in varchar2 default hr_api.g_varchar2
299 ,p_lei_information10 in varchar2 default hr_api.g_varchar2
300 ,p_lei_information11 in varchar2 default hr_api.g_varchar2
301 ,p_lei_information12 in varchar2 default hr_api.g_varchar2
302 ,p_lei_information13 in varchar2 default hr_api.g_varchar2
303 ,p_lei_information14 in varchar2 default hr_api.g_varchar2
304 ,p_lei_information15 in varchar2 default hr_api.g_varchar2
305 ,p_lei_information16 in varchar2 default hr_api.g_varchar2
306 ,p_lei_information17 in varchar2 default hr_api.g_varchar2
307 ,p_lei_information18 in varchar2 default hr_api.g_varchar2
308 ,p_lei_information19 in varchar2 default hr_api.g_varchar2
309 ,p_lei_information20 in varchar2 default hr_api.g_varchar2
310 ,p_lei_information21 in varchar2 default hr_api.g_varchar2
311 ,p_lei_information22 in varchar2 default hr_api.g_varchar2
312 ,p_lei_information23 in varchar2 default hr_api.g_varchar2
313 ,p_lei_information24 in varchar2 default hr_api.g_varchar2
314 ,p_lei_information25 in varchar2 default hr_api.g_varchar2
315 ,p_lei_information26 in varchar2 default hr_api.g_varchar2
316 ,p_lei_information27 in varchar2 default hr_api.g_varchar2
317 ,p_lei_information28 in varchar2 default hr_api.g_varchar2
318 ,p_lei_information29 in varchar2 default hr_api.g_varchar2
319 ,p_lei_information30 in varchar2 default hr_api.g_varchar2
320 );
321 --
322 -- ----------------------------------------------------------------------------
323 -- |------------------------< delete_location_extra_info >--------------------|
324 -- ----------------------------------------------------------------------------
325 --
326 -- {Start Of Comments}
327 /*#
328 * This API deletes a location extra information record.
329 *
330 *
331 * <p><b>Licensing</b><br>
332 * This API is licensed for use with Human Resources.
333 *
334 * <p><b>Prerequisites</b><br>
335 * The location extra information record must exist.
336 *
337 * <p><b>Post Success</b><br>
338 * The location extra information record is deleted.
339 *
340 * <p><b>Post Failure</b><br>
341 * The API does not delete the location extra information record, and raises an
342 * error.
343 * @param p_validate If true, then validation alone will be performed and the
344 * database will remain unchanged. If false and all validation checks pass,
345 * then the database will be modified.
346 * @param p_location_extra_info_id Identifies the location extra information
347 * record to delete.
348 * @param p_object_version_number Current version number of the location extra
349 * information record to be deleted.
350 * @rep:displayname Delete Location Extra Information
351 * @rep:category BUSINESS_ENTITY HR_LOCATION
352 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
353 * @rep:scope public
354 * @rep:lifecycle active
355 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
356 */
357 --
358 -- {End Of Comments}
359 --
360 procedure delete_location_extra_info
361 (p_validate in boolean default false
362 ,p_location_extra_info_id in number
363 ,p_object_version_number in number
364 );
365 --
366 end hr_location_extra_info_api;