DBA Data[Home] [Help]

PACKAGE: APPS.HR_POSITION_EXTRA_INFO_API

Source


1 Package hr_position_extra_info_api as
2 /* $Header: pepoiapi.pkh 120.1 2005/10/02 02:21:45 aroussel $ */
3 /*#
4  * This package contains APIs that create and maintain position extra
5  * information.
6  * @rep:scope public
7  * @rep:product per
8  * @rep:displayname Position Extra Information
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |------------------------< create_position_extra_info >--------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17  * This API creates extra information for a given position.
18  *
19  *
20  * <p><b>Licensing</b><br>
21  * This API is licensed for use with Human Resources.
22  *
23  * <p><b>Prerequisites</b><br>
24  * Position and position information type must already exist
25  *
26  * <p><b>Post Success</b><br>
27  * Position extra info is created.
28  *
29  * <p><b>Post Failure</b><br>
30  * The API does not create the position extra information and raises an 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_position_id Uniquely identifies the position to which the extra
35  * information applies.
36  * @param p_information_type Information type the extra info applies to
37  * @param p_poei_attribute_category This context value determines which
38  * flexfield structure to use with the poei_attribute descriptive flexfield
39  * segments.
40  * @param p_poei_attribute1 Descriptive flexfield
41  * @param p_poei_attribute2 Descriptive flexfield
42  * @param p_poei_attribute3 Descriptive flexfield
43  * @param p_poei_attribute4 Descriptive flexfield
44  * @param p_poei_attribute5 Descriptive flexfield
45  * @param p_poei_attribute6 Descriptive flexfield
46  * @param p_poei_attribute7 Descriptive flexfield
47  * @param p_poei_attribute8 Descriptive flexfield
48  * @param p_poei_attribute9 Descriptive flexfield
49  * @param p_poei_attribute10 Descriptive flexfield
50  * @param p_poei_attribute11 Descriptive flexfield
51  * @param p_poei_attribute12 Descriptive flexfield
52  * @param p_poei_attribute13 Descriptive flexfield
53  * @param p_poei_attribute14 Descriptive flexfield
54  * @param p_poei_attribute15 Descriptive flexfield
55  * @param p_poei_attribute16 Descriptive flexfield
56  * @param p_poei_attribute17 Descriptive flexfield
57  * @param p_poei_attribute18 Descriptive flexfield
58  * @param p_poei_attribute19 Descriptive flexfield
59  * @param p_poei_attribute20 Descriptive flexfield
60  * @param p_poei_information_category This context value determines which
61  * flexfield structure to use with the poei_information developer descriptive
62  * flexfield segments.
63  * @param p_poei_information1 Developer descriptive flexfield
64  * @param p_poei_information2 Developer descriptive flexfield
65  * @param p_poei_information3 Developer descriptive flexfield
66  * @param p_poei_information4 Developer descriptive flexfield
67  * @param p_poei_information5 Developer descriptive flexfield
68  * @param p_poei_information6 Developer descriptive flexfield
69  * @param p_poei_information7 Developer descriptive flexfield
70  * @param p_poei_information8 Developer descriptive flexfield
71  * @param p_poei_information9 Developer descriptive flexfield
72  * @param p_poei_information10 Developer descriptive flexfield
73  * @param p_poei_information11 Developer descriptive flexfield
74  * @param p_poei_information12 Developer descriptive flexfield
75  * @param p_poei_information13 Developer descriptive flexfield
76  * @param p_poei_information14 Developer descriptive flexfield
77  * @param p_poei_information15 Developer descriptive flexfield
78  * @param p_poei_information16 Developer descriptive flexfield
79  * @param p_poei_information17 Developer descriptive flexfield
80  * @param p_poei_information18 Developer descriptive flexfield
81  * @param p_poei_information19 Developer descriptive flexfield
82  * @param p_poei_information20 Developer descriptive flexfield
83  * @param p_poei_information21 Developer descriptive flexfield
84  * @param p_poei_information22 Developer descriptive flexfield
85  * @param p_poei_information23 Developer descriptive flexfield
86  * @param p_poei_information24 Developer descriptive flexfield
87  * @param p_poei_information25 Developer descriptive flexfield
88  * @param p_poei_information26 Developer descriptive flexfield
89  * @param p_poei_information27 Developer descriptive flexfield
90  * @param p_poei_information28 Developer descriptive flexfield
91  * @param p_poei_information29 Developer descriptive flexfield
92  * @param p_poei_information30 Developer descriptive flexfield
93  * @param p_position_extra_info_id If p_validate is false, uniquely identifies
94  * the position extra information created. If p_validate is true, set to null.
95  * @param p_object_version_number If p_validate is false, then set to the
96  * version number of the created Position Extra Information. If p_validate is
97  * true, then the value will be null.
98  * @rep:displayname Create Position Extra Information
99  * @rep:category BUSINESS_ENTITY PER_POSITION
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_position_extra_info
109   (p_validate                      in     boolean  default false
110   ,p_position_id                   in     number
111   ,p_information_type              in     varchar2
112   ,p_poei_attribute_category       in     varchar2 default null
113   ,p_poei_attribute1               in     varchar2 default null
114   ,p_poei_attribute2               in     varchar2 default null
115   ,p_poei_attribute3               in     varchar2 default null
116   ,p_poei_attribute4               in     varchar2 default null
117   ,p_poei_attribute5               in     varchar2 default null
118   ,p_poei_attribute6               in     varchar2 default null
119   ,p_poei_attribute7               in     varchar2 default null
120   ,p_poei_attribute8               in     varchar2 default null
121   ,p_poei_attribute9               in     varchar2 default null
122   ,p_poei_attribute10              in     varchar2 default null
123   ,p_poei_attribute11              in     varchar2 default null
124   ,p_poei_attribute12              in     varchar2 default null
125   ,p_poei_attribute13              in     varchar2 default null
126   ,p_poei_attribute14              in     varchar2 default null
127   ,p_poei_attribute15              in     varchar2 default null
128   ,p_poei_attribute16              in     varchar2 default null
129   ,p_poei_attribute17              in     varchar2 default null
130   ,p_poei_attribute18              in     varchar2 default null
131   ,p_poei_attribute19              in     varchar2 default null
132   ,p_poei_attribute20              in     varchar2 default null
133   ,p_poei_information_category     in     varchar2 default null
134   ,p_poei_information1             in     varchar2 default null
135   ,p_poei_information2             in     varchar2 default null
136   ,p_poei_information3             in     varchar2 default null
137   ,p_poei_information4             in     varchar2 default null
138   ,p_poei_information5             in     varchar2 default null
139   ,p_poei_information6             in     varchar2 default null
140   ,p_poei_information7             in     varchar2 default null
141   ,p_poei_information8             in     varchar2 default null
142   ,p_poei_information9             in     varchar2 default null
143   ,p_poei_information10            in     varchar2 default null
144   ,p_poei_information11            in     varchar2 default null
145   ,p_poei_information12            in     varchar2 default null
146   ,p_poei_information13            in     varchar2 default null
147   ,p_poei_information14            in     varchar2 default null
148   ,p_poei_information15            in     varchar2 default null
149   ,p_poei_information16            in     varchar2 default null
150   ,p_poei_information17            in     varchar2 default null
151   ,p_poei_information18            in     varchar2 default null
152   ,p_poei_information19            in     varchar2 default null
153   ,p_poei_information20            in     varchar2 default null
154   ,p_poei_information21            in     varchar2 default null
155   ,p_poei_information22            in     varchar2 default null
156   ,p_poei_information23            in     varchar2 default null
157   ,p_poei_information24            in     varchar2 default null
158   ,p_poei_information25            in     varchar2 default null
159   ,p_poei_information26            in     varchar2 default null
160   ,p_poei_information27            in     varchar2 default null
161   ,p_poei_information28            in     varchar2 default null
162   ,p_poei_information29            in     varchar2 default null
163   ,p_poei_information30            in     varchar2 default null
164   ,p_position_extra_info_id           out nocopy number
165   ,p_object_version_number            out nocopy number
166   );
167 --
168 -- ----------------------------------------------------------------------------
169 -- |------------------------< update_position_extra_info >--------------------|
170 -- ----------------------------------------------------------------------------
171 --
172 -- {Start Of Comments}
173 /*#
174  * This API updates extra information for a given position.
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 position extra info as identified by the in parameter
182  * p_position_extra_info_id and the in out parameter p_object_version_number
183  * must already exist.
184  *
185  * <p><b>Post Success</b><br>
186  * The position extra info is updated.
187  *
188  * <p><b>Post Failure</b><br>
189  * The API does not update the position extra info and raises an error.
190  * @param p_validate If true, then validation alone will be performed and the
191  * database will remain unchanged. If false and all validation checks pass,
192  * then the database will be modified.
193  * @param p_position_extra_info_id Identifies the position extra info record to
194  * modify.
195  * @param p_object_version_number Pass in the current version number of the
196  * Position Extra Information to be updated. When the API completes if
197  * p_validate is false, will be set to the new version number of the updated
198  * Position Extra Information. If p_validate is true will be set to the same
199  * value which was passed in.
200  * @param p_poei_attribute_category This context value determines which
201  * flexfield structure to use with the poei_attribute descriptive flexfield
202  * segments.
203  * @param p_poei_attribute1 Descriptive flexfield
204  * @param p_poei_attribute2 Descriptive flexfield
205  * @param p_poei_attribute3 Descriptive flexfield
206  * @param p_poei_attribute4 Descriptive flexfield
207  * @param p_poei_attribute5 Descriptive flexfield
208  * @param p_poei_attribute6 Descriptive flexfield
209  * @param p_poei_attribute7 Descriptive flexfield
210  * @param p_poei_attribute8 Descriptive flexfield
211  * @param p_poei_attribute9 Descriptive flexfield
212  * @param p_poei_attribute10 Descriptive flexfield
213  * @param p_poei_attribute11 Descriptive flexfield
214  * @param p_poei_attribute12 Descriptive flexfield
215  * @param p_poei_attribute13 Descriptive flexfield
216  * @param p_poei_attribute14 Descriptive flexfield
217  * @param p_poei_attribute15 Descriptive flexfield
218  * @param p_poei_attribute16 Descriptive flexfield
219  * @param p_poei_attribute17 Descriptive flexfield
220  * @param p_poei_attribute18 Descriptive flexfield
221  * @param p_poei_attribute19 Descriptive flexfield
222  * @param p_poei_attribute20 Descriptive flexfield
223  * @param p_poei_information_category This context value determines which
224  * flexfield structure to use with the poei_information developer descriptive
225  * flexfield segments.
226  * @param p_poei_information1 Developer descriptive flexfield
227  * @param p_poei_information2 Developer descriptive flexfield
228  * @param p_poei_information3 Developer descriptive flexfield
229  * @param p_poei_information4 Developer descriptive flexfield
230  * @param p_poei_information5 Developer descriptive flexfield
231  * @param p_poei_information6 Developer descriptive flexfield
232  * @param p_poei_information7 Developer descriptive flexfield
233  * @param p_poei_information8 Developer descriptive flexfield
234  * @param p_poei_information9 Developer descriptive flexfield
235  * @param p_poei_information10 Developer descriptive flexfield
236  * @param p_poei_information11 Developer descriptive flexfield
237  * @param p_poei_information12 Developer descriptive flexfield
238  * @param p_poei_information13 Developer descriptive flexfield
239  * @param p_poei_information14 Developer descriptive flexfield
240  * @param p_poei_information15 Developer descriptive flexfield
241  * @param p_poei_information16 Developer descriptive flexfield
242  * @param p_poei_information17 Developer descriptive flexfield
243  * @param p_poei_information18 Developer descriptive flexfield
244  * @param p_poei_information19 Developer descriptive flexfield
245  * @param p_poei_information20 Developer descriptive flexfield
246  * @param p_poei_information21 Developer descriptive flexfield
247  * @param p_poei_information22 Developer descriptive flexfield
248  * @param p_poei_information23 Developer descriptive flexfield
249  * @param p_poei_information24 Developer descriptive flexfield
250  * @param p_poei_information25 Developer descriptive flexfield
251  * @param p_poei_information26 Developer descriptive flexfield
252  * @param p_poei_information27 Developer descriptive flexfield
253  * @param p_poei_information28 Developer descriptive flexfield
254  * @param p_poei_information29 Developer descriptive flexfield
255  * @param p_poei_information30 Developer descriptive flexfield
256  * @rep:displayname Update Position Extra Information
257  * @rep:category BUSINESS_ENTITY PER_POSITION
258  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
259  * @rep:scope public
260  * @rep:lifecycle active
261  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
262 */
263 --
264 -- {End Of Comments}
265 --
266 procedure update_position_extra_info
267   (p_validate                      in     boolean  default false
268   ,p_position_extra_info_id        in     number
269   ,p_object_version_number         in out nocopy number
270   ,p_poei_attribute_category       in     varchar2 default hr_api.g_varchar2
271   ,p_poei_attribute1               in     varchar2 default hr_api.g_varchar2
272   ,p_poei_attribute2               in     varchar2 default hr_api.g_varchar2
273   ,p_poei_attribute3               in     varchar2 default hr_api.g_varchar2
274   ,p_poei_attribute4               in     varchar2 default hr_api.g_varchar2
275   ,p_poei_attribute5               in     varchar2 default hr_api.g_varchar2
276   ,p_poei_attribute6               in     varchar2 default hr_api.g_varchar2
277   ,p_poei_attribute7               in     varchar2 default hr_api.g_varchar2
278   ,p_poei_attribute8               in     varchar2 default hr_api.g_varchar2
279   ,p_poei_attribute9               in     varchar2 default hr_api.g_varchar2
280   ,p_poei_attribute10              in     varchar2 default hr_api.g_varchar2
281   ,p_poei_attribute11              in     varchar2 default hr_api.g_varchar2
282   ,p_poei_attribute12              in     varchar2 default hr_api.g_varchar2
283   ,p_poei_attribute13              in     varchar2 default hr_api.g_varchar2
284   ,p_poei_attribute14              in     varchar2 default hr_api.g_varchar2
285   ,p_poei_attribute15              in     varchar2 default hr_api.g_varchar2
286   ,p_poei_attribute16              in     varchar2 default hr_api.g_varchar2
287   ,p_poei_attribute17              in     varchar2 default hr_api.g_varchar2
288   ,p_poei_attribute18              in     varchar2 default hr_api.g_varchar2
289   ,p_poei_attribute19              in     varchar2 default hr_api.g_varchar2
290   ,p_poei_attribute20              in     varchar2 default hr_api.g_varchar2
291   ,p_poei_information_category     in     varchar2 default hr_api.g_varchar2
292   ,p_poei_information1             in     varchar2 default hr_api.g_varchar2
293   ,p_poei_information2             in     varchar2 default hr_api.g_varchar2
294   ,p_poei_information3             in     varchar2 default hr_api.g_varchar2
295   ,p_poei_information4             in     varchar2 default hr_api.g_varchar2
296   ,p_poei_information5             in     varchar2 default hr_api.g_varchar2
297   ,p_poei_information6             in     varchar2 default hr_api.g_varchar2
298   ,p_poei_information7             in     varchar2 default hr_api.g_varchar2
299   ,p_poei_information8             in     varchar2 default hr_api.g_varchar2
300   ,p_poei_information9             in     varchar2 default hr_api.g_varchar2
301   ,p_poei_information10            in     varchar2 default hr_api.g_varchar2
302   ,p_poei_information11            in     varchar2 default hr_api.g_varchar2
303   ,p_poei_information12            in     varchar2 default hr_api.g_varchar2
304   ,p_poei_information13            in     varchar2 default hr_api.g_varchar2
305   ,p_poei_information14            in     varchar2 default hr_api.g_varchar2
306   ,p_poei_information15            in     varchar2 default hr_api.g_varchar2
307   ,p_poei_information16            in     varchar2 default hr_api.g_varchar2
308   ,p_poei_information17            in     varchar2 default hr_api.g_varchar2
309   ,p_poei_information18            in     varchar2 default hr_api.g_varchar2
310   ,p_poei_information19            in     varchar2 default hr_api.g_varchar2
311   ,p_poei_information20            in     varchar2 default hr_api.g_varchar2
312   ,p_poei_information21            in     varchar2 default hr_api.g_varchar2
313   ,p_poei_information22            in     varchar2 default hr_api.g_varchar2
314   ,p_poei_information23            in     varchar2 default hr_api.g_varchar2
315   ,p_poei_information24            in     varchar2 default hr_api.g_varchar2
316   ,p_poei_information25            in     varchar2 default hr_api.g_varchar2
317   ,p_poei_information26            in     varchar2 default hr_api.g_varchar2
318   ,p_poei_information27            in     varchar2 default hr_api.g_varchar2
319   ,p_poei_information28            in     varchar2 default hr_api.g_varchar2
320   ,p_poei_information29            in     varchar2 default hr_api.g_varchar2
321   ,p_poei_information30            in     varchar2 default hr_api.g_varchar2
322   );
323 --
324 -- ----------------------------------------------------------------------------
325 -- |------------------------< delete_position_extra_info >--------------------|
326 -- ----------------------------------------------------------------------------
327 --
328 -- {Start Of Comments}
329 /*#
330  * This API deletes extra information for a given position.
331  *
332  *
333  * <p><b>Licensing</b><br>
334  * This API is licensed for use with Human Resources.
335  *
336  * <p><b>Prerequisites</b><br>
337  * The position extra info as identified by the in parameter
338  * p_position_extra_info_id and the in out parameter p_object_version_number
339  * must already exist.
340  *
341  * <p><b>Post Success</b><br>
342  * The position extra info is deleted
343  *
344  * <p><b>Post Failure</b><br>
345  * The API does not delete the position extra info and raises an error.
346  * @param p_validate If true, then validation alone will be performed and the
347  * database will remain unchanged. If false and all validation checks pass,
348  * then the database will be modified.
349  * @param p_position_extra_info_id Uniquely identifies the position extra
350  * information record to be deleted.
351  * @param p_object_version_number Current version number of the Position Extra
352  * Information to be deleted.
353  * @rep:displayname Delete Position Extra Information
354  * @rep:category BUSINESS_ENTITY PER_POSITION
355  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
356  * @rep:scope public
357  * @rep:lifecycle active
358  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
359 */
360 --
361 -- {End Of Comments}
362 --
363 procedure delete_position_extra_info
364   (p_validate                      in     boolean  default false
365   ,p_position_extra_info_id        in     number
366   ,p_object_version_number         in     number
367   );
368 --
369 end hr_position_extra_info_api;