1 Package PQH_RATE_FACTOR_ON_ELMNTS_API AUTHID CURRENT_USER as
2 /* $Header: pqrfeapi.pkh 120.2 2005/11/30 15:00:21 srajakum noship $ */
3 /*#
4 * This package contains rate factor on elements APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Rate Factor on Element
8 */
9
10 --
11 -- ----------------------------------------------------------------------------
12 -- |--------------------------< create_rate_factor_on_elmnt >--------------------------|
13 -- ----------------------------------------------------------------------------
14 -- {Start Of Comments}
15 --
16 /*#
17 * This API creates a new rate factor on element record.
18 *
19 * In addition to storing the person's rate value for a given criteria rate
20 * definition on its associated element, this API allows user to store the value of
21 * rate factors used in the rate calculation for a criteria rate definition. The rate
22 * factor value can be stored either as a input value to the element or as a entry
23 * value on the element entry record.
24 *
25 * <p><b>Licensing</b><br>
26 * This API is licensed for use with Human Resources and HR Foundation.
27 *
28 * <p><b>Prerequisites</b><br>
29 * The rate factor values for a given criteria rate definition can be stored
30 * as a input value or as a entry value on the element entry record only for the
31 * element types linked to the criteria rate definition.
32 *
33 * <p><b>Post Success</b><br>
34 * The rate factor on element record is created.
35 *
36 * <p><b>Post Failure</b><br>
37 * The rate factor on element record is not created and error is raised.
38 *
39 * @param p_validate If true, then validation alone will be performed and the
40 * database will remain unchanged. If false and all validation checks pass,
41 * then the database will be modified.
42 * @param p_effective_date p_effective_date Reference date for validating lookup values are
43 * effective during the start to end active date range. This date does not
44 * determine when the changes take effect.
45 * @param p_rate_factor_on_elmnt_id If p_validate is false, then this uniquely
46 * identifies the rate factor on element created. If p_validate is true, then set to null.
47 * @param p_criteria_rate_element_id Element type linked to a criteria rate definition.
48 * @param p_criteria_rate_factor_id Rate factor used to calculate the rate for a
49 * criteria rate deinition.
50 * @param p_rate_factor_val_record_tbl Table name where the rate factor value
51 * is stored. Valid values are identified by lookup type PQH_RBC_RT_FACTOR_ELMNT_TBL.
52 * @param p_rate_factor_val_record_col Column name where the rate factor
53 * value must be stored.
54 * @param p_business_group_id Business group of the rate factor on element.
55 * @param p_legislation_code Legislation of the rate factor on element.
56 * @param p_object_version_number If p_validate is false, then set to the
57 * version number of the created rate factor on element. If p_validate is true,
58 * then set to null.
59 * @rep:displayname Create rate factor on element
60 * @rep:category BUSINESS_ENTITY PQH_RBC_RATE_MATRIX
61 * @rep:lifecycle active
62 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
63 * @rep:scope public
64 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
65 */
66 --
67 -- {End Of Comments}
68 --
69
70 procedure create_rate_factor_on_elmnt
71 (p_validate in boolean default false
72 ,p_effective_date in date
73 ,p_rate_factor_on_elmnt_id out nocopy number
74 ,p_criteria_rate_element_id in number
75 ,p_criteria_rate_factor_id in number
76 ,p_rate_factor_val_record_tbl in varchar2
77 ,p_rate_factor_val_record_col in varchar2
78 ,p_business_group_id in number default null
79 ,p_legislation_code in varchar2 default null
80 ,p_object_version_number out nocopy number
81 );
82 --
83
84 --
85 -- ----------------------------------------------------------------------------
86 -- |--------------------------< update_rate_factor_on_elmnt >--------------------------|
87 -- ----------------------------------------------------------------------------
88 -- {Start Of Comments}
89 --
90 /*#
91 * This API updates a rate factor on element.
92 *
93 * In addition to storing the person's rate value for a given criteria rate
94 * definition on its associated element, this API allows user to store the value of
95 * rate factors used in the rate calculation for a criteria rate definition. The rate
96 * factor value can be stored either as a input value to the element or as a entry
97 * value on the element entry record.
98 *
99 * <p><b>Licensing</b><br>
100 * This API is licensed for use with Human Resources and HR Foundation.
101 *
102 * <p><b>Prerequisites</b><br>
103 * The rate factor values for a given criteria rate definition can be stored
104 * as a input value or as a entry value on the element entry record only for the
105 * element types linked to the criteria rate definition.
106 *
107 * <p><b>Post Success</b><br>
108 * The rate factor on element record is updated.
109 *
110 * <p><b>Post Failure</b><br>
111 * The rate factor on element record is not updated and error is raised.
112 *
113 * @param p_validate If true, then validation alone will be performed and the
114 * database will remain unchanged. If false and all validation checks pass,
115 * then the database will be modified.
116 * @param p_effective_date Reference date for validating lookup values are
117 * effective during the start to end active date range. This date does not
118 * determine when the changes take effect.
119 * @param p_rate_factor_on_elmnt_id Identifies the rate factor on element
120 * record to be modified.
121 * @param p_criteria_rate_element_id Element type linked to a criteria rate definition.
122 * @param p_criteria_rate_factor_id Rate factor used to calculate the rate for a
123 * criteria rate deinition.
124 * @param p_rate_factor_val_record_tbl Table name where the rate factor value
125 * is stored. Valid values are identified by lookup type PQH_RBC_RT_FACTOR_ELMNT_TBL.
126 * @param p_rate_factor_val_record_col Column name where the rate factor
127 * value must be stored.
128 * @param p_business_group_id Business group of the rate factor on element.
129 * @param p_legislation_code Legislation of the rate factor on element.
130 * @param p_object_version_number Pass in the current version number of the
131 * rate factor on element to be updated. When the API completes if p_validate is false,
132 * will be set to the new version number of the updated rate factor on element.
133 * If p_validate is true will be set to the same value which was passed in.
134 * @rep:displayname Update rate factor on element
135 * @rep:category BUSINESS_ENTITY PQH_RBC_RATE_MATRIX
136 * @rep:lifecycle active
137 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
138 * @rep:scope public
139 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
140 */
141 --
142 -- {End Of Comments}
143 --
144
145 procedure update_rate_factor_on_elmnt
146 (p_validate in boolean default false
147 ,p_effective_date in date
148 ,p_rate_factor_on_elmnt_id in number
149 ,p_criteria_rate_element_id in number default hr_api.g_number
150 ,p_criteria_rate_factor_id in number default hr_api.g_number
151 ,p_rate_factor_val_record_tbl in varchar2 default hr_api.g_varchar2
152 ,p_rate_factor_val_record_col in varchar2 default hr_api.g_varchar2
153 ,p_business_group_id in number default hr_api.g_number
154 ,p_legislation_code in varchar2 default hr_api.g_varchar2
155 ,p_object_version_number in out nocopy number
156 );
157 --
158
159 --
160 -- ----------------------------------------------------------------------------
161 -- |--------------------------< delete_rate_factor_on_elmnt >--------------------------|
162 -- ----------------------------------------------------------------------------
163 -- {Start Of Comments}
164 --
165 /*#
166 * This API deletes a rate factor on element.
167 *
168 * The API only deletes the information about where the rate factors used in the
169 * rate calculation for a criteria rate definition are stored. It does not delete
170 * the rate factor details.
171 *
172 * <p><b>Licensing</b><br>
173 * This API is licensed for use with Human Resources and HR Foundation.
174 *
175 * <p><b>Prerequisites</b><br>
176 * The rate factor on element information that is to be deleted must exist.
177 *
178 * <p><b>Post Success</b><br>
179 * The rate factor on element record is deleted.
180 *
181 * <p><b>Post Failure</b><br>
182 * The rate factor on element record is not deleted and error is raised.
183 *
184 * @param p_validate If true, then validation alone will be performed and the
185 * database will remain unchanged. If false and all validation checks pass,
186 * then the database will be modified.
187 * @param p_effective_date Reference date for validating lookup values
188 * are applicable during the start to end active date range. This date does not
189 * determine when the changes take effect.
190 * @param p_rate_factor_on_elmnt_id Identifies the rate factor on element
191 * record to be deleted.
192 * @param p_object_version_number Current version number of the rate
193 * factor on element to be deleted.
194 * @rep:displayname Delete rate factor on element
195 * @rep:category BUSINESS_ENTITY PQH_RBC_RATE_MATRIX
196 * @rep:lifecycle active
197 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
198 * @rep:scope public
199 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
200 */
201 --
202 -- {End Of Comments}
203 --
204
205 procedure delete_rate_factor_on_elmnt
206 (p_validate in boolean default false
207 ,p_effective_date in date
208 ,p_rate_factor_on_elmnt_id in number
209 ,p_object_version_number in number
210 );
211
212
213 --
214
215 end PQH_RATE_FACTOR_ON_ELMNTS_API;
216
[Home] [Help]