DBA Data[Home] [Help]

PACKAGE: APPS.BEN_PGM_EXTRA_INFO_API

Source


1 Package ben_pgm_extra_info_api as
2 /* $Header: bepgiapi.pkh 120.0 2005/05/28 10:45:47 appldev noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |----------------------< create_pgm_extra_info >----------------------|
6 -- ----------------------------------------------------------------------------
7 -- {Start Of Comments}
8 --
9 -- Description:
10 --   This API creates extra information for a given pgm
11 --
12 -- Prerequisites:
13 --   pgm must exits
14 --   pgm Information Type must already exist
15 --
16 -- In Parameters:
17 --   Name                           Reqd Type     Description
18 --   p_validate                          boolean  If true, the database
19 --                                                remains unchanged. If false,
20 --                                                the extra info is created
21 --   p_pgm_id                  Yes  number   pgm for which the extra
22 --                                                info applies
23 --   p_information_type             Yes  varchar2 Information type the extra
24 --                                                info applies to
25 --   p_pgi_attribute_category           varchar2 Determines context of the
26 --                                                pgm_attribute descriptive
27 --                                                flexfield in parameters
28 --   p_pgi_attribute1                   varchar2 Descriptive flexfield
29 --   p_pgi_attribute2                   varchar2 Descriptive flexfield
30 --   p_pgi_attribute3                   varchar2 Descriptive flexfield
31 --   p_pgi_attribute4                   varchar2 Descriptive flexfield
32 --   p_pgi_attribute5                   varchar2 Descriptive flexfield
33 --   p_pgi_attribute6                   varchar2 Descriptive flexfield
34 --   p_pgi_attribute7                   varchar2 Descriptive flexfield
35 --   p_pgi_attribute8                   varchar2 Descriptive flexfield
36 --   p_pgi_attribute9                   varchar2 Descriptive flexfield
37 --   p_pgi_attribute10                  varchar2 Descriptive flexfield
38 --   p_pgi_attribute11                  varchar2 Descriptive flexfield
39 --   p_pgi_attribute12                  varchar2 Descriptive flexfield
40 --   p_pgi_attribute13                  varchar2 Descriptive flexfield
41 --   p_pgi_attribute14                  varchar2 Descriptive flexfield
42 --   p_pgi_attribute15                  varchar2 Descriptive flexfield
43 --   p_pgi_attribute16                  varchar2 Descriptive flexfield
44 --   p_pgi_attribute17                  varchar2 Descriptive flexfield
45 --   p_pgi_attribute18                  varchar2 Descriptive flexfield
46 --   p_pgi_attribute19                  varchar2 Descriptive flexfield
47 --   p_pgi_attribute20                  varchar2 Descriptive flexfield
48 --   p_pgi_information_category         varchar2 Determines context of the
49 --                                                pgm_attribute developer
50 --                                                descriptive flexfield in
51 --                                                parameters
52 --   p_pgi_information1                 varchar2 Developer descriptive
53 --                                                flexfield
54 --   p_pgi_information2                 varchar2 Descriptive flexfield
55 --                                                flexfield
56 --   p_pgi_information3                 varchar2 Developer descriptive
57 --                                                flexfield
58 --   p_pgi_information4                 varchar2 Developer descriptive
59 --                                                flexfield
60 --   p_pgi_information5                 varchar2 Developer descriptive
61 --                                                flexfield
62 --   p_pgi_information6                 varchar2 Developer descriptive
63 --                                                flexfield
64 --   p_pgi_information7                 varchar2 Developer descriptive
65 --                                                flexfield
66 --   p_pgi_information8                 varchar2 Developer descriptive
67 --                                                flexfield
68 --   p_pgi_information9                 varchar2 Developer descriptive
69 --                                                flexfield
70 --   p_pgi_information10                varchar2 Developer descriptive
71 --                                                flexfield
72 --   p_pgi_information11                varchar2 Developer descriptive
73 --                                                flexfield
74 --   p_pgi_information12                varchar2 Developer descriptive
75 --                                                flexfield
76 --   p_pgi_information13                varchar2 Developer descriptive
77 --                                                flexfield
78 --   p_pgi_information14                varchar2 Developer descriptive
79 --                                                flexfield
80 --   p_pgi_information15                varchar2 Developer descriptive
81 --                                                flexfield
82 --   p_pgi_information16                varchar2 Developer descriptive
83 --                                                flexfield
84 --   p_pgi_information17                varchar2 Developer descriptive
85 --                                                flexfield
86 --   p_pgi_information18                varchar2 Developer descriptive
87 --                                                flexfield
88 --   p_pgi_information19                varchar2 Developer descriptive
89 --                                                flexfield
90 --   p_pgi_information20                varchar2 Developer descriptive
91 --                                                flexfield
92 --   p_pgi_information21                varchar2 Developer descriptive
93 --                                                flexfield
94 --   p_pgi_information22                varchar2 Developer descriptive
95 --                                                flexfield
96 --   p_pgi_information23                varchar2 Developer descriptive
97 --                                                flexfield
98 --   p_pgi_information24                varchar2 Developer descriptive
99 --                                                flexfield
100 --   p_pgi_information25                varchar2 Developer descriptive
101 --                                                flexfield
102 --   p_pgi_information26                varchar2 Developer descriptive
103 --                                                flexfield
104 --   p_pgi_information27                varchar2 Developer descriptive
105 --                                                flexfield
106 --   p_pgi_information28                varchar2 Developer descriptive
107 --                                                flexfield
108 --   p_pgi_information29                varchar2 Developer descriptive
109 --                                                flexfield
110 --   p_pgi_information30                varchar2 default null
111 --                                                flexfield
112 --
113 -- Post Success:
114 --   The pgm extra info is created and the API sets the following out
115 --   parameters.
116 --
117 --   Name                           Type     Description
118 --   p_pgm_extra_info_id       number   If p_validate is false, uniquely
119 --                                           identifies the pgm extra info
120 --                                           created.
121 --                                           If p_validate is true, set to
122 --                                           null.
123 --   p_object_version_number        number   If p_validate is false, set to
124 --                                           the version number of this
125 --                                           pgm extra info.
126 --                                           If p_validate is true, set to
127 --                                           null.
128 --
129 -- Post Failure:
130 --   The API does not create the pgm extra info and raises an error.
131 --
132 -- Access Status:
133 --   Public.
134 --
135 -- {End Of Comments}
136 --
137 procedure create_pgm_extra_info
138   (p_validate                     in     boolean  default false
139   ,p_pgm_id                       in     number
140   ,p_information_type             in     varchar2
141   ,p_pgi_attribute_category       in     varchar2 default null
142   ,p_pgi_attribute1               in     varchar2 default null
143   ,p_pgi_attribute2               in     varchar2 default null
144   ,p_pgi_attribute3               in     varchar2 default null
145   ,p_pgi_attribute4               in     varchar2 default null
146   ,p_pgi_attribute5               in     varchar2 default null
147   ,p_pgi_attribute6               in     varchar2 default null
148   ,p_pgi_attribute7               in     varchar2 default null
149   ,p_pgi_attribute8               in     varchar2 default null
150   ,p_pgi_attribute9               in     varchar2 default null
151   ,p_pgi_attribute10              in     varchar2 default null
152   ,p_pgi_attribute11              in     varchar2 default null
153   ,p_pgi_attribute12              in     varchar2 default null
154   ,p_pgi_attribute13              in     varchar2 default null
155   ,p_pgi_attribute14              in     varchar2 default null
156   ,p_pgi_attribute15              in     varchar2 default null
157   ,p_pgi_attribute16              in     varchar2 default null
158   ,p_pgi_attribute17              in     varchar2 default null
159   ,p_pgi_attribute18              in     varchar2 default null
160   ,p_pgi_attribute19              in     varchar2 default null
161   ,p_pgi_attribute20              in     varchar2 default null
162   ,p_pgi_information_category     in     varchar2 default null
163   ,p_pgi_information1             in     varchar2 default null
164   ,p_pgi_information2             in     varchar2 default null
165   ,p_pgi_information3             in     varchar2 default null
166   ,p_pgi_information4             in     varchar2 default null
167   ,p_pgi_information5             in     varchar2 default null
168   ,p_pgi_information6             in     varchar2 default null
169   ,p_pgi_information7             in     varchar2 default null
170   ,p_pgi_information8             in     varchar2 default null
171   ,p_pgi_information9             in     varchar2 default null
172   ,p_pgi_information10            in     varchar2 default null
173   ,p_pgi_information11            in     varchar2 default null
174   ,p_pgi_information12            in     varchar2 default null
175   ,p_pgi_information13            in     varchar2 default null
176   ,p_pgi_information14            in     varchar2 default null
177   ,p_pgi_information15            in     varchar2 default null
178   ,p_pgi_information16            in     varchar2 default null
179   ,p_pgi_information17            in     varchar2 default null
180   ,p_pgi_information18            in     varchar2 default null
181   ,p_pgi_information19            in     varchar2 default null
182   ,p_pgi_information20            in     varchar2 default null
183   ,p_pgi_information21            in     varchar2 default null
184   ,p_pgi_information22            in     varchar2 default null
185   ,p_pgi_information23            in     varchar2 default null
186   ,p_pgi_information24            in     varchar2 default null
187   ,p_pgi_information25            in     varchar2 default null
188   ,p_pgi_information26            in     varchar2 default null
189   ,p_pgi_information27            in     varchar2 default null
190   ,p_pgi_information28            in     varchar2 default null
191   ,p_pgi_information29            in     varchar2 default null
192   ,p_pgi_information30            in     varchar2 default null
193   ,p_pgm_extra_info_id           out nocopy number
194   ,p_object_version_number            out nocopy number
195   );
196 --
197 -- ----------------------------------------------------------------------------
198 -- |----------------------< update_pgm_extra_info >----------------------|
199 -- ----------------------------------------------------------------------------
200 -- {Start Of Comments}
201 --
202 -- Description:
203 --   This API updates extra information for a given pgm as identified by the
204 --   in parameter p_pgm_extra_info_id and the in out parameter
205 --   p_object_version_number.
206 --
207 -- Prerequisites:
208 --   The pgm extra info as identified by the in parameter
209 --   p_pgm_extra_info_id and the in out parameter p_object_version_number must
210 --   already exist.
211 --
212 -- In Parameters:
213 --   Name                           Reqd Type     Description
214 --   p_validate                          boolean  If true, the database
215 --                                                remains unchanged. If false,
216 --                                                the extra info is updated
217 --   p_pgm_extra_info_id       yes  number   Primary key of the pgm
218 --                                                extra info
219 --   p_object_version_number        yes  number   Current version of the
220 --                                                pgm extra info to be
221 --                                                updated
222 --   p_pgi_attribute_category           varchar2 Determines context of the
223 --                                                pgm_attribute descriptive
224 --                                                flexfield in parameters
225 --   p_pgi_attribute1                   varchar2 Descriptive flexfield
226 --   p_pgi_attribute2                   varchar2 Descriptive flexfield
227 --   p_pgi_attribute3                   varchar2 Descriptive flexfield
228 --   p_pgi_attribute4                   varchar2 Descriptive flexfield
229 --   p_pgi_attribute5                   varchar2 Descriptive flexfield
230 --   p_pgi_attribute6                   varchar2 Descriptive flexfield
231 --   p_pgi_attribute7                   varchar2 Descriptive flexfield
232 --   p_pgi_attribute8                   varchar2 Descriptive flexfield
233 --   p_pgi_attribute9                   varchar2 Descriptive flexfield
234 --   p_pgi_attribute10                  varchar2 Descriptive flexfield
235 --   p_pgi_attribute11                  varchar2 Descriptive flexfield
236 --   p_pgi_attribute12                  varchar2 Descriptive flexfield
237 --   p_pgi_attribute13                  varchar2 Descriptive flexfield
238 --   p_pgi_attribute14                  varchar2 Descriptive flexfield
239 --   p_pgi_attribute15                  varchar2 Descriptive flexfield
240 --   p_pgi_attribute16                  varchar2 Descriptive flexfield
241 --   p_pgi_attribute17                  varchar2 Descriptive flexfield
242 --   p_pgi_attribute18                  varchar2 Descriptive flexfield
243 --   p_pgi_attribute19                  varchar2 Descriptive flexfield
244 --   p_pgi_attribute20                  varchar2 Descriptive flexfield
245 --   p_pgi_information_category         varchar2 Determines context of the
246 --                                                pgm_attribute developer
247 --                                                descriptive flexfield in
248 --                                                parameters
249 --   p_pgi_information1                 varchar2 Developer descriptive
250 --                                                flexfield
251 --   p_pgi_information2                 varchar2 Descriptive flexfield
252 --                                                flexfield
253 --   p_pgi_information3                 varchar2 Developer descriptive
254 --                                                flexfield
255 --   p_pgi_information4                 varchar2 Developer descriptive
256 --                                                flexfield
257 --   p_pgi_information5                 varchar2 Developer descriptive
258 --                                                flexfield
259 --   p_pgi_information6                 varchar2 Developer descriptive
260 --                                                flexfield
261 --   p_pgi_information7                 varchar2 Developer descriptive
262 --                                                flexfield
263 --   p_pgi_information8                 varchar2 Developer descriptive
264 --                                                flexfield
265 --   p_pgi_information9                 varchar2 Developer descriptive
266 --                                                flexfield
267 --   p_pgi_information10                varchar2 Developer descriptive
268 --                                                flexfield
269 --   p_pgi_information11                varchar2 Developer descriptive
270 --                                                flexfield
271 --   p_pgi_information12                varchar2 Developer descriptive
272 --                                                flexfield
273 --   p_pgi_information13                varchar2 Developer descriptive
274 --                                                flexfield
275 --   p_pgi_information14                varchar2 Developer descriptive
276 --                                                flexfield
277 --   p_pgi_information15                varchar2 Developer descriptive
278 --                                                flexfield
279 --   p_pgi_information16                varchar2 Developer descriptive
280 --                                                flexfield
281 --   p_pgi_information17                varchar2 Developer descriptive
282 --                                                flexfield
283 --   p_pgi_information18                varchar2 Developer descriptive
284 --                                                flexfield
285 --   p_pgi_information19                varchar2 Developer descriptive
286 --                                                flexfield
287 --   p_pgi_information20                varchar2 Developer descriptive
288 --                                                flexfield
289 --   p_pgi_information21                varchar2 Developer descriptive
290 --                                                flexfield
291 --   p_pgi_information22                varchar2 Developer descriptive
292 --                                                flexfield
293 --   p_pgi_information23                varchar2 Developer descriptive
294 --                                                flexfield
295 --   p_pgi_information24                varchar2 Developer descriptive
296 --                                                flexfield
297 --   p_pgi_information25                varchar2 Developer descriptive
298 --                                                flexfield
299 --   p_pgi_information26                varchar2 Developer descriptive
300 --                                                flexfield
301 --   p_pgi_information27                varchar2 Developer descriptive
302 --                                                flexfield
303 --   p_pgi_information28                varchar2 Developer descriptive
304 --                                                flexfield
305 --   p_pgi_information29                varchar2 Developer descriptive
306 --                                                flexfield
307 --   p_pgi_information30                varchar2 default null
308 --                                                flexfield
309 --
310 -- Post Success:
311 --   The pgm extra info is updated and the API sets the following out
312 --   parameters.
313 --
314 --   Name                           Type     Description
315 --   p_object_version_number        number   If p_validate is false, set to
316 --                                           the version number of this
317 --                                           pgm extra info.
318 --                                           If p_validate is true, set to
319 --                                           null.
320 --
321 -- Post Failure:
322 --   The API does not update the pgm extra info and raises an error.
323 --
324 -- Access Status:
325 --   Public.
326 --
327 -- {End Of Comments}
328 --
329 procedure update_pgm_extra_info
330   (p_validate                     in     boolean  default false
331   ,p_pgm_extra_info_id            in     number
332   ,p_object_version_number        in out nocopy number
333   ,p_pgi_attribute_category       in     varchar2 default hr_api.g_varchar2
334   ,p_pgi_attribute1               in     varchar2 default hr_api.g_varchar2
335   ,p_pgi_attribute2               in     varchar2 default hr_api.g_varchar2
336   ,p_pgi_attribute3               in     varchar2 default hr_api.g_varchar2
337   ,p_pgi_attribute4               in     varchar2 default hr_api.g_varchar2
338   ,p_pgi_attribute5               in     varchar2 default hr_api.g_varchar2
339   ,p_pgi_attribute6               in     varchar2 default hr_api.g_varchar2
340   ,p_pgi_attribute7               in     varchar2 default hr_api.g_varchar2
341   ,p_pgi_attribute8               in     varchar2 default hr_api.g_varchar2
342   ,p_pgi_attribute9               in     varchar2 default hr_api.g_varchar2
343   ,p_pgi_attribute10              in     varchar2 default hr_api.g_varchar2
344   ,p_pgi_attribute11              in     varchar2 default hr_api.g_varchar2
345   ,p_pgi_attribute12              in     varchar2 default hr_api.g_varchar2
346   ,p_pgi_attribute13              in     varchar2 default hr_api.g_varchar2
347   ,p_pgi_attribute14              in     varchar2 default hr_api.g_varchar2
348   ,p_pgi_attribute15              in     varchar2 default hr_api.g_varchar2
349   ,p_pgi_attribute16              in     varchar2 default hr_api.g_varchar2
350   ,p_pgi_attribute17              in     varchar2 default hr_api.g_varchar2
351   ,p_pgi_attribute18              in     varchar2 default hr_api.g_varchar2
352   ,p_pgi_attribute19              in     varchar2 default hr_api.g_varchar2
353   ,p_pgi_attribute20              in     varchar2 default hr_api.g_varchar2
354   ,p_pgi_information_category     in     varchar2 default hr_api.g_varchar2
355   ,p_pgi_information1             in     varchar2 default hr_api.g_varchar2
356   ,p_pgi_information2             in     varchar2 default hr_api.g_varchar2
357   ,p_pgi_information3             in     varchar2 default hr_api.g_varchar2
358   ,p_pgi_information4             in     varchar2 default hr_api.g_varchar2
359   ,p_pgi_information5             in     varchar2 default hr_api.g_varchar2
360   ,p_pgi_information6             in     varchar2 default hr_api.g_varchar2
361   ,p_pgi_information7             in     varchar2 default hr_api.g_varchar2
362   ,p_pgi_information8             in     varchar2 default hr_api.g_varchar2
363   ,p_pgi_information9             in     varchar2 default hr_api.g_varchar2
364   ,p_pgi_information10            in     varchar2 default hr_api.g_varchar2
365   ,p_pgi_information11            in     varchar2 default hr_api.g_varchar2
366   ,p_pgi_information12            in     varchar2 default hr_api.g_varchar2
367   ,p_pgi_information13            in     varchar2 default hr_api.g_varchar2
368   ,p_pgi_information14            in     varchar2 default hr_api.g_varchar2
369   ,p_pgi_information15            in     varchar2 default hr_api.g_varchar2
370   ,p_pgi_information16            in     varchar2 default hr_api.g_varchar2
371   ,p_pgi_information17            in     varchar2 default hr_api.g_varchar2
372   ,p_pgi_information18            in     varchar2 default hr_api.g_varchar2
373   ,p_pgi_information19            in     varchar2 default hr_api.g_varchar2
374   ,p_pgi_information20            in     varchar2 default hr_api.g_varchar2
375   ,p_pgi_information21            in     varchar2 default hr_api.g_varchar2
376   ,p_pgi_information22            in     varchar2 default hr_api.g_varchar2
377   ,p_pgi_information23            in     varchar2 default hr_api.g_varchar2
378   ,p_pgi_information24            in     varchar2 default hr_api.g_varchar2
379   ,p_pgi_information25            in     varchar2 default hr_api.g_varchar2
380   ,p_pgi_information26            in     varchar2 default hr_api.g_varchar2
381   ,p_pgi_information27            in     varchar2 default hr_api.g_varchar2
382   ,p_pgi_information28            in     varchar2 default hr_api.g_varchar2
383   ,p_pgi_information29            in     varchar2 default hr_api.g_varchar2
384   ,p_pgi_information30            in     varchar2 default hr_api.g_varchar2
385   );
386 --
387 -- ----------------------------------------------------------------------------
388 -- |----------------------< delete_pgm_extra_info >----------------------|
389 -- ----------------------------------------------------------------------------
390 -- {Start Of Comments}
391 --
392 -- Description:
393 --   This API deletes extra information for a given pgm as identified by the
394 --   in parameter p_pgm_extra_info_id and the in parameter
395 --   p_object_version_number.
396 --
397 -- Prerequisites:
398 --   The pgm extra info as identified by the in parameter
399 --   p_pgm_extra_info_id and the in out parameter p_object_version_number must
400 --   already exist.
401 --
402 -- In Parameters:
403 --   Name                           Reqd Type     Description
404 --   p_validate                          boolean  If true, the database
405 --                                                remains unchanged. If false,
406 --                                                the extra info is deleted
407 --   p_pgm_extra_info_id       yes  number   Primary key of the pgm
408 --                                                extra info
409 --   p_object_version_number        yes  number   Current version of the
410 --                                                pgm extra info to be
411 --                                                deleted
412 --
413 -- Post Success:
414 --   The pgm extra info is deleted
415 --
416 -- Post Failure:
417 --   The API does not delete the pgm extra info and raises an error.
418 --
419 -- Access Status:
420 --   Public.
421 --
422 -- {End Of Comments}
423 --
424 procedure delete_pgm_extra_info
425   (p_validate                      	in     boolean  default false
426   ,p_pgm_extra_info_id        	in     number
427   ,p_object_version_number         	in     number
428   );
429 --
430 end ben_pgm_extra_info_api;