[Home] [Help]
PACKAGE: APPS.HR_DE_ORGANIZATION_LINKS_API
Source
1 Package hr_de_organization_links_api as
2 /* $Header: hrordapi.pkh 120.1 2005/10/02 02:04:52 aroussel $ */
3 /*#
4 * This package contains APIs to maintain organization links for Germany.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Organization Link for Germany
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-------------------------------< create_link >----------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates an organization link for Germany.
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 two organizations to be linked must exist.
24 *
25 * <p><b>Post Success</b><br>
26 * The organization link is successfully created in the database.
27 *
28 * <p><b>Post Failure</b><br>
29 * The API does not create the organization link and raises an error.
30 * @param p_validate If true, then validation alone will be performed and the
31 * database will remain unchanged. If false and all validation checks pass,
32 * then the database will be modified.
33 * @param p_effective_date Reference date for validating lookup values are
34 * applicable during the start to end active date range. This date does not
35 * determine when the changes take effect.
36 * @param p_parent_organization_id Parent organization.
37 * @param p_child_organization_id Child organization.
38 * @param p_org_link_type Type of organization link. Valid values exist in the
39 * 'DE_LINK_TYPE' lookup type.
40 * @param p_org_link_information_categor This context value determines which
41 * flexfield structure to use with the descriptive flexfield segments.
42 * @param p_org_link_information1 Developer descriptive flexfield segment.
43 * @param p_org_link_information2 Developer descriptive flexfield segment.
44 * @param p_org_link_information3 Developer descriptive flexfield segment.
45 * @param p_org_link_information4 Developer descriptive flexfield segment.
46 * @param p_org_link_information5 Developer descriptive flexfield segment.
47 * @param p_org_link_information6 Developer descriptive flexfield segment.
48 * @param p_org_link_information7 Developer descriptive flexfield segment.
49 * @param p_org_link_information8 Developer descriptive flexfield segment.
50 * @param p_org_link_information9 Developer descriptive flexfield segment.
51 * @param p_org_link_information10 Developer descriptive flexfield segment.
52 * @param p_org_link_information11 Developer descriptive flexfield segment.
53 * @param p_org_link_information12 Developer descriptive flexfield segment.
54 * @param p_org_link_information13 Developer descriptive flexfield segment.
55 * @param p_org_link_information14 Developer descriptive flexfield segment.
56 * @param p_org_link_information15 Developer descriptive flexfield segment.
57 * @param p_org_link_information16 Developer descriptive flexfield segment.
58 * @param p_org_link_information17 Developer descriptive flexfield segment.
59 * @param p_org_link_information18 Developer descriptive flexfield segment.
60 * @param p_org_link_information19 Developer descriptive flexfield segment.
61 * @param p_org_link_information20 Developer descriptive flexfield segment.
62 * @param p_org_link_information21 Developer descriptive flexfield segment.
63 * @param p_org_link_information22 Developer descriptive flexfield segment.
64 * @param p_org_link_information23 Developer descriptive flexfield segment.
65 * @param p_org_link_information24 Developer descriptive flexfield segment.
66 * @param p_org_link_information25 Developer descriptive flexfield segment.
67 * @param p_org_link_information26 Developer descriptive flexfield segment.
68 * @param p_org_link_information27 Developer descriptive flexfield segment.
69 * @param p_org_link_information28 Developer descriptive flexfield segment.
70 * @param p_org_link_information29 Developer descriptive flexfield segment.
71 * @param p_org_link_information30 Developer descriptive flexfield segment.
72 * @param p_attribute_category This context value determines which flexfield
73 * structure to use with the descriptive flexfield segments.
74 * @param p_attribute1 Descriptive flexfield segment.
75 * @param p_attribute2 Descriptive flexfield segment.
76 * @param p_attribute3 Descriptive flexfield segment.
77 * @param p_attribute4 Descriptive flexfield segment.
78 * @param p_attribute5 Descriptive flexfield segment.
79 * @param p_attribute6 Descriptive flexfield segment.
80 * @param p_attribute7 Descriptive flexfield segment.
81 * @param p_attribute8 Descriptive flexfield segment.
82 * @param p_attribute9 Descriptive flexfield segment.
83 * @param p_attribute10 Descriptive flexfield segment.
84 * @param p_attribute11 Descriptive flexfield segment.
85 * @param p_attribute12 Descriptive flexfield segment.
86 * @param p_attribute13 Descriptive flexfield segment.
87 * @param p_attribute14 Descriptive flexfield segment.
88 * @param p_attribute15 Descriptive flexfield segment.
89 * @param p_attribute16 Descriptive flexfield segment.
90 * @param p_attribute17 Descriptive flexfield segment.
91 * @param p_attribute18 Descriptive flexfield segment.
92 * @param p_attribute19 Descriptive flexfield segment.
93 * @param p_attribute20 Descriptive flexfield segment.
94 * @param p_attribute21 Descriptive flexfield segment.
95 * @param p_attribute22 Descriptive flexfield segment.
96 * @param p_attribute23 Descriptive flexfield segment.
97 * @param p_attribute24 Descriptive flexfield segment.
98 * @param p_attribute25 Descriptive flexfield segment.
99 * @param p_attribute26 Descriptive flexfield segment.
100 * @param p_attribute27 Descriptive flexfield segment.
101 * @param p_attribute28 Descriptive flexfield segment.
102 * @param p_attribute29 Descriptive flexfield segment.
103 * @param p_attribute30 Descriptive flexfield segment.
104 * @param p_organization_link_id If p_validate is false, then set to the
105 * identifier of the organization link. If p_validate is true, then set to
106 * nulll.
107 * @param p_object_version_number If p_validate is false, then set to the
108 * version number of the created organization link. If p_validate is true, then
109 * the value will be null.
110 * @rep:displayname Create Organization Link for Germany
111 * @rep:category BUSINESS_ENTITY HR_ORGANIZATION_LINK
112 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
113 * @rep:scope public
114 * @rep:lifecycle active
115 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
116 */
117 --
118 -- {End Of Comments}
119 --
120 procedure create_link
121 (p_validate in boolean default false
122 ,p_effective_date in date
123 ,p_parent_organization_id in number
124 ,p_child_organization_id in number
125 ,p_org_link_type in varchar2
126 ,p_org_link_information_categor in varchar2 default null
127 ,p_org_link_information1 in varchar2 default null
128 ,p_org_link_information2 in varchar2 default null
129 ,p_org_link_information3 in varchar2 default null
130 ,p_org_link_information4 in varchar2 default null
131 ,p_org_link_information5 in varchar2 default null
132 ,p_org_link_information6 in varchar2 default null
133 ,p_org_link_information7 in varchar2 default null
134 ,p_org_link_information8 in varchar2 default null
135 ,p_org_link_information9 in varchar2 default null
136 ,p_org_link_information10 in varchar2 default null
137 ,p_org_link_information11 in varchar2 default null
138 ,p_org_link_information12 in varchar2 default null
139 ,p_org_link_information13 in varchar2 default null
140 ,p_org_link_information14 in varchar2 default null
141 ,p_org_link_information15 in varchar2 default null
142 ,p_org_link_information16 in varchar2 default null
143 ,p_org_link_information17 in varchar2 default null
144 ,p_org_link_information18 in varchar2 default null
145 ,p_org_link_information19 in varchar2 default null
146 ,p_org_link_information20 in varchar2 default null
147 ,p_org_link_information21 in varchar2 default null
148 ,p_org_link_information22 in varchar2 default null
149 ,p_org_link_information23 in varchar2 default null
150 ,p_org_link_information24 in varchar2 default null
151 ,p_org_link_information25 in varchar2 default null
152 ,p_org_link_information26 in varchar2 default null
153 ,p_org_link_information27 in varchar2 default null
154 ,p_org_link_information28 in varchar2 default null
155 ,p_org_link_information29 in varchar2 default null
156 ,p_org_link_information30 in varchar2 default null
157 ,p_attribute_category in varchar2 default null
158 ,p_attribute1 in varchar2 default null
159 ,p_attribute2 in varchar2 default null
160 ,p_attribute3 in varchar2 default null
161 ,p_attribute4 in varchar2 default null
162 ,p_attribute5 in varchar2 default null
163 ,p_attribute6 in varchar2 default null
164 ,p_attribute7 in varchar2 default null
165 ,p_attribute8 in varchar2 default null
166 ,p_attribute9 in varchar2 default null
167 ,p_attribute10 in varchar2 default null
168 ,p_attribute11 in varchar2 default null
169 ,p_attribute12 in varchar2 default null
170 ,p_attribute13 in varchar2 default null
171 ,p_attribute14 in varchar2 default null
172 ,p_attribute15 in varchar2 default null
173 ,p_attribute16 in varchar2 default null
174 ,p_attribute17 in varchar2 default null
175 ,p_attribute18 in varchar2 default null
176 ,p_attribute19 in varchar2 default null
177 ,p_attribute20 in varchar2 default null
178 ,p_attribute21 in varchar2 default null
179 ,p_attribute22 in varchar2 default null
180 ,p_attribute23 in varchar2 default null
181 ,p_attribute24 in varchar2 default null
182 ,p_attribute25 in varchar2 default null
183 ,p_attribute26 in varchar2 default null
184 ,p_attribute27 in varchar2 default null
185 ,p_attribute28 in varchar2 default null
186 ,p_attribute29 in varchar2 default null
187 ,p_attribute30 in varchar2 default null
188 ,p_organization_link_id out nocopy number
189 ,p_object_version_number out nocopy number
190 );
191 --
192 -- ----------------------------------------------------------------------------
193 -- |-------------------------------< update_link >----------------------------|
194 -- ----------------------------------------------------------------------------
195 --
196 -- {Start Of Comments}
197 /*#
198 * This API updates an organization link for Germany.
199 *
200 *
201 * <p><b>Licensing</b><br>
202 * This API is licensed for use with Human Resources.
203 *
204 * <p><b>Prerequisites</b><br>
205 * The organization link record must exist.
206 *
207 * <p><b>Post Success</b><br>
208 * The organization link is successfully updated in the database.
209 *
210 * <p><b>Post Failure</b><br>
211 * The API does not update the organization link and raises an error.
212 * @param p_validate If true, then validation alone will be performed and the
213 * database will remain unchanged. If false and all validation checks pass,
214 * then the database will be modified.
215 * @param p_effective_date Reference date for validating lookup values are
216 * applicable during the start to end active date range. This date does not
217 * determine when the changes take effect.
218 * @param p_organization_link_id Identifier of the organization link record to
219 * be updated.
220 * @param p_org_link_information_categor This context value determines which
221 * flexfield structure to use with the descriptive flexfield segments.
222 * @param p_org_link_information1 Developer descriptive flexfield segment.
223 * @param p_org_link_information2 Developer descriptive flexfield segment.
224 * @param p_org_link_information3 Developer descriptive flexfield segment.
225 * @param p_org_link_information4 Developer descriptive flexfield segment.
226 * @param p_org_link_information5 Developer descriptive flexfield segment.
227 * @param p_org_link_information6 Developer descriptive flexfield segment.
228 * @param p_org_link_information7 Developer descriptive flexfield segment.
229 * @param p_org_link_information8 Developer descriptive flexfield segment.
230 * @param p_org_link_information9 Developer descriptive flexfield segment.
231 * @param p_org_link_information10 Developer descriptive flexfield segment.
232 * @param p_org_link_information11 Developer descriptive flexfield segment.
233 * @param p_org_link_information12 Developer descriptive flexfield segment.
234 * @param p_org_link_information13 Developer descriptive flexfield segment.
235 * @param p_org_link_information14 Developer descriptive flexfield segment.
236 * @param p_org_link_information15 Developer descriptive flexfield segment.
237 * @param p_org_link_information16 Developer descriptive flexfield segment.
238 * @param p_org_link_information17 Developer descriptive flexfield segment.
239 * @param p_org_link_information18 Developer descriptive flexfield segment.
240 * @param p_org_link_information19 Developer descriptive flexfield segment.
241 * @param p_org_link_information20 Developer descriptive flexfield segment.
242 * @param p_org_link_information21 Developer descriptive flexfield segment.
243 * @param p_org_link_information22 Developer descriptive flexfield segment.
244 * @param p_org_link_information23 Developer descriptive flexfield segment.
245 * @param p_org_link_information24 Developer descriptive flexfield segment.
246 * @param p_org_link_information25 Developer descriptive flexfield segment.
247 * @param p_org_link_information26 Developer descriptive flexfield segment.
248 * @param p_org_link_information27 Developer descriptive flexfield segment.
249 * @param p_org_link_information28 Developer descriptive flexfield segment.
250 * @param p_org_link_information29 Developer descriptive flexfield segment.
251 * @param p_org_link_information30 Developer descriptive flexfield segment.
252 * @param p_attribute_category This context value determines which flexfield
253 * structure to use with the descriptive flexfield segments.
254 * @param p_attribute1 Descriptive flexfield segment.
255 * @param p_attribute2 Descriptive flexfield segment.
256 * @param p_attribute3 Descriptive flexfield segment.
257 * @param p_attribute4 Descriptive flexfield segment.
258 * @param p_attribute5 Descriptive flexfield segment.
259 * @param p_attribute6 Descriptive flexfield segment.
260 * @param p_attribute7 Descriptive flexfield segment.
261 * @param p_attribute8 Descriptive flexfield segment.
262 * @param p_attribute9 Descriptive flexfield segment.
263 * @param p_attribute10 Descriptive flexfield segment.
264 * @param p_attribute11 Descriptive flexfield segment.
265 * @param p_attribute12 Descriptive flexfield segment.
266 * @param p_attribute13 Descriptive flexfield segment.
267 * @param p_attribute14 Descriptive flexfield segment.
268 * @param p_attribute15 Descriptive flexfield segment.
269 * @param p_attribute16 Descriptive flexfield segment.
270 * @param p_attribute17 Descriptive flexfield segment.
271 * @param p_attribute18 Descriptive flexfield segment.
272 * @param p_attribute19 Descriptive flexfield segment.
273 * @param p_attribute20 Descriptive flexfield segment.
274 * @param p_attribute21 Descriptive flexfield segment.
275 * @param p_attribute22 Descriptive flexfield segment.
276 * @param p_attribute23 Descriptive flexfield segment.
277 * @param p_attribute24 Descriptive flexfield segment.
278 * @param p_attribute25 Descriptive flexfield segment.
279 * @param p_attribute26 Descriptive flexfield segment.
280 * @param p_attribute27 Descriptive flexfield segment.
281 * @param p_attribute28 Descriptive flexfield segment.
282 * @param p_attribute29 Descriptive flexfield segment.
283 * @param p_attribute30 Descriptive flexfield segment.
284 * @param p_object_version_number If p_validate is false, then set to the
285 * version number of the updated link. If p_validate is true, then the value
286 * will be null.
287 * @rep:displayname Update Organization Link for Germany
288 * @rep:category BUSINESS_ENTITY HR_ORGANIZATION_LINK
289 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
290 * @rep:scope public
291 * @rep:lifecycle active
292 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
293 */
294 --
295 -- {End Of Comments}
296 --
297 procedure update_link
298 (p_validate in boolean default false
299 ,p_effective_date in date
300 ,p_organization_link_id in number
301 ,p_org_link_information_categor in varchar2 default hr_api.g_varchar2
302 ,p_org_link_information1 in varchar2 default hr_api.g_varchar2
303 ,p_org_link_information2 in varchar2 default hr_api.g_varchar2
304 ,p_org_link_information3 in varchar2 default hr_api.g_varchar2
305 ,p_org_link_information4 in varchar2 default hr_api.g_varchar2
306 ,p_org_link_information5 in varchar2 default hr_api.g_varchar2
307 ,p_org_link_information6 in varchar2 default hr_api.g_varchar2
308 ,p_org_link_information7 in varchar2 default hr_api.g_varchar2
309 ,p_org_link_information8 in varchar2 default hr_api.g_varchar2
310 ,p_org_link_information9 in varchar2 default hr_api.g_varchar2
311 ,p_org_link_information10 in varchar2 default hr_api.g_varchar2
312 ,p_org_link_information11 in varchar2 default hr_api.g_varchar2
313 ,p_org_link_information12 in varchar2 default hr_api.g_varchar2
314 ,p_org_link_information13 in varchar2 default hr_api.g_varchar2
315 ,p_org_link_information14 in varchar2 default hr_api.g_varchar2
316 ,p_org_link_information15 in varchar2 default hr_api.g_varchar2
317 ,p_org_link_information16 in varchar2 default hr_api.g_varchar2
318 ,p_org_link_information17 in varchar2 default hr_api.g_varchar2
319 ,p_org_link_information18 in varchar2 default hr_api.g_varchar2
320 ,p_org_link_information19 in varchar2 default hr_api.g_varchar2
321 ,p_org_link_information20 in varchar2 default hr_api.g_varchar2
322 ,p_org_link_information21 in varchar2 default hr_api.g_varchar2
323 ,p_org_link_information22 in varchar2 default hr_api.g_varchar2
324 ,p_org_link_information23 in varchar2 default hr_api.g_varchar2
325 ,p_org_link_information24 in varchar2 default hr_api.g_varchar2
326 ,p_org_link_information25 in varchar2 default hr_api.g_varchar2
327 ,p_org_link_information26 in varchar2 default hr_api.g_varchar2
328 ,p_org_link_information27 in varchar2 default hr_api.g_varchar2
329 ,p_org_link_information28 in varchar2 default hr_api.g_varchar2
330 ,p_org_link_information29 in varchar2 default hr_api.g_varchar2
331 ,p_org_link_information30 in varchar2 default hr_api.g_varchar2
332 ,p_attribute_category in varchar2 default hr_api.g_varchar2
333 ,p_attribute1 in varchar2 default hr_api.g_varchar2
334 ,p_attribute2 in varchar2 default hr_api.g_varchar2
335 ,p_attribute3 in varchar2 default hr_api.g_varchar2
336 ,p_attribute4 in varchar2 default hr_api.g_varchar2
337 ,p_attribute5 in varchar2 default hr_api.g_varchar2
338 ,p_attribute6 in varchar2 default hr_api.g_varchar2
339 ,p_attribute7 in varchar2 default hr_api.g_varchar2
340 ,p_attribute8 in varchar2 default hr_api.g_varchar2
341 ,p_attribute9 in varchar2 default hr_api.g_varchar2
342 ,p_attribute10 in varchar2 default hr_api.g_varchar2
343 ,p_attribute11 in varchar2 default hr_api.g_varchar2
344 ,p_attribute12 in varchar2 default hr_api.g_varchar2
345 ,p_attribute13 in varchar2 default hr_api.g_varchar2
346 ,p_attribute14 in varchar2 default hr_api.g_varchar2
347 ,p_attribute15 in varchar2 default hr_api.g_varchar2
348 ,p_attribute16 in varchar2 default hr_api.g_varchar2
349 ,p_attribute17 in varchar2 default hr_api.g_varchar2
350 ,p_attribute18 in varchar2 default hr_api.g_varchar2
351 ,p_attribute19 in varchar2 default hr_api.g_varchar2
352 ,p_attribute20 in varchar2 default hr_api.g_varchar2
353 ,p_attribute21 in varchar2 default hr_api.g_varchar2
354 ,p_attribute22 in varchar2 default hr_api.g_varchar2
355 ,p_attribute23 in varchar2 default hr_api.g_varchar2
356 ,p_attribute24 in varchar2 default hr_api.g_varchar2
357 ,p_attribute25 in varchar2 default hr_api.g_varchar2
358 ,p_attribute26 in varchar2 default hr_api.g_varchar2
359 ,p_attribute27 in varchar2 default hr_api.g_varchar2
360 ,p_attribute28 in varchar2 default hr_api.g_varchar2
361 ,p_attribute29 in varchar2 default hr_api.g_varchar2
362 ,p_attribute30 in varchar2 default hr_api.g_varchar2
363 ,p_object_version_number in out nocopy number
364 );
365 --
366 -- ----------------------------------------------------------------------------
367 -- |-------------------------------< delete_link >----------------------------|
368 -- ----------------------------------------------------------------------------
369 --
370 -- {Start Of Comments}
371 /*#
372 * This API deletes an existing organization link for Germany.
373 *
374 *
375 * <p><b>Licensing</b><br>
376 * This API is licensed for use with Human Resources.
377 *
378 * <p><b>Prerequisites</b><br>
379 * The organization link record must exist.
380 *
381 * <p><b>Post Success</b><br>
382 * The organization link record is successfully deleted from the database.
383 *
384 * <p><b>Post Failure</b><br>
385 * The API does not delete the organization link and raises an error.
386 * @param p_validate If true, then validation alone will be performed and the
387 * database will remain unchanged. If false and all validation checks pass,
388 * then the database will be modified.
389 * @param p_organization_link_id Unique identifier of the link record.
390 * @param p_object_version_number Current version number of the link to be
391 * deleted.
392 * @rep:displayname Delete Organization Link for Germany
393 * @rep:category BUSINESS_ENTITY HR_ORGANIZATION_LINK
394 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
395 * @rep:scope public
396 * @rep:lifecycle active
397 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
398 */
399 --
400 -- {End Of Comments}
401 --
402 procedure delete_link
403 (p_validate in boolean default false
404 ,p_organization_link_id in number
405 ,p_object_version_number in number
406 );
407 --
408 -- ----------------------------------------------------------------------------
409 -- |-----------------------------------< lck >--------------------------------|
410 -- ----------------------------------------------------------------------------
411 -- {Start Of Comments}
412 --
413 -- Description:
414 --
415 -- This API locks an existing organization link.
416 --
417 -- Prerequisites:
418 --
419 -- The organization link record must exist.
420 --
421 -- In Parameters:
422 --
423 -- Name Reqd Type Description
424 -- p_organization_link_id Yes number PK of the record.
425 -- p_object_version_number Yes number OVN of the record.
426 --
427 -- Post Success:
428 --
429 -- When the organization link has been sucessfully locked, the
430 -- following out parameters are set:
431 --
432 -- Name Type Description
433 --
434 -- Post Failure:
435 --
436 -- The API does not lock the organization link and raises an error.
437 --
438 -- Access Status:
439 --
440 -- Public.
441 --
442 -- {End Of Comments}
443 --
444 procedure lck
445 (p_organization_link_id in number
446 ,p_object_version_number in number
447 );
448 --
449 end hr_de_organization_links_api;