1 Package hr_progression_point_api as
2 /* $Header: pepspapi.pkh 120.1 2005/10/02 02:22:39 aroussel $ */
3 /*#
4 * This package contains APIs that maintain points within pay scales.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Scale Point
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-------------------------< create_progression_point >---------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a new point within a pay scale.
17 *
18 * You can use any name for the point. The sequence of the points indicates how
19 * an employee will progress up the pay scale.
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 * A pay scale must exist before a point can be created within it.
26 *
27 * <p><b>Post Success</b><br>
28 * A point will be created within the pay scale.
29 *
30 * <p><b>Post Failure</b><br>
31 * A point will not be created within the pay scale and an error will be
32 * raised.
33 * @param p_validate If true, then validation alone will be performed and the
34 * database will remain unchanged. If false and all validation checks pass,
35 * then the database will be modified.
36 * @param p_effective_date Determines when the DateTrack operation comes into
37 * force.
38 * @param p_business_group_id Uniquely identifies the business group in which
39 * the pay scale point is created. Must match the business group of the parent
40 * pay scale.
41 * @param p_parent_spine_id Uniquely identifies the pay scale in which the
42 * point will be created.
43 * @param p_sequence The incremental order of this point within the pay scale.
44 * @param p_spinal_point The name or number of the progression point.
45 * @param p_request_id When the API is executed from a concurrent program set
46 * to the concurrent request identifier.
47 * @param p_program_application_id When the API is executed from a concurrent
48 * program set to the program's Application.
49 * @param p_program_id When the API is executed from a concurrent program set
50 * to the program's identifier.
51 * @param p_program_update_date When the API is executed from a concurrent
52 * program set to when the program was ran.
53 * @param p_information_category This context value determines which flexfield
54 * structure to use with the developer descriptive flexfield segments.
55 * @param p_information1 Developer descriptive flexfield segment.
56 * @param p_information2 Developer descriptive flexfield segment.
57 * @param p_information3 Developer descriptive flexfield segment.
58 * @param p_information4 Developer descriptive flexfield segment.
59 * @param p_information5 Developer descriptive flexfield segment.
60 * @param p_information6 Developer descriptive flexfield segment.
61 * @param p_information7 Developer descriptive flexfield segment.
62 * @param p_information8 Developer descriptive flexfield segment.
63 * @param p_information9 Developer descriptive flexfield segment.
64 * @param p_information10 Developer descriptive flexfield segment.
65 * @param p_information11 Developer descriptive flexfield segment.
66 * @param p_information12 Developer descriptive flexfield segment.
67 * @param p_information13 Developer descriptive flexfield segment.
68 * @param p_information14 Developer descriptive flexfield segment.
69 * @param p_information15 Developer descriptive flexfield segment.
70 * @param p_information16 Developer descriptive flexfield segment.
71 * @param p_information17 Developer descriptive flexfield segment.
72 * @param p_information18 Developer descriptive flexfield segment.
73 * @param p_information19 Developer descriptive flexfield segment.
74 * @param p_information20 Developer descriptive flexfield segment.
75 * @param p_information21 Developer descriptive flexfield segment.
76 * @param p_information22 Developer descriptive flexfield segment.
77 * @param p_information23 Developer descriptive flexfield segment.
78 * @param p_information24 Developer descriptive flexfield segment.
79 * @param p_information25 Developer descriptive flexfield segment.
80 * @param p_information26 Developer descriptive flexfield segment.
81 * @param p_information27 Developer descriptive flexfield segment.
82 * @param p_information28 Developer descriptive flexfield segment.
83 * @param p_information29 Developer descriptive flexfield segment.
84 * @param p_information30 Developer descriptive flexfield segment.
85 * @param p_spinal_point_id If p_validate is false, uniquely identifies the pay
86 * scale point created. If p_validate is true, set to null.
87 * @param p_object_version_number If p_validate is false, then set to the
88 * version number of the created pay scale point. If p_validate is true, then
89 * the value will be null.
90 * @rep:displayname Create Pay Scale Point
91 * @rep:category BUSINESS_ENTITY HR_PAY_SCALE
92 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
93 * @rep:scope public
94 * @rep:lifecycle active
95 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
96 */
97 --
98 -- {End Of Comments}
99 --
100 procedure create_progression_point
101 (p_validate in boolean default false
102 ,p_effective_date in date default null
103 ,p_business_group_id in number
104 ,p_parent_spine_id in number
105 ,p_sequence in number
106 ,p_spinal_point in varchar2
107 ,p_request_id in number default null
108 ,p_program_application_id in number default null
109 ,p_program_id in number default null
110 ,p_program_update_date in date default null
111 ,p_information_category in varchar2 default null
112 ,p_information1 in varchar2 default null
113 ,p_information2 in varchar2 default null
114 ,p_information3 in varchar2 default null
115 ,p_information4 in varchar2 default null
116 ,p_information5 in varchar2 default null
117 ,p_information6 in varchar2 default null
118 ,p_information7 in varchar2 default null
119 ,p_information8 in varchar2 default null
120 ,p_information9 in varchar2 default null
121 ,p_information10 in varchar2 default null
122 ,p_information11 in varchar2 default null
123 ,p_information12 in varchar2 default null
124 ,p_information13 in varchar2 default null
125 ,p_information14 in varchar2 default null
126 ,p_information15 in varchar2 default null
127 ,p_information16 in varchar2 default null
128 ,p_information17 in varchar2 default null
129 ,p_information18 in varchar2 default null
130 ,p_information19 in varchar2 default null
131 ,p_information20 in varchar2 default null
132 ,p_information21 in varchar2 default null
133 ,p_information22 in varchar2 default null
134 ,p_information23 in varchar2 default null
135 ,p_information24 in varchar2 default null
136 ,p_information25 in varchar2 default null
137 ,p_information26 in varchar2 default null
138 ,p_information27 in varchar2 default null
139 ,p_information28 in varchar2 default null
140 ,p_information29 in varchar2 default null
141 ,p_information30 in varchar2 default null
142 ,p_spinal_point_id out nocopy number
143 ,p_object_version_number out nocopy number
144 ) ;
145 --
146 -- ----------------------------------------------------------------------------
147 -- |-------------------------< update_progression_point >---------------------|
148 -- ----------------------------------------------------------------------------
149 --
150 -- {Start Of Comments}
151 /*#
152 * This API updates a point within a pay scale.
153 *
154 * You can use any name for the point. The sequence of the points indicates how
155 * an employee will progress up the pay scale.
156 *
157 * <p><b>Licensing</b><br>
158 * This API is licensed for use with Human Resources.
159 *
160 * <p><b>Prerequisites</b><br>
161 * The point must exist in the pay scale on the date of the update.
162 *
163 * <p><b>Post Success</b><br>
164 * A point will be updated.
165 *
166 * <p><b>Post Failure</b><br>
167 * A point will not be updated and an error will be raised.
168 * @param p_validate If true, then validation alone will be performed and the
169 * database will remain unchanged. If false and all validation checks pass,
170 * then the database will be modified.
171 * @param p_spinal_point_id Uniquely identifies the pay scale point to be
172 * updated.
173 * @param p_effective_date Determines when the DateTrack operation comes into
174 * force.
175 * @param p_business_group_id Uniquely identifies the business group in which
176 * the pay scale point is created. Must match the business group of the parent
177 * pay scale, and you cannot update it.
178 * @param p_parent_spine_id Uniquely identifies the pay scale in which the
179 * point will be created. You cannot update it.
180 * @param p_sequence The incremental order of this point within the pay scale.
181 * @param p_spinal_point The name or number of the progression point
182 * @param p_request_id When the API is executed from a concurrent program set
183 * to the concurrent request identifier.
184 * @param p_program_application_id When the API is executed from a concurrent
185 * program set to the program's Application.
186 * @param p_program_id When the API is executed from a concurrent program set
187 * to the program's identifier.
188 * @param p_program_update_date When the API is executed from a concurrent
189 * program set to when the program was ran.
190 * @param p_information_category This context value determines which flexfield
191 * structure to use with the developer descriptive flexfield segments.
192 * @param p_information1 Developer descriptive flexfield segment.
193 * @param p_information2 Developer descriptive flexfield segment.
194 * @param p_information3 Developer descriptive flexfield segment.
195 * @param p_information4 Developer descriptive flexfield segment.
196 * @param p_information5 Developer descriptive flexfield segment.
197 * @param p_information6 Developer descriptive flexfield segment.
198 * @param p_information7 Developer descriptive flexfield segment.
199 * @param p_information8 Developer descriptive flexfield segment.
200 * @param p_information9 Developer descriptive flexfield segment.
201 * @param p_information10 Developer descriptive flexfield segment.
202 * @param p_information11 Developer descriptive flexfield segment.
203 * @param p_information12 Developer descriptive flexfield segment.
204 * @param p_information13 Developer descriptive flexfield segment.
205 * @param p_information14 Developer descriptive flexfield segment.
206 * @param p_information15 Developer descriptive flexfield segment.
207 * @param p_information16 Developer descriptive flexfield segment.
208 * @param p_information17 Developer descriptive flexfield segment.
209 * @param p_information18 Developer descriptive flexfield segment.
210 * @param p_information19 Developer descriptive flexfield segment.
211 * @param p_information20 Developer descriptive flexfield segment.
212 * @param p_information21 Developer descriptive flexfield segment.
213 * @param p_information22 Developer descriptive flexfield segment.
214 * @param p_information23 Developer descriptive flexfield segment.
215 * @param p_information24 Developer descriptive flexfield segment.
216 * @param p_information25 Developer descriptive flexfield segment.
217 * @param p_information26 Developer descriptive flexfield segment.
218 * @param p_information27 Developer descriptive flexfield segment.
219 * @param p_information28 Developer descriptive flexfield segment.
220 * @param p_information29 Developer descriptive flexfield segment.
221 * @param p_information30 Developer descriptive flexfield segment.
222 * @param p_object_version_number Pass in the current version number of the pay
223 * scale point to be updated. When the API completes if p_validate is false,
224 * will be set to the new version number of the updated pay scale point. If
225 * p_validate is true will be set to the same value which was passed in.
226 * @rep:displayname Update Pay Scale Point
227 * @rep:category BUSINESS_ENTITY HR_PAY_SCALE
228 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
229 * @rep:scope public
230 * @rep:lifecycle active
231 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
232 */
233 --
234 -- {End Of Comments}
235 --
236 procedure update_progression_point
237 (p_validate in boolean default false
238 ,p_spinal_point_id in number
239 ,p_effective_date in date default hr_api.g_date
240 ,p_business_group_id in number default hr_api.g_number
241 ,p_parent_spine_id in number default hr_api.g_number
242 ,p_sequence in number default hr_api.g_number
243 ,p_spinal_point in varchar2 default hr_api.g_varchar2
244 ,p_request_id in number default hr_api.g_number
245 ,p_program_application_id in number default hr_api.g_number
246 ,p_program_id in number default hr_api.g_number
247 ,p_program_update_date in date default hr_api.g_date
248 ,p_information_category in varchar2 default hr_api.g_varchar2
249 ,p_information1 in varchar2 default hr_api.g_varchar2
250 ,p_information2 in varchar2 default hr_api.g_varchar2
251 ,p_information3 in varchar2 default hr_api.g_varchar2
252 ,p_information4 in varchar2 default hr_api.g_varchar2
253 ,p_information5 in varchar2 default hr_api.g_varchar2
254 ,p_information6 in varchar2 default hr_api.g_varchar2
255 ,p_information7 in varchar2 default hr_api.g_varchar2
256 ,p_information8 in varchar2 default hr_api.g_varchar2
257 ,p_information9 in varchar2 default hr_api.g_varchar2
258 ,p_information10 in varchar2 default hr_api.g_varchar2
259 ,p_information11 in varchar2 default hr_api.g_varchar2
260 ,p_information12 in varchar2 default hr_api.g_varchar2
261 ,p_information13 in varchar2 default hr_api.g_varchar2
262 ,p_information14 in varchar2 default hr_api.g_varchar2
263 ,p_information15 in varchar2 default hr_api.g_varchar2
264 ,p_information16 in varchar2 default hr_api.g_varchar2
265 ,p_information17 in varchar2 default hr_api.g_varchar2
266 ,p_information18 in varchar2 default hr_api.g_varchar2
267 ,p_information19 in varchar2 default hr_api.g_varchar2
268 ,p_information20 in varchar2 default hr_api.g_varchar2
269 ,p_information21 in varchar2 default hr_api.g_varchar2
270 ,p_information22 in varchar2 default hr_api.g_varchar2
271 ,p_information23 in varchar2 default hr_api.g_varchar2
272 ,p_information24 in varchar2 default hr_api.g_varchar2
273 ,p_information25 in varchar2 default hr_api.g_varchar2
274 ,p_information26 in varchar2 default hr_api.g_varchar2
275 ,p_information27 in varchar2 default hr_api.g_varchar2
276 ,p_information28 in varchar2 default hr_api.g_varchar2
277 ,p_information29 in varchar2 default hr_api.g_varchar2
278 ,p_information30 in varchar2 default hr_api.g_varchar2
279 ,p_object_version_number in out nocopy number
280 ) ;
281 --
282 -- ----------------------------------------------------------------------------
283 -- |-------------------------< delete_progression_point >---------------------|
284 -- ----------------------------------------------------------------------------
285 --
286 -- {Start Of Comments}
287 /*#
288 * This API deletes a point from a pay scale.
289 *
290 * You can use any name for the point. The sequence of the points indicates how
291 * an employee will progress up the pay scale.
292 *
293 * <p><b>Licensing</b><br>
294 * This API is licensed for use with Human Resources.
295 *
296 * <p><b>Prerequisites</b><br>
297 * The point must exist in the pay scale on the date of the delete. You cannot
298 * delete the pay scale point if any grade steps are associated with it.
299 *
300 * <p><b>Post Success</b><br>
301 * The point will be deleted.
302 *
303 * <p><b>Post Failure</b><br>
304 * The point will not be deleted and an error will be raised.
305 * @param p_validate If true, then validation alone will be performed and the
306 * database will remain unchanged. If false and all validation checks pass,
307 * then the database will be modified.
308 * @param p_spinal_point_id Uniquely identifies the pay scale point to be
309 * deleted.
310 * @param p_object_version_number Current version number of the pay scale point
311 * to be deleted.
312 * @rep:displayname Delete Pay Scale Point
313 * @rep:category BUSINESS_ENTITY HR_PAY_SCALE
314 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
315 * @rep:scope public
316 * @rep:lifecycle active
317 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
318 */
319 --
320 -- {End Of Comments}
321 --
322 procedure delete_progression_point
323 (p_validate in boolean default false
324 ,p_spinal_point_id in number
325 ,p_object_version_number in number
326 );
327
328 --
329 end hr_progression_point_api;
330 --
[Home] [Help]