4 * This package contains the Balance Category API.
1 Package PAY_BALANCE_CATEGORY_API AUTHID CURRENT_USER as
2 /* $Header: pypbcapi.pkh 120.2 2005/10/22 01:25:41 aroussel noship $ */
3 /*#
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Balance Category
8 */
9 g_dml_status boolean:= FALSE; -- Global package variable
10 --
11 -- ----------------------------------------------------------------------------
12 -- |-------------------------< create_balance_category >----------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates the balance category.
18 *
19 *
20 * <p><b>Licensing</b><br>
21 * This API is licensed for use with Human Resources.
22 *
23 * <p><b>Prerequisites</b><br>
24 * A valid business group should exists.
25 *
26 * <p><b>Post Success</b><br>
27 * The balance category will be successfully inserted into the database.
28 *
29 * <p><b>Post Failure</b><br>
30 * The API does not create the balance category 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_category_name The name for the category
37 * @param p_business_group_id Business Group of the Record.
38 * @param p_legislation_code Legislation Code
42 * @param p_pbc_information_category This context value determines which
39 * @param p_save_run_balance_enabled Flag for determining whether to create run
40 * balances.
41 * @param p_user_category_name Holds NLS value for category name
43 * Flexfield Structure to use with the Developer Descriptive flexfield
44 * segments.
45 * @param p_pbc_information1 Developer Descriptive flexfield segment.
46 * @param p_pbc_information2 Developer Descriptive flexfield segment.
47 * @param p_pbc_information3 Developer Descriptive flexfield segment.
48 * @param p_pbc_information4 Developer Descriptive flexfield segment.
49 * @param p_pbc_information5 Developer Descriptive flexfield segment.
50 * @param p_pbc_information6 Developer Descriptive flexfield segment.
51 * @param p_pbc_information7 Developer Descriptive flexfield segment.
52 * @param p_pbc_information8 Developer Descriptive flexfield segment.
53 * @param p_pbc_information9 Developer Descriptive flexfield segment.
54 * @param p_pbc_information10 Developer Descriptive flexfield segment.
55 * @param p_pbc_information11 Developer Descriptive flexfield segment.
56 * @param p_pbc_information12 Developer Descriptive flexfield segment.
57 * @param p_pbc_information13 Developer Descriptive flexfield segment.
58 * @param p_pbc_information14 Developer Descriptive flexfield segment.
59 * @param p_pbc_information15 Developer Descriptive flexfield segment.
60 * @param p_pbc_information16 Developer Descriptive flexfield segment.
61 * @param p_pbc_information17 Developer Descriptive flexfield segment.
62 * @param p_pbc_information18 Developer Descriptive flexfield segment.
63 * @param p_pbc_information19 Developer Descriptive flexfield segment.
64 * @param p_pbc_information20 Developer Descriptive flexfield segment.
65 * @param p_pbc_information21 Developer Descriptive flexfield segment.
66 * @param p_pbc_information22 Developer Descriptive flexfield segment.
67 * @param p_pbc_information23 Developer Descriptive flexfield segment.
68 * @param p_pbc_information24 Developer Descriptive flexfield segment.
69 * @param p_pbc_information25 Developer Descriptive flexfield segment.
70 * @param p_pbc_information26 Developer Descriptive flexfield segment.
71 * @param p_pbc_information27 Developer Descriptive flexfield segment.
72 * @param p_pbc_information28 Developer Descriptive flexfield segment.
73 * @param p_pbc_information29 Developer Descriptive flexfield segment.
74 * @param p_pbc_information30 Developer Descriptive flexfield segment.
75 * @param p_balance_category_id If p_validate is false, this uniquely
76 * identifies the balance category created. If p_validate is set to true, this
77 * parameter will be null.
78 * @param p_effective_start_date If p_validate is false, then set to the
79 * earliest effective start date for the created balance category. If
80 * p_validate is true, then set to null.
81 * @param p_effective_end_date If p_validate is false, then set to the
82 * effective end date for the created balance category. If p_validate is true,
83 * then set to null.
84 * @param p_object_version_number If p_validate is false, then set to the
85 * version number of the created balance category. If p_validate is true, then
86 * the value will be null.
87 * @rep:displayname Create Balance Category
88 * @rep:category BUSINESS_ENTITY PAY_BALANCE
89 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
90 * @rep:scope public
91 * @rep:lifecycle active
92 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
93 */
94 --
95 -- {End Of Comments}
96 --
97 procedure create_balance_category
98 (p_validate in boolean default false
99 ,p_effective_date in date
100 ,p_category_name in varchar2
101 ,p_business_group_id in number default null
102 ,p_legislation_code in varchar2 default null
103 ,p_save_run_balance_enabled in varchar2 default null
104 ,p_user_category_name in varchar2 default null
105 ,p_pbc_information_category in varchar2 default null
106 ,p_pbc_information1 in varchar2 default null
107 ,p_pbc_information2 in varchar2 default null
108 ,p_pbc_information3 in varchar2 default null
109 ,p_pbc_information4 in varchar2 default null
110 ,p_pbc_information5 in varchar2 default null
111 ,p_pbc_information6 in varchar2 default null
112 ,p_pbc_information7 in varchar2 default null
113 ,p_pbc_information8 in varchar2 default null
114 ,p_pbc_information9 in varchar2 default null
115 ,p_pbc_information10 in varchar2 default null
116 ,p_pbc_information11 in varchar2 default null
117 ,p_pbc_information12 in varchar2 default null
118 ,p_pbc_information13 in varchar2 default null
119 ,p_pbc_information14 in varchar2 default null
120 ,p_pbc_information15 in varchar2 default null
121 ,p_pbc_information16 in varchar2 default null
122 ,p_pbc_information17 in varchar2 default null
123 ,p_pbc_information18 in varchar2 default null
124 ,p_pbc_information19 in varchar2 default null
125 ,p_pbc_information20 in varchar2 default null
126 ,p_pbc_information21 in varchar2 default null
127 ,p_pbc_information22 in varchar2 default null
128 ,p_pbc_information23 in varchar2 default null
129 ,p_pbc_information24 in varchar2 default null
130 ,p_pbc_information25 in varchar2 default null
134 ,p_pbc_information29 in varchar2 default null
131 ,p_pbc_information26 in varchar2 default null
132 ,p_pbc_information27 in varchar2 default null
133 ,p_pbc_information28 in varchar2 default null
135 ,p_pbc_information30 in varchar2 default null
136 ,p_balance_category_id out nocopy number
137 ,p_effective_start_date out nocopy date
138 ,p_effective_end_date out nocopy date
139 ,p_object_version_number out nocopy number
140 );
141 --
142 -- ----------------------------------------------------------------------------
143 -- |-------------------------< update_balance_category >----------------------|
144 -- ----------------------------------------------------------------------------
145 --
146 -- {Start Of Comments}
147 /*#
148 * This API updates a balance category.
149 *
150 *
151 * <p><b>Licensing</b><br>
152 * This API is licensed for use with Human Resources.
153 *
154 * <p><b>Prerequisites</b><br>
155 * The balance category as identified by the in parameters
156 * p_balance_category_id and p_object_version_number must already exist.
157 *
158 * <p><b>Post Success</b><br>
159 * The balance category will be successfully updated in the database.
160 *
161 * <p><b>Post Failure</b><br>
162 * The API does not update the balance category and raises an error.
163 * @param p_validate If true, then validation alone will be performed and the
164 * database will remain unchanged. If false and all validation checks pass,
165 * then the database will be modified.
166 * @param p_effective_date Determines when the DateTrack operation comes into
167 * force.
168 * @param p_datetrack_update_mode Indicates which DateTrack mode to use when
169 * updating the record. You must set to either UPDATE, CORRECTION,
170 * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
171 * particular record depend on the dates of previous record changes and the
172 * effective date of this change.
173 * @param p_balance_category_id {@rep:casecolumn
174 * PAY_BALANCE_CATEGORIES_F.BALANCE_CATEGORY_ID}
175 * @param p_object_version_number Pass in the current version number of the
176 * balance category to be updated. When the API completes if p_validate is
177 * false, will be set to the new version number of the updated balance
178 * category. If p_validate is true will be set to the same value which was
179 * passed in.
180 * @param p_business_group_id Business Group of the Record.
181 * @param p_legislation_code Legislation Code
182 * @param p_save_run_balance_enabled Flag for determining whether run balances
183 * are to be created
184 * @param p_user_category_name Provides NLS support for category_name column
185 * @param p_pbc_information_category This context value determines which
186 * Flexfield Structure to use with the Developer Descriptive flexfield
187 * segments.
188 * @param p_pbc_information1 Developer Descriptive flexfield segment.
189 * @param p_pbc_information2 Developer Descriptive flexfield segment.
190 * @param p_pbc_information3 Developer Descriptive flexfield segment.
191 * @param p_pbc_information4 Developer Descriptive flexfield segment.
192 * @param p_pbc_information5 Developer Descriptive flexfield segment.
193 * @param p_pbc_information6 Developer Descriptive flexfield segment.
194 * @param p_pbc_information7 Developer Descriptive flexfield segment.
195 * @param p_pbc_information8 Developer Descriptive flexfield segment.
196 * @param p_pbc_information9 Developer Descriptive flexfield segment.
197 * @param p_pbc_information10 Developer Descriptive flexfield segment.
198 * @param p_pbc_information11 Developer Descriptive flexfield segment.
199 * @param p_pbc_information12 Developer Descriptive flexfield segment.
200 * @param p_pbc_information13 Developer Descriptive flexfield segment.
201 * @param p_pbc_information14 Developer Descriptive flexfield segment.
202 * @param p_pbc_information15 Developer Descriptive flexfield segment.
203 * @param p_pbc_information16 Developer Descriptive flexfield segment.
204 * @param p_pbc_information17 Developer Descriptive flexfield segment.
205 * @param p_pbc_information18 Developer Descriptive flexfield segment.
206 * @param p_pbc_information19 Developer Descriptive flexfield segment.
207 * @param p_pbc_information20 Developer Descriptive flexfield segment.
208 * @param p_pbc_information21 Developer Descriptive flexfield segment.
209 * @param p_pbc_information22 Developer Descriptive flexfield segment.
210 * @param p_pbc_information23 Developer Descriptive flexfield segment.
211 * @param p_pbc_information24 Developer Descriptive flexfield segment.
212 * @param p_pbc_information25 Developer Descriptive flexfield segment.
213 * @param p_pbc_information26 Developer Descriptive flexfield segment.
214 * @param p_pbc_information27 Developer Descriptive flexfield segment.
215 * @param p_pbc_information28 Developer Descriptive flexfield segment.
216 * @param p_pbc_information29 Developer Descriptive flexfield segment.
217 * @param p_pbc_information30 Developer Descriptive flexfield segment.
218 * @param p_effective_start_date If p_validate is false, then set to the
219 * effective start date on the updated balance category row which now exists as
220 * of the effective date. If p_validate is true, then set to null.
221 * @param p_effective_end_date If p_validate is false, then set to the
222 * effective end date on the updated balance category row which now exists as
223 * of the effective date. If p_validate is true, then set to null.
224 * @rep:displayname Update Balance Category
225 * @rep:category BUSINESS_ENTITY PAY_BALANCE
226 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
227 * @rep:scope public
228 * @rep:lifecycle active
229 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
230 */
231 --
235 (p_validate in boolean default false
232 -- {End Of Comments}
233 --
234 procedure update_balance_category
236 ,p_effective_date in date
237 ,p_datetrack_update_mode in varchar2
238 ,p_balance_category_id in number
239 ,p_object_version_number in out nocopy number
240 ,p_business_group_id in number default hr_api.g_number
241 ,p_legislation_code in varchar2 default hr_api.g_varchar2
242 ,p_save_run_balance_enabled in varchar2 default hr_api.g_varchar2
243 ,p_user_category_name in varchar2 default hr_api.g_varchar2
244 ,p_pbc_information_category in varchar2 default hr_api.g_varchar2
245 ,p_pbc_information1 in varchar2 default hr_api.g_varchar2
246 ,p_pbc_information2 in varchar2 default hr_api.g_varchar2
247 ,p_pbc_information3 in varchar2 default hr_api.g_varchar2
248 ,p_pbc_information4 in varchar2 default hr_api.g_varchar2
249 ,p_pbc_information5 in varchar2 default hr_api.g_varchar2
250 ,p_pbc_information6 in varchar2 default hr_api.g_varchar2
251 ,p_pbc_information7 in varchar2 default hr_api.g_varchar2
252 ,p_pbc_information8 in varchar2 default hr_api.g_varchar2
253 ,p_pbc_information9 in varchar2 default hr_api.g_varchar2
254 ,p_pbc_information10 in varchar2 default hr_api.g_varchar2
255 ,p_pbc_information11 in varchar2 default hr_api.g_varchar2
256 ,p_pbc_information12 in varchar2 default hr_api.g_varchar2
257 ,p_pbc_information13 in varchar2 default hr_api.g_varchar2
258 ,p_pbc_information14 in varchar2 default hr_api.g_varchar2
259 ,p_pbc_information15 in varchar2 default hr_api.g_varchar2
260 ,p_pbc_information16 in varchar2 default hr_api.g_varchar2
261 ,p_pbc_information17 in varchar2 default hr_api.g_varchar2
262 ,p_pbc_information18 in varchar2 default hr_api.g_varchar2
263 ,p_pbc_information19 in varchar2 default hr_api.g_varchar2
264 ,p_pbc_information20 in varchar2 default hr_api.g_varchar2
265 ,p_pbc_information21 in varchar2 default hr_api.g_varchar2
266 ,p_pbc_information22 in varchar2 default hr_api.g_varchar2
267 ,p_pbc_information23 in varchar2 default hr_api.g_varchar2
268 ,p_pbc_information24 in varchar2 default hr_api.g_varchar2
269 ,p_pbc_information25 in varchar2 default hr_api.g_varchar2
270 ,p_pbc_information26 in varchar2 default hr_api.g_varchar2
271 ,p_pbc_information27 in varchar2 default hr_api.g_varchar2
272 ,p_pbc_information28 in varchar2 default hr_api.g_varchar2
273 ,p_pbc_information29 in varchar2 default hr_api.g_varchar2
274 ,p_pbc_information30 in varchar2 default hr_api.g_varchar2
275 ,p_effective_start_date out nocopy date
276 ,p_effective_end_date out nocopy date
277 );
278 --
279 -- ----------------------------------------------------------------------------
280 -- |-------------------------< delete_balance_category >----------------------|
281 -- ----------------------------------------------------------------------------
282 --
283 -- {Start Of Comments}
284 /*#
285 * This API deletes a balance category.
286 *
287 *
288 * <p><b>Licensing</b><br>
289 * This API is licensed for use with Human Resources.
290 *
291 * <p><b>Prerequisites</b><br>
292 * The balance category as identified by the in parameters
293 * p_balance_category_id and p_object_version_number must already exist.
294 *
295 * <p><b>Post Success</b><br>
296 * The balance category will be successfully deleted from the database.
297 *
298 * <p><b>Post Failure</b><br>
299 * The API does not delete the balance category and raises an error.
300 * @param p_validate If true, then validation alone will be performed and the
301 * database will remain unchanged. If false and all validation checks pass,
302 * then the database will be modified.
303 * @param p_effective_date Determines when the DateTrack operation comes into
304 * force.
305 * @param p_datetrack_delete_mode Indicates which DateTrack mode to use when
306 * deleting the record. You must set to either ZAP, DELETE, FUTURE_CHANGE or
307 * DELETE_NEXT_CHANGE. Modes available for use with a particular record depend
308 * on the dates of previous record changes and the effective date of this
309 * change.
310 * @param p_balance_category_id {@rep:casecolumn
311 * PAY_BALANCE_CATEGORIES_F.BALANCE_CATEGORY_ID}
312 * @param p_object_version_number Pass in the current version number of the
313 * balance category to be deleted. When the API completes if p_validate is
314 * false, will be set to the new version number of the deleted balance
315 * category. If p_validate is true will be set to the same value which was
316 * passed in.
317 * @param p_business_group_id Business Group of the Record.
318 * @param p_legislation_code Legislation Code
319 * @param p_effective_start_date If p_validate is false, then set to the
320 * effective start date for the deleted balance category row which now exists
321 * as of the effective date. If p_validate is true or all row instances have
322 * been deleted then set to null.
323 * @param p_effective_end_date If p_validate is false, then set to the
324 * effective end date for the deleted balance category row which now exists as
325 * of the effective date. If p_validate is true or all row instances have been
326 * deleted then set to null.
327 * @rep:displayname Delete Balance Category
328 * @rep:category BUSINESS_ENTITY PAY_BALANCE
329 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
330 * @rep:scope public
331 * @rep:lifecycle active
332 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
333 */
334 --
335 -- {End Of Comments}
336 --
337 procedure delete_balance_category
338 (p_validate in boolean default false
339 ,p_effective_date in date
340 ,p_datetrack_delete_mode in varchar2
341 ,p_balance_category_id in number
342 ,p_object_version_number in out nocopy number
343 ,p_business_group_id in number default hr_api.g_number
344 ,p_legislation_code in varchar2 default hr_api.g_varchar2
345 ,p_effective_start_date out nocopy date
346 ,p_effective_end_date out nocopy date
347 );
348 --
349 function return_dml_status return boolean;
350 --
351 end PAY_BALANCE_CATEGORY_API;
[Home] [Help]