1 Package PAY_BALANCE_TYPES_API as
2 /* $Header: pybltapi.pkh 120.1 2005/10/02 02:46:06 aroussel $ */
3 /*#
4 * This package contains Balance Type APIs.
5 * @rep:scope public
6 * @rep:product PAY
7 * @rep:displayname Balance Type
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-----------------------------< create_bal_type >--------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This Business Process is used to create a new Balance Type.
17 *
18 *
19 * <p><b>Licensing</b><br>
20 * This API is licensed for use with Payroll.
21 *
22 * <p><b>Prerequisites</b><br>
23 * If this balance type to be used only within a business group then a valid
24 * business group should exist.
25 *
26 * <p><b>Post Success</b><br>
27 * The balance type will be successfully inserted into the database.
28 *
29 * <p><b>Post Failure</b><br>
30 * Error Messages are raised if any business rule is violated and the balance
31 * type is not created.
32 *
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 Reference date for validating lookup values are
37 * applicable during the start to end active date range. This date does not
38 * determine when the changes take effect.
39 * @param p_language_code Specifies to which language the translation values
40 * apply. You can set to the base or any installed language. The default value
41 * of hr_api.userenv_lang is equivalent to the RDBMS userenv('LANG') function
42 * value.
43 * @param p_balance_name Name of the Balance.
44 * @param p_balance_uom Unit of Measure of the Balance. Valid values are
45 * defined by the 'UNITS' lookup type.
46 * @param p_business_group_id Business group of the Balance.
47 * @param p_legislation_code Legislation of the Balance.
48 * @param p_currency_code Currency code.
49 * @param p_assignment_remuneration_flag Indicates the balance is used for
50 * assignment remuneration or for third party payments. (Default 'N')
51 * @param p_comments Balance Type comment.
52 * @param p_legislation_subgroup Identifies the legislation of the predefined
53 * data for the element.
54 * @param p_reporting_name User name for reporting purposes.
55 * @param p_attribute_category This context value determines which flexfield
56 * structure to use with the descriptive flexfield segments.
57 * @param p_attribute1 Descriptive flexfield segment.
58 * @param p_attribute2 Descriptive flexfield segment.
59 * @param p_attribute3 Descriptive flexfield segment.
60 * @param p_attribute4 Descriptive flexfield segment.
61 * @param p_attribute5 Descriptive flexfield segment.
62 * @param p_attribute6 Descriptive flexfield segment.
63 * @param p_attribute7 Descriptive flexfield segment.
64 * @param p_attribute8 Descriptive flexfield segment.
65 * @param p_attribute9 Descriptive flexfield segment.
66 * @param p_attribute10 Descriptive flexfield segment.
67 * @param p_attribute11 Descriptive flexfield segment.
68 * @param p_attribute12 Descriptive flexfield segment.
69 * @param p_attribute13 Descriptive flexfield segment.
70 * @param p_attribute14 Descriptive flexfield segment.
71 * @param p_attribute15 Descriptive flexfield segment.
72 * @param p_attribute16 Descriptive flexfield segment.
73 * @param p_attribute17 Descriptive flexfield segment.
74 * @param p_attribute18 Descriptive flexfield segment.
75 * @param p_attribute19 Descriptive flexfield segment.
76 * @param p_attribute20 Descriptive flexfield segment.
77 * @param p_jurisdiction_level US specific. Indicates the jurisdiction level
78 * that applies to the balance type, federal, state, county or city.
79 * @param p_tax_type US specific. Tax type of the balance.
80 * @param p_balance_category_id Balance Category id
81 * @param p_base_balance_type_id Balance_Type_Id for base balance.
82 * @param p_input_value_id Input_value_id for primary balance
83 * @param p_balance_type_id Primary Key If p_validate is true then this will be
84 * set to null.
85 * @param p_object_version_number If p_validate is false, then set to the
86 * version number of the created event procedure. If p_validate is true, then
87 * the value will be null.
88 * @rep:displayname Create Balance Type
89 * @rep:category BUSINESS_ENTITY PAY_BALANCE
90 * @rep:lifecycle active
91 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
92 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
93 * @rep:scope public
94 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
95 */
96 --
97 -- {End Of Comments}
98 --
99 procedure create_bal_type
100 (p_validate in boolean default false
101 ,p_effective_date in date
102 ,p_language_code in varchar2 Default hr_api.userenv_lang
103 ,p_balance_name in varchar2
104 ,p_balance_uom in varchar2
105 ,p_business_group_id in number
106 ,p_legislation_code in varchar2 default null
107 ,p_currency_code in varchar2 default null
108 ,p_assignment_remuneration_flag in varchar2 default 'N'
109 ,p_comments in varchar2 default null
110 ,p_legislation_subgroup in varchar2 default null
111 ,p_reporting_name in varchar2 default null
112 ,p_attribute_category in varchar2 default null
113 ,p_attribute1 in varchar2 default null
114 ,p_attribute2 in varchar2 default null
115 ,p_attribute3 in varchar2 default null
116 ,p_attribute4 in varchar2 default null
117 ,p_attribute5 in varchar2 default null
118 ,p_attribute6 in varchar2 default null
119 ,p_attribute7 in varchar2 default null
120 ,p_attribute8 in varchar2 default null
121 ,p_attribute9 in varchar2 default null
122 ,p_attribute10 in varchar2 default null
123 ,p_attribute11 in varchar2 default null
124 ,p_attribute12 in varchar2 default null
125 ,p_attribute13 in varchar2 default null
126 ,p_attribute14 in varchar2 default null
127 ,p_attribute15 in varchar2 default null
128 ,p_attribute16 in varchar2 default null
129 ,p_attribute17 in varchar2 default null
130 ,p_attribute18 in varchar2 default null
131 ,p_attribute19 in varchar2 default null
132 ,p_attribute20 in varchar2 default null
133 ,p_jurisdiction_level in number default null
134 ,p_tax_type in varchar2 default null
135 ,p_balance_category_id in number default null
136 ,p_base_balance_type_id in number default null
137 ,p_input_value_id in number default null
138 ,p_balance_type_id out nocopy number
139 ,p_object_version_number out nocopy number
140 );
141 --
142 -- ----------------------------------------------------------------------------
143 -- |-----------------------------< update_bal_type >--------------------------|
144 -- ----------------------------------------------------------------------------
145 --
146 -- {Start Of Comments}
147 /*#
148 * This Business Process is used to update Balance Type.
149 *
150 *
151 * <p><b>Licensing</b><br>
152 * This API is licensed for use with Payroll.
153 *
154 * <p><b>Prerequisites</b><br>
155 * The balance type to be updated should exist.
156 *
157 * <p><b>Post Success</b><br>
158 * The balance type will be successfully updated into the database.
159 *
160 * <p><b>Post Failure</b><br>
161 * Error Messages are raised if any business rule is violated and the balance
162 * type is not updated.
163 *
164 * @param p_validate If true, then validation alone will be performed and the
165 * database will remain unchanged. If false and all validation checks pass,
166 * then the database will be modified.
167 * @param p_effective_date Reference date for validating lookup values are
168 * applicable during the start to end active date range. This date does not
169 * determine when the changes take effect.
170 * @param p_language_code Specifies to which language the translation values
171 * apply. You can set to the base or any installed language. The default value
172 * of hr_api.userenv_lang is equivalent to the RDBMS userenv('LANG') function
173 * value.
174 * @param p_balance_type_id primary key.
175 * @param p_object_version_number Pass in the current version number of the
176 * balance type to be updated. When the API completes if p_validate is false,
177 * will be set to the new version number of the updated balance type. If
178 * p_validate is true will be set to the same value which was passed in.
179 * @param p_balance_name name of the Balance.
180 * @param p_balance_uom Unit of Measure of the Balance. Valid values are
181 * defined by the 'UNITS' lookup type.
182 * @param p_currency_code Currency code.
183 * @param p_assignment_remuneration_flag Indicates the balance is used for
184 * assignment remuneration or for third party payments. (Default 'N')
185 * @param p_comments Blance type comment text.
186 * @param p_reporting_name User name for reporting purposes.
187 * @param p_attribute_category This context value determines which flexfield
188 * structure to use with the descriptive flexfield segments.
189 * @param p_attribute1 Descriptive flexfield segment.
190 * @param p_attribute2 Descriptive flexfield segment.
191 * @param p_attribute3 Descriptive flexfield segment.
192 * @param p_attribute4 Descriptive flexfield segment.
193 * @param p_attribute5 Descriptive flexfield segment.
194 * @param p_attribute6 Descriptive flexfield segment.
195 * @param p_attribute7 Descriptive flexfield segment.
196 * @param p_attribute8 Descriptive flexfield segment.
197 * @param p_attribute9 Descriptive flexfield segment.
198 * @param p_attribute10 Descriptive flexfield segment.
199 * @param p_attribute11 Descriptive flexfield segment.
200 * @param p_attribute12 Descriptive flexfield segment.
201 * @param p_attribute13 Descriptive flexfield segment.
202 * @param p_attribute14 Descriptive flexfield segment.
203 * @param p_attribute15 Descriptive flexfield segment.
204 * @param p_attribute16 Descriptive flexfield segment.
205 * @param p_attribute17 Descriptive flexfield segment.
206 * @param p_attribute18 Descriptive flexfield segment.
207 * @param p_attribute19 Descriptive flexfield segment.
208 * @param p_attribute20 Descriptive flexfield segment.
209 * @param p_balance_category_id Balance Category id
210 * @param p_base_balance_type_id Balance_Type_Id for base balance.
211 * @param p_input_value_id Input_value_id for primary balance
212 * @param p_balance_name_warning this parameter will be set when balance_name
213 * is updated.
214 * @rep:displayname Update Balance Type
215 * @rep:category BUSINESS_ENTITY PAY_BALANCE
216 * @rep:lifecycle active
217 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
218 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
219 * @rep:scope public
220 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
221 */
222 --
223 -- {End Of Comments}
224 --
225 procedure update_bal_type
226 (p_validate in boolean default false
227 ,p_effective_date in date
228 ,p_language_code in varchar2 Default hr_api.userenv_lang
229 ,p_balance_type_id in number
230 ,p_object_version_number in out nocopy number
231 ,p_balance_name in varchar2 default hr_api.g_varchar2
232 ,p_balance_uom in varchar2 default hr_api.g_varchar2
233 ,p_currency_code in varchar2 default hr_api.g_varchar2
234 ,p_assignment_remuneration_flag in varchar2 default hr_api.g_varchar2
235 ,p_comments in varchar2 default hr_api.g_varchar2
236 ,p_reporting_name in varchar2 default hr_api.g_varchar2
237 ,p_attribute_category in varchar2 default hr_api.g_varchar2
238 ,p_attribute1 in varchar2 default hr_api.g_varchar2
242 ,p_attribute5 in varchar2 default hr_api.g_varchar2
239 ,p_attribute2 in varchar2 default hr_api.g_varchar2
240 ,p_attribute3 in varchar2 default hr_api.g_varchar2
241 ,p_attribute4 in varchar2 default hr_api.g_varchar2
243 ,p_attribute6 in varchar2 default hr_api.g_varchar2
244 ,p_attribute7 in varchar2 default hr_api.g_varchar2
245 ,p_attribute8 in varchar2 default hr_api.g_varchar2
246 ,p_attribute9 in varchar2 default hr_api.g_varchar2
247 ,p_attribute10 in varchar2 default hr_api.g_varchar2
248 ,p_attribute11 in varchar2 default hr_api.g_varchar2
249 ,p_attribute12 in varchar2 default hr_api.g_varchar2
250 ,p_attribute13 in varchar2 default hr_api.g_varchar2
251 ,p_attribute14 in varchar2 default hr_api.g_varchar2
252 ,p_attribute15 in varchar2 default hr_api.g_varchar2
253 ,p_attribute16 in varchar2 default hr_api.g_varchar2
254 ,p_attribute17 in varchar2 default hr_api.g_varchar2
255 ,p_attribute18 in varchar2 default hr_api.g_varchar2
256 ,p_attribute19 in varchar2 default hr_api.g_varchar2
257 ,p_attribute20 in varchar2 default hr_api.g_varchar2
258 ,p_balance_category_id in number default hr_api.g_number
259 ,p_base_balance_type_id in number default hr_api.g_number
260 ,p_input_value_id in number default hr_api.g_number
261 ,p_balance_name_warning out nocopy number
262 );
263 --
264 -- ----------------------------------------------------------------------------
265 -- |-----------------------------< delete_bal_type >--------------------------|
266 -- ----------------------------------------------------------------------------
267 --
268 -- {Start Of Comments}
269 /*#
270 * This Business Process is used to delete Balance Type.
271 *
272 *
273 * <p><b>Licensing</b><br>
274 * This API is licensed for use with Payroll.
275 *
276 * <p><b>Prerequisites</b><br>
277 * The balance type to be deleted should exist.
278 *
279 * <p><b>Post Success</b><br>
280 * The balance type will be successfully deleted from the database.
281 *
282 * <p><b>Post Failure</b><br>
283 * Error Messages are raised if any business rule is violated and the balance
284 * type is not deleted.
285 *
286 * @param p_validate If true, then validation alone will be performed and the
287 * database will remain unchanged. If false and all validation checks pass,
288 * then the database will be modified.
289 * @param p_balance_type_id primary key.
290 * @param p_object_version_number Pass in the current version number of the
291 * balance type to be deleted. When the API completes if p_validate is false,
292 * will be set to the new version number of the deleted balance type. If
293 * p_validate is true will be set to the same value which was passed in.
294 * @rep:displayname Delete Balance Type
295 * @rep:category BUSINESS_ENTITY PAY_BALANCE
296 * @rep:lifecycle active
297 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
298 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
299 * @rep:scope public
300 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
301 */
302 --
303 -- {End Of Comments}
304 --
305 procedure delete_bal_type
306 (p_validate in boolean default false
307 ,p_balance_type_id in number
308 ,p_object_version_number in out nocopy number
309 );
310 --
311
312 end PAY_BALANCE_TYPES_API;
[Home] [Help]