1 Package hr_de_liability_premiums_api as
2 /* $Header: hrlipapi.pkh 120.1 2005/10/02 02:03:34 aroussel $ */
3 /*#
4 * This package contains APIs to maintain liability premiums for Germany.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Liability Premium for Germany
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |------------------------------< create_premium >--------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a new liability premium for an organization link.
17 *
18 * An organization link is an association between two organizations. The two
19 * linked organizations consist of a HR organization and a workers liability
20 * insurance organization.
21 *
22 * <p><b>Licensing</b><br>
23 * This API is licensed for use with Human Resources.
24 *
25 * <p><b>Prerequisites</b><br>
26 * The organization link record must exist.
27 *
28 * <p><b>Post Success</b><br>
29 * The liability premium is successfully created in the database.
30 *
31 * <p><b>Post Failure</b><br>
32 * The API does not create the liability premium and raises an error.
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 Determines when the DateTrack operation comes into
37 * force.
38 * @param p_organization_link_id Identifier of the organization link.
39 * @param p_std_percentage Standard premium percentage.
40 * @param p_calculation_method Method for calculating the standard working
41 * hours. Valid values exist in the 'DE_WORKING_HOURS_CALC_METHOD' lookup type.
42 * @param p_std_working_hours_per_year An average for the standard working
43 * hours.
44 * @param p_max_remuneration Maximum remuneration limit.
45 * @param p_attribute_category This context value determines which flexfield
46 * structure to use with the descriptive flexfield segments.
47 * @param p_attribute1 Descriptive flexfield segment.
48 * @param p_attribute2 Descriptive flexfield segment.
49 * @param p_attribute3 Descriptive flexfield segment.
50 * @param p_attribute4 Descriptive flexfield segment.
51 * @param p_attribute5 Descriptive flexfield segment.
52 * @param p_attribute6 Descriptive flexfield segment.
53 * @param p_attribute7 Descriptive flexfield segment.
54 * @param p_attribute8 Descriptive flexfield segment.
55 * @param p_attribute9 Descriptive flexfield segment.
56 * @param p_attribute10 Descriptive flexfield segment.
57 * @param p_attribute11 Descriptive flexfield segment.
58 * @param p_attribute12 Descriptive flexfield segment.
59 * @param p_attribute13 Descriptive flexfield segment.
60 * @param p_attribute14 Descriptive flexfield segment.
61 * @param p_attribute15 Descriptive flexfield segment.
62 * @param p_attribute16 Descriptive flexfield segment.
63 * @param p_attribute17 Descriptive flexfield segment.
64 * @param p_attribute18 Descriptive flexfield segment.
65 * @param p_attribute19 Descriptive flexfield segment.
66 * @param p_attribute20 Descriptive flexfield segment.
67 * @param p_liability_premiums_id If p_validate is false, the parameter value
68 * is set to the unique identifier of the liability premium record. If
69 * p_validate is true, the value is null.
70 * @param p_object_version_number If p_validate is false, then set to the
71 * version number of the created liability premium. If p_validate is true, then
72 * the value will be null.
73 * @param p_effective_start_date If p_validate is false, then set to the
74 * earliest effective start date for the created liability premium. If
75 * p_validate is true, then set to null.
76 * @param p_effective_end_date If p_validate is false, then set to the
77 * effective end date for the created liability premium. If p_validate is true,
78 * then set to null.
79 * @rep:displayname Create Liability Premium for Germany
80 * @rep:category BUSINESS_ENTITY HR_LIABILITY_PREMIUM
81 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
82 * @rep:scope public
83 * @rep:lifecycle active
84 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
85 */
86 --
87 -- {End Of Comments}
88 --
89 procedure create_premium
90 (p_validate in boolean default false
91 ,p_effective_date in date
92 ,p_organization_link_id in number
93 ,p_std_percentage in number default null
94 ,p_calculation_method in varchar2 default null
95 ,p_std_working_hours_per_year in number default null
96 ,p_max_remuneration in number default null
97 ,p_attribute_category in varchar2 default null
98 ,p_attribute1 in varchar2 default null
99 ,p_attribute2 in varchar2 default null
100 ,p_attribute3 in varchar2 default null
101 ,p_attribute4 in varchar2 default null
102 ,p_attribute5 in varchar2 default null
103 ,p_attribute6 in varchar2 default null
104 ,p_attribute7 in varchar2 default null
105 ,p_attribute8 in varchar2 default null
106 ,p_attribute9 in varchar2 default null
107 ,p_attribute10 in varchar2 default null
108 ,p_attribute11 in varchar2 default null
109 ,p_attribute12 in varchar2 default null
110 ,p_attribute13 in varchar2 default null
111 ,p_attribute14 in varchar2 default null
112 ,p_attribute15 in varchar2 default null
113 ,p_attribute16 in varchar2 default null
114 ,p_attribute17 in varchar2 default null
115 ,p_attribute18 in varchar2 default null
116 ,p_attribute19 in varchar2 default null
117 ,p_attribute20 in varchar2 default null
118 ,p_liability_premiums_id out nocopy number
119 ,p_object_version_number out nocopy number
120 ,p_effective_start_date out nocopy date
121 ,p_effective_end_date out nocopy date
122 );
123 --
124 -- ----------------------------------------------------------------------------
125 -- |------------------------------< update_premium >--------------------------|
126 -- ----------------------------------------------------------------------------
127 --
128 -- {Start Of Comments}
129 /*#
130 * This API updates a liability premium for Germany.
131 *
132 *
133 * <p><b>Licensing</b><br>
134 * This API is licensed for use with Human Resources.
135 *
136 * <p><b>Prerequisites</b><br>
137 * The liability premium record must exist.
138 *
139 * <p><b>Post Success</b><br>
140 * The API updates the liability premium record in the database.
141 *
142 * <p><b>Post Failure</b><br>
143 * The API does not update the liability premium and raises an error.
144 * @param p_validate If true, then validation alone will be performed and the
145 * database will remain unchanged. If false and all validation checks pass,
146 * then the database will be modified.
147 * @param p_effective_date Determines when the DateTrack operation comes into
148 * force.
149 * @param p_datetrack_mode Indicates which DateTrack mode to use when updating
150 * the record. You must set to either UPDATE, CORRECTION, UPDATE_OVERRIDE or
151 * UPDATE_CHANGE_INSERT. Modes available for use with a particular record
152 * depend on the dates of previous record changes and the effective date of
153 * this change.
154 * @param p_liability_premiums_id The identifier of the liability premium to
155 * update.
156 * @param p_std_percentage Standard premium percentage.
157 * @param p_calculation_method Method for calculating the standard working
158 * hours. Valid values exist in the 'DE_WORKING_HOURS_CALC_METHOD' lookup type.
159 * @param p_std_working_hours_per_year An average for the standard working
160 * hours.
161 * @param p_max_remuneration Maximum remuneration limit.
162 * @param p_attribute_category This context value determines which flexfield
163 * structure to use with the descriptive flexfield segments.
164 * @param p_attribute1 Descriptive flexfield segment.
165 * @param p_attribute2 Descriptive flexfield segment.
166 * @param p_attribute3 Descriptive flexfield segment.
167 * @param p_attribute4 Descriptive flexfield segment.
168 * @param p_attribute5 Descriptive flexfield segment.
169 * @param p_attribute6 Descriptive flexfield segment.
170 * @param p_attribute7 Descriptive flexfield segment.
171 * @param p_attribute8 Descriptive flexfield segment.
172 * @param p_attribute9 Descriptive flexfield segment.
173 * @param p_attribute10 Descriptive flexfield segment.
174 * @param p_attribute11 Descriptive flexfield segment.
175 * @param p_attribute12 Descriptive flexfield segment.
176 * @param p_attribute13 Descriptive flexfield segment.
177 * @param p_attribute14 Descriptive flexfield segment.
178 * @param p_attribute15 Descriptive flexfield segment.
179 * @param p_attribute16 Descriptive flexfield segment.
180 * @param p_attribute17 Descriptive flexfield segment.
181 * @param p_attribute18 Descriptive flexfield segment.
182 * @param p_attribute19 Descriptive flexfield segment.
183 * @param p_attribute20 Descriptive flexfield segment.
184 * @param p_object_version_number Pass in the current version number of the
185 * liability premium to be updated. When the API completes if p_validate is
186 * false, will be set to the new version number of the updated liability
187 * premium. If p_validate is true will be set to the same value which was
188 * passed in.
189 * @param p_effective_start_date If p_validate is false, then set to the
190 * effective start date on the updated liability premium row which now exists
191 * as of the effective date. If p_validate is true, then set to null.
192 * @param p_effective_end_date If p_validate is false, then set to the
193 * effective end date on the updated liability premium row which now exists as
194 * of the effective date. If p_validate is true, then set to null.
195 * @rep:displayname Update Liability Premium for Germany
196 * @rep:category BUSINESS_ENTITY HR_LIABILITY_PREMIUM
197 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
198 * @rep:scope public
199 * @rep:lifecycle active
200 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
201 */
202 --
203 -- {End Of Comments}
204 --
205 procedure update_premium
206 (p_validate in boolean default false
207 ,p_effective_date in date
208 ,p_datetrack_mode in varchar2
209 ,p_liability_premiums_id in number
210 ,p_std_percentage in number default hr_api.g_number
211 ,p_calculation_method in varchar2 default hr_api.g_varchar2
212 ,p_std_working_hours_per_year in number default hr_api.g_number
213 ,p_max_remuneration in number default hr_api.g_number
214 ,p_attribute_category in varchar2 default hr_api.g_varchar2
215 ,p_attribute1 in varchar2 default hr_api.g_varchar2
216 ,p_attribute2 in varchar2 default hr_api.g_varchar2
217 ,p_attribute3 in varchar2 default hr_api.g_varchar2
218 ,p_attribute4 in varchar2 default hr_api.g_varchar2
219 ,p_attribute5 in varchar2 default hr_api.g_varchar2
220 ,p_attribute6 in varchar2 default hr_api.g_varchar2
221 ,p_attribute7 in varchar2 default hr_api.g_varchar2
222 ,p_attribute8 in varchar2 default hr_api.g_varchar2
223 ,p_attribute9 in varchar2 default hr_api.g_varchar2
224 ,p_attribute10 in varchar2 default hr_api.g_varchar2
225 ,p_attribute11 in varchar2 default hr_api.g_varchar2
226 ,p_attribute12 in varchar2 default hr_api.g_varchar2
227 ,p_attribute13 in varchar2 default hr_api.g_varchar2
228 ,p_attribute14 in varchar2 default hr_api.g_varchar2
229 ,p_attribute15 in varchar2 default hr_api.g_varchar2
230 ,p_attribute16 in varchar2 default hr_api.g_varchar2
231 ,p_attribute17 in varchar2 default hr_api.g_varchar2
232 ,p_attribute18 in varchar2 default hr_api.g_varchar2
233 ,p_attribute19 in varchar2 default hr_api.g_varchar2
234 ,p_attribute20 in varchar2 default hr_api.g_varchar2
235 ,p_object_version_number in out nocopy number
236 ,p_effective_start_date out nocopy date
237 ,p_effective_end_date out nocopy date
238 );
239 --
240 -- ----------------------------------------------------------------------------
241 -- |------------------------------< delete_premium >--------------------------|
242 -- ----------------------------------------------------------------------------
243 --
244 -- {Start Of Comments}
245 /*#
246 * This API deletes an existing liability premium for Germany.
247 *
248 *
249 * <p><b>Licensing</b><br>
250 * This API is licensed for use with Human Resources.
251 *
252 * <p><b>Prerequisites</b><br>
253 * The liability premium record must exist.
254 *
255 * <p><b>Post Success</b><br>
256 * The liability premium record is successfully deleted from the database.
257 *
258 * <p><b>Post Failure</b><br>
259 * The API does not update the liability premium and raises an error.
260 * @param p_validate If true, then validation alone will be performed and the
261 * database will remain unchanged. If false and all validation checks pass,
262 * then the database will be modified.
263 * @param p_effective_date Determines when the DateTrack operation comes into
264 * force.
265 * @param p_datetrack_mode Indicates which DateTrack mode to use when deleting
266 * the record. You must set to either ZAP, DELETE, FUTURE_CHANGE or
267 * DELETE_NEXT_CHANGE. Modes available for use with a particular record depend
268 * on the dates of previous record changes and the effective date of this
269 * change.
270 * @param p_liability_premiums_id Identifier of the liability premium to
271 * delete.
272 * @param p_object_version_number Current version number of the liability
273 * premium to be deleted.
274 * @param p_effective_start_date If p_validate is false, then set to the
275 * effective start date for the deleted liability premium row which now exists
276 * as of the effective date. If p_validate is true or all row instances have
277 * been deleted then set to null.
278 * @param p_effective_end_date If p_validate is false, then set to the
279 * effective end date for the deleted liability premium row which now exists as
280 * of the effective date. If p_validate is true or all row instances have been
281 * deleted then set to null.
282 * @rep:displayname Delete Liability Premium for Germany
283 * @rep:category BUSINESS_ENTITY HR_LIABILITY_PREMIUM
284 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
285 * @rep:scope public
286 * @rep:lifecycle active
287 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
288 */
289 --
290 -- {End Of Comments}
291 --
292 procedure delete_premium
293 (p_validate in boolean default false
294 ,p_effective_date in date
295 ,p_datetrack_mode in varchar2
296 ,p_liability_premiums_id in number
297 ,p_object_version_number in out nocopy number
298 ,p_effective_start_date out nocopy date
299 ,p_effective_end_date out nocopy date
300 );
301 --
302 -- ----------------------------------------------------------------------------
303 -- |----------------------------------< lck >---------------------------------|
304 -- ----------------------------------------------------------------------------
305 -- {Start Of Comments}
306 --
307 -- Description:
308 --
312 --
309 -- This API locks an existing liability premium.
310 --
311 -- Prerequisites:
313 -- The liability premium record must exist.
314 --
315 -- In Parameters:
316 --
317 -- Name Reqd Type Description
318 -- p_effective_date Yes date Session date.
319 -- p_datetrack_mode Yes varchar2 datetrack mode.
320 -- p_liability_premiums_id Yes number PK of record.
321 -- p_object_version_number Yes number OVN of record.
322 --
323 -- Post Success:
324 --
325 -- When the liability premium has been succesfully locked, the
326 -- following out parameters are set:
327 --
328 -- Name Type Description
329 -- p_object_version_number number OVN of record.
330 -- p_validation_start_date date Derived effective start date.
331 -- p_validation_end_date date Derived effective end date.
332 --
333 -- Post Failure:
334 --
335 -- The API does not lock the liability premium and raises an error.
336 --
337 -- Access Status:
338 --
339 -- Public.
340 --
341 -- {End Of Comments}
342 --
343 procedure lck
344 (p_effective_date in date
345 ,p_datetrack_mode in varchar2
346 ,p_liability_premiums_id in number
347 ,p_object_version_number in number
348 ,p_validation_start_date out nocopy date
349 ,p_validation_end_date out nocopy date
350 );
351 --
352 end hr_de_liability_premiums_api;
[Home] [Help]