1 Package PQH_CRITERIA_RATE_DEFN_API AUTHID CURRENT_USER as
2 /* $Header: pqcrdapi.pkh 120.6 2006/03/14 11:28:41 srajakum noship $ */
3 /*#
4 * This package contains criteria rate definition APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Criteria rate definition
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |--------------------------< create_criteria_rate_defn >--------------------------|
12 -- ----------------------------------------------------------------------------
13 -- {Start Of Comments}
14 /*#
15 * This API creates a new criteria rate definition.
16 *
17 * The API allows the user to configure if they would like to define a maximum ,
18 * minimum , mid-value and default value when defining rates for a defining criteria
19 * rate definition.
20 *
21 * <p><b>Licensing</b><br>
22 * This API is licensed for use with Human Resources and HR Foundation.
23 *
24 * <p><b>Prerequisites</b><br>
25 * The business group in which the criteria rate definition is created must already
26 * exist.
27 *
28 * <p><b>Post Success</b><br>
32 * The criteria rate definition will not be created and error is raised.
29 * The criteria rate definition is created.
30 *
31 * <p><b>Post Failure</b><br>
33 *
34 * @param p_validate If true, then validation alone will be performed and
35 * the database will remain unchanged. If false and all validation checks pass,
36 * then the database will be modified.
37 * @param p_effective_date Reference date for validating lookup values are
38 * effective during the start to end active date range. This date does not
39 * determine when the changes take effect.
40 * @param p_business_group_id Business group of the criteria rate definition.
41 * @param p_criteria_rate_defn_id If p_validate is false, then this uniquely
42 * identifies the criteria rate definition created. If p_validate is true, then
43 * set to null.
44 * @param p_short_name Short name.
45 * @param p_name Name of the criteria rate definition.
46 * @param p_language_code Specifies to which language the translation
47 * values apply. You can set to the base or any installed language. The default
48 * value of hr_api.userenv_lang is equivalent to the RDBMS userenv('LANG')
49 * function value.
50 * @param p_uom Unit of measure. Valid values are defined by PQH_RBC_UOM
51 * lookup type.
52 * @param p_currency_code The currency for rates defined for this criteria
53 * rate definition.
54 * @param p_reference_period_cd The frequency of rate value defined for this criteria
55 * rate definition. Valid values are defined by PQH_RBC_REFERENCE_PERIOD lookup type.
56 * @param p_define_max_rate_flag Define maximum rate value. Valid values are defined
57 * by the PQH_YES_NO lookup type.
58 * @param p_define_min_rate_flag Define minimum rate value. Valid values are defined
59 * by the PQH_YES_NO lookup type.
60 * @param p_define_mid_rate_flag Define mid rate value. Valid values are defined
61 * by the PQH_YES_NO lookup type.
62 * @param p_define_std_rate_flag Define default rate value. Valid values are defined
63 * by the PQH_YES_NO lookup type.
64 * @param p_rate_calc_cd Rate calculation method. Valid values are defined by
65 * PQH_RBC_RATE_CALC_METHOD lookup type.
66 * @param p_rate_calc_rule Fast formula used for rate calculation.
67 * @param p_preferential_rate_cd Preferential rate calculation method. Valid values
68 * are defined by PQH_RBC_PEFERENTIAL_RATE lookup type.
69 * @param p_preferential_rate_rule Fast formual used to calculate preferential rate.
70 * @param p_rounding_cd Rounding method. Valid values are defined by
71 * PQH_RBC_ROUNDING lookup type.
72 * @param p_rounding_rule Fast formula used to perform rounding.
73 * @param p_legislation_code Legislation code of the criteria rate definition.
74 * @param p_attribute_category This context value determines which
75 * flexfield structure to use with the descriptive flexfield segments.
76 * @param p_attribute1 Descriptive flexfield segment.
77 * @param p_attribute2 Descriptive flexfield segment.
78 * @param p_attribute3 Descriptive flexfield segment.
79 * @param p_attribute4 Descriptive flexfield segment.
80 * @param p_attribute5 Descriptive flexfield segment.
81 * @param p_attribute6 Descriptive flexfield segment.
82 * @param p_attribute7 Descriptive flexfield segment.
83 * @param p_attribute8 Descriptive flexfield segment.
84 * @param p_attribute9 Descriptive flexfield segment.
85 * @param p_attribute10 Descriptive flexfield segment.
86 * @param p_attribute11 Descriptive flexfield segment.
87 * @param p_attribute12 Descriptive flexfield segment.
88 * @param p_attribute13 Descriptive flexfield segment.
89 * @param p_attribute14 Descriptive flexfield segment.
90 * @param p_attribute15 Descriptive flexfield segment.
91 * @param p_attribute16 Descriptive flexfield segment.
92 * @param p_attribute17 Descriptive flexfield segment.
93 * @param p_attribute18 Descriptive flexfield segment.
94 * @param p_attribute19 Descriptive flexfield segment.
95 * @param p_attribute20 Descriptive flexfield segment.
96 * @param p_attribute21 Descriptive flexfield segment.
97 * @param p_attribute22 Descriptive flexfield segment.
98 * @param p_attribute23 Descriptive flexfield segment.
99 * @param p_attribute24 Descriptive flexfield segment.
100 * @param p_attribute25 Descriptive flexfield segment.
101 * @param p_attribute26 Descriptive flexfield segment.
102 * @param p_attribute27 Descriptive flexfield segment.
103 * @param p_attribute28 Descriptive flexfield segment.
104 * @param p_attribute29 Descriptive flexfield segment.
105 * @param p_attribute30 Descriptive flexfield segment.
106 * @param p_object_version_number If p_validate is false, then set to
107 * the version number of the created criteria rate definition. If p_validate
108 * is true, then the value will be null.
109 * @rep:displayname Create criteria rate definition
110 * @rep:category BUSINESS_ENTITY PQH_RBC_RATE_MATRIX
111 * @rep:lifecycle active
112 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
113 * @rep:scope public
114 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
115 */
116 --
117 -- {End Of Comments}
118 --
119
120 procedure create_criteria_rate_defn
121 (
122 p_validate in boolean default false
123 ,p_effective_date in date
124 ,p_business_group_id in number
125 ,p_criteria_rate_defn_id out nocopy number
126 ,p_short_name in varchar2 default null
127 ,p_name in varchar2
128 ,p_language_code in varchar2 default hr_api.userenv_lang
129 ,p_uom in varchar2
130 ,p_currency_code in varchar2 default null
134 ,p_define_mid_rate_flag in varchar2 default null
131 ,p_reference_period_cd in varchar2 default null
132 ,p_define_max_rate_flag in varchar2 default null
133 ,p_define_min_rate_flag in varchar2 default null
135 ,p_define_std_rate_flag in varchar2 default null
136 ,p_rate_calc_cd in varchar2
137 ,p_rate_calc_rule in number default null
138 ,p_preferential_rate_cd in varchar2
139 ,p_preferential_rate_rule in number default null
140 ,p_rounding_cd in varchar2
141 ,p_rounding_rule in number default null
142 ,p_legislation_code in varchar2 default null
143 ,p_attribute_category in varchar2 default null
144 ,p_attribute1 in varchar2 default null
145 ,p_attribute2 in varchar2 default null
146 ,p_attribute3 in varchar2 default null
147 ,p_attribute4 in varchar2 default null
148 ,p_attribute5 in varchar2 default null
149 ,p_attribute6 in varchar2 default null
150 ,p_attribute7 in varchar2 default null
151 ,p_attribute8 in varchar2 default null
152 ,p_attribute9 in varchar2 default null
153 ,p_attribute10 in varchar2 default null
154 ,p_attribute11 in varchar2 default null
155 ,p_attribute12 in varchar2 default null
156 ,p_attribute13 in varchar2 default null
157 ,p_attribute14 in varchar2 default null
158 ,p_attribute15 in varchar2 default null
159 ,p_attribute16 in varchar2 default null
160 ,p_attribute17 in varchar2 default null
161 ,p_attribute18 in varchar2 default null
162 ,p_attribute19 in varchar2 default null
163 ,p_attribute20 in varchar2 default null
164 ,p_attribute21 in varchar2 default null
165 ,p_attribute22 in varchar2 default null
166 ,p_attribute23 in varchar2 default null
167 ,p_attribute24 in varchar2 default null
168 ,p_attribute25 in varchar2 default null
169 ,p_attribute26 in varchar2 default null
170 ,p_attribute27 in varchar2 default null
171 ,p_attribute28 in varchar2 default null
172 ,p_attribute29 in varchar2 default null
173 ,p_attribute30 in varchar2 default null
174 ,p_object_version_number out nocopy number
175 );
176 --
177 --
178 -- ----------------------------------------------------------------------------
179 -- |--------------------------< update_criteria_rate_defn >--------------------------|
180 -- ----------------------------------------------------------------------------
181 --
182 --
183 -- {Start Of Comments}
184 /*#
185 * This API updates details of an existing criteria rate definition.
186 *
187 * The currency code and frequency details are mandatory if the unit of measure
188 * is Money.
189 *
190 * <p><b>Licensing</b><br>
191 * This API is licensed for use with Human Resources and HR Foundation.
192 *
193 * <p><b>Prerequisites</b><br>
194 * The criteria rate definition details can be updated only if it is not already
195 * used in a rate matrix to define rates.
196 *
197 * <p><b>Post Success</b><br>
198 * The criteria rate definition details are successfully updated.
199 *
200 * <p><b>Post Failure</b><br>
201 * The criteria rate definition details will not be updated and error is raised.
202 *
203 * @param p_validate If true, then validation alone will be performed and
204 * the database will remain unchanged. If false and all validation checks pass,
205 * then the database will be modified.
206 * @param p_effective_date Reference date for validating lookup
207 * values are effective during the start to end active date range. This date does not
208 * determine when the changes take effect.
209 * @param p_business_group_id Business group of the criteria rate definition.
210 * @param p_criteria_rate_defn_id Uniquely identifies the criteria rate
211 * definition to be modified.
212 * @param p_short_name Short name.
213 * @param p_name Name of the criteria rate definition.
214 * @param p_language_code Specifies to which language the translation
215 * values apply. You can set to the base or any installed language. The default
216 * value of hr_api.userenv_lang is equivalent to the RDBMS userenv('LANG')
217 * function value.
218 * @param p_uom Unit of measure. Valid values are defined by PQH_RBC_UOM
219 * lookup type.
220 * @param p_currency_code The currency for rates defined for this criteria
221 * rate definition.
222 * @param p_reference_period_cd The frequency of rate value defined for this criteria
223 * rate definition. Valid values are defined by PQH_RBC_REFERENCE_PERIOD lookup type.
224 * @param p_define_max_rate_flag Define maximum rate value. Valid values are defined
225 * by the PQH_YES_NO lookup type.
226 * @param p_define_min_rate_flag Define minimum rate value. Valid values are defined
227 * by the PQH_YES_NO lookup type.
228 * @param p_define_mid_rate_flag Define mid rate value. Valid values are defined
229 * by the PQH_YES_NO lookup type.
230 * @param p_define_std_rate_flag Define default rate value. Valid values are defined
231 * by the PQH_YES_NO lookup type.
232 * @param p_rate_calc_cd Rate calculation method. Valid values are defined by
233 * PQH_RBC_RATE_CALC_METHOD lookup type.
234 * @param p_rate_calc_rule Fast formula used for rate calculation.
235 * @param p_preferential_rate_cd Preferential rate calculation method. Valid values
236 * are defined by PQH_RBC_PEFERENTIAL_RATE lookup type.
237 * @param p_preferential_rate_rule Fast formual used to calculate preferential rate.
238 * @param p_rounding_cd Rounding method. Valid values are defined by
239 * PQH_RBC_ROUNDING lookup type.
240 * @param p_rounding_rule Fast formula used to perform rounding.
241 * @param p_legislation_code Legislation code of the criteria rate definition.
242 * @param p_attribute_category This context value determines which
243 * flexfield 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_object_version_number Pass in the current version number of the criteria
275 * rate definition to be updated. When the API completes if p_validate is false, will be
276 * set to the new version number of the updated criteria rate definition. If p_validate
277 * is true will be set to the same value which was passed in.
278 * @rep:displayname Update criteria rate definition
279 * @rep:category BUSINESS_ENTITY PQH_RBC_RATE_MATRIX
280 * @rep:lifecycle active
281 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
282 * @rep:scope public
283 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
284 */
285 --
286 -- {End Of Comments}
287 --
288 --
289 procedure update_criteria_rate_defn
290 (p_validate in boolean default false
291 ,p_effective_date in date
292 ,p_business_group_id in number
293 ,p_criteria_rate_defn_id in number
294 ,p_short_name in varchar2 default hr_api.g_varchar2
295 ,p_name in varchar2
296 ,p_language_code in varchar2 default hr_api.userenv_lang
297 ,p_uom in varchar2
298 ,p_currency_code in varchar2 default hr_api.g_varchar2
299 ,p_reference_period_cd in varchar2 default hr_api.g_varchar2
300 ,p_define_max_rate_flag in varchar2 default hr_api.g_varchar2
301 ,p_define_min_rate_flag in varchar2 default hr_api.g_varchar2
302 ,p_define_mid_rate_flag in varchar2 default hr_api.g_varchar2
303 ,p_define_std_rate_flag in varchar2 default hr_api.g_varchar2
304 ,p_rate_calc_cd in varchar2
305 ,p_rate_calc_rule in number default hr_api.g_number
306 ,p_preferential_rate_cd in varchar2
307 ,p_preferential_rate_rule in number default hr_api.g_number
308 ,p_rounding_cd in varchar2
309 ,p_rounding_rule in number default hr_api.g_number
310 ,p_legislation_code in varchar2 default hr_api.g_varchar2
311 ,p_attribute_category in varchar2 default hr_api.g_varchar2
312 ,p_attribute1 in varchar2 default hr_api.g_varchar2
313 ,p_attribute2 in varchar2 default hr_api.g_varchar2
314 ,p_attribute3 in varchar2 default hr_api.g_varchar2
315 ,p_attribute4 in varchar2 default hr_api.g_varchar2
316 ,p_attribute5 in varchar2 default hr_api.g_varchar2
317 ,p_attribute6 in varchar2 default hr_api.g_varchar2
318 ,p_attribute7 in varchar2 default hr_api.g_varchar2
319 ,p_attribute8 in varchar2 default hr_api.g_varchar2
320 ,p_attribute9 in varchar2 default hr_api.g_varchar2
321 ,p_attribute10 in varchar2 default hr_api.g_varchar2
322 ,p_attribute11 in varchar2 default hr_api.g_varchar2
323 ,p_attribute12 in varchar2 default hr_api.g_varchar2
324 ,p_attribute13 in varchar2 default hr_api.g_varchar2
325 ,p_attribute14 in varchar2 default hr_api.g_varchar2
326 ,p_attribute15 in varchar2 default hr_api.g_varchar2
327 ,p_attribute16 in varchar2 default hr_api.g_varchar2
328 ,p_attribute17 in varchar2 default hr_api.g_varchar2
329 ,p_attribute18 in varchar2 default hr_api.g_varchar2
330 ,p_attribute19 in varchar2 default hr_api.g_varchar2
331 ,p_attribute20 in varchar2 default hr_api.g_varchar2
332 ,p_attribute21 in varchar2 default hr_api.g_varchar2
333 ,p_attribute22 in varchar2 default hr_api.g_varchar2
334 ,p_attribute23 in varchar2 default hr_api.g_varchar2
335 ,p_attribute24 in varchar2 default hr_api.g_varchar2
336 ,p_attribute25 in varchar2 default hr_api.g_varchar2
337 ,p_attribute26 in varchar2 default hr_api.g_varchar2
338 ,p_attribute27 in varchar2 default hr_api.g_varchar2
339 ,p_attribute28 in varchar2 default hr_api.g_varchar2
340 ,p_attribute29 in varchar2 default hr_api.g_varchar2
341 ,p_attribute30 in varchar2 default hr_api.g_varchar2
342 ,p_object_version_number in out nocopy number
343 );
344 --
345 -- ----------------------------------------------------------------------------
346 -- |--------------------------< delete_criteria_rate_defn >--------------------------|
347 -- ----------------------------------------------------------------------------
348 --
349 /*#
350 * This API deletes a criteria rate definition.
351 *
352 * Deleting a criteria rate definition removes a rate type for which rates can be defined
353 * from the current business group.
354 *
355 * <p><b>Licensing</b><br>
356 * This API is licensed for use with Human Resources and HR Foundation.
357 *
358 * <p><b>Prerequisites</b><br>
359 * This criteria rate definition must not be used as a rate factor for rate
360 * calculation by other criteria rate definitions in the business group. The criteria
361 * rate definition must not be used in any rate matrix to define rates.
362 *
363 * <p><b>Post Success</b><br>
364 * The criteria rate definition is deleted.
365 *
366 * <p><b>Post Failure</b><br>
367 * The criteria rate definition is not deleted and error is raised.
368 *
369 * @param p_validate If true, then validation alone will be performed and
370 * the database will remain unchanged. If false and all validation checks pass,
371 * then the database will be modified.
372 * @param p_effective_date Reference date for validating lookup values
373 * are applicable during the start to end active date range. This date does not
374 * determine when the changes take effect.
375 * @param p_criteria_rate_defn_id Identifies the criteria rate definition
376 * to be deleted.
377 * @param p_object_version_number Current version number of the criteria rate
378 * definition to be deleted.
379 * @rep:displayname Delete criteria rate definition
380 * @rep:category BUSINESS_ENTITY PQH_RBC_RATE_MATRIX
381 * @rep:lifecycle active
382 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
383 * @rep:scope public
384 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
385 */
386 --
387 -- {End Of Comments}
388 --
389
390 procedure delete_criteria_rate_defn
391 (p_validate in boolean default false
392 ,p_effective_date in date
393 ,p_criteria_rate_defn_id in number
394 ,p_object_version_number in number
395 );
396 --
397 end PQH_CRITERIA_RATE_DEFN_API;
[Home] [Help]