[Home] [Help]
PACKAGE: APPS.HR_SALARY_BASIS_API
Source
1 Package hr_salary_basis_api as
2 /* $Header: peppbapi.pkh 120.1 2005/10/02 02:21:58 aroussel $ */
3 /*#
4 * This package contains APIs to create and maintain a salary basis.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Salary Basis
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |---------------------------< create_salary_basis >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a new Salary Basis.
17 *
18 * Salary basis specifies the duration the enterprise uses to quote a salary
19 * for an assignment. Salary basis is a combination of pay basis, annualization
20 * factor, and element input value. Optionally, you can link salary basis to a
21 * Grade Rate.
22 *
23 * <p><b>Licensing</b><br>
24 * This API is licensed for use with Human Resources.
25 *
26 * <p><b>Prerequisites</b><br>
27 * Input value for which the basis is set up must exist. Also Define Pay Basis
28 * Flexfield - Additional Salary Basis Details.
29 *
30 * <p><b>Post Success</b><br>
31 * Creates the salary basis record in the database.
32 *
33 * <p><b>Post Failure</b><br>
34 * The API does not create the salary basis and raises an error.
35 * @param p_validate If true, then validation alone will be performed and the
36 * database will remain unchanged. If false and all validation checks pass,
37 * then the database will be modified.
38 * @param p_business_group_id Serves as a foreign key to HR_ORGANIZATION_UNITS.
39 * Uniquely identifies the business group for which the salary basis is
40 * created.
41 * @param p_input_value_id {@rep:casecolumn PER_PAY_BASES.INPUT_VALUE_ID}
42 * @param p_rate_id {@rep:casecolumn PER_PAY_BASES.RATE_ID}
43 * @param p_name Unique name of the pay basis the process creates.
44 * @param p_pay_basis The time basis for recording actual salary values, such
45 * as Annual, Monthly, or Hourly. Valid values are identified by the
46 * 'PAY_BASIS' lookup type.
47 * @param p_rate_basis {@rep:casecolumn PER_PAY_BASES.RATE_BASIS}
48 * @param p_pay_annualization_factor {@rep:casecolumn
49 * PER_PAY_BASES.PAY_ANNUALIZATION_FACTOR}
50 * @param p_grade_annualization_factor {@rep:casecolumn
51 * PER_PAY_BASES.GRADE_ANNUALIZATION_FACTOR}
52 * @param p_attribute_category This context value determines which flexfield
53 * structure to use with the descriptive flexfield segments.
54 * @param p_attribute1 Descriptive flexfield segment.
55 * @param p_attribute2 Descriptive flexfield segment.
56 * @param p_attribute3 Descriptive flexfield segment.
57 * @param p_attribute4 Descriptive flexfield segment.
58 * @param p_attribute5 Descriptive flexfield segment.
59 * @param p_attribute6 Descriptive flexfield segment.
60 * @param p_attribute7 Descriptive flexfield segment.
61 * @param p_attribute8 Descriptive flexfield segment.
62 * @param p_attribute9 Descriptive flexfield segment.
63 * @param p_attribute10 Descriptive flexfield segment.
64 * @param p_attribute11 Descriptive flexfield segment.
65 * @param p_attribute12 Descriptive flexfield segment.
66 * @param p_attribute13 Descriptive flexfield segment.
67 * @param p_attribute14 Descriptive flexfield segment.
68 * @param p_attribute15 Descriptive flexfield segment.
69 * @param p_attribute16 Descriptive flexfield segment.
70 * @param p_attribute17 Descriptive flexfield segment.
71 * @param p_attribute18 Descriptive flexfield segment.
72 * @param p_attribute19 Descriptive flexfield segment.
73 * @param p_attribute20 Descriptive flexfield segment.
74 * @param p_last_update_date {@rep:casecolumn PER_PAY_BASES.LAST_UPDATE_DATE}
75 * @param p_last_updated_by {@rep:casecolumn PER_PAY_BASES.LAST_UPDATED_BY}
76 * @param p_last_update_login {@rep:casecolumn PER_PAY_BASES.LAST_UPDATE_LOGIN}
77 * @param p_created_by {@rep:casecolumn PER_PAY_BASES.CREATED_BY}
78 * @param p_creation_date {@rep:casecolumn PER_PAY_BASES.CREATION_DATE}
79 * @param p_information_category This context value determines which flexfield
80 * structure to use with the developer descriptive flexfield segments.
81 * @param p_information1 Developer descriptive flexfield segment.
82 * @param p_information2 Developer descriptive flexfield segment.
83 * @param p_information3 Developer descriptive flexfield segment.
84 * @param p_information4 Developer descriptive flexfield segment.
85 * @param p_information5 Developer descriptive flexfield segment.
86 * @param p_information6 Developer descriptive flexfield segment.
87 * @param p_information7 Developer descriptive flexfield segment.
88 * @param p_information8 Developer descriptive flexfield segment.
89 * @param p_information9 Developer descriptive flexfield segment.
90 * @param p_information10 Developer descriptive flexfield segment.
91 * @param p_information11 Developer descriptive flexfield segment.
92 * @param p_information12 Developer descriptive flexfield segment.
93 * @param p_information13 Developer descriptive flexfield segment.
94 * @param p_information14 Developer descriptive flexfield segment.
95 * @param p_information15 Developer descriptive flexfield segment.
96 * @param p_information16 Developer descriptive flexfield segment.
97 * @param p_information17 Developer descriptive flexfield segment.
98 * @param p_information18 Developer descriptive flexfield segment.
99 * @param p_information19 Developer descriptive flexfield segment.
100 * @param p_information20 Developer descriptive flexfield segment.
101 * @param p_pay_basis_id If p_validate is false, uniquely identifies the salary
102 * basis created. If p_validate is true, set to null.
103 * @param p_object_version_number If p_validate is false, then set to the
104 * version number of the created salary basis. If p_validate is true, then the
105 * value will be null.
106 * @rep:displayname Create Salary Basis
107 * @rep:category BUSINESS_ENTITY HR_SALARY_BASIS
108 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
109 * @rep:scope public
110 * @rep:lifecycle active
111 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
112 */
113 --
114 -- {End Of Comments}
115 --
116 procedure create_salary_basis
117 (p_validate in boolean default false
118 ,p_business_group_id in number
119 ,p_input_value_id in number
120 ,p_rate_id in number default null
121 ,p_name in varchar2
122 ,p_pay_basis in varchar2
123 ,p_rate_basis in varchar2
124 ,p_pay_annualization_factor in number default null
125 ,p_grade_annualization_factor in number default null
126 ,p_attribute_category in varchar2 default null
127 ,p_attribute1 in varchar2 default null
128 ,p_attribute2 in varchar2 default null
129 ,p_attribute3 in varchar2 default null
130 ,p_attribute4 in varchar2 default null
131 ,p_attribute5 in varchar2 default null
132 ,p_attribute6 in varchar2 default null
133 ,p_attribute7 in varchar2 default null
134 ,p_attribute8 in varchar2 default null
135 ,p_attribute9 in varchar2 default null
136 ,p_attribute10 in varchar2 default null
137 ,p_attribute11 in varchar2 default null
138 ,p_attribute12 in varchar2 default null
139 ,p_attribute13 in varchar2 default null
140 ,p_attribute14 in varchar2 default null
141 ,p_attribute15 in varchar2 default null
142 ,p_attribute16 in varchar2 default null
143 ,p_attribute17 in varchar2 default null
144 ,p_attribute18 in varchar2 default null
145 ,p_attribute19 in varchar2 default null
146 ,p_attribute20 in varchar2 default null
147 ,p_last_update_date in date default null
148 ,p_last_updated_by in number default null
149 ,p_last_update_login in number default null
150 ,p_created_by in number default null
151 ,p_creation_date in date default null
152 ,p_information_category in varchar2 default null
153 ,p_information1 in varchar2 default null
154 ,p_information2 in varchar2 default null
155 ,p_information3 in varchar2 default null
156 ,p_information4 in varchar2 default null
157 ,p_information5 in varchar2 default null
158 ,p_information6 in varchar2 default null
159 ,p_information7 in varchar2 default null
160 ,p_information8 in varchar2 default null
161 ,p_information9 in varchar2 default null
162 ,p_information10 in varchar2 default null
163 ,p_information11 in varchar2 default null
164 ,p_information12 in varchar2 default null
165 ,p_information13 in varchar2 default null
166 ,p_information14 in varchar2 default null
167 ,p_information15 in varchar2 default null
168 ,p_information16 in varchar2 default null
169 ,p_information17 in varchar2 default null
170 ,p_information18 in varchar2 default null
171 ,p_information19 in varchar2 default null
172 ,p_information20 in varchar2 default null
173 ,p_pay_basis_id out nocopy number
174 ,p_object_version_number out nocopy number
175 );
176 --
177 -- ----------------------------------------------------------------------------
178 -- |---------------------------< update_salary_basis >------------------------|
179 -- ----------------------------------------------------------------------------
180 --
181 -- {Start Of Comments}
182 /*#
183 * This API updates an existing salary basis record.
184 *
185 * Salary basis specifies the duration the enterprise uses to quote a salary
186 * for an assignment. Salary basis is a combination of pay basis, annualization
187 * factor, and element input value. Optionally, you can link salary basis to a
188 * Grade Rate.
189 *
190 * <p><b>Licensing</b><br>
191 * This API is licensed for use with Human Resources.
192 *
193 * <p><b>Prerequisites</b><br>
194 * A salary basis as specified by the in parameter p_pay_basis_id and the in
195 * out parameter p_object_version_number must already exist.
196 *
197 * <p><b>Post Success</b><br>
198 * Salary basis details are updated in the database.
199 *
200 * <p><b>Post Failure</b><br>
201 * The API does not update the salary basis and raises an error.
202 * @param p_validate If true, then validation alone will be performed and the
203 * database will remain unchanged. If false and all validation checks pass,
204 * then the database will be modified.
205 * @param p_pay_basis_id {@rep:casecolumn PER_PAY_BASES.PAY_BASIS_ID}
206 * @param p_input_value_id {@rep:casecolumn PER_PAY_BASES.INPUT_VALUE_ID}
207 * @param p_rate_id {@rep:casecolumn PER_PAY_BASES.RATE_ID}
208 * @param p_name Unique name of the pay basis the process creates.
209 * @param p_pay_basis The time basis for recording actual salary values, such
210 * as Annual, Monthly, or Hourly. Valid values are identified by the
211 * 'PAY_BASIS' lookup type.
212 * @param p_rate_basis {@rep:casecolumn PER_PAY_BASES.RATE_BASIS}
213 * @param p_pay_annualization_factor {@rep:casecolumn
214 * PER_PAY_BASES.PAY_ANNUALIZATION_FACTOR}
215 * @param p_grade_annualization_factor {@rep:casecolumn
216 * PER_PAY_BASES.GRADE_ANNUALIZATION_FACTOR}
217 * @param p_attribute_category This context value determines which flexfield
218 * structure to use with the descriptive flexfield segments.
219 * @param p_attribute1 Descriptive flexfield segment.
220 * @param p_attribute2 Descriptive flexfield segment.
221 * @param p_attribute3 Descriptive flexfield segment.
222 * @param p_attribute4 Descriptive flexfield segment.
223 * @param p_attribute5 Descriptive flexfield segment.
224 * @param p_attribute6 Descriptive flexfield segment.
225 * @param p_attribute7 Descriptive flexfield segment.
226 * @param p_attribute8 Descriptive flexfield segment.
227 * @param p_attribute9 Descriptive flexfield segment.
228 * @param p_attribute10 Descriptive flexfield segment.
229 * @param p_attribute11 Descriptive flexfield segment.
230 * @param p_attribute12 Descriptive flexfield segment.
231 * @param p_attribute13 Descriptive flexfield segment.
232 * @param p_attribute14 Descriptive flexfield segment.
233 * @param p_attribute15 Descriptive flexfield segment.
234 * @param p_attribute16 Descriptive flexfield segment.
235 * @param p_attribute17 Descriptive flexfield segment.
236 * @param p_attribute18 Descriptive flexfield segment.
237 * @param p_attribute19 Descriptive flexfield segment.
238 * @param p_attribute20 Descriptive flexfield segment.
239 * @param p_information_category This context value determines which flexfield
240 * structure to use with the developer descriptive flexfield segments.
241 * @param p_information1 Developer descriptive flexfield segment.
242 * @param p_information2 Developer descriptive flexfield segment.
243 * @param p_information3 Developer descriptive flexfield segment.
244 * @param p_information4 Developer descriptive flexfield segment.
245 * @param p_information5 Developer descriptive flexfield segment.
246 * @param p_information6 Developer descriptive flexfield segment.
247 * @param p_information7 Developer descriptive flexfield segment.
248 * @param p_information8 Developer descriptive flexfield segment.
249 * @param p_information9 Developer descriptive flexfield segment.
250 * @param p_information10 Developer descriptive flexfield segment.
251 * @param p_information11 Developer descriptive flexfield segment.
252 * @param p_information12 Developer descriptive flexfield segment.
253 * @param p_information13 Developer descriptive flexfield segment.
254 * @param p_information14 Developer descriptive flexfield segment.
255 * @param p_information15 Developer descriptive flexfield segment.
256 * @param p_information16 Developer descriptive flexfield segment.
257 * @param p_information17 Developer descriptive flexfield segment.
258 * @param p_information18 Developer descriptive flexfield segment.
259 * @param p_information19 Developer descriptive flexfield segment.
260 * @param p_information20 Developer descriptive flexfield segment.
261 * @param p_last_update_date {@rep:casecolumn PER_PAY_BASES.LAST_UPDATE_DATE}
262 * @param p_last_updated_by {@rep:casecolumn PER_PAY_BASES.LAST_UPDATED_BY}
263 * @param p_last_update_login {@rep:casecolumn PER_PAY_BASES.LAST_UPDATE_LOGIN}
264 * @param p_created_by {@rep:casecolumn PER_PAY_BASES.CREATED_BY}
265 * @param p_creation_date {@rep:casecolumn PER_PAY_BASES.CREATION_DATE}
266 * @param p_object_version_number Pass in the current version number of the
267 * salary basis to be updated. When the API completes if p_validate is false,
268 * will be set to the new version number of the updated salary basis. If
269 * p_validate is true will be set to the same value which was passed in.
270 * @rep:displayname Update Salary Basis
271 * @rep:category BUSINESS_ENTITY HR_SALARY_BASIS
272 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
273 * @rep:scope public
274 * @rep:lifecycle active
278 -- {End Of Comments}
275 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
276 */
277 --
279 --
280 procedure update_salary_basis
281 (P_VALIDATE IN BOOLEAN default false
282 ,P_PAY_BASIS_ID IN NUMBER
283 ,P_INPUT_VALUE_ID IN NUMBER default hr_api.g_number
284 ,P_RATE_ID IN NUMBER default hr_api.g_number
285 ,P_NAME IN VARCHAR2 default hr_api.g_varchar2
286 ,P_PAY_BASIS IN VARCHAR2 default hr_api.g_varchar2
287 ,P_RATE_BASIS IN VARCHAR2 default hr_api.g_varchar2
288 ,P_PAY_ANNUALIZATION_FACTOR IN NUMBER default hr_api.g_number
289 ,P_GRADE_ANNUALIZATION_FACTOR IN NUMBER default hr_api.g_number
290 ,P_ATTRIBUTE_CATEGORY IN VARCHAR2 default hr_api.g_varchar2
291 ,P_ATTRIBUTE1 IN VARCHAR2 default hr_api.g_varchar2
292 ,P_ATTRIBUTE2 IN VARCHAR2 default hr_api.g_varchar2
293 ,P_ATTRIBUTE3 IN VARCHAR2 default hr_api.g_varchar2
294 ,P_ATTRIBUTE4 IN VARCHAR2 default hr_api.g_varchar2
295 ,P_ATTRIBUTE5 IN VARCHAR2 default hr_api.g_varchar2
296 ,P_ATTRIBUTE6 IN VARCHAR2 default hr_api.g_varchar2
297 ,P_ATTRIBUTE7 IN VARCHAR2 default hr_api.g_varchar2
298 ,P_ATTRIBUTE8 IN VARCHAR2 default hr_api.g_varchar2
299 ,P_ATTRIBUTE9 IN VARCHAR2 default hr_api.g_varchar2
300 ,P_ATTRIBUTE10 IN VARCHAR2 default hr_api.g_varchar2
301 ,P_ATTRIBUTE11 IN VARCHAR2 default hr_api.g_varchar2
302 ,P_ATTRIBUTE12 IN VARCHAR2 default hr_api.g_varchar2
303 ,P_ATTRIBUTE13 IN VARCHAR2 default hr_api.g_varchar2
304 ,P_ATTRIBUTE14 IN VARCHAR2 default hr_api.g_varchar2
305 ,P_ATTRIBUTE15 IN VARCHAR2 default hr_api.g_varchar2
306 ,P_ATTRIBUTE16 IN VARCHAR2 default hr_api.g_varchar2
307 ,P_ATTRIBUTE17 IN VARCHAR2 default hr_api.g_varchar2
308 ,P_ATTRIBUTE18 IN VARCHAR2 default hr_api.g_varchar2
309 ,P_ATTRIBUTE19 IN VARCHAR2 default hr_api.g_varchar2
310 ,P_ATTRIBUTE20 IN VARCHAR2 default hr_api.g_varchar2
311 ,P_INFORMATION_CATEGORY IN VARCHAR2 default hr_api.g_varchar2
312 ,P_INFORMATION1 IN VARCHAR2 default hr_api.g_varchar2
313 ,P_INFORMATION2 IN VARCHAR2 default hr_api.g_varchar2
314 ,P_INFORMATION3 IN VARCHAR2 default hr_api.g_varchar2
315 ,P_INFORMATION4 IN VARCHAR2 default hr_api.g_varchar2
316 ,P_INFORMATION5 IN VARCHAR2 default hr_api.g_varchar2
317 ,P_INFORMATION6 IN VARCHAR2 default hr_api.g_varchar2
318 ,P_INFORMATION7 IN VARCHAR2 default hr_api.g_varchar2
319 ,P_INFORMATION8 IN VARCHAR2 default hr_api.g_varchar2
320 ,P_INFORMATION9 IN VARCHAR2 default hr_api.g_varchar2
321 ,P_INFORMATION10 IN VARCHAR2 default hr_api.g_varchar2
322 ,P_INFORMATION11 IN VARCHAR2 default hr_api.g_varchar2
323 ,P_INFORMATION12 IN VARCHAR2 default hr_api.g_varchar2
324 ,P_INFORMATION13 IN VARCHAR2 default hr_api.g_varchar2
325 ,P_INFORMATION14 IN VARCHAR2 default hr_api.g_varchar2
326 ,P_INFORMATION15 IN VARCHAR2 default hr_api.g_varchar2
327 ,P_INFORMATION16 IN VARCHAR2 default hr_api.g_varchar2
328 ,P_INFORMATION17 IN VARCHAR2 default hr_api.g_varchar2
329 ,P_INFORMATION18 IN VARCHAR2 default hr_api.g_varchar2
330 ,P_INFORMATION19 IN VARCHAR2 default hr_api.g_varchar2
331 ,P_INFORMATION20 IN VARCHAR2 default hr_api.g_varchar2
332 ,P_LAST_UPDATE_DATE IN DATE default hr_api.g_date
333 ,P_LAST_UPDATED_BY IN NUMBER default hr_api.g_number
334 ,P_LAST_UPDATE_LOGIN IN NUMBER default hr_api.g_number
335 ,P_CREATED_BY IN NUMBER default hr_api.g_number
336 ,P_CREATION_DATE IN DATE default hr_api.g_date
337 ,P_OBJECT_VERSION_NUMBER IN OUT nocopy NUMBER
338
339 );
340 --
341 -- ----------------------------------------------------------------------------
342 -- |---------------------------< delete_salary_basis >------------------------|
343 -- ----------------------------------------------------------------------------
344 --
345 -- {Start Of Comments}
346 /*#
347 * This API deletes an existing salary basis record.
348 *
349 * You can delete a salary basis record only when there are no assignments on
350 * the salary basis.
351 *
352 * <p><b>Licensing</b><br>
353 * This API is licensed for use with Human Resources.
354 *
355 * <p><b>Prerequisites</b><br>
356 * The salary basis as identified by the in parameter p_pay_basis_id and the in
357 * out parameter p_object_version_number must already exist; and no records
358 * relating to the pay_basis_id in the reference tables can exist.
359 *
360 * <p><b>Post Success</b><br>
361 * This API deletes the salary basis that corresponds to the ID value passed to
362 * the API.
363 *
364 * <p><b>Post Failure</b><br>
365 * The API does not delete Salary Basis and raises an error.
366 * @param p_validate If true, then validation alone will be performed and the
367 * database will remain unchanged. If false and all validation checks pass,
368 * then the database will be modified.
371 * be deleted.
372 * @rep:displayname Delete Salary Basis
373 * @rep:category BUSINESS_ENTITY HR_SALARY_BASIS
374 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
375 * @rep:scope public
376 * @rep:lifecycle active
377 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
378 */
379 --
380 -- {End Of Comments}
381 --
382 procedure delete_salary_basis
383 (p_validate in boolean default false
384 ,p_pay_basis_id in number
385 ,p_object_version_number in out nocopy number);
386
387 --
388 end hr_salary_basis_api;
389 --
370 * @param p_object_version_number Current version number of the salary basis to
369 * @param p_pay_basis_id {@rep:casecolumn PER_PAY_BASES.PAY_BASIS_ID}