[Home] [Help]
PACKAGE: APPS.PQH_ROLE_EXTRA_INFO_API
Source
4 * This package contains role extra information APIs .
1 Package pqh_role_extra_info_api AUTHID CURRENT_USER as
2 /* $Header: pqreiapi.pkh 120.1 2005/10/02 02:27:16 aroussel $ */
3 /*#
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Role Extra Information
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |--------------------------< create_role_extra_info >----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates role extra information.
17 *
18 * The user can define as many extra information types as required to hold
19 * additional information about roles. Some predefined extra information types
20 * for roles are: French Public Sector Committee Rules, French Public Sector
21 * Committee Election, French Public Sector Committee Vote Rules, French Public
22 * Sector Establishments and Corps.
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 * The role for which the extra information is created must already exist. The
29 * role information type must already exist.
30 *
31 * <p><b>Post Success</b><br>
32 * The role extra information is successfully created in the database.
33 *
34 * <p><b>Post Failure</b><br>
35 * The role extra information is not created and an error 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_role_id The role for which the extra information applies.
40 * @param p_information_type Information type of the extra information stored
41 * for the role.
42 * @param p_attribute_category This context value determines which flexfield
43 * structure to use with the descriptive flexfield segments.
44 * @param p_attribute1 Descriptive flexfield segment.
45 * @param p_attribute2 Descriptive flexfield segment.
46 * @param p_attribute3 Descriptive flexfield segment.
47 * @param p_attribute4 Descriptive flexfield segment.
48 * @param p_attribute5 Descriptive flexfield segment.
49 * @param p_attribute6 Descriptive flexfield segment.
50 * @param p_attribute7 Descriptive flexfield segment.
51 * @param p_attribute8 Descriptive flexfield segment.
52 * @param p_attribute9 Descriptive flexfield segment.
53 * @param p_attribute10 Descriptive flexfield segment.
54 * @param p_attribute11 Descriptive flexfield segment.
55 * @param p_attribute12 Descriptive flexfield segment.
56 * @param p_attribute13 Descriptive flexfield segment.
57 * @param p_attribute14 Descriptive flexfield segment.
58 * @param p_attribute15 Descriptive flexfield segment.
59 * @param p_attribute16 Descriptive flexfield segment.
60 * @param p_attribute17 Descriptive flexfield segment.
61 * @param p_attribute18 Descriptive flexfield segment.
62 * @param p_attribute19 Descriptive flexfield segment.
63 * @param p_attribute20 Descriptive flexfield segment.
64 * @param p_attribute21 Descriptive flexfield segment.
65 * @param p_attribute22 Descriptive flexfield segment.
66 * @param p_attribute23 Descriptive flexfield segment.
67 * @param p_attribute24 Descriptive flexfield segment.
68 * @param p_attribute25 Descriptive flexfield segment.
69 * @param p_attribute26 Descriptive flexfield segment.
70 * @param p_attribute27 Descriptive flexfield segment.
71 * @param p_attribute28 Descriptive flexfield segment.
72 * @param p_attribute29 Descriptive flexfield segment.
73 * @param p_attribute30 Descriptive flexfield segment.
74 * @param p_information_category This context value determines which flexfield
75 * structure to use with the developer descriptive flexfield segments.
76 * @param p_information1 Developer descriptive flexfield segment.
77 * @param p_information2 Developer descriptive flexfield segment.
78 * @param p_information3 Developer descriptive flexfield segment.
79 * @param p_information4 Developer descriptive flexfield segment.
80 * @param p_information5 Developer descriptive flexfield segment.
81 * @param p_information6 Developer descriptive flexfield segment.
82 * @param p_information7 Developer descriptive flexfield segment.
83 * @param p_information8 Developer descriptive flexfield segment.
84 * @param p_information9 Developer descriptive flexfield segment.
85 * @param p_information10 Developer descriptive flexfield segment.
86 * @param p_information11 Developer descriptive flexfield segment.
87 * @param p_information12 Developer descriptive flexfield segment.
88 * @param p_information13 Developer descriptive flexfield segment.
89 * @param p_information14 Developer descriptive flexfield segment.
90 * @param p_information15 Developer descriptive flexfield segment.
91 * @param p_information16 Developer descriptive flexfield segment.
92 * @param p_information17 Developer descriptive flexfield segment.
93 * @param p_information18 Developer descriptive flexfield segment.
94 * @param p_information19 Developer descriptive flexfield segment.
95 * @param p_information20 Developer descriptive flexfield segment.
96 * @param p_information21 Developer descriptive flexfield segment.
97 * @param p_information22 Developer descriptive flexfield segment.
98 * @param p_information23 Developer descriptive flexfield segment.
99 * @param p_information24 Developer descriptive flexfield segment.
100 * @param p_information25 Developer descriptive flexfield segment.
101 * @param p_information26 Developer descriptive flexfield segment.
102 * @param p_information27 Developer descriptive flexfield segment.
103 * @param p_information28 Developer descriptive flexfield segment.
104 * @param p_information29 Developer descriptive flexfield segment.
105 * @param p_information30 Developer descriptive flexfield segment.
106 * @param p_role_extra_info_id If p_validate is false, uniquely identifies the
107 * role 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 role extra information. If p_validate is true,
110 * then the value will be null.
111 * @rep:displayname Create Role Extra Information
112 * @rep:category BUSINESS_ENTITY HR_ROLE
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_role_extra_info
122 (p_validate in boolean default false
123 ,p_role_id in number
124 ,p_information_type in varchar2
128 ,p_attribute3 in varchar2 default null
125 ,p_attribute_category in varchar2 default null
126 ,p_attribute1 in varchar2 default null
127 ,p_attribute2 in varchar2 default null
129 ,p_attribute4 in varchar2 default null
130 ,p_attribute5 in varchar2 default null
131 ,p_attribute6 in varchar2 default null
132 ,p_attribute7 in varchar2 default null
133 ,p_attribute8 in varchar2 default null
134 ,p_attribute9 in varchar2 default null
135 ,p_attribute10 in varchar2 default null
136 ,p_attribute11 in varchar2 default null
137 ,p_attribute12 in varchar2 default null
138 ,p_attribute13 in varchar2 default null
139 ,p_attribute14 in varchar2 default null
140 ,p_attribute15 in varchar2 default null
141 ,p_attribute16 in varchar2 default null
142 ,p_attribute17 in varchar2 default null
143 ,p_attribute18 in varchar2 default null
144 ,p_attribute19 in varchar2 default null
145 ,p_attribute20 in varchar2 default null
146 ,p_attribute21 in varchar2 default null
147 ,p_attribute22 in varchar2 default null
148 ,p_attribute23 in varchar2 default null
149 ,p_attribute24 in varchar2 default null
150 ,p_attribute25 in varchar2 default null
151 ,p_attribute26 in varchar2 default null
152 ,p_attribute27 in varchar2 default null
153 ,p_attribute28 in varchar2 default null
154 ,p_attribute29 in varchar2 default null
155 ,p_attribute30 in varchar2 default null
156 ,p_information_category in varchar2 default null
157 ,p_information1 in varchar2 default null
158 ,p_information2 in varchar2 default null
159 ,p_information3 in varchar2 default null
160 ,p_information4 in varchar2 default null
161 ,p_information5 in varchar2 default null
162 ,p_information6 in varchar2 default null
163 ,p_information7 in varchar2 default null
164 ,p_information8 in varchar2 default null
165 ,p_information9 in varchar2 default null
166 ,p_information10 in varchar2 default null
167 ,p_information11 in varchar2 default null
168 ,p_information12 in varchar2 default null
169 ,p_information13 in varchar2 default null
170 ,p_information14 in varchar2 default null
171 ,p_information15 in varchar2 default null
175 ,p_information19 in varchar2 default null
172 ,p_information16 in varchar2 default null
173 ,p_information17 in varchar2 default null
174 ,p_information18 in varchar2 default null
176 ,p_information20 in varchar2 default null
177 ,p_information21 in varchar2 default null
178 ,p_information22 in varchar2 default null
179 ,p_information23 in varchar2 default null
180 ,p_information24 in varchar2 default null
181 ,p_information25 in varchar2 default null
182 ,p_information26 in varchar2 default null
183 ,p_information27 in varchar2 default null
184 ,p_information28 in varchar2 default null
185 ,p_information29 in varchar2 default null
186 ,p_information30 in varchar2 default null
187 ,p_role_extra_info_id out nocopy number
188 ,p_object_version_number out nocopy number
189 );
190 --
191 -- ----------------------------------------------------------------------------
192 -- |--------------------------< update_role_extra_info >----------------------|
193 -- ----------------------------------------------------------------------------
194 --
195 -- {Start Of Comments}
196 /*#
197 * This API updates extra information for a given role.
198 *
199 * The API validates all the developer descriptive flexfield values and
200 * descriptive flexfield values before updating the role extra information.
201 *
202 * <p><b>Licensing</b><br>
203 * This API is licensed for use with Human Resources.
204 *
205 * <p><b>Prerequisites</b><br>
206 * The role extra information record must already exist. The role information
207 * type must already exist.
208 *
209 * <p><b>Post Success</b><br>
210 * The role extra information is updated successfully in the database.
211 *
212 * <p><b>Post Failure</b><br>
213 * The role extra information is not updated and an error is raised.
214 * @param p_validate If true, then validation alone will be performed and the
215 * database will remain unchanged. If false and all validation checks pass,
216 * then the database will be modified.
217 * @param p_role_extra_info_id Identifies the role extra information record to
218 * be modified
219 * @param p_object_version_number Pass in the current version number of the
220 * role extra information record to be updated. When the API completes if
221 * p_validate is false, will be set to the new version number of the updated
222 * role extra information record . If p_validate is true will be set to the
223 * same value which was passed in.
224 * @param p_attribute_category This context value determines which flexfield
225 * structure to use with the descriptive flexfield segments.
226 * @param p_attribute1 Descriptive flexfield segment.
227 * @param p_attribute2 Descriptive flexfield segment.
228 * @param p_attribute3 Descriptive flexfield segment.
229 * @param p_attribute4 Descriptive flexfield segment.
230 * @param p_attribute5 Descriptive flexfield segment.
231 * @param p_attribute6 Descriptive flexfield segment.
232 * @param p_attribute7 Descriptive flexfield segment.
233 * @param p_attribute8 Descriptive flexfield segment.
234 * @param p_attribute9 Descriptive flexfield segment.
235 * @param p_attribute10 Descriptive flexfield segment.
236 * @param p_attribute11 Descriptive flexfield segment.
237 * @param p_attribute12 Descriptive flexfield segment.
238 * @param p_attribute13 Descriptive flexfield segment.
239 * @param p_attribute14 Descriptive flexfield segment.
240 * @param p_attribute15 Descriptive flexfield segment.
241 * @param p_attribute16 Descriptive flexfield segment.
242 * @param p_attribute17 Descriptive flexfield segment.
243 * @param p_attribute18 Descriptive flexfield segment.
244 * @param p_attribute19 Descriptive flexfield segment.
248 * @param p_attribute23 Descriptive flexfield segment.
245 * @param p_attribute20 Descriptive flexfield segment.
246 * @param p_attribute21 Descriptive flexfield segment.
247 * @param p_attribute22 Descriptive flexfield segment.
249 * @param p_attribute24 Descriptive flexfield segment.
250 * @param p_attribute25 Descriptive flexfield segment.
251 * @param p_attribute26 Descriptive flexfield segment.
252 * @param p_attribute27 Descriptive flexfield segment.
253 * @param p_attribute28 Descriptive flexfield segment.
254 * @param p_attribute29 Descriptive flexfield segment.
255 * @param p_attribute30 Descriptive flexfield segment.
256 * @param p_information_category This context value determines which flexfield
257 * structure to use with the developer descriptive flexfield segments.
258 * @param p_information1 Developer descriptive flexfield segment.
259 * @param p_information2 Developer descriptive flexfield segment.
263 * @param p_information6 Developer descriptive flexfield segment.
260 * @param p_information3 Developer descriptive flexfield segment.
261 * @param p_information4 Developer descriptive flexfield segment.
262 * @param p_information5 Developer descriptive flexfield segment.
264 * @param p_information7 Developer descriptive flexfield segment.
265 * @param p_information8 Developer descriptive flexfield segment.
266 * @param p_information9 Developer descriptive flexfield segment.
267 * @param p_information10 Developer descriptive flexfield segment.
268 * @param p_information11 Developer descriptive flexfield segment.
269 * @param p_information12 Developer descriptive flexfield segment.
270 * @param p_information13 Developer descriptive flexfield segment.
271 * @param p_information14 Developer descriptive flexfield segment.
272 * @param p_information15 Developer descriptive flexfield segment.
273 * @param p_information16 Developer descriptive flexfield segment.
274 * @param p_information17 Developer descriptive flexfield segment.
275 * @param p_information18 Developer descriptive flexfield segment.
276 * @param p_information19 Developer descriptive flexfield segment.
277 * @param p_information20 Developer descriptive flexfield segment.
278 * @param p_information21 Developer descriptive flexfield segment.
279 * @param p_information22 Developer descriptive flexfield segment.
280 * @param p_information23 Developer descriptive flexfield segment.
281 * @param p_information24 Developer descriptive flexfield segment.
282 * @param p_information25 Developer descriptive flexfield segment.
283 * @param p_information26 Developer descriptive flexfield segment.
284 * @param p_information27 Developer descriptive flexfield segment.
285 * @param p_information28 Developer descriptive flexfield segment.
286 * @param p_information29 Developer descriptive flexfield segment.
287 * @param p_information30 Developer descriptive flexfield segment.
288 * @rep:displayname Update Role Extra Information
289 * @rep:category BUSINESS_ENTITY HR_ROLE
290 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
291 * @rep:scope public
292 * @rep:lifecycle active
293 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
294 */
295 --
296 -- {End Of Comments}
297 --
298 procedure update_role_extra_info
299 (p_validate in boolean default false
300 ,p_role_extra_info_id in number
301 ,p_object_version_number in out nocopy number
302 ,p_attribute_category in varchar2 default hr_api.g_varchar2
303 ,p_attribute1 in varchar2 default hr_api.g_varchar2
304 ,p_attribute2 in varchar2 default hr_api.g_varchar2
305 ,p_attribute3 in varchar2 default hr_api.g_varchar2
306 ,p_attribute4 in varchar2 default hr_api.g_varchar2
307 ,p_attribute5 in varchar2 default hr_api.g_varchar2
308 ,p_attribute6 in varchar2 default hr_api.g_varchar2
309 ,p_attribute7 in varchar2 default hr_api.g_varchar2
310 ,p_attribute8 in varchar2 default hr_api.g_varchar2
311 ,p_attribute9 in varchar2 default hr_api.g_varchar2
312 ,p_attribute10 in varchar2 default hr_api.g_varchar2
313 ,p_attribute11 in varchar2 default hr_api.g_varchar2
314 ,p_attribute12 in varchar2 default hr_api.g_varchar2
315 ,p_attribute13 in varchar2 default hr_api.g_varchar2
316 ,p_attribute14 in varchar2 default hr_api.g_varchar2
317 ,p_attribute15 in varchar2 default hr_api.g_varchar2
318 ,p_attribute16 in varchar2 default hr_api.g_varchar2
319 ,p_attribute17 in varchar2 default hr_api.g_varchar2
320 ,p_attribute18 in varchar2 default hr_api.g_varchar2
321 ,p_attribute19 in varchar2 default hr_api.g_varchar2
322 ,p_attribute20 in varchar2 default hr_api.g_varchar2
323 ,p_attribute21 in varchar2 default hr_api.g_varchar2
324 ,p_attribute22 in varchar2 default hr_api.g_varchar2
325 ,p_attribute23 in varchar2 default hr_api.g_varchar2
326 ,p_attribute24 in varchar2 default hr_api.g_varchar2
327 ,p_attribute25 in varchar2 default hr_api.g_varchar2
328 ,p_attribute26 in varchar2 default hr_api.g_varchar2
329 ,p_attribute27 in varchar2 default hr_api.g_varchar2
330 ,p_attribute28 in varchar2 default hr_api.g_varchar2
331 ,p_attribute29 in varchar2 default hr_api.g_varchar2
332 ,p_attribute30 in varchar2 default hr_api.g_varchar2
333 ,p_information_category in varchar2 default hr_api.g_varchar2
334 ,p_information1 in varchar2 default hr_api.g_varchar2
335 ,p_information2 in varchar2 default hr_api.g_varchar2
336 ,p_information3 in varchar2 default hr_api.g_varchar2
337 ,p_information4 in varchar2 default hr_api.g_varchar2
338 ,p_information5 in varchar2 default hr_api.g_varchar2
339 ,p_information6 in varchar2 default hr_api.g_varchar2
340 ,p_information7 in varchar2 default hr_api.g_varchar2
341 ,p_information8 in varchar2 default hr_api.g_varchar2
342 ,p_information9 in varchar2 default hr_api.g_varchar2
343 ,p_information10 in varchar2 default hr_api.g_varchar2
344 ,p_information11 in varchar2 default hr_api.g_varchar2
345 ,p_information12 in varchar2 default hr_api.g_varchar2
346 ,p_information13 in varchar2 default hr_api.g_varchar2
347 ,p_information14 in varchar2 default hr_api.g_varchar2
348 ,p_information15 in varchar2 default hr_api.g_varchar2
349 ,p_information16 in varchar2 default hr_api.g_varchar2
350 ,p_information17 in varchar2 default hr_api.g_varchar2
351 ,p_information18 in varchar2 default hr_api.g_varchar2
352 ,p_information19 in varchar2 default hr_api.g_varchar2
353 ,p_information20 in varchar2 default hr_api.g_varchar2
354 ,p_information21 in varchar2 default hr_api.g_varchar2
355 ,p_information22 in varchar2 default hr_api.g_varchar2
356 ,p_information23 in varchar2 default hr_api.g_varchar2
357 ,p_information24 in varchar2 default hr_api.g_varchar2
358 ,p_information25 in varchar2 default hr_api.g_varchar2
359 ,p_information26 in varchar2 default hr_api.g_varchar2
360 ,p_information27 in varchar2 default hr_api.g_varchar2
361 ,p_information28 in varchar2 default hr_api.g_varchar2
362 ,p_information29 in varchar2 default hr_api.g_varchar2
363 ,p_information30 in varchar2 default hr_api.g_varchar2
364 );
365 --
366 -- ----------------------------------------------------------------------------
367 -- |--------------------------< delete_role_extra_info >----------------------|
368 -- ----------------------------------------------------------------------------
369 --
370 -- {Start Of Comments}
371 /*#
372 * This API deletes extra information for a given role.
373 *
374 *
375 * <p><b>Licensing</b><br>
376 * This API is licensed for use with Human Resources.
377 *
378 * <p><b>Prerequisites</b><br>
379 * The role extra information record must already exist.
380 *
381 * <p><b>Post Success</b><br>
382 * The role extra information record is deleted successfully from the database.
383 *
384 * <p><b>Post Failure</b><br>
385 * The role extra information is not deleted and an error is raised.
386 * @param p_validate If true, then validation alone will be performed and the
387 * database will remain unchanged. If false and all validation checks pass,
388 * then the database will be modified.
389 * @param p_role_extra_info_id Identifies the role extra information record to
390 * be deleted.
391 * @param p_object_version_number Current version number of the role extra
392 * information to be deleted.
393 * @rep:displayname Delete Role Extra Information
394 * @rep:category BUSINESS_ENTITY HR_ROLE
395 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
396 * @rep:scope public
397 * @rep:lifecycle active
398 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
399 */
400 --
401 -- {End Of Comments}
402 --
403 procedure delete_role_extra_info
404 (p_validate in boolean default false
405 ,p_role_extra_info_id in number
406 ,p_object_version_number in number
407 );
408 --
409 end pqh_role_extra_info_api;