1 Package pqh_corps_extra_info_api as
2 /* $Header: pqceiapi.pkh 120.1 2005/10/02 02:26:26 aroussel $ */
3 /*#
4 * This package contains APIs to validate, create, update and delete corps
5 * extra information records.
6 * @rep:scope public
7 * @rep:product per
8 * @rep:displayname CORPS Extra Information for France
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |-------------------------< create_corps_extra_info >----------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API validates the inputs and creates a new corps extra information
18 * record.
19 *
20 * Validates the information entered for each of the seeded information types,
21 * also checks for uniqueness of data within an information type for a corps.
22 * The record is created in PQH_CORPS_EXTRA_INFO table
23 *
24 * <p><b>Licensing</b><br>
25 * This API is licensed for use with Human Resources.
26 *
27 * <p><b>Prerequisites</b><br>
28 * Corps must exist as of the effective date.
29 *
30 * <p><b>Post Success</b><br>
31 * A new corps extra information record is created in the database.
32 *
33 * <p><b>Post Failure</b><br>
34 * A corps extra information record is not created in the database and an error
35 * is raised
36 * @param p_validate If true, then validation alone will be performed and the
37 * database will remain unchanged. If false and all validation checks pass,
38 * then the database will be modified.
39 * @param p_effective_date Specifies the reference date for validating lookup
40 * values, applicable within the active date range. This date does not
41 * determine when the changes take effect.
42 * @param p_corps_extra_info_id The process returns the unique corps extra
43 * information identifier generated for each new record as a primary key
44 * @param p_corps_definition_id Corps definition identifier for the extra
45 * information. It is primary key of PQH_CORPS_DEFINITIONS
46 * @param p_information_type Identifies the type of information being provided.
47 * Valid values are DOCUMENT, EXAM, FILERE, ORGANIZATION and TRAINING.
48 * @param p_information1 Developer descriptive flexfield segment.
49 * @param p_information2 Developer descriptive flexfield segment.
50 * @param p_information3 Developer descriptive flexfield segment.
51 * @param p_information4 Developer descriptive flexfield segment.
52 * @param p_information5 Developer descriptive flexfield segment.
53 * @param p_information6 Developer descriptive flexfield segment.
54 * @param p_information7 Developer descriptive flexfield segment.
55 * @param p_information8 Developer descriptive flexfield segment.
56 * @param p_information9 Developer descriptive flexfield segment.
57 * @param p_information10 Developer descriptive flexfield segment.
58 * @param p_information11 Developer descriptive flexfield segment.
59 * @param p_information12 Developer descriptive flexfield segment.
60 * @param p_information13 Developer descriptive flexfield segment.
61 * @param p_information14 Developer descriptive flexfield segment.
62 * @param p_information15 Developer descriptive flexfield segment.
63 * @param p_information16 Developer descriptive flexfield segment.
64 * @param p_information17 Developer descriptive flexfield segment.
65 * @param p_information18 Developer descriptive flexfield segment.
66 * @param p_information19 Developer descriptive flexfield segment.
67 * @param p_information20 Developer descriptive flexfield segment.
68 * @param p_information21 Developer descriptive flexfield segment.
69 * @param p_information22 Developer descriptive flexfield segment.
70 * @param p_information23 Developer descriptive flexfield segment.
71 * @param p_information24 Developer descriptive flexfield segment.
72 * @param p_information25 Developer descriptive flexfield segment.
73 * @param p_information26 Developer descriptive flexfield segment.
74 * @param p_information27 Developer descriptive flexfield segment.
75 * @param p_information28 Developer descriptive flexfield segment.
76 * @param p_information29 Developer descriptive flexfield segment.
77 * @param p_information30 Developer descriptive flexfield segment.
78 * @param p_information_category This context value determines which flexfield
79 * structure to use with the developer descriptive flexfield segments.
80 * @param p_attribute1 Descriptive flexfield segment.
81 * @param p_attribute2 Descriptive flexfield segment.
82 * @param p_attribute3 Descriptive flexfield segment.
83 * @param p_attribute4 Descriptive flexfield segment.
84 * @param p_attribute5 Descriptive flexfield segment.
85 * @param p_attribute6 Descriptive flexfield segment.
86 * @param p_attribute7 Descriptive flexfield segment.
87 * @param p_attribute8 Descriptive flexfield segment.
88 * @param p_attribute9 Descriptive flexfield segment.
89 * @param p_attribute10 Descriptive flexfield segment.
90 * @param p_attribute11 Descriptive flexfield segment.
91 * @param p_attribute12 Descriptive flexfield segment.
92 * @param p_attribute13 Descriptive flexfield segment.
93 * @param p_attribute14 Descriptive flexfield segment.
94 * @param p_attribute15 Descriptive flexfield segment.
95 * @param p_attribute16 Descriptive flexfield segment.
96 * @param p_attribute17 Descriptive flexfield segment.
97 * @param p_attribute18 Descriptive flexfield segment.
98 * @param p_attribute19 Descriptive flexfield segment.
99 * @param p_attribute20 Descriptive flexfield segment.
100 * @param p_attribute21 Descriptive flexfield segment.
101 * @param p_attribute22 Descriptive flexfield segment.
102 * @param p_attribute23 Descriptive flexfield segment.
103 * @param p_attribute24 Descriptive flexfield segment.
104 * @param p_attribute25 Descriptive flexfield segment.
105 * @param p_attribute26 Descriptive flexfield segment.
106 * @param p_attribute27 Descriptive flexfield segment.
107 * @param p_attribute28 Descriptive flexfield segment.
108 * @param p_attribute29 Descriptive flexfield segment.
109 * @param p_attribute30 Descriptive flexfield segment.
110 * @param p_attribute_category This context value determines which flexfield
111 * structure to use with the descriptive flexfield segments.
112 * @param p_object_version_number If p_validate is false, the process returns
113 * the version number of the created corps extra information. If p_validate is
114 * true, it returns null
115 * @rep:displayname Create CORPS Extra Information
116 * @rep:category BUSINESS_ENTITY PQH_FR_CORPS
117 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
118 * @rep:scope public
119 * @rep:lifecycle active
120 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
121 */
122 --
123 -- {End Of Comments}
124 --
125 procedure create_corps_extra_info
126 (
127 p_validate in boolean default false
128 ,p_effective_date in date
129 ,p_corps_extra_info_id out nocopy number
130 ,p_corps_definition_id in number
131 ,p_information_type in varchar2
132 ,p_information1 in varchar2 default null
133 ,p_information2 in varchar2 default null
134 ,p_information3 in varchar2 default null
135 ,p_information4 in varchar2 default null
136 ,p_information5 in varchar2 default null
137 ,p_information6 in varchar2 default null
138 ,p_information7 in varchar2 default null
139 ,p_information8 in varchar2 default null
140 ,p_information9 in varchar2 default null
141 ,p_information10 in varchar2 default null
142 ,p_information11 in varchar2 default null
143 ,p_information12 in varchar2 default null
144 ,p_information13 in varchar2 default null
145 ,p_information14 in varchar2 default null
146 ,p_information15 in varchar2 default null
147 ,p_information16 in varchar2 default null
148 ,p_information17 in varchar2 default null
149 ,p_information18 in varchar2 default null
150 ,p_information19 in varchar2 default null
151 ,p_information20 in varchar2 default null
152 ,p_information21 in varchar2 default null
153 ,p_information22 in varchar2 default null
154 ,p_information23 in varchar2 default null
155 ,p_information24 in varchar2 default null
156 ,p_information25 in varchar2 default null
157 ,p_information26 in varchar2 default null
158 ,p_information27 in varchar2 default null
159 ,p_information28 in varchar2 default null
160 ,p_information29 in varchar2 default null
161 ,p_information30 in varchar2 default null
162 ,p_information_category in varchar2 default null
163 ,p_attribute1 in varchar2 default null
164 ,p_attribute2 in varchar2 default null
165 ,p_attribute3 in varchar2 default null
166 ,p_attribute4 in varchar2 default null
167 ,p_attribute5 in varchar2 default null
168 ,p_attribute6 in varchar2 default null
169 ,p_attribute7 in varchar2 default null
170 ,p_attribute8 in varchar2 default null
171 ,p_attribute9 in varchar2 default null
172 ,p_attribute10 in varchar2 default null
173 ,p_attribute11 in varchar2 default null
174 ,p_attribute12 in varchar2 default null
175 ,p_attribute13 in varchar2 default null
176 ,p_attribute14 in varchar2 default null
177 ,p_attribute15 in varchar2 default null
178 ,p_attribute16 in varchar2 default null
179 ,p_attribute17 in varchar2 default null
180 ,p_attribute18 in varchar2 default null
181 ,p_attribute19 in varchar2 default null
182 ,p_attribute20 in varchar2 default null
183 ,p_attribute21 in varchar2 default null
184 ,p_attribute22 in varchar2 default null
185 ,p_attribute23 in varchar2 default null
186 ,p_attribute24 in varchar2 default null
187 ,p_attribute25 in varchar2 default null
188 ,p_attribute26 in varchar2 default null
189 ,p_attribute27 in varchar2 default null
190 ,p_attribute28 in varchar2 default null
191 ,p_attribute29 in varchar2 default null
192 ,p_attribute30 in varchar2 default null
193 ,p_attribute_category in varchar2 default null
194 ,p_object_version_number out nocopy number
195 );
196 --
197 -- ----------------------------------------------------------------------------
198 -- |-------------------------< update_corps_extra_info >----------------------|
199 -- ----------------------------------------------------------------------------
200 --
201 -- {Start Of Comments}
202 /*#
203 * This API validates the record when an existing corps extra information
204 * record is changed and updates the record in the database.
205 *
206 * Validates the information entered for each of the seeded information types,
207 * also checks for uniqueness of data within an information type for a corps.
208 * The record is created in PQH_CORPS_EXTRA_INFO table
209 *
210 * <p><b>Licensing</b><br>
211 * This API is licensed for use with Human Resources.
212 *
213 * <p><b>Prerequisites</b><br>
214 * This corps extra information record must exist with the specified object
215 * version number.
216 *
217 * <p><b>Post Success</b><br>
218 * The existing corps extra information record is updated in the database.
219 *
220 * <p><b>Post Failure</b><br>
221 * The existing corps extra information record is not changed in the database
222 * and an error is raised
223 * @param p_validate If true, then validation alone will be performed and the
224 * database will remain unchanged. If false and all validation checks pass,
225 * then the database will be modified.
226 * @param p_effective_date Specifies the reference date for validating lookup
227 * values, applicable within the active date range. This date does not
228 * determine when the changes take effect.
229 * @param p_corps_extra_info_id Unique corps extra information identifier
230 * generated for each new record as a primary key
231 * @param p_corps_definition_id Corps definition identifier for the extra
232 * information being provided. It is primary key of PQH_CORPS_DEFINITIONS
233 * @param p_information_type Identifies the type of information being provided.
234 * Valid values are DOCUMENT, EXAM, FILERE, ORGANIZATION and TRAINING.
235 * @param p_information1 Developer descriptive flexfield segment.
236 * @param p_information2 Developer descriptive flexfield segment.
237 * @param p_information3 Developer descriptive flexfield segment.
238 * @param p_information4 Developer descriptive flexfield segment.
239 * @param p_information5 Developer descriptive flexfield segment.
240 * @param p_information6 Developer descriptive flexfield segment.
241 * @param p_information7 Developer descriptive flexfield segment.
242 * @param p_information8 Developer descriptive flexfield segment.
243 * @param p_information9 Developer descriptive flexfield segment.
244 * @param p_information10 Developer descriptive flexfield segment.
245 * @param p_information11 Developer descriptive flexfield segment.
246 * @param p_information12 Developer descriptive flexfield segment.
247 * @param p_information13 Developer descriptive flexfield segment.
248 * @param p_information14 Developer descriptive flexfield segment.
249 * @param p_information15 Developer descriptive flexfield segment.
250 * @param p_information16 Developer descriptive flexfield segment.
251 * @param p_information17 Developer descriptive flexfield segment.
252 * @param p_information18 Developer descriptive flexfield segment.
253 * @param p_information19 Developer descriptive flexfield segment.
254 * @param p_information20 Developer descriptive flexfield segment.
255 * @param p_information21 Developer descriptive flexfield segment.
256 * @param p_information22 Developer descriptive flexfield segment.
257 * @param p_information23 Developer descriptive flexfield segment.
258 * @param p_information24 Developer descriptive flexfield segment.
259 * @param p_information25 Developer descriptive flexfield segment.
260 * @param p_information26 Developer descriptive flexfield segment.
261 * @param p_information27 Developer descriptive flexfield segment.
262 * @param p_information28 Developer descriptive flexfield segment.
263 * @param p_information29 Developer descriptive flexfield segment.
264 * @param p_information30 Developer descriptive flexfield segment.
265 * @param p_information_category This context value determines which flexfield
266 * structure to use with the developer descriptive flexfield segments.
267 * @param p_attribute1 Descriptive flexfield segment.
268 * @param p_attribute2 Descriptive flexfield segment.
269 * @param p_attribute3 Descriptive flexfield segment.
270 * @param p_attribute4 Descriptive flexfield segment.
271 * @param p_attribute5 Descriptive flexfield segment.
272 * @param p_attribute6 Descriptive flexfield segment.
273 * @param p_attribute7 Descriptive flexfield segment.
274 * @param p_attribute8 Descriptive flexfield segment.
275 * @param p_attribute9 Descriptive flexfield segment.
276 * @param p_attribute10 Descriptive flexfield segment.
277 * @param p_attribute11 Descriptive flexfield segment.
278 * @param p_attribute12 Descriptive flexfield segment.
279 * @param p_attribute13 Descriptive flexfield segment.
280 * @param p_attribute14 Descriptive flexfield segment.
281 * @param p_attribute15 Descriptive flexfield segment.
282 * @param p_attribute16 Descriptive flexfield segment.
283 * @param p_attribute17 Descriptive flexfield segment.
284 * @param p_attribute18 Descriptive flexfield segment.
285 * @param p_attribute19 Descriptive flexfield segment.
286 * @param p_attribute20 Descriptive flexfield segment.
287 * @param p_attribute21 Descriptive flexfield segment.
288 * @param p_attribute22 Descriptive flexfield segment.
289 * @param p_attribute23 Descriptive flexfield segment.
290 * @param p_attribute24 Descriptive flexfield segment.
291 * @param p_attribute25 Descriptive flexfield segment.
292 * @param p_attribute26 Descriptive flexfield segment.
293 * @param p_attribute27 Descriptive flexfield segment.
294 * @param p_attribute28 Descriptive flexfield segment.
295 * @param p_attribute29 Descriptive flexfield segment.
296 * @param p_attribute30 Descriptive flexfield segment.
297 * @param p_attribute_category This context value determines which flexfield
298 * structure to use with the descriptive flexfield segments.
299 * @param p_object_version_number Passes the current version number of the
300 * corps extra information to be updated. When the API completes if p_validate
301 * is false, the process returns the new version number of the updated corps
302 * extra information If p_validate is true, it returns the same value which was
303 * passed in
304 * @rep:displayname Update CORPS Extra Information
305 * @rep:category BUSINESS_ENTITY PQH_FR_CORPS
306 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
307 * @rep:scope public
308 * @rep:lifecycle active
309 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
310 */
311 --
312 -- {End Of Comments}
313 --
314 procedure update_corps_extra_info
315 (
316 p_validate in boolean default false
317 ,p_effective_date in date
318 ,p_corps_extra_info_id in number
319 ,p_corps_definition_id in number default hr_api.g_number
320 ,p_information_type in varchar2 default hr_api.g_varchar2
321 ,p_information1 in varchar2 default hr_api.g_varchar2
322 ,p_information2 in varchar2 default hr_api.g_varchar2
323 ,p_information3 in varchar2 default hr_api.g_varchar2
324 ,p_information4 in varchar2 default hr_api.g_varchar2
325 ,p_information5 in varchar2 default hr_api.g_varchar2
326 ,p_information6 in varchar2 default hr_api.g_varchar2
327 ,p_information7 in varchar2 default hr_api.g_varchar2
328 ,p_information8 in varchar2 default hr_api.g_varchar2
329 ,p_information9 in varchar2 default hr_api.g_varchar2
330 ,p_information10 in varchar2 default hr_api.g_varchar2
331 ,p_information11 in varchar2 default hr_api.g_varchar2
332 ,p_information12 in varchar2 default hr_api.g_varchar2
333 ,p_information13 in varchar2 default hr_api.g_varchar2
334 ,p_information14 in varchar2 default hr_api.g_varchar2
335 ,p_information15 in varchar2 default hr_api.g_varchar2
336 ,p_information16 in varchar2 default hr_api.g_varchar2
337 ,p_information17 in varchar2 default hr_api.g_varchar2
338 ,p_information18 in varchar2 default hr_api.g_varchar2
339 ,p_information19 in varchar2 default hr_api.g_varchar2
340 ,p_information20 in varchar2 default hr_api.g_varchar2
341 ,p_information21 in varchar2 default hr_api.g_varchar2
342 ,p_information22 in varchar2 default hr_api.g_varchar2
343 ,p_information23 in varchar2 default hr_api.g_varchar2
344 ,p_information24 in varchar2 default hr_api.g_varchar2
345 ,p_information25 in varchar2 default hr_api.g_varchar2
346 ,p_information26 in varchar2 default hr_api.g_varchar2
347 ,p_information27 in varchar2 default hr_api.g_varchar2
348 ,p_information28 in varchar2 default hr_api.g_varchar2
349 ,p_information29 in varchar2 default hr_api.g_varchar2
350 ,p_information30 in varchar2 default hr_api.g_varchar2
351 ,p_information_category in varchar2 default hr_api.g_varchar2
352 ,p_attribute1 in varchar2 default hr_api.g_varchar2
353 ,p_attribute2 in varchar2 default hr_api.g_varchar2
354 ,p_attribute3 in varchar2 default hr_api.g_varchar2
355 ,p_attribute4 in varchar2 default hr_api.g_varchar2
356 ,p_attribute5 in varchar2 default hr_api.g_varchar2
357 ,p_attribute6 in varchar2 default hr_api.g_varchar2
358 ,p_attribute7 in varchar2 default hr_api.g_varchar2
359 ,p_attribute8 in varchar2 default hr_api.g_varchar2
360 ,p_attribute9 in varchar2 default hr_api.g_varchar2
361 ,p_attribute10 in varchar2 default hr_api.g_varchar2
362 ,p_attribute11 in varchar2 default hr_api.g_varchar2
363 ,p_attribute12 in varchar2 default hr_api.g_varchar2
364 ,p_attribute13 in varchar2 default hr_api.g_varchar2
365 ,p_attribute14 in varchar2 default hr_api.g_varchar2
366 ,p_attribute15 in varchar2 default hr_api.g_varchar2
367 ,p_attribute16 in varchar2 default hr_api.g_varchar2
368 ,p_attribute17 in varchar2 default hr_api.g_varchar2
369 ,p_attribute18 in varchar2 default hr_api.g_varchar2
370 ,p_attribute19 in varchar2 default hr_api.g_varchar2
371 ,p_attribute20 in varchar2 default hr_api.g_varchar2
372 ,p_attribute21 in varchar2 default hr_api.g_varchar2
373 ,p_attribute22 in varchar2 default hr_api.g_varchar2
374 ,p_attribute23 in varchar2 default hr_api.g_varchar2
375 ,p_attribute24 in varchar2 default hr_api.g_varchar2
376 ,p_attribute25 in varchar2 default hr_api.g_varchar2
377 ,p_attribute26 in varchar2 default hr_api.g_varchar2
378 ,p_attribute27 in varchar2 default hr_api.g_varchar2
379 ,p_attribute28 in varchar2 default hr_api.g_varchar2
380 ,p_attribute29 in varchar2 default hr_api.g_varchar2
381 ,p_attribute30 in varchar2 default hr_api.g_varchar2
382 ,p_attribute_category in varchar2 default hr_api.g_varchar2
383 ,p_object_version_number in out nocopy number
384 );
385 --
386 -- ----------------------------------------------------------------------------
387 -- |-------------------------< delete_corps_extra_info >----------------------|
388 -- ----------------------------------------------------------------------------
389 --
390 -- {Start Of Comments}
391 /*#
392 * This API deletes corps extra information records from the database.
393 *
394 * The record is deleted from PQH_CORPS_EXTRA_INFO table
395 *
396 * <p><b>Licensing</b><br>
397 * This API is licensed for use with Human Resources.
398 *
399 * <p><b>Prerequisites</b><br>
400 * This corps extra information must exist with the specified object version
401 * number.
402 *
403 * <p><b>Post Success</b><br>
404 * The corps extra information record is deleted from the database.
405 *
406 * <p><b>Post Failure</b><br>
407 * The corps extra information record is not deleted from the database and an
408 * error is raised
409 * @param p_validate If true, then validation alone will be performed and the
410 * database will remain unchanged. If false and all validation checks pass,
411 * then the database will be modified.
412 * @param p_corps_extra_info_id Corps definition identifier for the extra
413 * information being provided. It is the primary key of PQH_CORPS_DEFINITIONS
414 * table.
415 * @param p_object_version_number Current version number of the corps extra
416 * information record to be deleted
417 * @rep:displayname Delete CORPS Extra Information
418 * @rep:category BUSINESS_ENTITY PQH_FR_CORPS
419 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
420 * @rep:scope public
421 * @rep:lifecycle active
422 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
423 */
424 --
425 -- {End Of Comments}
426 --
427 procedure delete_corps_extra_info
428 (
429 p_validate in boolean default false
430 ,p_corps_extra_info_id in number
431 ,p_object_version_number in number
432 );
433 --
434 end pqh_corps_extra_info_api;
[Home] [Help]