[Home] [Help]
PACKAGE: APPS.HR_ELECTIONS_API
Source
1 Package hr_elections_api as
2 /* $Header: peelcapi.pkh 120.1 2005/10/02 02:15:24 aroussel $ */
3 /*#
4 * This package contains APIs that create and maintain election information.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Election
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-----------------------< create_election_information >--------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates election information.
17 *
18 *
19 * <p><b>Licensing</b><br>
20 * This API is licensed for use with Human Resources.
21 *
22 * <p><b>Prerequisites</b><br>
23 * Organization with the classification of representative body should already
24 * exist.
25 *
26 * <p><b>Post Success</b><br>
27 * Election information is created.
28 *
29 * <p><b>Post Failure</b><br>
30 * Election information does not get created and error is returned.
31 * @param p_validate If true, then validation alone will be performed and the
32 * database will remain unchanged. If false and all validation checks pass,
33 * then the database will be modified.
34 * @param p_effective_date Reference date for validating lookup values are
35 * applicable during the start to end active date range. This date does not
36 * determine when the changes take effect.
37 * @param p_business_group_id Uniquely identifies the business group associated
38 * with the representative body.
39 * @param p_election_date The election date.
40 * @param p_description Description of the election.
41 * @param p_rep_body_id Uniquely identifies the representative body for which
42 * the election is taking place.
43 * @param p_previous_election_date Date of the previous election
44 * @param p_next_election_date Date of the next election
45 * @param p_result_publish_date Date on which the election results will be
46 * publshed.
47 * @param p_attribute_category This context value determines which flexfield
48 * structure to use with the descriptive flexfield segments.
49 * @param p_attribute1 Descriptive flexfield segment.
50 * @param p_attribute2 Descriptive flexfield segment.
51 * @param p_attribute3 Descriptive flexfield segment.
52 * @param p_attribute4 Descriptive flexfield segment.
53 * @param p_attribute5 Descriptive flexfield segment.
54 * @param p_attribute6 Descriptive flexfield segment.
55 * @param p_attribute7 Descriptive flexfield segment.
56 * @param p_attribute8 Descriptive flexfield segment.
57 * @param p_attribute9 Descriptive flexfield segment.
58 * @param p_attribute10 Descriptive flexfield segment.
59 * @param p_attribute11 Descriptive flexfield segment.
60 * @param p_attribute12 Descriptive flexfield segment.
61 * @param p_attribute13 Descriptive flexfield segment.
62 * @param p_attribute14 Descriptive flexfield segment.
63 * @param p_attribute15 Descriptive flexfield segment.
64 * @param p_attribute16 Descriptive flexfield segment.
65 * @param p_attribute17 Descriptive flexfield segment.
66 * @param p_attribute18 Descriptive flexfield segment.
67 * @param p_attribute19 Descriptive flexfield segment.
68 * @param p_attribute20 Descriptive flexfield segment.
69 * @param p_attribute21 Descriptive flexfield segment.
70 * @param p_attribute22 Descriptive flexfield segment.
71 * @param p_attribute23 Descriptive flexfield segment.
72 * @param p_attribute24 Descriptive flexfield segment.
73 * @param p_attribute25 Descriptive flexfield segment.
74 * @param p_attribute26 Descriptive flexfield segment.
75 * @param p_attribute27 Descriptive flexfield segment.
76 * @param p_attribute28 Descriptive flexfield segment.
77 * @param p_attribute29 Descriptive flexfield segment.
78 * @param p_attribute30 Descriptive flexfield segment.
79 * @param p_election_info_category This context value determines which
80 * flexfield structure to use with the developer descriptive flexfield
81 * segments.
82 * @param p_election_information1 Developers descriptive flexfield.
83 * @param p_election_information2 Developers descriptive flexfield.
84 * @param p_election_information3 Developers descriptive flexfield.
85 * @param p_election_information4 Developers descriptive flexfield.
86 * @param p_election_information5 Developers descriptive flexfield.
87 * @param p_election_information6 Developers descriptive flexfield.
88 * @param p_election_information7 Developers descriptive flexfield.
89 * @param p_election_information8 Developers descriptive flexfield.
90 * @param p_election_information9 Developers descriptive flexfield.
91 * @param p_election_information10 Developers descriptive flexfield.
92 * @param p_election_information11 Developers descriptive flexfield.
93 * @param p_election_information12 Developers descriptive flexfield.
94 * @param p_election_information13 Developers descriptive flexfield.
95 * @param p_election_information14 Developers descriptive flexfield.
96 * @param p_election_information15 Developers descriptive flexfield.
97 * @param p_election_information16 Developers descriptive flexfield.
98 * @param p_election_information17 Developers descriptive flexfield.
99 * @param p_election_information18 Developers descriptive flexfield.
100 * @param p_election_information19 Developers descriptive flexfield.
101 * @param p_election_information20 Developers descriptive flexfield.
102 * @param p_election_information21 Developers descriptive flexfield.
103 * @param p_election_information22 Developers descriptive flexfield.
104 * @param p_election_information23 Developers descriptive flexfield.
105 * @param p_election_information24 Developers descriptive flexfield.
106 * @param p_election_information25 Developers descriptive flexfield.
107 * @param p_election_information26 Developers descriptive flexfield.
108 * @param p_election_information27 Developers descriptive flexfield.
109 * @param p_election_information28 Developers descriptive flexfield.
110 * @param p_election_information29 Developers descriptive flexfield.
111 * @param p_election_information30 Developers descriptive flexfield.
112 * @param p_election_id If p_validate is false, then this uniquely identifies
113 * the election information record created. If p_validate is true, then set to
114 * null..
115 * @param p_object_version_number If p_validate is false, then set to the
116 * version number of the created election information record. If p_validate is
117 * true, then the value will be null.
118 * @rep:displayname Create Election Information
119 * @rep:category BUSINESS_ENTITY PER_WORK_COUNCIL_ELECTION
120 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
121 * @rep:scope public
122 * @rep:lifecycle active
123 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
124 */
125 --
126 -- {End Of Comments}
127 --
128 procedure create_election_information
129 (p_validate in boolean default false
130 ,p_effective_date in date
131 ,p_business_group_id in number
132 ,p_election_date in date
133 ,p_description in varchar2 default null
134 ,p_rep_body_id in number
135 ,p_previous_election_date in date default null
136 ,p_next_election_date in date default null
137 ,p_result_publish_date in date default null
138 ,p_attribute_category in varchar2 default null
139 ,p_attribute1 in varchar2 default null
140 ,p_attribute2 in varchar2 default null
141 ,p_attribute3 in varchar2 default null
142 ,p_attribute4 in varchar2 default null
143 ,p_attribute5 in varchar2 default null
144 ,p_attribute6 in varchar2 default null
145 ,p_attribute7 in varchar2 default null
146 ,p_attribute8 in varchar2 default null
147 ,p_attribute9 in varchar2 default null
148 ,p_attribute10 in varchar2 default null
149 ,p_attribute11 in varchar2 default null
150 ,p_attribute12 in varchar2 default null
151 ,p_attribute13 in varchar2 default null
152 ,p_attribute14 in varchar2 default null
153 ,p_attribute15 in varchar2 default null
154 ,p_attribute16 in varchar2 default null
155 ,p_attribute17 in varchar2 default null
156 ,p_attribute18 in varchar2 default null
157 ,p_attribute19 in varchar2 default null
158 ,p_attribute20 in varchar2 default null
159 ,p_attribute21 in varchar2 default null
160 ,p_attribute22 in varchar2 default null
161 ,p_attribute23 in varchar2 default null
162 ,p_attribute24 in varchar2 default null
163 ,p_attribute25 in varchar2 default null
164 ,p_attribute26 in varchar2 default null
165 ,p_attribute27 in varchar2 default null
166 ,p_attribute28 in varchar2 default null
167 ,p_attribute29 in varchar2 default null
168 ,p_attribute30 in varchar2 default null
169 ,p_election_info_category in varchar2 default null
170 ,p_election_information1 in varchar2 default null
171 ,p_election_information2 in varchar2 default null
172 ,p_election_information3 in varchar2 default null
173 ,p_election_information4 in varchar2 default null
174 ,p_election_information5 in varchar2 default null
175 ,p_election_information6 in varchar2 default null
176 ,p_election_information7 in varchar2 default null
177 ,p_election_information8 in varchar2 default null
178 ,p_election_information9 in varchar2 default null
179 ,p_election_information10 in varchar2 default null
180 ,p_election_information11 in varchar2 default null
181 ,p_election_information12 in varchar2 default null
182 ,p_election_information13 in varchar2 default null
183 ,p_election_information14 in varchar2 default null
184 ,p_election_information15 in varchar2 default null
185 ,p_election_information16 in varchar2 default null
186 ,p_election_information17 in varchar2 default null
187 ,p_election_information18 in varchar2 default null
188 ,p_election_information19 in varchar2 default null
189 ,p_election_information20 in varchar2 default null
190 ,p_election_information21 in varchar2 default null
191 ,p_election_information22 in varchar2 default null
192 ,p_election_information23 in varchar2 default null
193 ,p_election_information24 in varchar2 default null
194 ,p_election_information25 in varchar2 default null
195 ,p_election_information26 in varchar2 default null
196 ,p_election_information27 in varchar2 default null
197 ,p_election_information28 in varchar2 default null
198 ,p_election_information29 in varchar2 default null
199 ,p_election_information30 in varchar2 default null
200 ,p_election_id out nocopy number
201 ,p_object_version_number out nocopy number
202 );
203 --
204 -- ----------------------------------------------------------------------------
205 -- |-----------------------< update_election_information >--------------------|
206 -- ----------------------------------------------------------------------------
207 --
208 -- {Start Of Comments}
209 /*#
210 * This API updates election information.
211 *
212 *
213 * <p><b>Licensing</b><br>
214 * This API is licensed for use with Human Resources.
215 *
216 * <p><b>Prerequisites</b><br>
217 * Election Information should exist.
218 *
219 * <p><b>Post Success</b><br>
220 * Election Information is updated.
221 *
222 * <p><b>Post Failure</b><br>
223 * Election Information is not updated and error is returned.
224 * @param p_validate If true, then validation alone will be performed and the
225 * database will remain unchanged. If false and all validation checks pass,
226 * then the database will be modified.
227 * @param p_effective_date Reference date for validating lookup values are
228 * applicable during the start to end active date range. This date does not
229 * determine when the changes take effect.
230 * @param p_election_id If p_validate is false, uniquely identifies the updated
231 * election record. If p_validate is true, set to null.
232 * @param p_business_group_id Uniquely identifies the business group associated
233 * with the representative body.
234 * @param p_election_date Date of the election.
235 * @param p_description Description of the election process.
236 * @param p_rep_body_id Uniquely identifies the representative body for which
237 * the election is taking place.
238 * @param p_previous_election_date Date of the previous election.
239 * @param p_next_election_date Date of the next election.
240 * @param p_result_publish_date Date on which the election results will be
241 * publshed.
242 * @param p_attribute_category This context value determines which flexfield
243 * structure to use with the descriptive flexfield segments.
244 * @param p_attribute1 Descriptive flexfield segment.
245 * @param p_attribute2 Descriptive flexfield segment.
246 * @param p_attribute3 Descriptive flexfield segment.
247 * @param p_attribute4 Descriptive flexfield segment.
248 * @param p_attribute5 Descriptive flexfield segment.
249 * @param p_attribute6 Descriptive flexfield segment.
250 * @param p_attribute7 Descriptive flexfield segment.
251 * @param p_attribute8 Descriptive flexfield segment.
252 * @param p_attribute9 Descriptive flexfield segment.
253 * @param p_attribute10 Descriptive flexfield segment.
254 * @param p_attribute11 Descriptive flexfield segment.
255 * @param p_attribute12 Descriptive flexfield segment.
256 * @param p_attribute13 Descriptive flexfield segment.
257 * @param p_attribute14 Descriptive flexfield segment.
258 * @param p_attribute15 Descriptive flexfield segment.
259 * @param p_attribute16 Descriptive flexfield segment.
260 * @param p_attribute17 Descriptive flexfield segment.
261 * @param p_attribute18 Descriptive flexfield segment.
262 * @param p_attribute19 Descriptive flexfield segment.
263 * @param p_attribute20 Descriptive flexfield segment.
264 * @param p_attribute21 Descriptive flexfield segment.
265 * @param p_attribute22 Descriptive flexfield segment.
266 * @param p_attribute23 Descriptive flexfield segment.
267 * @param p_attribute24 Descriptive flexfield segment.
268 * @param p_attribute25 Descriptive flexfield segment.
269 * @param p_attribute26 Descriptive flexfield segment.
270 * @param p_attribute27 Descriptive flexfield segment.
271 * @param p_attribute28 Descriptive flexfield segment.
272 * @param p_attribute29 Descriptive flexfield segment.
273 * @param p_attribute30 Descriptive flexfield segment.
274 * @param p_election_info_category This context value determines which
275 * flexfield structure to use with the developer descriptive flexfield
276 * segments.
277 * @param p_election_information1 Developers descriptive flexfield.
278 * @param p_election_information2 Developers descriptive flexfield.
279 * @param p_election_information3 Developers descriptive flexfield.
280 * @param p_election_information4 Developers descriptive flexfield.
281 * @param p_election_information5 Developers descriptive flexfield.
282 * @param p_election_information6 Developers descriptive flexfield.
283 * @param p_election_information7 Developers descriptive flexfield.
284 * @param p_election_information8 Developers descriptive flexfield.
285 * @param p_election_information9 Developers descriptive flexfield.
286 * @param p_election_information10 Developers descriptive flexfield.
287 * @param p_election_information11 Developers descriptive flexfield.
288 * @param p_election_information12 Developers descriptive flexfield.
289 * @param p_election_information13 Developers descriptive flexfield.
290 * @param p_election_information14 Developers descriptive flexfield.
291 * @param p_election_information15 Developers descriptive flexfield.
292 * @param p_election_information16 Developers descriptive flexfield.
293 * @param p_election_information17 Developers descriptive flexfield.
294 * @param p_election_information18 Developers descriptive flexfield.
295 * @param p_election_information19 Developers descriptive flexfield.
296 * @param p_election_information20 Developers descriptive flexfield.
297 * @param p_election_information21 Developers descriptive flexfield.
298 * @param p_election_information22 Developers descriptive flexfield.
299 * @param p_election_information23 Developers descriptive flexfield.
300 * @param p_election_information24 Developers descriptive flexfield.
301 * @param p_election_information25 Developers descriptive flexfield.
302 * @param p_election_information26 Developers descriptive flexfield.
303 * @param p_election_information27 Developers descriptive flexfield.
304 * @param p_election_information28 Developers descriptive flexfield.
305 * @param p_election_information29 Developers descriptive flexfield.
306 * @param p_election_information30 Developers descriptive flexfield.
307 * @param p_object_version_number Pass in the current version number of the
308 * Election Information to be updated. When the API completes if p_validate is
309 * false, will be set to the new version number of the updated Election
310 * Information. If p_validate is true will be set to the same value which was
311 * passed in.
312 * @rep:displayname Update Election Information
313 * @rep:category BUSINESS_ENTITY PER_WORK_COUNCIL_ELECTION
314 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
315 * @rep:scope public
316 * @rep:lifecycle active
317 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
318 */
319 --
320 -- {End Of Comments}
321 --
322 procedure update_election_information
323 (p_validate in boolean default false
324 ,p_effective_date in date
325 ,p_election_id in out nocopy number
326 ,p_business_group_id in number
327 ,p_election_date in date
328 ,p_description in varchar2
329 ,p_rep_body_id in number
330 ,p_previous_election_date in date default hr_api.g_date
331 ,p_next_election_date in date default hr_api.g_date
332 ,p_result_publish_date in date default hr_api.g_date
333 ,p_attribute_category in varchar2 default hr_api.g_varchar2
334 ,p_attribute1 in varchar2 default hr_api.g_varchar2
335 ,p_attribute2 in varchar2 default hr_api.g_varchar2
336 ,p_attribute3 in varchar2 default hr_api.g_varchar2
337 ,p_attribute4 in varchar2 default hr_api.g_varchar2
338 ,p_attribute5 in varchar2 default hr_api.g_varchar2
339 ,p_attribute6 in varchar2 default hr_api.g_varchar2
340 ,p_attribute7 in varchar2 default hr_api.g_varchar2
341 ,p_attribute8 in varchar2 default hr_api.g_varchar2
342 ,p_attribute9 in varchar2 default hr_api.g_varchar2
343 ,p_attribute10 in varchar2 default hr_api.g_varchar2
344 ,p_attribute11 in varchar2 default hr_api.g_varchar2
345 ,p_attribute12 in varchar2 default hr_api.g_varchar2
346 ,p_attribute13 in varchar2 default hr_api.g_varchar2
347 ,p_attribute14 in varchar2 default hr_api.g_varchar2
348 ,p_attribute15 in varchar2 default hr_api.g_varchar2
349 ,p_attribute16 in varchar2 default hr_api.g_varchar2
350 ,p_attribute17 in varchar2 default hr_api.g_varchar2
351 ,p_attribute18 in varchar2 default hr_api.g_varchar2
352 ,p_attribute19 in varchar2 default hr_api.g_varchar2
353 ,p_attribute20 in varchar2 default hr_api.g_varchar2
354 ,p_attribute21 in varchar2 default hr_api.g_varchar2
355 ,p_attribute22 in varchar2 default hr_api.g_varchar2
356 ,p_attribute23 in varchar2 default hr_api.g_varchar2
357 ,p_attribute24 in varchar2 default hr_api.g_varchar2
358 ,p_attribute25 in varchar2 default hr_api.g_varchar2
359 ,p_attribute26 in varchar2 default hr_api.g_varchar2
360 ,p_attribute27 in varchar2 default hr_api.g_varchar2
361 ,p_attribute28 in varchar2 default hr_api.g_varchar2
362 ,p_attribute29 in varchar2 default hr_api.g_varchar2
363 ,p_attribute30 in varchar2 default hr_api.g_varchar2
364 ,p_election_info_category in varchar2 default hr_api.g_varchar2
365 ,p_election_information1 in varchar2 default hr_api.g_varchar2
366 ,p_election_information2 in varchar2 default hr_api.g_varchar2
367 ,p_election_information3 in varchar2 default hr_api.g_varchar2
368 ,p_election_information4 in varchar2 default hr_api.g_varchar2
369 ,p_election_information5 in varchar2 default hr_api.g_varchar2
370 ,p_election_information6 in varchar2 default hr_api.g_varchar2
371 ,p_election_information7 in varchar2 default hr_api.g_varchar2
372 ,p_election_information8 in varchar2 default hr_api.g_varchar2
373 ,p_election_information9 in varchar2 default hr_api.g_varchar2
374 ,p_election_information10 in varchar2 default hr_api.g_varchar2
375 ,p_election_information11 in varchar2 default hr_api.g_varchar2
376 ,p_election_information12 in varchar2 default hr_api.g_varchar2
377 ,p_election_information13 in varchar2 default hr_api.g_varchar2
378 ,p_election_information14 in varchar2 default hr_api.g_varchar2
379 ,p_election_information15 in varchar2 default hr_api.g_varchar2
380 ,p_election_information16 in varchar2 default hr_api.g_varchar2
381 ,p_election_information17 in varchar2 default hr_api.g_varchar2
382 ,p_election_information18 in varchar2 default hr_api.g_varchar2
383 ,p_election_information19 in varchar2 default hr_api.g_varchar2
384 ,p_election_information20 in varchar2 default hr_api.g_varchar2
385 ,p_election_information21 in varchar2 default hr_api.g_varchar2
386 ,p_election_information22 in varchar2 default hr_api.g_varchar2
387 ,p_election_information23 in varchar2 default hr_api.g_varchar2
388 ,p_election_information24 in varchar2 default hr_api.g_varchar2
389 ,p_election_information25 in varchar2 default hr_api.g_varchar2
390 ,p_election_information26 in varchar2 default hr_api.g_varchar2
391 ,p_election_information27 in varchar2 default hr_api.g_varchar2
392 ,p_election_information28 in varchar2 default hr_api.g_varchar2
393 ,p_election_information29 in varchar2 default hr_api.g_varchar2
394 ,p_election_information30 in varchar2 default hr_api.g_varchar2
395 ,p_object_version_number in out nocopy number
396 );
397 --
398 -- ----------------------------------------------------------------------------
399 -- |-----------------------< delete_election_information >--------------------|
400 -- ----------------------------------------------------------------------------
401 --
402 -- {Start Of Comments}
403 /*#
404 * This API deletes an election information record and stores the details.
405 *
406 *
407 * <p><b>Licensing</b><br>
408 * This API is licensed for use with Human Resources.
409 *
410 * <p><b>Prerequisites</b><br>
411 * Election iformation record should exist.
412 *
413 * <p><b>Post Success</b><br>
414 * Election information is deleted.
415 *
416 * <p><b>Post Failure</b><br>
417 * Election information is not deleted and error is returned.
418 * @param p_validate If true, then validation alone will be performed and the
419 * database will remain unchanged. If false and all validation checks pass,
420 * then the database will be modified.
421 * @param p_election_id Identifies the election record to delete..
422 * @param p_object_version_number Current version number of the Election
423 * Information to be deleted.
424 * @rep:displayname Delete Election Information
425 * @rep:category BUSINESS_ENTITY PER_WORK_COUNCIL_ELECTION
426 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
427 * @rep:scope public
428 * @rep:lifecycle active
429 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
430 */
431 --
432 -- {End Of Comments}
433 --
434 procedure delete_election_information
435 (p_validate in boolean default false
436 ,p_election_id in number
437 ,p_object_version_number in number
438 );
439 --
440 end hr_elections_api;