DBA Data[Home] [Help]

PACKAGE: APPS.PER_JOB_EXTRA_INFO_API

Source


1 Package per_job_extra_info_api as
2 /* $Header: pejeiapi.pkh 120.1 2005/10/02 02:17:57 aroussel $ */
3 /*#
4  * This package contains APIs which create and maintain extra information
5  * records for a job.
6  * @rep:scope public
7  * @rep:product per
8  * @rep:displayname Job Extra Information
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |--------------------------< create_job_extra_info >-----------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17  * This API creates extra information for a job.
18  *
19  * Extra information provides the ability for users to easily extend and
20  * configure information the system holds about a particular job, allowing the
21  * system to capture multiple additional sets of structured data in relation to
22  * a specific parent job record. Extra information is based on descriptive
23  * flexfields and so the user must first define the job extra information
24  * flexfield structures, in terms of the number and type of segments for each
25  * structure, and any validation which should be applied to each segment. These
26  * structures correspond to extra information types. The user is then able to
27  * populate one or more instances of each of the predefined job extra
28  * information types (structures), for each of the jobs that they have set up
29  * on the system, using this API.
30  *
31  * <p><b>Licensing</b><br>
32  * This API is licensed for use with Human Resources.
33  *
34  * <p><b>Prerequisites</b><br>
35  * The job and the job extra information type (flexfield structure) must
36  * already exist.
37  *
38  * <p><b>Post Success</b><br>
39  * The job extra information is created.
40  *
41  * <p><b>Post Failure</b><br>
42  * The job extra information is not created and an error is raised.
43  * @param p_validate If true, then validation alone will be performed and the
44  * database will remain unchanged. If false and all validation checks pass,
45  * then the database will be modified.
46  * @param p_job_id Uniquely identifies the job to which this extra information
47  * record applies.
48  * @param p_information_type The name of the information type corresponding to
49  * the flexfield context which provides the structure of the extra information
50  * record.
51  * @param p_jei_attribute_category This context value determines which
52  * Flexfield Structure to use with the Descriptive flexfield segments.
53  * @param p_jei_attribute1 Descriptive flexfield segment.
54  * @param p_jei_attribute2 Descriptive flexfield segment.
55  * @param p_jei_attribute3 Descriptive flexfield segment.
56  * @param p_jei_attribute4 Descriptive flexfield segment.
57  * @param p_jei_attribute5 Descriptive flexfield segment.
58  * @param p_jei_attribute6 Descriptive flexfield segment.
59  * @param p_jei_attribute7 Descriptive flexfield segment.
60  * @param p_jei_attribute8 Descriptive flexfield segment.
61  * @param p_jei_attribute9 Descriptive flexfield segment.
62  * @param p_jei_attribute10 Descriptive flexfield segment.
63  * @param p_jei_attribute11 Descriptive flexfield segment.
64  * @param p_jei_attribute12 Descriptive flexfield segment.
65  * @param p_jei_attribute13 Descriptive flexfield segment.
66  * @param p_jei_attribute14 Descriptive flexfield segment.
67  * @param p_jei_attribute15 Descriptive flexfield segment.
68  * @param p_jei_attribute16 Descriptive flexfield segment.
69  * @param p_jei_attribute17 Descriptive flexfield segment.
70  * @param p_jei_attribute18 Descriptive flexfield segment.
71  * @param p_jei_attribute19 Descriptive flexfield segment.
72  * @param p_jei_attribute20 Descriptive flexfield segment.
73  * @param p_jei_information_category This context value determines which
74  * Flexfield Structure to use with the Developer Descriptive flexfield
75  * segments.
76  * @param p_jei_information1 Developer Descriptive flexfield segment.
77  * @param p_jei_information2 Developer Descriptive flexfield segment.
78  * @param p_jei_information3 Developer Descriptive flexfield segment.
79  * @param p_jei_information4 Developer Descriptive flexfield segment.
80  * @param p_jei_information5 Developer Descriptive flexfield segment.
81  * @param p_jei_information6 Developer Descriptive flexfield segment.
82  * @param p_jei_information7 Developer Descriptive flexfield segment.
83  * @param p_jei_information8 Developer Descriptive flexfield segment.
84  * @param p_jei_information9 Developer Descriptive flexfield segment.
85  * @param p_jei_information10 Developer Descriptive flexfield segment.
86  * @param p_jei_information11 Developer Descriptive flexfield segment.
87  * @param p_jei_information12 Developer Descriptive flexfield segment.
88  * @param p_jei_information13 Developer Descriptive flexfield segment.
89  * @param p_jei_information14 Developer Descriptive flexfield segment.
90  * @param p_jei_information15 Developer Descriptive flexfield segment.
91  * @param p_jei_information16 Developer Descriptive flexfield segment.
92  * @param p_jei_information17 Developer Descriptive flexfield segment.
93  * @param p_jei_information18 Developer Descriptive flexfield segment.
94  * @param p_jei_information19 Developer Descriptive flexfield segment.
95  * @param p_jei_information20 Developer Descriptive flexfield segment.
96  * @param p_jei_information21 Developer Descriptive flexfield segment.
97  * @param p_jei_information22 Developer Descriptive flexfield segment.
98  * @param p_jei_information23 Developer Descriptive flexfield segment.
99  * @param p_jei_information24 Developer Descriptive flexfield segment.
100  * @param p_jei_information25 Developer Descriptive flexfield segment.
101  * @param p_jei_information26 Developer Descriptive flexfield segment.
102  * @param p_jei_information27 Developer Descriptive flexfield segment.
103  * @param p_jei_information28 Developer Descriptive flexfield segment.
104  * @param p_jei_information29 Developer Descriptive flexfield segment.
105  * @param p_jei_information30 Developer Descriptive flexfield segment.
106  * @param p_job_extra_info_id If p_validate is false, uniquely identifies the
107  * job extra information created. If p_validate is true, set to null.
108  * @param p_object_version_number If p_validate is false, then set to the
109  * version number of the created job extra information. If p_validate is true,
110  * then the value will be null.
111  * @rep:displayname Create Job Extra Information
112  * @rep:category BUSINESS_ENTITY PER_JOB
113  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
114  * @rep:scope public
115  * @rep:lifecycle active
116  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
117 */
118 --
119 -- {End Of Comments}
120 --
121 procedure create_job_extra_info
122   (p_validate                     in     boolean  default false
123   ,p_job_id                       in     number
124   ,p_information_type             in     varchar2
125   ,p_jei_attribute_category       in     varchar2 default null
126   ,p_jei_attribute1               in     varchar2 default null
127   ,p_jei_attribute2               in     varchar2 default null
128   ,p_jei_attribute3               in     varchar2 default null
129   ,p_jei_attribute4               in     varchar2 default null
130   ,p_jei_attribute5               in     varchar2 default null
131   ,p_jei_attribute6               in     varchar2 default null
132   ,p_jei_attribute7               in     varchar2 default null
133   ,p_jei_attribute8               in     varchar2 default null
134   ,p_jei_attribute9               in     varchar2 default null
135   ,p_jei_attribute10              in     varchar2 default null
136   ,p_jei_attribute11              in     varchar2 default null
137   ,p_jei_attribute12              in     varchar2 default null
138   ,p_jei_attribute13              in     varchar2 default null
139   ,p_jei_attribute14              in     varchar2 default null
140   ,p_jei_attribute15              in     varchar2 default null
141   ,p_jei_attribute16              in     varchar2 default null
142   ,p_jei_attribute17              in     varchar2 default null
143   ,p_jei_attribute18              in     varchar2 default null
144   ,p_jei_attribute19              in     varchar2 default null
145   ,p_jei_attribute20              in     varchar2 default null
146   ,p_jei_information_category     in     varchar2 default null
147   ,p_jei_information1             in     varchar2 default null
148   ,p_jei_information2             in     varchar2 default null
149   ,p_jei_information3             in     varchar2 default null
150   ,p_jei_information4             in     varchar2 default null
151   ,p_jei_information5             in     varchar2 default null
152   ,p_jei_information6             in     varchar2 default null
153   ,p_jei_information7             in     varchar2 default null
154   ,p_jei_information8             in     varchar2 default null
155   ,p_jei_information9             in     varchar2 default null
156   ,p_jei_information10            in     varchar2 default null
157   ,p_jei_information11            in     varchar2 default null
158   ,p_jei_information12            in     varchar2 default null
159   ,p_jei_information13            in     varchar2 default null
160   ,p_jei_information14            in     varchar2 default null
161   ,p_jei_information15            in     varchar2 default null
162   ,p_jei_information16            in     varchar2 default null
163   ,p_jei_information17            in     varchar2 default null
164   ,p_jei_information18            in     varchar2 default null
165   ,p_jei_information19            in     varchar2 default null
166   ,p_jei_information20            in     varchar2 default null
167   ,p_jei_information21            in     varchar2 default null
168   ,p_jei_information22            in     varchar2 default null
169   ,p_jei_information23            in     varchar2 default null
170   ,p_jei_information24            in     varchar2 default null
171   ,p_jei_information25            in     varchar2 default null
172   ,p_jei_information26            in     varchar2 default null
173   ,p_jei_information27            in     varchar2 default null
174   ,p_jei_information28            in     varchar2 default null
175   ,p_jei_information29            in     varchar2 default null
176   ,p_jei_information30            in     varchar2 default null
177   ,p_job_extra_info_id           out nocopy number
178   ,p_object_version_number            out nocopy number
179   );
180 --
181 -- ----------------------------------------------------------------------------
182 -- |--------------------------< update_job_extra_info >-----------------------|
183 -- ----------------------------------------------------------------------------
184 --
185 -- {Start Of Comments}
186 /*#
187  * This API updates extra information for a job.
188  *
189  * Extra information provides the ability for users to easily extend and
190  * configure information the system holds about a particular job, allowing the
191  * system to capture multiple additional sets of structured data in relation to
192  * a specific parent job record. Extra information is based on descriptive
193  * flexfields and so the user must first define the job extra information
194  * flexfield structures, in terms of the number and type of segments for each
195  * structure, and any validation which should be applied to each segment. These
196  * structures correspond to extra information types. The user is then able to
197  * maintain one or more instances of each of the predefined job extra
198  * information types (structures), for each of the jobs that they have set up
199  * on the system, using this API.
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 job extra information must already exist.
206  *
207  * <p><b>Post Success</b><br>
208  * The job extra information is updated.
209  *
210  * <p><b>Post Failure</b><br>
211  * The job extra information is not updated and an error is raised.
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_job_extra_info_id Uniquely identifies the job extra information
216  * record to be updated.
217  * @param p_object_version_number Pass in the current version number of the job
218  * extra information to be updated. When the API completes if p_validate is
219  * false, will be set to the new version number of the updated job extra
220  * information. If p_validate is true will be set to the same value which was
221  * passed in.
222  * @param p_jei_attribute_category This context value determines which
223  * Flexfield Structure to use with the Descriptive flexfield segments.
224  * @param p_jei_attribute1 Descriptive flexfield segment.
225  * @param p_jei_attribute2 Descriptive flexfield segment.
226  * @param p_jei_attribute3 Descriptive flexfield segment.
227  * @param p_jei_attribute4 Descriptive flexfield segment.
228  * @param p_jei_attribute5 Descriptive flexfield segment.
229  * @param p_jei_attribute6 Descriptive flexfield segment.
230  * @param p_jei_attribute7 Descriptive flexfield segment.
231  * @param p_jei_attribute8 Descriptive flexfield segment.
232  * @param p_jei_attribute9 Descriptive flexfield segment.
233  * @param p_jei_attribute10 Descriptive flexfield segment.
234  * @param p_jei_attribute11 Descriptive flexfield segment.
235  * @param p_jei_attribute12 Descriptive flexfield segment.
236  * @param p_jei_attribute13 Descriptive flexfield segment.
237  * @param p_jei_attribute14 Descriptive flexfield segment.
238  * @param p_jei_attribute15 Descriptive flexfield segment.
239  * @param p_jei_attribute16 Descriptive flexfield segment.
240  * @param p_jei_attribute17 Descriptive flexfield segment.
241  * @param p_jei_attribute18 Descriptive flexfield segment.
242  * @param p_jei_attribute19 Descriptive flexfield segment.
243  * @param p_jei_attribute20 Descriptive flexfield segment.
244  * @param p_jei_information_category This context value determines which
245  * Flexfield Structure to use with the Developer Descriptive flexfield
246  * segments.
247  * @param p_jei_information1 Developer Descriptive flexfield segment.
248  * @param p_jei_information2 Developer Descriptive flexfield segment.
249  * @param p_jei_information3 Developer Descriptive flexfield segment.
250  * @param p_jei_information4 Developer Descriptive flexfield segment.
251  * @param p_jei_information5 Developer Descriptive flexfield segment.
252  * @param p_jei_information6 Developer Descriptive flexfield segment.
256  * @param p_jei_information10 Developer Descriptive flexfield segment.
253  * @param p_jei_information7 Developer Descriptive flexfield segment.
254  * @param p_jei_information8 Developer Descriptive flexfield segment.
255  * @param p_jei_information9 Developer Descriptive flexfield segment.
257  * @param p_jei_information11 Developer Descriptive flexfield segment.
258  * @param p_jei_information12 Developer Descriptive flexfield segment.
259  * @param p_jei_information13 Developer Descriptive flexfield segment.
260  * @param p_jei_information14 Developer Descriptive flexfield segment.
261  * @param p_jei_information15 Developer Descriptive flexfield segment.
262  * @param p_jei_information16 Developer Descriptive flexfield segment.
263  * @param p_jei_information17 Developer Descriptive flexfield segment.
264  * @param p_jei_information18 Developer Descriptive flexfield segment.
265  * @param p_jei_information19 Developer Descriptive flexfield segment.
266  * @param p_jei_information20 Developer Descriptive flexfield segment.
267  * @param p_jei_information21 Developer Descriptive flexfield segment.
268  * @param p_jei_information22 Developer Descriptive flexfield segment.
269  * @param p_jei_information23 Developer Descriptive flexfield segment.
270  * @param p_jei_information24 Developer Descriptive flexfield segment.
271  * @param p_jei_information25 Developer Descriptive flexfield segment.
272  * @param p_jei_information26 Developer Descriptive flexfield segment.
273  * @param p_jei_information27 Developer Descriptive flexfield segment.
274  * @param p_jei_information28 Developer Descriptive flexfield segment.
275  * @param p_jei_information29 Developer Descriptive flexfield segment.
276  * @param p_jei_information30 Developer Descriptive flexfield segment.
277  * @rep:displayname Update Job Extra Information
278  * @rep:category BUSINESS_ENTITY PER_JOB
279  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
280  * @rep:scope public
281  * @rep:lifecycle active
282  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
283 */
284 --
285 -- {End Of Comments}
286 --
287 procedure update_job_extra_info
288   (p_validate                     in     boolean  default false
289   ,p_job_extra_info_id            in     number
290   ,p_object_version_number        in out nocopy number
291   ,p_jei_attribute_category       in     varchar2 default hr_api.g_varchar2
292   ,p_jei_attribute1               in     varchar2 default hr_api.g_varchar2
293   ,p_jei_attribute2               in     varchar2 default hr_api.g_varchar2
294   ,p_jei_attribute3               in     varchar2 default hr_api.g_varchar2
295   ,p_jei_attribute4               in     varchar2 default hr_api.g_varchar2
296   ,p_jei_attribute5               in     varchar2 default hr_api.g_varchar2
297   ,p_jei_attribute6               in     varchar2 default hr_api.g_varchar2
298   ,p_jei_attribute7               in     varchar2 default hr_api.g_varchar2
299   ,p_jei_attribute8               in     varchar2 default hr_api.g_varchar2
300   ,p_jei_attribute9               in     varchar2 default hr_api.g_varchar2
301   ,p_jei_attribute10              in     varchar2 default hr_api.g_varchar2
302   ,p_jei_attribute11              in     varchar2 default hr_api.g_varchar2
303   ,p_jei_attribute12              in     varchar2 default hr_api.g_varchar2
304   ,p_jei_attribute13              in     varchar2 default hr_api.g_varchar2
305   ,p_jei_attribute14              in     varchar2 default hr_api.g_varchar2
306   ,p_jei_attribute15              in     varchar2 default hr_api.g_varchar2
307   ,p_jei_attribute16              in     varchar2 default hr_api.g_varchar2
308   ,p_jei_attribute17              in     varchar2 default hr_api.g_varchar2
309   ,p_jei_attribute18              in     varchar2 default hr_api.g_varchar2
310   ,p_jei_attribute19              in     varchar2 default hr_api.g_varchar2
311   ,p_jei_attribute20              in     varchar2 default hr_api.g_varchar2
312   ,p_jei_information_category     in     varchar2 default hr_api.g_varchar2
313   ,p_jei_information1             in     varchar2 default hr_api.g_varchar2
314   ,p_jei_information2             in     varchar2 default hr_api.g_varchar2
315   ,p_jei_information3             in     varchar2 default hr_api.g_varchar2
316   ,p_jei_information4             in     varchar2 default hr_api.g_varchar2
317   ,p_jei_information5             in     varchar2 default hr_api.g_varchar2
318   ,p_jei_information6             in     varchar2 default hr_api.g_varchar2
319   ,p_jei_information7             in     varchar2 default hr_api.g_varchar2
320   ,p_jei_information8             in     varchar2 default hr_api.g_varchar2
321   ,p_jei_information9             in     varchar2 default hr_api.g_varchar2
322   ,p_jei_information10            in     varchar2 default hr_api.g_varchar2
323   ,p_jei_information11            in     varchar2 default hr_api.g_varchar2
324   ,p_jei_information12            in     varchar2 default hr_api.g_varchar2
325   ,p_jei_information13            in     varchar2 default hr_api.g_varchar2
326   ,p_jei_information14            in     varchar2 default hr_api.g_varchar2
327   ,p_jei_information15            in     varchar2 default hr_api.g_varchar2
328   ,p_jei_information16            in     varchar2 default hr_api.g_varchar2
329   ,p_jei_information17            in     varchar2 default hr_api.g_varchar2
330   ,p_jei_information18            in     varchar2 default hr_api.g_varchar2
331   ,p_jei_information19            in     varchar2 default hr_api.g_varchar2
332   ,p_jei_information20            in     varchar2 default hr_api.g_varchar2
333   ,p_jei_information21            in     varchar2 default hr_api.g_varchar2
334   ,p_jei_information22            in     varchar2 default hr_api.g_varchar2
335   ,p_jei_information23            in     varchar2 default hr_api.g_varchar2
336   ,p_jei_information24            in     varchar2 default hr_api.g_varchar2
337   ,p_jei_information25            in     varchar2 default hr_api.g_varchar2
338   ,p_jei_information26            in     varchar2 default hr_api.g_varchar2
339   ,p_jei_information27            in     varchar2 default hr_api.g_varchar2
340   ,p_jei_information28            in     varchar2 default hr_api.g_varchar2
341   ,p_jei_information29            in     varchar2 default hr_api.g_varchar2
342   ,p_jei_information30            in     varchar2 default hr_api.g_varchar2
343   );
344 --
345 -- ----------------------------------------------------------------------------
346 -- |--------------------------< delete_job_extra_info >-----------------------|
347 -- ----------------------------------------------------------------------------
348 --
349 -- {Start Of Comments}
350 /*#
351  * This API deletes extra information for a job.
352  *
353  * Extra information provides the ability for users to easily extend and
354  * configure information the system holds about a particular job, allowing the
355  * system to capture multiple additional sets of structured data in relation to
356  * a specific parent job record. Extra information is based on descriptive
357  * flexfields and so the user must first define the job extra information
358  * flexfield structures, in terms of the number and type of segments for each
359  * structure, and any validation which should be applied to each segment. These
360  * structures correspond to extra information types. The user is then able to
361  * populate one or more instances of each of the predefined job extra
362  * information types (structures), for each of the jobs that they have set up
363  * on the system.
364  *
365  * <p><b>Licensing</b><br>
366  * This API is licensed for use with Human Resources.
367  *
368  * <p><b>Prerequisites</b><br>
369  * The job extra information must exist.
370  *
371  * <p><b>Post Success</b><br>
372  * The job extra information is deleted.
373  *
374  * <p><b>Post Failure</b><br>
375  * The job extra information is not deleted and an error is raised.
376  * @param p_validate If true, then validation alone will be performed and the
377  * database will remain unchanged. If false and all validation checks pass,
378  * then the database will be modified.
379  * @param p_job_extra_info_id Uniquely identifies the job extra information
380  * record to be deleted.
381  * @param p_object_version_number Current version number of the job extra
382  * information to be deleted.
383  * @rep:displayname Delete Job Extra Information
384  * @rep:category BUSINESS_ENTITY PER_JOB
385  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
386  * @rep:scope public
387  * @rep:lifecycle active
388  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
389 */
390 --
391 -- {End Of Comments}
392 --
393 procedure delete_job_extra_info
394   (p_validate                      	in     boolean  default false
395   ,p_job_extra_info_id        	in     number
396   ,p_object_version_number         	in     number
397   );
398 --
399 end per_job_extra_info_api;