1 Package pqh_fr_global_payscale_api AUTHID CURRENT_USER as
2 /* $Header: pqginapi.pkh 120.1 2005/10/02 02:45 aroussel $ */
3 /*#
4 * This package contains global payscale APIs.
5 * @rep:scope public
6 * @rep:product PER
7 * @rep:displayname Global Payscale for France
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |--------------------------< create_indemnity_rate >-----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This procedure creates indemnity rate for global payscale.
17 *
18 * In this case, type_of_record is assumed to be INM.
19 *
20 * <p><b>Licensing</b><br>
21 * This API is licensed for use with Human Resources.
22 *
23 * <p><b>Prerequisites</b><br>
27 * <p><b>Post Success</b><br>
24 * The indeminity rates are defined at global site level so there is no
25 * prerequsite for it.
26 *
28 * Creates the indeminity rates for global index.
29 *
30 * <p><b>Post Failure</b><br>
31 * Raises appropriate error message and the changes will not be posted to the
32 * database.
33 *
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_basic_salary_rate Determines the Basic Salary Rate.
40 * @param p_housing_indemnity_rate Determines the Housing Indemnity Rate.
41 * @param p_currency_code Determines the Currency.
42 * @param p_global_index_id Gives the Global Index Identifier when indeminity
43 * get created.
44 * @param p_object_version_number If p_validate is false, then set to the
45 * version number of the created Indeminity. If p_validate is true, then the
46 * value will be null.
47 * @param p_effective_start_date If p_validate is false, then set to the
48 * earliest effective start date for the created Indeminity. If p_validate is
49 * true, then set to null.
50 * @param p_effective_end_date If p_validate is false, then set to the
51 * effective end date for the created Indeminity. If p_validate is true, then
52 * set to null.
53 * @rep:displayname Create Indemnity Rate
54 * @rep:category BUSINESS_ENTITY PQH_GLOBAL_PAY_SCALE
55 * @rep:lifecycle active
56 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
57 * @rep:scope public
58 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
59 */
60 --
61 -- {End Of Comments}
62 --
63 procedure create_indemnity_rate
64 ( p_validate in boolean default false
65 ,p_effective_date in date
66 ,p_basic_salary_rate in number default null
67 ,p_housing_indemnity_rate in number default null
68 ,p_currency_code in varchar2
69 ,p_global_index_id out nocopy number
70 ,p_object_version_number out nocopy number
71 ,p_effective_start_date out nocopy date
72 ,p_effective_end_date out nocopy date
73 );
74 --
75 -- ----------------------------------------------------------------------------
76 -- |---------------------------< create_global_index >------------------------|
77 -- ----------------------------------------------------------------------------
78 --
79 -- {Start Of Comments}
80 /*#
81 * This procedure creates global index for global payscale.
82 *
83 * In this case type_of_record is assumed to be IND.
84 *
85 * <p><b>Licensing</b><br>
86 * This API is licensed for use with Human Resources.
87 *
88 * <p><b>Prerequisites</b><br>
89 * Indeminty rates should exists at the site level.
90 *
91 * <p><b>Post Success</b><br>
92 * Creates a new Global index for the defined gross and increased index.
93 *
94 * <p><b>Post Failure</b><br>
95 * Raises appropriate error message and the changes are not posted to the
96 * database.
97 *
98 * @param p_validate If true, then validation alone will be performed and the
99 * database will remain unchanged. If false and all validation checks pass,
100 * then the database will be modified.
101 * @param p_effective_date Determines when the DateTrack operation comes into
102 * force.
103 * @param p_gross_index Determines the value of Gross index.
104 * @param p_increased_index Determines the value of Increased index.
105 * @param p_global_index_id Determines the Global Index Identifier when Global
106 * index for the Gross and Increased index get created.
107 * @param p_object_version_number If p_validate is false, then set to the
108 * version number of the created global index for gross and increased index. If
109 * p_validate is true, then the value will be null.
110 * @param p_effective_start_date If p_validate is false, then set to the
111 * earliest effective start date for the created created global index for gross
112 * and increased index. If p_validate is true, then set to null.
113 * @param p_effective_end_date If p_validate is false, then set to the
114 * effective end date for the created created global index for gross and
115 * increased index. If p_validate is true, then set to null.
116 * @rep:displayname Create Global Index
117 * @rep:category BUSINESS_ENTITY PQH_GLOBAL_PAY_SCALE
118 * @rep:lifecycle active
119 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
120 * @rep:scope public
121 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
122 */
123 --
124 -- {End Of Comments}
125 --
126 procedure create_global_index
127 (p_validate in boolean default false
128 ,p_effective_date in date
129 ,p_gross_index in number default null
130 ,p_increased_index in number default null
131 ,p_global_index_id out nocopy number
132 ,p_object_version_number out nocopy number
133 ,p_effective_start_date out nocopy date
134 ,p_effective_end_date out nocopy date
135 );
136 --
137 -- ----------------------------------------------------------------------------
138 -- |--------------------------< update_indemnity_rate >-----------------------|
139 -- ----------------------------------------------------------------------------
140 --
141 -- {Start Of Comments}
142 /*#
143 * This procedure updates the Indeminity rates for global payscale.
144 *
145 * Updates the value of basic salary rate, housing indeminity rate or Currency
146 * for the Global index.
147 *
148 * <p><b>Licensing</b><br>
149 * This API is licensed for use with Human Resources.
150 *
151 * <p><b>Prerequisites</b><br>
152 * The global index identifier should exist.
153 *
154 * <p><b>Post Success</b><br>
155 * Updates the changed value to the database as of the effective date.
156 *
157 * <p><b>Post Failure</b><br>
158 * Raises appropriate error message and the changes are not posted to the
159 * database.
160 *
161 * @param p_validate If true, then validation alone will be performed and the
162 * database will remain unchanged. If false and all validation checks pass,
163 * then the database will be modified.
164 * @param p_effective_date Determines when the DateTrack operation comes into
165 * force.
166 * @param p_datetrack_mode Indicates which DateTrack mode to use when updating
167 * the record. You must set to either UPDATE, CORRECTION, UPDATE_OVERRIDE or
168 * UPDATE_CHANGE_INSERT. Modes available for use with a particular record
169 * depend on the dates of previous record changes and the effective date of
170 * this change.
171 * @param p_global_index_id Determines the Global Index Identifier which needed
172 * to be updated.
173 * @param p_object_version_number Pass in the current version number of the
174 * global index to be updated. When the API completes if p_validate is false,
175 * will be set to the new version number of the updated Global index. If
176 * p_validate is true will be set to the same value which was passed in.
177 * @param p_basic_salary_rate Determines the changed Basic Salary rate
178 * @param p_housing_indemnity_rate Determines the changed Housing Indeminity
179 * rate
180 * @param p_currency_code Determines the changed Currency
181 * @param p_effective_start_date If p_validate is false, then set to the
182 * effective start date on the updated global index row which now exists as of
183 * the effective date. If p_validate is true, then set to null.
184 * @param p_effective_end_date If p_validate is false, then set to the
185 * effective end date on the updated global index row which now exists as of
186 * the effective date. If p_validate is true, then set to null.
187 * @rep:displayname Update Indemnity Rate
188 * @rep:category BUSINESS_ENTITY PQH_GLOBAL_PAY_SCALE
189 * @rep:lifecycle active
190 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
191 * @rep:scope public
192 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
193 */
194 --
195 -- {End Of Comments}
196 --
197 procedure update_indemnity_rate
198 (p_validate in boolean default false
199 ,p_effective_date in date
200 ,p_datetrack_mode in varchar2
201 ,p_global_index_id in number
202 ,p_object_version_number in out nocopy number
203 ,p_basic_salary_rate in number default hr_api.g_number
204 ,p_housing_indemnity_rate in number default hr_api.g_number
205 ,p_currency_code in varchar2
206 ,p_effective_start_date out nocopy date
207 ,p_effective_end_date out nocopy date
208 );
209 --
210 -- ----------------------------------------------------------------------------
211 -- |---------------------------< update_global_index >------------------------|
212 -- ----------------------------------------------------------------------------
213 --
214 -- {Start Of Comments}
215 /*#
216 * This procedure updates the global index for global payscale.
217 *
218 * Updates the value of Gross and increased for the Global index.
219 *
220 * <p><b>Licensing</b><br>
221 * This API is licensed for use with Human Resources.
222 *
223 * <p><b>Prerequisites</b><br>
224 * The global index identifier should exist.
225 *
226 * <p><b>Post Success</b><br>
227 * Updates the changed value to the database as of the effective date.
228 *
229 * <p><b>Post Failure</b><br>
230 * Raises appropriate error message and the changes are not posted to the
231 * database.
232 *
233 * @param p_validate If true, then validation alone will be performed and the
234 * database will remain unchanged. If false and all validation checks pass,
235 * then the database will be modified.
236 * @param p_effective_date Determines when the DateTrack operation comes into
237 * force.
238 * @param p_datetrack_mode Indicates which DateTrack mode to use when updating
239 * the record. You must set to either UPDATE, CORRECTION, UPDATE_OVERRIDE or
240 * UPDATE_CHANGE_INSERT. Modes available for use with a particular record
244 * to be updated.
241 * depend on the dates of previous record changes and the effective date of
242 * this change.
243 * @param p_global_index_id Determines the Global Index Identifier which needed
245 * @param p_object_version_number Pass in the current version number of the
246 * global index to be updated. When the API completes if p_validate is false,
247 * will be set to the new version number of the updated Global index. If
248 * p_validate is true will be set to the same value which was passed in.
249 * @param p_gross_index Determines the changed Gross Index
250 * @param p_increased_index Determines the changed Incresed Index
251 * @param p_effective_start_date If p_validate is false, then set to the
252 * effective start date on the updated global index row which now exists as of
253 * the effective date. If p_validate is true, then set to null.
254 * @param p_effective_end_date If p_validate is false, then set to the
255 * effective end date on the updated global index row which now exists as of
256 * the effective date. If p_validate is true, then set to null.
257 * @rep:displayname Update Global Index
258 * @rep:category BUSINESS_ENTITY PQH_GLOBAL_PAY_SCALE
259 * @rep:lifecycle active
260 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
261 * @rep:scope public
262 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
263 */
264 --
265 -- {End Of Comments}
266 --
267 procedure update_global_index
268 (p_validate in boolean default false
269 ,p_effective_date in date
270 ,p_datetrack_mode in varchar2
271 ,p_global_index_id in number
272 ,p_object_version_number in out nocopy number
273 ,p_gross_index in number default hr_api.g_number
274 ,p_increased_index in number default hr_api.g_number
275 ,p_effective_start_date out nocopy date
276 ,p_effective_end_date out nocopy date
277 );
278 --
279 -- ----------------------------------------------------------------------------
280 -- |--------------------------< delete_indemnity_rate >-----------------------|
281 -- ----------------------------------------------------------------------------
282 --
283 -- {Start Of Comments}
284 /*#
285 * This procedure deletes the indeminity rate for global payscale.
286 *
287 * Procedure deletes or end dates the record depending on the datetrack mode
288 * passed as of the effective date
289 *
290 * <p><b>Licensing</b><br>
291 * This API is licensed for use with Human Resources.
292 *
293 * <p><b>Prerequisites</b><br>
294 * The global index identifier should exist
295 *
296 * <p><b>Post Success</b><br>
297 * Procedure deletes or updates the record in the database depending on the
298 * datetrack mode passed as of the effective date.
299 *
300 * <p><b>Post Failure</b><br>
301 * Raises appropriate error message and the changes are not posted to the
302 * database.
303 *
304 * @param p_validate If true, then validation alone will be performed and the
305 * database will remain unchanged. If false and all validation checks pass,
306 * then the database will be modified.
307 * @param p_effective_date Determines when the DateTrack operation comes into
308 * force.
309 * @param p_datetrack_mode Indicates which DateTrack mode to use when deleting
310 * the record. You must set to either ZAP, DELETE, FUTURE_CHANGE or
311 * DELETE_NEXT_CHANGE. Modes available for use with a particular record depend
312 * on the dates of previous record changes and the effective date of this
313 * change.
314 * @param p_global_index_id Determines the Global index identifier to be
315 * deleted
316 * @param p_object_version_number Pass in the current version number of the
317 * Indeminity rate to be deletedWhen the API completes if p_validate is false,
318 * and record is end dated as of the effective date then it will be set to the
319 * new version number of the updated glonal index. Other wise it is set to
320 * null.If p_validate is true will be set to the same value which was passed
321 * in.
322 * @param p_effective_start_date If p_validate is false, then set to the
323 * effective start date for the deleted indeminity rate row which now exists as
324 * of the effective date. If p_validate is true or all row instances have been
325 * deleted then set to null.
326 * @param p_effective_end_date If p_validate is false, then set to the
327 * effective end date for the deleted indeminity rate row which now exists as
328 * of the effective date. If p_validate is true or all row instances have been
329 * deleted then set to null.
330 * @rep:displayname Delete Indemnity Rate
331 * @rep:category BUSINESS_ENTITY PQH_GLOBAL_PAY_SCALE
332 * @rep:lifecycle active
333 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
334 * @rep:scope public
335 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
336 */
337 --
338 -- {End Of Comments}
339 --
340 procedure delete_indemnity_rate
341 (p_validate in boolean default false
342 ,p_effective_date in date
343 ,p_datetrack_mode in varchar2
344 ,p_global_index_id in number
345 ,p_object_version_number in out nocopy number
346 ,p_effective_start_date out nocopy date
347 ,p_effective_end_date out nocopy date
348 );
349 --
350 -- ----------------------------------------------------------------------------
351 -- |---------------------------< delete_global_index >------------------------|
352 -- ----------------------------------------------------------------------------
353 --
354 -- {Start Of Comments}
355 /*#
356 * This procedure deletes the global index for global payscale.
357 *
358 * Procedure deletes or end dates the record depending on the datetrack mode
359 * passed as of the effective date
360 *
361 * <p><b>Licensing</b><br>
362 * This API is licensed for use with Human Resources.
363 *
364 * <p><b>Prerequisites</b><br>
365 * The global index identifier should exist
366 *
367 * <p><b>Post Success</b><br>
368 * Procedure deletes or updates the record in the database depending on the
369 * datetrack mode passed as of the effective date.
370 *
371 * <p><b>Post Failure</b><br>
372 * Raises appropriate error message and the changes are not posted to the
373 * database.
374 *
375 * @param p_validate If true, then validation alone will be performed and the
376 * database will remain unchanged. If false and all validation checks pass,
377 * then the database will be modified.
378 * @param p_effective_date Determines when the DateTrack operation comes into
379 * force.
380 * @param p_datetrack_mode Indicates which DateTrack mode to use when deleting
381 * the record. You must set to either ZAP, DELETE, FUTURE_CHANGE or
382 * DELETE_NEXT_CHANGE. Modes available for use with a particular record depend
383 * on the dates of previous record changes and the effective date of this
384 * change.
385 * @param p_global_index_id Determines the Global index identifier to be
386 * deleted
387 * @param p_object_version_number Pass in the current version number of the
388 * global index to be deleted.When the API completes if p_validate is false,
389 * and record is end dated as of the effective date, then it will be set to the
390 * new version number of the updated global index. Other wise, it is set to
391 * null. If p_validate is true, it will be set to the same value which was
392 * passed in.
393 * @param p_effective_start_date If p_validate is false, then set to the
394 * effective start date for the deleted global index row which now exists as of
395 * the effective date. If p_validate is true or all row instances have been
396 * deleted then set to null.
397 * @param p_effective_end_date If p_validate is false, then set to the
398 * effective end date for the deleted global index row which now exists as of
399 * the effective date. If p_validate is true or all row instances have been
400 * deleted then set to null.
401 * @rep:displayname Delete Global Index
402 * @rep:category BUSINESS_ENTITY PQH_GLOBAL_PAY_SCALE
403 * @rep:lifecycle active
404 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
405 * @rep:scope public
406 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
407 */
408 --
409 -- {End Of Comments}
410 --
411 procedure delete_global_index
412 (p_validate in boolean default false
413 ,p_effective_date in date
414 ,p_datetrack_mode in varchar2
415 ,p_global_index_id in number
416 ,p_object_version_number in out nocopy number
417 ,p_effective_start_date out nocopy date
418 ,p_effective_end_date out nocopy date
419 );
420 --
421
422 end pqh_fr_global_payscale_api;
[Home] [Help]