1 Package pay_run_type_api as
2 /* $Header: pyprtapi.pkh 120.1 2005/10/02 02:33:16 aroussel $ */
3 /*#
4 * This package contains the Create Payroll API.
5 * @rep:scope public
6 * @rep:product pay
7 * @rep:displayname Run Type
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-----------------------------< create_run_type >--------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates new run types.
17 *
18 * Created run types will then be used by the Payroll processes.
19 *
20 * <p><b>Licensing</b><br>
21 * This API is licensed for use with Payroll.
22 *
23 * <p><b>Prerequisites</b><br>
24 * The business group where this record to be created should exist.
25 *
26 * <p><b>Post Success</b><br>
27 * The run type will be successfully inserted into the database.
28 *
29 * <p><b>Post Failure</b><br>
30 * The API does not create the run type and raises an error.
31 * @param p_validate If true, then validation alone will be performed and the
32 * database will remain unchanged. If false and all validation checks pass,
33 * then the database will be modified.
34 * @param p_effective_date Determines when the DateTrack operation comes into
35 * force.
36 * @param p_language_code Specifies to which language the translation values
37 * apply. You can set to the base or any installed language. The default value
38 * of hr_api.userenv_lang is equivalent to the RDBMS userenv('LANG') function
39 * value.
40 * @param p_run_type_name The name for the run type.
41 * @param p_run_method The method for the run type, this will either be 'N',
42 * 'C', 'P' or 'S'.
43 * @param p_business_group_id Business Group of the Record.
44 * @param p_legislation_code Legislation Code
45 * @param p_shortname Short name for the run type
46 * @param p_srs_flag If 'Y', then run type would be used in SRS definition.
47 * @param p_run_information_category Developer Descriptive flexfield for Run
48 * Type
49 * @param p_run_information1 Developer Descriptive flexfield segment.
50 * @param p_run_information2 Developer Descriptive flexfield segment.
51 * @param p_run_information3 Developer Descriptive flexfield segment.
52 * @param p_run_information4 Developer Descriptive flexfield segment.
53 * @param p_run_information5 Developer Descriptive flexfield segment.
54 * @param p_run_information6 Developer Descriptive flexfield segment.
55 * @param p_run_information7 Developer Descriptive flexfield segment.
56 * @param p_run_information8 Developer Descriptive flexfield segment.
57 * @param p_run_information9 Developer Descriptive flexfield segment.
58 * @param p_run_information10 Developer Descriptive flexfield segment.
59 * @param p_run_information11 Developer Descriptive flexfield segment.
60 * @param p_run_information12 Developer Descriptive flexfield segment.
61 * @param p_run_information13 Developer Descriptive flexfield segment.
62 * @param p_run_information14 Developer Descriptive flexfield segment.
63 * @param p_run_information15 Developer Descriptive flexfield segment.
64 * @param p_run_information16 Developer Descriptive flexfield segment.
65 * @param p_run_information17 Developer Descriptive flexfield segment.
66 * @param p_run_information18 Developer Descriptive flexfield segment.
67 * @param p_run_information19 Developer Descriptive flexfield segment.
68 * @param p_run_information20 Developer Descriptive flexfield segment.
69 * @param p_run_information21 Developer Descriptive flexfield segment.
70 * @param p_run_information22 Developer Descriptive flexfield segment.
71 * @param p_run_information23 Developer Descriptive flexfield segment.
72 * @param p_run_information24 Developer Descriptive flexfield segment.
73 * @param p_run_information25 Developer Descriptive flexfield segment.
74 * @param p_run_information26 Developer Descriptive flexfield segment.
75 * @param p_run_information27 Developer Descriptive flexfield segment.
76 * @param p_run_information28 Developer Descriptive flexfield segment.
77 * @param p_run_information29 Developer Descriptive flexfield segment.
78 * @param p_run_information30 Developer Descriptive flexfield segment.
79 * @param p_run_type_id If p_validate is false, this uniquely identifies the
80 * run type created. If p_validate is set to true, this parameter will be null.
81 * @param p_effective_start_date If p_validate is false, then set to the
82 * earliest effective start date for the created run type. If p_validate is
83 * true, then set to null.
84 * @param p_effective_end_date If p_validate is false, then set to the
85 * effective end date for the created run type. If p_validate is true, then set
86 * to null.
87 * @param p_object_version_number If p_validate is false, then set to the
88 * version number of the run type. If p_validate is true, then the value will
89 * be null.
90 * @rep:displayname Create Run Type
91 * @rep:category BUSINESS_ENTITY PAY_RUN_TYPE
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_run_type
101 (p_validate in boolean default false
102 ,p_effective_date in date
103 ,p_language_code in varchar2 default hr_api.userenv_lang
104 ,p_run_type_name in varchar2
105 ,p_run_method in varchar2
106 ,p_business_group_id in number default null
107 ,p_legislation_code in varchar2 default null
108 ,p_shortname in varchar2 default null
109 ,p_srs_flag in varchar2 default 'Y'
110 ,p_run_information_category in varchar2 default null
111 ,p_run_information1 in varchar2 default null
112 ,p_run_information2 in varchar2 default null
113 ,p_run_information3 in varchar2 default null
114 ,p_run_information4 in varchar2 default null
115 ,p_run_information5 in varchar2 default null
116 ,p_run_information6 in varchar2 default null
117 ,p_run_information7 in varchar2 default null
118 ,p_run_information8 in varchar2 default null
119 ,p_run_information9 in varchar2 default null
120 ,p_run_information10 in varchar2 default null
121 ,p_run_information11 in varchar2 default null
122 ,p_run_information12 in varchar2 default null
123 ,p_run_information13 in varchar2 default null
124 ,p_run_information14 in varchar2 default null
125 ,p_run_information15 in varchar2 default null
126 ,p_run_information16 in varchar2 default null
127 ,p_run_information17 in varchar2 default null
128 ,p_run_information18 in varchar2 default null
129 ,p_run_information19 in varchar2 default null
130 ,p_run_information20 in varchar2 default null
131 ,p_run_information21 in varchar2 default null
132 ,p_run_information22 in varchar2 default null
133 ,p_run_information23 in varchar2 default null
134 ,p_run_information24 in varchar2 default null
135 ,p_run_information25 in varchar2 default null
136 ,p_run_information26 in varchar2 default null
137 ,p_run_information27 in varchar2 default null
138 ,p_run_information28 in varchar2 default null
139 ,p_run_information29 in varchar2 default null
140 ,p_run_information30 in varchar2 default null
141 ,p_run_type_id out nocopy number
142 ,p_effective_start_date out nocopy date
143 ,p_effective_end_date out nocopy date
144 ,p_object_version_number out nocopy number
145 );
146 --
147 -- ----------------------------------------------------------------------------
148 -- |-----------------------------< update_run_type >--------------------------|
149 -- ----------------------------------------------------------------------------
150 --
151 -- {Start Of Comments}
152 /*#
153 * This API updates run type.
154 *
155 *
156 * <p><b>Licensing</b><br>
157 * This API is licensed for use with Payroll.
158 *
159 * <p><b>Prerequisites</b><br>
160 * The run type as identified by the in parameters p_run_type and
161 * p_object_version_number must already exist.
162 *
163 * <p><b>Post Success</b><br>
164 * Run type data will be updated.
165 *
166 * <p><b>Post Failure</b><br>
167 * The API does not update the run type and raises an error.
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_effective_date Determines when the DateTrack operation comes into
172 * force.
173 * @param p_datetrack_update_mode Indicates which DateTrack mode to use when
174 * updating the record. You must set to either UPDATE, CORRECTION,
175 * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
176 * particular record depend on the dates of previous record changes and the
177 * effective date of this change.
178 * @param p_language_code Specifies to which language the translation values
179 * apply. You can set to the base or any installed language. The default value
180 * of hr_api.userenv_lang is equivalent to the RDBMS userenv('LANG') function
181 * value.
182 * @param p_run_type_id Identifier of the run type being updated.
183 * @param p_object_version_number Pass in the current version number of the run
184 * type to be updated. When the API completes if p_validate is false, will be
185 * set to the new version number of the updated run type. If p_validate is true
186 * will be set to the same value which was passed in.
187 * @param p_business_group_id Business Group of the Record.
188 * @param p_legislation_code Legislation Code
189 * @param p_shortname Short name for the run type
190 * @param p_srs_flag If 'Y', then run type would be used in SRS definition.
191 * @param p_run_information_category Developer Descriptive flexfield for Run
192 * Type
193 * @param p_run_information1 Developer Descriptive flexfield segment.
194 * @param p_run_information2 Developer Descriptive flexfield segment.
195 * @param p_run_information3 Developer Descriptive flexfield segment.
196 * @param p_run_information4 Developer Descriptive flexfield segment.
197 * @param p_run_information5 Developer Descriptive flexfield segment.
198 * @param p_run_information6 Developer Descriptive flexfield segment.
199 * @param p_run_information7 Developer Descriptive flexfield segment.
200 * @param p_run_information8 Developer Descriptive flexfield segment.
201 * @param p_run_information9 Developer Descriptive flexfield segment.
202 * @param p_run_information10 Developer Descriptive flexfield segment.
203 * @param p_run_information11 Developer Descriptive flexfield segment.
204 * @param p_run_information12 Developer Descriptive flexfield segment.
205 * @param p_run_information13 Developer Descriptive flexfield segment.
206 * @param p_run_information14 Developer Descriptive flexfield segment.
207 * @param p_run_information15 Developer Descriptive flexfield segment.
208 * @param p_run_information16 Developer Descriptive flexfield segment.
209 * @param p_run_information17 Developer Descriptive flexfield segment.
210 * @param p_run_information18 Developer Descriptive flexfield segment.
211 * @param p_run_information19 Developer Descriptive flexfield segment.
212 * @param p_run_information20 Developer Descriptive flexfield segment.
213 * @param p_run_information21 Developer Descriptive flexfield segment.
214 * @param p_run_information22 Developer Descriptive flexfield segment.
215 * @param p_run_information23 Developer Descriptive flexfield segment.
216 * @param p_run_information24 Developer Descriptive flexfield segment.
217 * @param p_run_information25 Developer Descriptive flexfield segment.
218 * @param p_run_information26 Developer Descriptive flexfield segment.
219 * @param p_run_information27 Developer Descriptive flexfield segment.
220 * @param p_run_information28 Developer Descriptive flexfield segment.
221 * @param p_run_information29 Developer Descriptive flexfield segment.
222 * @param p_run_information30 Developer Descriptive flexfield segment.
223 * @param p_effective_start_date If p_validate is false, then set to the
224 * effective start date on the updated run type row which now exists as of the
225 * effective date. If p_validate is true, then set to null.
226 * @param p_effective_end_date If p_validate is false, then set to the
227 * effective end date on the updated run type row which now exists as of the
228 * effective date. If p_validate is true, then set to null.
229 * @rep:displayname Update Run Type
230 * @rep:category BUSINESS_ENTITY PAY_RUN_TYPE
231 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
232 * @rep:scope public
233 * @rep:lifecycle active
234 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
235 */
236 --
237 -- {End Of Comments}
238 --
239 procedure update_run_type
240 (p_validate in boolean default false
241 ,p_effective_date in date
242 ,p_datetrack_update_mode in varchar2
243 ,p_language_code in varchar2 default hr_api.userenv_lang
244 ,p_run_type_id in number
245 ,p_object_version_number in out nocopy number
246 ,p_business_group_id in number default hr_api.g_number
247 ,p_legislation_code in varchar2 default hr_api.g_varchar2
248 ,p_shortname in varchar2 default hr_api.g_varchar2
249 ,p_srs_flag in varchar2 default hr_api.g_varchar2
250 ,p_run_information_category in varchar2 default hr_api.g_varchar2
251 ,p_run_information1 in varchar2 default hr_api.g_varchar2
252 ,p_run_information2 in varchar2 default hr_api.g_varchar2
253 ,p_run_information3 in varchar2 default hr_api.g_varchar2
254 ,p_run_information4 in varchar2 default hr_api.g_varchar2
255 ,p_run_information5 in varchar2 default hr_api.g_varchar2
256 ,p_run_information6 in varchar2 default hr_api.g_varchar2
257 ,p_run_information7 in varchar2 default hr_api.g_varchar2
258 ,p_run_information8 in varchar2 default hr_api.g_varchar2
259 ,p_run_information9 in varchar2 default hr_api.g_varchar2
260 ,p_run_information10 in varchar2 default hr_api.g_varchar2
261 ,p_run_information11 in varchar2 default hr_api.g_varchar2
262 ,p_run_information12 in varchar2 default hr_api.g_varchar2
263 ,p_run_information13 in varchar2 default hr_api.g_varchar2
264 ,p_run_information14 in varchar2 default hr_api.g_varchar2
265 ,p_run_information15 in varchar2 default hr_api.g_varchar2
266 ,p_run_information16 in varchar2 default hr_api.g_varchar2
267 ,p_run_information17 in varchar2 default hr_api.g_varchar2
268 ,p_run_information18 in varchar2 default hr_api.g_varchar2
269 ,p_run_information19 in varchar2 default hr_api.g_varchar2
270 ,p_run_information20 in varchar2 default hr_api.g_varchar2
271 ,p_run_information21 in varchar2 default hr_api.g_varchar2
272 ,p_run_information22 in varchar2 default hr_api.g_varchar2
273 ,p_run_information23 in varchar2 default hr_api.g_varchar2
274 ,p_run_information24 in varchar2 default hr_api.g_varchar2
275 ,p_run_information25 in varchar2 default hr_api.g_varchar2
276 ,p_run_information26 in varchar2 default hr_api.g_varchar2
277 ,p_run_information27 in varchar2 default hr_api.g_varchar2
278 ,p_run_information28 in varchar2 default hr_api.g_varchar2
279 ,p_run_information29 in varchar2 default hr_api.g_varchar2
280 ,p_run_information30 in varchar2 default hr_api.g_varchar2
281 ,p_effective_start_date out nocopy date
282 ,p_effective_end_date out nocopy date
283 );
284 --
285 -- ----------------------------------------------------------------------------
286 -- |-----------------------------< delete_run_type >--------------------------|
287 -- ----------------------------------------------------------------------------
288 --
289 -- {Start Of Comments}
290 /*#
291 * This API deletes a run type.
292 *
293 *
294 * <p><b>Licensing</b><br>
295 * This API is licensed for use with Payroll.
296 *
297 * <p><b>Prerequisites</b><br>
298 * The run type as identified by the in parameters p_run_type and
299 * p_object_version_number must already exist.
300 *
301 * <p><b>Post Success</b><br>
302 * Rub type will be successfully deleted from the database.
303 *
304 * <p><b>Post Failure</b><br>
305 * The API does not delete the run type and raises an error.
306 * @param p_validate If true, then validation alone will be performed and the
307 * database will remain unchanged. If false and all validation checks pass,
308 * then the database will be modified.
309 * @param p_effective_date Determines when the DateTrack operation comes into
310 * force.
311 * @param p_datetrack_delete_mode Indicates which DateTrack mode to use when
312 * deleting the record. You must set to either ZAP, DELETE, FUTURE_CHANGE or
313 * DELETE_NEXT_CHANGE. Modes available for use with a particular record depend
314 * on the dates of previous record changes and the effective date of this
315 * change.
316 * @param p_run_type_id Identifier of the run type being deleted.
317 * @param p_object_version_number Pass in the current version number of the
318 * organization payment method to be deleted. When the API completes if
319 * p_validate is false, will be set to the new version number of the deleted
320 * organization payment method. If p_validate is true will be set to the same
321 * value which was passed in.
322 * @param p_business_group_id Business Group of the Record.
323 * @param p_legislation_code Legislation Code
324 * @param p_effective_start_date If p_validate is false, then set to the
325 * effective start date for the deleted run type row which now exists as of the
326 * effective date. If p_validate is true or all row instances have been deleted
327 * then set to null.
328 * @param p_effective_end_date If p_validate is false, then set to the
329 * effective end date for the deleted run type row which now exists as of the
330 * effective date. If p_validate is true or all row instances have been deleted
331 * then set to null.
332 * @rep:displayname Delete Run Type
333 * @rep:category BUSINESS_ENTITY PAY_RUN_TYPE
334 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
335 * @rep:scope public
336 * @rep:lifecycle active
337 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
338 */
339 --
340 -- {End Of Comments}
341 --
342 procedure delete_run_type
343 (p_validate in boolean default false
344 ,p_effective_date in date
345 ,p_datetrack_delete_mode in varchar2
346 ,p_run_type_id in number
347 ,p_object_version_number in out nocopy number
348 ,p_business_group_id in number default hr_api.g_number
349 ,p_legislation_code in varchar2 default hr_api.g_varchar2
350 ,p_effective_start_date out nocopy date
351 ,p_effective_end_date out nocopy date
352 );
353 --
354
355 end pay_run_type_api;
[Home] [Help]