[Home] [Help]
PACKAGE: APPS.HR_ELC_CANDIDATE_API
Source
1 Package hr_elc_candidate_api as
2 /* $Header: peecaapi.pkh 120.1 2005/10/02 02:15:09 aroussel $ */
3 /*#
4 * This package creates candidates for an election for a representative body.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Election Candidate
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |------------------------< create_election_candidate >---------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates candidates for an election for a representative body.
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 * Person must exist. Supplementary roles must already have been defined.
24 *
25 * <p><b>Post Success</b><br>
26 * Election Candidate is created.
27 *
28 * <p><b>Post Failure</b><br>
29 * Election candidate is not created and raises an error
30 * @param p_validate If true, then validation alone will be performed and the
31 * database will remain unchanged. If false and all validation checks pass,
32 * then the database will be modified.
33 * @param p_business_group_id Business group associated with the election
34 * candidate.
35 * @param p_person_id Uniquely identifies the person for whom you create the
36 * election candidate record.
37 * @param p_election_id Election id of the candidate.
38 * @param p_rank Rank of the candidate.
39 * @param p_role_id Role of the candidate.
40 * @param p_attribute_category This context value determines which flexfield
41 * structure to use with the descriptive flexfield segments.
42 * @param p_attribute1 Descriptive flexfield segment.
43 * @param p_attribute2 Descriptive flexfield segment.
44 * @param p_attribute3 Descriptive flexfield segment.
45 * @param p_attribute4 Descriptive flexfield segment.
46 * @param p_attribute5 Descriptive flexfield segment.
47 * @param p_attribute6 Descriptive flexfield segment.
48 * @param p_attribute7 Descriptive flexfield segment.
49 * @param p_attribute8 Descriptive flexfield segment.
50 * @param p_attribute9 Descriptive flexfield segment.
51 * @param p_attribute10 Descriptive flexfield segment.
52 * @param p_attribute11 Descriptive flexfield segment.
53 * @param p_attribute12 Descriptive flexfield segment.
54 * @param p_attribute13 Descriptive flexfield segment.
55 * @param p_attribute14 Descriptive flexfield segment.
56 * @param p_attribute15 Descriptive flexfield segment.
57 * @param p_attribute16 Descriptive flexfield segment.
58 * @param p_attribute17 Descriptive flexfield segment.
59 * @param p_attribute18 Descriptive flexfield segment.
60 * @param p_attribute19 Descriptive flexfield segment.
61 * @param p_attribute20 Descriptive flexfield segment.
62 * @param p_attribute21 Descriptive flexfield segment.
63 * @param p_attribute22 Descriptive flexfield segment.
64 * @param p_attribute23 Descriptive flexfield segment.
65 * @param p_attribute24 Descriptive flexfield segment.
66 * @param p_attribute25 Descriptive flexfield segment.
67 * @param p_attribute26 Descriptive flexfield segment.
68 * @param p_attribute27 Descriptive flexfield segment.
69 * @param p_attribute28 Descriptive flexfield segment.
70 * @param p_attribute29 Descriptive flexfield segment.
71 * @param p_attribute30 Descriptive flexfield segment.
72 * @param p_candidate_info_category This context value determines which
73 * flexfield structure to use with the candidate_information developer
74 * descriptive flexfield segments.
75 * @param p_candidate_information1 Developer descriptive flexfield
76 * @param p_candidate_information2 Developer descriptive flexfield
77 * @param p_candidate_information3 Developer descriptive flexfield
78 * @param p_candidate_information4 Developer descriptive flexfield
79 * @param p_candidate_information5 Developer descriptive flexfield
80 * @param p_candidate_information6 Developer descriptive flexfield
81 * @param p_candidate_information7 Developer descriptive flexfield
82 * @param p_candidate_information8 Developer descriptive flexfield
83 * @param p_candidate_information9 Developer descriptive flexfield
84 * @param p_candidate_information10 Developer descriptive flexfield
85 * @param p_candidate_information11 Developer descriptive flexfield
86 * @param p_candidate_information12 Developer descriptive flexfield
87 * @param p_candidate_information13 Developer descriptive flexfield
88 * @param p_candidate_information14 Developer descriptive flexfield
89 * @param p_candidate_information15 Developer descriptive flexfield
90 * @param p_candidate_information16 Developer descriptive flexfield
91 * @param p_candidate_information17 Developer descriptive flexfield
92 * @param p_candidate_information18 Developer descriptive flexfield
93 * @param p_candidate_information19 Developer descriptive flexfield
94 * @param p_candidate_information20 Developer descriptive flexfield
95 * @param p_candidate_information21 Developer descriptive flexfield
96 * @param p_candidate_information22 Developer descriptive flexfield
97 * @param p_candidate_information23 Developer descriptive flexfield
98 * @param p_candidate_information24 Developer descriptive flexfield
99 * @param p_candidate_information25 Developer descriptive flexfield
100 * @param p_candidate_information26 Developer descriptive flexfield
101 * @param p_candidate_information27 Developer descriptive flexfield
102 * @param p_candidate_information28 Developer descriptive flexfield
103 * @param p_candidate_information29 Developer descriptive flexfield
104 * @param p_candidate_information30 Developer descriptive flexfield
105 * @param p_election_candidate_id If p_validate is false, then this uniquely
106 * identifies the created election candidate. If p_validate is true, then set
107 * to null.
108 * @param p_object_version_number If p_validate is false, then set to the
109 * version number of the created Election Candidate. If p_validate is true,
110 * then the value will be null.
111 * @rep:displayname Create Election Candidate
112 * @rep:category BUSINESS_ENTITY PER_WORK_COUNCIL_ELECTION
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_election_candidate
122 (p_validate in boolean default false
123 ,p_business_group_id in number
124 ,p_person_id in number
125 ,p_election_id in number
126 ,p_rank in number
127 ,p_role_id in number
128 ,p_attribute_category in varchar2 default null
129 ,p_attribute1 in varchar2 default null
130 ,p_attribute2 in varchar2 default null
131 ,p_attribute3 in varchar2 default null
132 ,p_attribute4 in varchar2 default null
133 ,p_attribute5 in varchar2 default null
134 ,p_attribute6 in varchar2 default null
135 ,p_attribute7 in varchar2 default null
136 ,p_attribute8 in varchar2 default null
137 ,p_attribute9 in varchar2 default null
138 ,p_attribute10 in varchar2 default null
139 ,p_attribute11 in varchar2 default null
140 ,p_attribute12 in varchar2 default null
141 ,p_attribute13 in varchar2 default null
142 ,p_attribute14 in varchar2 default null
143 ,p_attribute15 in varchar2 default null
144 ,p_attribute16 in varchar2 default null
145 ,p_attribute17 in varchar2 default null
146 ,p_attribute18 in varchar2 default null
147 ,p_attribute19 in varchar2 default null
148 ,p_attribute20 in varchar2 default null
149 ,p_attribute21 in varchar2 default null
150 ,p_attribute22 in varchar2 default null
151 ,p_attribute23 in varchar2 default null
152 ,p_attribute24 in varchar2 default null
153 ,p_attribute25 in varchar2 default null
154 ,p_attribute26 in varchar2 default null
155 ,p_attribute27 in varchar2 default null
156 ,p_attribute28 in varchar2 default null
157 ,p_attribute29 in varchar2 default null
158 ,p_attribute30 in varchar2 default null
159 ,p_candidate_info_category in varchar2 default null
160 ,p_candidate_information1 in varchar2 default null
161 ,p_candidate_information2 in varchar2 default null
162 ,p_candidate_information3 in varchar2 default null
163 ,p_candidate_information4 in varchar2 default null
164 ,p_candidate_information5 in varchar2 default null
165 ,p_candidate_information6 in varchar2 default null
166 ,p_candidate_information7 in varchar2 default null
167 ,p_candidate_information8 in varchar2 default null
168 ,p_candidate_information9 in varchar2 default null
169 ,p_candidate_information10 in varchar2 default null
170 ,p_candidate_information11 in varchar2 default null
171 ,p_candidate_information12 in varchar2 default null
172 ,p_candidate_information13 in varchar2 default null
173 ,p_candidate_information14 in varchar2 default null
174 ,p_candidate_information15 in varchar2 default null
175 ,p_candidate_information16 in varchar2 default null
176 ,p_candidate_information17 in varchar2 default null
177 ,p_candidate_information18 in varchar2 default null
178 ,p_candidate_information19 in varchar2 default null
179 ,p_candidate_information20 in varchar2 default null
180 ,p_candidate_information21 in varchar2 default null
181 ,p_candidate_information22 in varchar2 default null
182 ,p_candidate_information23 in varchar2 default null
183 ,p_candidate_information24 in varchar2 default null
184 ,p_candidate_information25 in varchar2 default null
185 ,p_candidate_information26 in varchar2 default null
186 ,p_candidate_information27 in varchar2 default null
187 ,p_candidate_information28 in varchar2 default null
188 ,p_candidate_information29 in varchar2 default null
189 ,p_candidate_information30 in varchar2 default null
190 ,p_election_candidate_id out nocopy number
191 ,p_object_version_number out nocopy number
192 );
193 --
194 -- ----------------------------------------------------------------------------
195 -- |------------------------< update_election_candidate >---------------------|
196 -- ----------------------------------------------------------------------------
197 --
198 -- {Start Of Comments}
199 /*#
200 * This API updates an election candidate record.
201 *
202 * The record is identified by p_election_candidate_id and
203 * p_object_version_number.
204 *
205 * <p><b>Licensing</b><br>
206 * This API is licensed for use with Human Resources.
207 *
208 * <p><b>Prerequisites</b><br>
209 * Election candidate record must exist.
210 *
211 * <p><b>Post Success</b><br>
212 * Election candidate record is updated.
213 *
214 * <p><b>Post Failure</b><br>
215 * Election candidate record is not updated and returns an error
216 * @param p_validate If true, then validation alone will be performed and the
217 * database will remain unchanged. If false and all validation checks pass,
218 * then the database will be modified.
219 * @param p_election_candidate_id Identifies the election candidate record to
220 * modify.
221 * @param p_object_version_number Pass in the current version number of the
222 * election candidate to be updated. When the API completes if p_validate is
223 * false, will be set to the new version number of the updated election
224 * candidate. If p_validate is true will be set to the same value which was
225 * passed in..
226 * @param p_business_group_id Business group associated with the election
227 * candidate.
228 * @param p_person_id Person ID of the election candidate.
229 * @param p_election_id Election id of the candidate.
230 * @param p_rank Rank of the candidate.
231 * @param p_role_id Supplemenatry role of the candidate.
232 * @param p_attribute_category This context value determines which flexfield
233 * structure to use with the descriptive flexfield segments.
234 * @param p_attribute1 Descriptive flexfield segment.
235 * @param p_attribute2 Descriptive flexfield segment.
236 * @param p_attribute3 Descriptive flexfield segment.
237 * @param p_attribute4 Descriptive flexfield segment.
238 * @param p_attribute5 Descriptive flexfield segment.
239 * @param p_attribute6 Descriptive flexfield segment.
240 * @param p_attribute7 Descriptive flexfield segment.
241 * @param p_attribute8 Descriptive flexfield segment.
242 * @param p_attribute9 Descriptive flexfield segment.
243 * @param p_attribute10 Descriptive flexfield segment.
244 * @param p_attribute11 Descriptive flexfield segment.
245 * @param p_attribute12 Descriptive flexfield segment.
246 * @param p_attribute13 Descriptive flexfield segment.
247 * @param p_attribute14 Descriptive flexfield segment.
248 * @param p_attribute15 Descriptive flexfield segment.
249 * @param p_attribute16 Descriptive flexfield segment.
250 * @param p_attribute17 Descriptive flexfield segment.
251 * @param p_attribute18 Descriptive flexfield segment.
252 * @param p_attribute19 Descriptive flexfield segment.
253 * @param p_attribute20 Descriptive flexfield segment.
254 * @param p_attribute21 Descriptive flexfield segment.
255 * @param p_attribute22 Descriptive flexfield segment.
256 * @param p_attribute23 Descriptive flexfield segment.
257 * @param p_attribute24 Descriptive flexfield segment.
258 * @param p_attribute25 Descriptive flexfield segment.
259 * @param p_attribute26 Descriptive flexfield segment.
260 * @param p_attribute27 Descriptive flexfield segment.
261 * @param p_attribute28 Descriptive flexfield segment.
262 * @param p_attribute29 Descriptive flexfield segment.
263 * @param p_attribute30 Descriptive flexfield segment.
264 * @param p_candidate_info_category This context value determines which
265 * flexfield structure to use with the candidate_information developer
266 * descriptive flexfield segments.
267 * @param p_candidate_information1 Developer descriptive flexfield
268 * @param p_candidate_information2 Developer descriptive flexfield
269 * @param p_candidate_information3 Developer descriptive flexfield
270 * @param p_candidate_information4 Developer descriptive flexfield
271 * @param p_candidate_information5 Developer descriptive flexfield
272 * @param p_candidate_information6 Developer descriptive flexfield
273 * @param p_candidate_information7 Developer descriptive flexfield
274 * @param p_candidate_information8 Developer descriptive flexfield
275 * @param p_candidate_information9 Developer descriptive flexfield
276 * @param p_candidate_information10 Developer descriptive flexfield
277 * @param p_candidate_information11 Developer descriptive flexfield
278 * @param p_candidate_information12 Developer descriptive flexfield
279 * @param p_candidate_information13 Developer descriptive flexfield
280 * @param p_candidate_information14 Developer descriptive flexfield
281 * @param p_candidate_information15 Developer descriptive flexfield
282 * @param p_candidate_information16 Developer descriptive flexfield
283 * @param p_candidate_information17 Developer descriptive flexfield
284 * @param p_candidate_information18 Developer descriptive flexfield
285 * @param p_candidate_information19 Developer descriptive flexfield
286 * @param p_candidate_information20 Developer descriptive flexfield
287 * @param p_candidate_information21 Developer descriptive flexfield
288 * @param p_candidate_information22 Developer descriptive flexfield
289 * @param p_candidate_information23 Developer descriptive flexfield
290 * @param p_candidate_information24 Developer descriptive flexfield
291 * @param p_candidate_information25 Developer descriptive flexfield
292 * @param p_candidate_information26 Developer descriptive flexfield
293 * @param p_candidate_information27 Developer descriptive flexfield
294 * @param p_candidate_information28 Developer descriptive flexfield
295 * @param p_candidate_information29 Developer descriptive flexfield
296 * @param p_candidate_information30 Developer descriptive flexfield
297 * @rep:displayname Update Election Candidate
298 * @rep:category BUSINESS_ENTITY PER_WORK_COUNCIL_ELECTION
299 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
300 * @rep:scope public
301 * @rep:lifecycle active
302 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
303 */
304 --
305 -- {End Of Comments}
306 --
307 procedure update_election_candidate
308 (p_validate in boolean default false
309 ,p_election_candidate_id in number
310 ,p_object_version_number in out nocopy number
311 ,p_business_group_id in number default hr_api.g_number
312 ,p_person_id in number default hr_api.g_number
313 ,p_election_id in number default hr_api.g_number
314 ,p_rank in number default hr_api.g_number
315 ,p_role_id in number default hr_api.g_number
316 ,p_attribute_category in varchar2 default hr_api.g_varchar2
317 ,p_attribute1 in varchar2 default hr_api.g_varchar2
318 ,p_attribute2 in varchar2 default hr_api.g_varchar2
319 ,p_attribute3 in varchar2 default hr_api.g_varchar2
320 ,p_attribute4 in varchar2 default hr_api.g_varchar2
321 ,p_attribute5 in varchar2 default hr_api.g_varchar2
322 ,p_attribute6 in varchar2 default hr_api.g_varchar2
323 ,p_attribute7 in varchar2 default hr_api.g_varchar2
324 ,p_attribute8 in varchar2 default hr_api.g_varchar2
325 ,p_attribute9 in varchar2 default hr_api.g_varchar2
326 ,p_attribute10 in varchar2 default hr_api.g_varchar2
327 ,p_attribute11 in varchar2 default hr_api.g_varchar2
328 ,p_attribute12 in varchar2 default hr_api.g_varchar2
329 ,p_attribute13 in varchar2 default hr_api.g_varchar2
330 ,p_attribute14 in varchar2 default hr_api.g_varchar2
331 ,p_attribute15 in varchar2 default hr_api.g_varchar2
332 ,p_attribute16 in varchar2 default hr_api.g_varchar2
333 ,p_attribute17 in varchar2 default hr_api.g_varchar2
334 ,p_attribute18 in varchar2 default hr_api.g_varchar2
335 ,p_attribute19 in varchar2 default hr_api.g_varchar2
336 ,p_attribute20 in varchar2 default hr_api.g_varchar2
337 ,p_attribute21 in varchar2 default hr_api.g_varchar2
338 ,p_attribute22 in varchar2 default hr_api.g_varchar2
339 ,p_attribute23 in varchar2 default hr_api.g_varchar2
340 ,p_attribute24 in varchar2 default hr_api.g_varchar2
341 ,p_attribute25 in varchar2 default hr_api.g_varchar2
342 ,p_attribute26 in varchar2 default hr_api.g_varchar2
343 ,p_attribute27 in varchar2 default hr_api.g_varchar2
344 ,p_attribute28 in varchar2 default hr_api.g_varchar2
345 ,p_attribute29 in varchar2 default hr_api.g_varchar2
346 ,p_attribute30 in varchar2 default hr_api.g_varchar2
347 ,p_candidate_info_category in varchar2 default hr_api.g_varchar2
348 ,p_candidate_information1 in varchar2 default hr_api.g_varchar2
349 ,p_candidate_information2 in varchar2 default hr_api.g_varchar2
350 ,p_candidate_information3 in varchar2 default hr_api.g_varchar2
351 ,p_candidate_information4 in varchar2 default hr_api.g_varchar2
352 ,p_candidate_information5 in varchar2 default hr_api.g_varchar2
353 ,p_candidate_information6 in varchar2 default hr_api.g_varchar2
354 ,p_candidate_information7 in varchar2 default hr_api.g_varchar2
355 ,p_candidate_information8 in varchar2 default hr_api.g_varchar2
356 ,p_candidate_information9 in varchar2 default hr_api.g_varchar2
357 ,p_candidate_information10 in varchar2 default hr_api.g_varchar2
358 ,p_candidate_information11 in varchar2 default hr_api.g_varchar2
359 ,p_candidate_information12 in varchar2 default hr_api.g_varchar2
360 ,p_candidate_information13 in varchar2 default hr_api.g_varchar2
361 ,p_candidate_information14 in varchar2 default hr_api.g_varchar2
362 ,p_candidate_information15 in varchar2 default hr_api.g_varchar2
363 ,p_candidate_information16 in varchar2 default hr_api.g_varchar2
364 ,p_candidate_information17 in varchar2 default hr_api.g_varchar2
365 ,p_candidate_information18 in varchar2 default hr_api.g_varchar2
366 ,p_candidate_information19 in varchar2 default hr_api.g_varchar2
367 ,p_candidate_information20 in varchar2 default hr_api.g_varchar2
368 ,p_candidate_information21 in varchar2 default hr_api.g_varchar2
369 ,p_candidate_information22 in varchar2 default hr_api.g_varchar2
370 ,p_candidate_information23 in varchar2 default hr_api.g_varchar2
371 ,p_candidate_information24 in varchar2 default hr_api.g_varchar2
372 ,p_candidate_information25 in varchar2 default hr_api.g_varchar2
373 ,p_candidate_information26 in varchar2 default hr_api.g_varchar2
374 ,p_candidate_information27 in varchar2 default hr_api.g_varchar2
375 ,p_candidate_information28 in varchar2 default hr_api.g_varchar2
376 ,p_candidate_information29 in varchar2 default hr_api.g_varchar2
377 ,p_candidate_information30 in varchar2 default hr_api.g_varchar2
378 );
379 --
380 -- ----------------------------------------------------------------------------
381 -- |------------------------< delete_election_candidate >---------------------|
382 -- ----------------------------------------------------------------------------
383 --
384 -- {Start Of Comments}
385 /*#
386 * This API deletes an election candidate record.
387 *
388 * This API deletes a election candidate as identified by the in parameters
389 * p_election_candidate_id and p_object_version_number.
390 *
391 * <p><b>Licensing</b><br>
392 * This API is licensed for use with Human Resources.
393 *
394 * <p><b>Prerequisites</b><br>
395 * Election candidate must already exist.
396 *
397 * <p><b>Post Success</b><br>
398 * Election candidate is deleted.
399 *
400 * <p><b>Post Failure</b><br>
401 * Election candidate is not deleted and raises an error.
402 * @param p_validate If true, then validation alone will be performed and the
403 * database will remain unchanged. If false and all validation checks pass,
404 * then the database will be modified.
405 * @param p_election_candidate_id Identifies the election candidate record to
406 * delete.
407 * @param p_object_version_number Current version number of the election
408 * candidate record to be deleted.
409 * @rep:displayname Delete Election Candidate
410 * @rep:category BUSINESS_ENTITY PER_WORK_COUNCIL_ELECTION
411 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
412 * @rep:scope public
413 * @rep:lifecycle active
414 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
415 */
416 --
417 -- {End Of Comments}
418 --
419 procedure delete_election_candidate
420 (p_validate in boolean default false
421 ,p_election_candidate_id in number
422 ,p_object_version_number in out nocopy number
423 );
424
425 end hr_elc_candidate_api;