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