1 Package hr_grade_rate_value_api as
2 /* $Header: pygrrapi.pkh 120.1 2005/10/02 02:31:40 aroussel $ */
3 /*#
4 * This package contains APIs that will maintain rate values for grades.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Grade Rate Value
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-------------------------< create_grade_rate_value >----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a grade rate value for a grade.
17 *
18 * You can assign a rate (such as an amount for overtime) to an employee based
19 * on their grade. You can define a rate as a specific value or a range of
20 * values.
21 *
22 * <p><b>Licensing</b><br>
23 * This API is licensed for use with Human Resources.
24 *
25 * <p><b>Prerequisites</b><br>
26 * When creating a rate value for a grade, a grade must exist on the start date
27 * of the rate value.
28 *
29 * <p><b>Post Success</b><br>
30 * A grade rate value will be created.
31 *
32 * <p><b>Post Failure</b><br>
33 * A grade rate value will not be created and an error will be raised.
34 * @param p_validate If true, then validation alone will be performed and the
35 * database will remain unchanged. If false and all validation checks pass,
36 * then the database will be modified.
37 * @param p_effective_date Determines when the DateTrack operation comes into
38 * force
39 * @param p_rate_id If p_validate is false, uniquely identifies the rate value
40 * id created. If p_validate is true, set to null.
41 * @param p_grade_id The grade for which this rate value applies
42 * @param p_currency_code For pay rates that have the unit of 'MONEY', this
43 * parameter must be set to a value from the column
44 * FND_CURRENCIES.CURRENCY_CODE.
45 * @param p_maximum The maximum value allowed for the rate value.
46 * @param p_mid_value The median value for the rate value. This does not have
47 * to be the mean of the minimum and maximum value, it can take any value
48 * between the two extremes.
49 * @param p_minimum The minimum value allowed for the rate value.
50 * @param p_value The explicit value for the rate value. Must be set if the
51 * minimum and maximum values are not set.
52 * @param p_sequence Must be set to the sequence of the grade to which the rate
53 * value is attached.
54 * @param p_grade_rule_id If p_validate is false, uniquely identifies the grade
55 * rate value created. If p_validate is true, set to null.
56 * @param p_object_version_number If p_validate is false, then set to the
57 * version number of the created grade rate value. If p_validate is true, then
58 * the value will be null.
59 * @param p_effective_start_date If p_validate is false, then set to the
60 * earliest effective start date for the created grade rate value. If
61 * p_validate is true, then set to null.
62 * @param p_effective_end_date If p_validate is false, then set to the
63 * effective end date for the created grade rate value. If p_validate is true,
64 * then set to null.
65 * @rep:displayname Create Grade Rate Value
66 * @rep:category BUSINESS_ENTITY PER_GRADE
67 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
68 * @rep:scope public
69 * @rep:lifecycle active
70 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
71 */
72 --
73 -- {End Of Comments}
74 --
75 procedure create_grade_rate_value
76 (p_validate in boolean default false
77 ,p_effective_date in date
78 ,p_rate_id in number
79 ,p_grade_id in number
80 ,p_currency_code in varchar2 default null
81 ,p_maximum in varchar2 default null
82 ,p_mid_value in varchar2 default null
83 ,p_minimum in varchar2 default null
84 ,p_value in varchar2 default null
85 ,p_sequence in number default null
86 ,p_grade_rule_id out nocopy number
87 ,p_object_version_number out nocopy number
88 ,p_effective_start_date out nocopy date
89 ,p_effective_end_date out nocopy date
90 );
91 --
92 -- ----------------------------------------------------------------------------
93 -- |-------------------------< update_grade_rate_value >----------------------|
94 -- ----------------------------------------------------------------------------
95 --
96 -- {Start Of Comments}
97 /*#
98 * This API updates a grade rate value for a grade.
99 *
100 * You can assign a rate (such as an amount for overtime) to an employee based
101 * on their grade. You can define a rate as a specific value or a range of
102 * values.
103 *
104 * <p><b>Licensing</b><br>
105 * This API is licensed for use with Human Resources.
106 *
107 * <p><b>Prerequisites</b><br>
108 * The grade rate value must exist on the effective date of the update.
109 *
110 * <p><b>Post Success</b><br>
111 * The grade rate value will be updated.
112 *
113 * <p><b>Post Failure</b><br>
114 * The grade rate value will not be updated and an error will be raised.
115 * @param p_validate If true, then validation alone will be performed and the
116 * database will remain unchanged. If false and all validation checks pass,
117 * then the database will be modified.
118 * @param p_effective_date Determines when the DateTrack operation comes into
119 * force
120 * @param p_datetrack_update_mode Indicates which DateTrack mode to use when
121 * updating the record. You must set to either UPDATE, CORRECTION,
122 * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
123 * particular record depend on the dates of previous record changes and the
124 * effective date of this change.
125 * @param p_grade_rule_id Uniquely identifies the grade rate value to be
126 * updated.
127 * @param p_currency_code For pay rates that have the unit of 'MONEY', this
128 * parameter must be set to a value from the column
129 * FND_CURRENCIES.CURRENCY_CODE.
130 * @param p_object_version_number Pass in the current version number of the
131 * grade rate value to be updated. When the API completes if p_validate is
132 * false, will be set to the new version number of the updated grade rate
133 * value. If p_validate is true will be set to the same value which was passed
134 * in.
135 * @param p_maximum The maximum value allowed for the rate value.
136 * @param p_mid_value The median value for the rate value. This does not have
137 * to be the mean of the minimum and maximum value, it can take any value
138 * between the two extremes.
139 * @param p_minimum The minimum value allowed for the rate value.
140 * @param p_value The explicit value for the rate value. Must be set if the
141 * minimum and maximum values are not set.
142 * @param p_sequence Must be set to the sequence of the grade to which the rate
143 * value is attached.
144 * @param p_effective_start_date If p_validate is false, then set to the
145 * effective start date on the updated grade rate value row which now exists as
146 * of the effective date. If p_validate is true, then set to null.
147 * @param p_effective_end_date If p_validate is false, then set to the
148 * effective end date on the updated grade rate value row which now exists as
149 * of the effective date. If p_validate is true, then set to null.
150 * @rep:displayname Update Grade Rate Value
151 * @rep:category BUSINESS_ENTITY PER_GRADE
152 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
153 * @rep:scope public
154 * @rep:lifecycle active
155 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
156 */
157 --
158 -- {End Of Comments}
159 --
160 procedure update_grade_rate_value
161 (p_validate in boolean default false
162 ,p_effective_date in date
163 ,p_datetrack_update_mode in varchar2
164 ,p_grade_rule_id in number
165 ,p_currency_code in varchar2 default hr_api.g_varchar2
166 ,p_object_version_number in out nocopy number
167 ,p_maximum in varchar2 default hr_api.g_varchar2
168 ,p_mid_value in varchar2 default hr_api.g_varchar2
169 ,p_minimum in varchar2 default hr_api.g_varchar2
170 ,p_value in varchar2 default hr_api.g_varchar2
171 ,p_sequence in number default hr_api.g_number
172 ,p_effective_start_date out nocopy date
173 ,p_effective_end_date out nocopy date
174 );
175 --
176 -- ----------------------------------------------------------------------------
177 -- |-------------------------< delete_grade_rate_value >----------------------|
178 -- ----------------------------------------------------------------------------
179 --
180 -- {Start Of Comments}
181 /*#
182 * The API deletes a grade rate value for a grade.
183 *
184 * You can assign a rate (such as an amount for overtime) to an employee based
185 * on their grade. You can define a rate as a specific value or a range of
186 * values.
187 *
188 * <p><b>Licensing</b><br>
189 * This API is licensed for use with Human Resources.
190 *
191 * <p><b>Prerequisites</b><br>
192 * The grade rate value must exist on the effective date of the delete.
193 *
194 * <p><b>Post Success</b><br>
195 * The grade rate value will be deleted.
196 *
197 * <p><b>Post Failure</b><br>
198 * The grade rate value will not be deleted and an error will be raised.
199 * @param p_validate If true, then validation alone will be performed and the
200 * database will remain unchanged. If false and all validation checks pass,
201 * then the database will be modified.
202 * @param p_effective_date Determines when the DateTrack operation comes into
203 * force
204 * @param p_datetrack_delete_mode Indicates which DateTrack mode to use when
205 * deleting the record. You must set to either ZAP, DELETE, FUTURE_CHANGE or
206 * DELETE_NEXT_CHANGE. Modes available for use with a particular record depend
207 * on the dates of previous record changes and the effective date of this
208 * change.
209 * @param p_grade_rule_id Uniquely identifies the grade rate value to be
210 * deleted.
211 * @param p_object_version_number Current version number of the grade rate
212 * value to be deleted.
213 * @param p_effective_start_date If p_validate is false, then set to the
214 * effective start date for the deleted grade rate value row which now exists
215 * as of the effective date. If p_validate is true or all row instances have
216 * been deleted then set to null.
217 * @param p_effective_end_date If p_validate is false, then set to the
218 * effective end date for the deleted grade rate value row which now exists as
219 * of the effective date. If p_validate is true or all row instances have been
220 * deleted then set to null.
221 * @rep:displayname Delete Grade Rate Value
222 * @rep:category BUSINESS_ENTITY PER_GRADE
223 * @rep:scope public
224 * @rep:lifecycle active
225 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
226 */
227 --
228 -- {End Of Comments}
229 --
230 procedure delete_grade_rate_value
231 (p_validate in boolean default false
232 ,p_effective_date in date
233 ,p_datetrack_delete_mode in varchar2
234 ,p_grade_rule_id in number
235 ,p_object_version_number in out nocopy number
236 ,p_effective_start_date out nocopy date
237 ,p_effective_end_date out nocopy date
238 );
239 end hr_grade_rate_value_api;
[Home] [Help]