DBA Data[Home] [Help]

PACKAGE: APPS.HR_ELC_RESULT_API

Source


1 Package hr_elc_result_api AUTHID CURRENT_USER as
2 /* $Header: peersapi.pkh 120.1 2005/10/02 02:16:48 aroussel $ */
3 /*#
4  * This API updates the election candidate record with the election results and
5  * creates roles for the candidates.
6  * @rep:scope public
7  * @rep:product per
8  * @rep:displayname Election Result
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |--------------------------< create_election_result >----------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17  * This API updates an election candidate role record with the results of an
18  * election.
19  *
20  *
21  * <p><b>Licensing</b><br>
22  * This API is licensed for use with Human Resources.
23  *
24  * <p><b>Prerequisites</b><br>
25  * Election Candidate and supplementary role must exist.
26  *
27  * <p><b>Post Success</b><br>
28  * Election candidate record updated with results.
29  *
30  * <p><b>Post Failure</b><br>
31  * Election candidate record is not updated with results and error is returned.
32  * @param p_validate If true, then validation alone will be performed and the
33  * database will remain unchanged. If false and all validation checks pass,
34  * then the database will be modified.
35  * @param p_effective_date Reference date for validating lookup values are
36  * applicable during the start to end active date range. This date does not
37  * determine when the changes take effect.
38  * @param p_job_id Uniquely identifies the Supplementary Role of the candidate.
39  * @param p_person_id Uniquely identifies the person (candidate) for whom the
40  * process enters election results.
41  * @param p_start_date Start date for the candidate's supplementary role.
42  * @param p_end_date End date for the candidate's suupplementary role.
43  * @param p_primary_contact_flag Flag specifying if this person is a primary
44  * contact for the representative body.
45  * @param p_election_candidate_id Uniquely identifies the election candidate
46  * record the process updates with election results.
47  * @param p_ovn_election_candidates Pass in the current version number of the
48  * election candidate role record to be updated with election results. When the
49  * API completes if p_validate is false, will be set to the new version number
50  * of the updated election candidate role. If p_validate is true will be set to
51  * the same value which was passed in.
52  * @param p_business_group_id Uniquely identifies the business group associated
53  * with the election candidate.
54  * @param p_election_id Uniquely identifies the election for which the process
55  * updates results.
56  * @param p_rank The rank of the candidate in the election.
57  * @param p_role_id If p_validate is false, then this uniquely identifies the
58  * created role for the candidate. If p_validate is true, then set to null.
59  * @param p_ovn_per_roles If p_validate is false, then set to the version
60  * number of the created role for the candidate. If p_validate is true, then
61  * the value will be null..
62  * @rep:displayname Create Election Result
63  * @rep:category BUSINESS_ENTITY PER_WORK_COUNCIL_ELECTION
64  * @rep:scope public
65  * @rep:lifecycle active
66  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
67 */
68 --
69 -- {End Of Comments}
70 --
71 procedure create_election_result
72   (p_validate                      in     boolean  default false
73   ,p_effective_date                in     date
74   ,p_job_id                        in     number
75   ,p_person_id                     in     number
76   ,p_start_date                    in     date
77   ,p_end_date                      in     date
78   ,p_primary_contact_flag          in     varchar2
79   ,p_election_candidate_id         in     number
80   ,p_ovn_election_candidates        in out nocopy number
81   ,p_business_group_id             in     number
82   ,p_election_id                   in     number
83   ,p_rank                          in     number
84   ,p_role_id                          out nocopy number
85   ,p_ovn_per_roles           out nocopy number
86   );
87 --
88 -- ----------------------------------------------------------------------------
89 -- |--------------------------< update_election_result >----------------------|
90 -- ----------------------------------------------------------------------------
91 --
92 -- {Start Of Comments}
93 /*#
94  * This API updates election result information in an election candidate role
95  * record.
96  *
97  *
98  * <p><b>Licensing</b><br>
99  * This API is licensed for use with Human Resources.
100  *
101  * <p><b>Prerequisites</b><br>
102  * Election result must already exist.
103  *
104  * <p><b>Post Success</b><br>
105  * Election Result updated.
106  *
107  * <p><b>Post Failure</b><br>
108  * Election result not updated and error returned.
109  * @param p_validate If true, then validation alone will be performed and the
110  * database will remain unchanged. If false and all validation checks pass,
111  * then the database will be modified.
112  * @param p_effective_date Reference date for validating lookup values are
113  * applicable during the start to end active date range. This date does not
114  * determine when the changes take effect.
115  * @param p_role_id Uniquely identifies the candidate's supplementary role
116  * (from per_roles).
117  * @param p_ovn_per_roles Pass in the current version number of the per_roles
118  * record to be updated. When the API completes if p_validate is false, will be
119  * set to the new version number of the updated per_roles record. If p_validate
120  * is true will be set to the same value which was passed in.
121  * @param p_job_id Uniquely identifies the supplementary role of the candidate.
122  * @param p_person_id Person ID of the election candidate.
123  * @param p_start_date Start date for the candidate's supplementary role.
124  * @param p_end_date End date for the candidate's suupplementary role.
125  * @param p_primary_contact_flag Flag specifying if this person is a primary
126  * contact for the representative body.
127  * @param p_election_candidate_id Uniquely identifies the election candidate
128  * record the process updates with election results.
129  * @param p_business_group_id Uniquely identifies the business group associated
130  * with the election candidate.
131  * @param p_election_id Election id
132  * @param p_ovn_election_candidates Pass in the current version number of the
133  * election candidate role record to be updated. When the API completes if
134  * p_validate is false, will be set to the new version number of the updated
135  * election candidate role record. If p_validate is true will be set to the
136  * same value which was passed in..
137  * @param p_rank Rank of the candidate in election.
138  * @rep:displayname Update Election Result
139  * @rep:category BUSINESS_ENTITY PER_WORK_COUNCIL_ELECTION
140  * @rep:scope public
141  * @rep:lifecycle active
142  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
143 */
144 --
145 -- {End Of Comments}
146 --
147 procedure update_election_result
148   (p_validate                      in     boolean  default false
149   ,p_effective_date                in     date
150   ,p_role_id                       in     number
151   ,p_ovn_per_roles                 in out nocopy number
152   ,p_job_id                        in     number   default hr_api.g_number
153   ,p_person_id                     in     number   default hr_api.g_number
154   ,p_start_date                    in     date     default hr_api.g_date
155   ,p_end_date                      in     date     default hr_api.g_date
156   ,p_primary_contact_flag          in     varchar2 default hr_api.g_varchar2
157   ,p_election_candidate_id         in     number   default hr_api.g_number
158   ,p_business_group_id             in     number   default hr_api.g_number
159   ,p_election_id                   in     number   default hr_api.g_number
160   ,p_ovn_election_candidates       in out nocopy number
161   ,p_rank                          in     number   default hr_api.g_number
162   );
163 --
164 end hr_elc_result_api;