1 Package pqp_pl_vehicle_allocations_api as
2 /* $Header: pqvalpli.pkh 120.3 2006/04/24 23:29:02 nprasath noship $ */
3 /*#
4 * This package contains Vehicle Allocation APIs for Poland.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Vehicle allocation for Poland
8 */---------------------------------------------------------------------------
9 -- |--------------------------< create_pl_vehicle_allocation>------------------|
10 -- ----------------------------------------------------------------------------
11 --
12 -- {Start Of Comments}
13 --
14 /*#
15 * This API creates vehicle allocation for polish person.
16 * This is an alternative to generic CREATE_VEHICLE_ALLOCATION API.
17 *
18 * <p><b>Licensing</b><br>
19 * This API is licensed for use with Human Resources.
20 *
21 * <p><b>Prerequisites</b><br>
22 * Vehicle should be present in the vehicle repository before allocating to an
23 * assignment.
24 *
25 * <p><b> Post Success</b><br>
26 * The vehicle allocation record will be successfully inserted into the
27 * database.
28 *
29 * <p><b> Post Failure</b><br>
30 * The vehicle allocation record will not be created and an error will be
31 * raised.
32 * @param p_validate If true, the database remains unchanged. If false,
33 * vehicle allocation is created.
34 * @param p_effective_date The start date of vehicle allocation record
35 * @param p_assignment_id The assignment identifier having this vehicle
36 * allocation.
37 * @param p_business_group_id Business group identifier
38 * @param p_vehicle_repository_id The repository identifier of the
39 * vehicle which is being allocated to this assignment.The id is from
40 * PQP_VEHICLE_REPOSITORY_F table
41 * @param p_across_assignments Identifies whether the vehicle allocation is
42 * across assignments,if there are multiple assignments for this employee.
43 * @param p_usage_type The usage type for this allocation. This value depends
44 * on the type of vehicle being allocated.Valid values are from
45 * 'PQP_COMPANY_VEHICLE_USER' or 'PQP_PRIVATE_VEHICLE_USER' lookup type.
46 * @param p_capital_contribution Capital contribution from the employee
47 * towards this vehicle
48 * @param p_private_contribution Private contribution from the employee
49 * towards this vehicle.
50 * @param p_default_vehicle Identifies whether this vehicle should be treated
51 * as the default vehicle for mileage claims when more than one vehicle
52 * is allocated.
53 * @param p_fuel_card Identifies whether a fuel card has been given for this
54 * allocation.
55 * @param p_fuel_card_number Fuel card number if fuel card has been given
56 * @param p_calculation_method Calculation method used for mileage
57 * calculation.Valid values are defined by 'PQP_VEHICLE_CALC_METHOD'
58 * lookup type
59 * @param p_rates_table_id Rates table identifier if the mileage rates
60 * should be based on a particular user defined table.
61 * @param p_element_type_id The element type identifier if a particular
62 * element should be used for mileage calculations.
63 * @param p_private_use_flag Indicates whether the company vehicle user
64 * can use this vehicle for private purposes.
65 * @param p_insurance_number Insurance number for the vehicle.
66 * @param p_insurance_expiry_date Insurance expiration date.
67 * @param p_val_attribute_category Descriptive flexfield column
68 * @param p_val_attribute1 Descriptive flexfield column
69 * @param p_val_attribute2 Descriptive flexfield column
70 * @param p_val_attribute3 Descriptive flexfield column
71 * @param p_val_attribute4 Descriptive flexfield column
72 * @param p_val_attribute5 Descriptive flexfield column
73 * @param p_val_attribute6 Descriptive flexfield column
74 * @param p_val_attribute7 Descriptive flexfield column
75 * @param p_val_attribute8 Descriptive flexfield column
76 * @param p_val_attribute9 Descriptive flexfield column
77 * @param p_val_attribute10 Descriptive flexfield column
78 * @param p_val_attribute11 Descriptive flexfield column
79 * @param p_val_attribute12 Descriptive flexfield column
80 * @param p_val_attribute13 Descriptive flexfield column
81 * @param p_val_attribute14 Descriptive flexfield column
82 * @param p_val_attribute15 Descriptive flexfield column
83 * @param p_val_attribute16 Descriptive flexfield column
84 * @param p_val_attribute17 Descriptive flexfield column
85 * @param p_val_attribute18 Descriptive flexfield column
86 * @param p_val_attribute19 Descriptive flexfield column
87 * @param p_val_attribute20 Descriptive flexfield column
88 * @param p_val_information_category Developer descriptive flexfield column
89 * @param p_agreement_description Agreement description
90 * @param p_month_mileage_limit_by_law Monthly mileage limit by law
91 * @param p_month_mileage_limit_by_emp Monthly mileage limit by employee
92 * @param p_other_conditions Other conditions
93 * @param p_fuel_benefit Identifies whether there is any additional fuel
94 * benefit for this allocation.
95 * @param p_sliding_rates_info Sliding rates table information.Valid values
96 * are defined by 'PQP_SLIDING_RATES' lookup type
97 * @param p_vehicle_allocation_id System generated primary key column from the
98 * sequence PQP_VEHICLE_ALLOCATIONS_F_S.If p_validate is false, uniquely
99 * identifies the Vehicle Allocation created.If p_validate is true, set to null
100 * @param p_object_version_number System generated version of row. Increments by
101 * one with each update.If p_validate is false, set to the version number of
102 * this vehicle allocation. If p_validate is true, set to null.If p_validate is
103 * false, set to the version number of this vehicle allocation.
104 * If p_validate is true,set to null.
105 * @param p_effective_start_date If p_validate is false, then set to the
106 * earliest effective start date for the allocated vehicle. If p_validate is
107 * true, then set to null.
108 * @param p_effective_end_date If p_validate is false, then set to the
109 * effective end date for the allocated vehicle. If p_validate is true,
110 * then set to null.
111 * @rep:displayname Create Vehicle Allocation for Poland
112 * @rep:category BUSINESS_ENTITY PQP_VEHICLE_ALLOCATION
113 * @rep:lifecycle active
114 * @rep:scope public
115 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
116 */
117 --
118 -- {End Of Comments}
119 --
120
121 procedure create_pl_vehicle_allocation
122 (p_validate in boolean default false
123 ,p_effective_date in date
124 ,p_assignment_id in number
125 ,p_business_group_id in number
126 ,p_vehicle_repository_id in number default null
127 ,p_across_assignments in varchar2 default null
128 ,p_usage_type in varchar2 default null
129 ,p_capital_contribution in number default null
130 ,p_private_contribution in number default null
131 ,p_default_vehicle in varchar2 default null
132 ,p_fuel_card in varchar2 default null
133 ,p_fuel_card_number in varchar2 default null
134 ,p_calculation_method in varchar2 default null
135 ,p_rates_table_id in number default null
136 ,p_element_type_id in number default null
137 ,p_private_use_flag in varchar2 default null
138 ,p_insurance_number in varchar2 default null
139 ,p_insurance_expiry_date in date default null
140 ,p_val_attribute_category in varchar2 default null
141 ,p_val_attribute1 in varchar2 default null
142 ,p_val_attribute2 in varchar2 default null
143 ,p_val_attribute3 in varchar2 default null
144 ,p_val_attribute4 in varchar2 default null
145 ,p_val_attribute5 in varchar2 default null
146 ,p_val_attribute6 in varchar2 default null
147 ,p_val_attribute7 in varchar2 default null
148 ,p_val_attribute8 in varchar2 default null
149 ,p_val_attribute9 in varchar2 default null
150 ,p_val_attribute10 in varchar2 default null
151 ,p_val_attribute11 in varchar2 default null
152 ,p_val_attribute12 in varchar2 default null
153 ,p_val_attribute13 in varchar2 default null
154 ,p_val_attribute14 in varchar2 default null
155 ,p_val_attribute15 in varchar2 default null
156 ,p_val_attribute16 in varchar2 default null
157 ,p_val_attribute17 in varchar2 default null
158 ,p_val_attribute18 in varchar2 default null
159 ,p_val_attribute19 in varchar2 default null
160 ,p_val_attribute20 in varchar2 default null
161 ,p_val_information_category in varchar2 default null
162 ,p_agreement_description in varchar2 default null
163 ,p_month_mileage_limit_by_law in varchar2 default null
164 ,p_month_mileage_limit_by_emp in varchar2 default null
165 ,p_other_conditions in varchar2 default null
166 ,p_fuel_benefit in varchar2 default null
167 ,p_sliding_rates_info in varchar2 default null
168 ,p_vehicle_allocation_id out nocopy number
169 ,p_object_version_number out nocopy number
170 ,p_effective_start_date out nocopy date
171 ,p_effective_end_date out nocopy date
172 );
173 --
174
175 -- --------------------------------------------------------------------------------------
176 -- |--------------------------< update_pl_vehicle_allocation >--------------------------|
177 -- --------------------------------------------------------------------------------------
178 --
179 -- {Start Of Comments}
180 --
181
182 /*#
183 * This API updates the vehicle allocation for polish person.
184 * This is an alternative to generic UPDATE_VEHICLE_ALLOCATION API.
185 *
186 * <p><b>Licensing</b><br>
187 * This API is licensed for use with Human Resources
188 *
189 * <p><b>Prerequisites</b><br>
190 * The Vehicle allocation to be updated must exist for Polish Localization
191 *
192 * <p><b> Post Success</b><br>
193 * The vehicle allocation record will be successfully updated into the
194 * database
195 *
196 * <p><b> Post Failure</b><br>
197 * The vehicle allocation record will not be updated and an error will be
198 * raised
199 * @param p_validate If true, the database remains unchanged. If false,
200 * the vehicle allocation is created
201 * @param p_effective_date Determines when the DateTrack operation comes into
202 * force
203 * @param p_datetrack_mode Indicates which DateTrack mode to use when
204 * updating the record. This must be set to either UPDATE, CORRECTION,
205 * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
206 * particular record depend on the dates of previous record changes and the
207 * effective date of this change.
208 * @param p_vehicle_allocation_id Identifies the vehicle allocation to be
209 * updated
210 * @param p_object_version_number System generated version of row. Increments
211 * by one with each update.If p_validate is false, set to the version number of
212 * updated vehicle allocation. If p_validate is true, the object number version
213 * is left unchanged
214 * @param p_assignment_id Assignment identifier having this vehicle allocation
215 * @param p_business_group_id Business Group Identifier
216 * @param p_vehicle_repository_id Repository identifier of the vehicle which is
217 * being allocated to this assignment.The id is from PQP_VEHICLE_REPOSITORY_F table
218 * @param p_across_assignments Identifies whether the vehicle allocation is
219 * across assignments if there are multiple assignments for this employee
220 * @param p_usage_type The usage type for this allocation. This value depends
221 * on the type of vehicle being allocated.Valid values are defiend by
222 * 'PQP_COMPANY_VEHICLE_USER' or 'PQP_PRIVATE_VEHICLE_USER' lookup type
223 * @param p_capital_contribution Capital contribution from the employee
224 * towards this vehicle
225 * @param p_private_contribution Private contribution from the employee
226 * towards this vehicle
227 * @param p_default_vehicle Identifies whether this vehicle should be treated
228 * as the default vehicle for mileage claims when more than one
229 * vehicle is allocated
230 * @param p_fuel_card Identifies whether a fuel card has been given for this
231 * allocation
232 * @param p_fuel_card_number Fuel card number if fuel card has been given
233 * @param p_calculation_method Calculation method used for mileage
234 * calculation.Valid values are defined by 'PQP_VEHICLE_CALC_METHOD'
235 * lookup type
236 * @param p_rates_table_id Rates table Identifier if the mileage rates
237 * should be based on a particular user defined table
238 * @param p_element_type_id Element type identifier if a particular
239 * element should be used for mileage calculations
240 * @param p_private_use_flag Indicates whether the company vehicle user can use
241 * this vehicle for private purposes
242 * @param p_insurance_number Insurance details for the vehicle
243 * @param p_insurance_expiry_date Insurance expiration date
244 * @param p_val_attribute_category Descriptive flexfield column
245 * @param p_val_attribute1 Descriptive flexfield column
246 * @param p_val_attribute2 Descriptive flexfield column
247 * @param p_val_attribute3 Descriptive flexfield column
248 * @param p_val_attribute4 Descriptive flexfield column
249 * @param p_val_attribute5 Descriptive flexfield column
250 * @param p_val_attribute6 Descriptive flexfield column
251 * @param p_val_attribute7 Descriptive flexfield column
252 * @param p_val_attribute8 Descriptive flexfield column
253 * @param p_val_attribute9 Descriptive flexfield column
254 * @param p_val_attribute10 Descriptive flexfield column
255 * @param p_val_attribute11 Descriptive flexfield column
256 * @param p_val_attribute12 Descriptive flexfield column
257 * @param p_val_attribute13 Descriptive flexfield column
258 * @param p_val_attribute14 Descriptive flexfield column
259 * @param p_val_attribute15 Descriptive flexfield column
260 * @param p_val_attribute16 Descriptive flexfield column
264 * @param p_val_attribute20 Descriptive flexfield column
261 * @param p_val_attribute17 Descriptive flexfield column
262 * @param p_val_attribute18 Descriptive flexfield column
263 * @param p_val_attribute19 Descriptive flexfield column
265 * @param p_val_information_category Developer descriptive flexfield column
266 * @param p_agreement_description Agreement description
267 * @param p_month_mileage_limit_by_emp Monthly mileage limit by employee
268 * @param p_month_mileage_limit_by_law Monthly milegae limit by law
269 * @param p_other_conditions Other Conditions
270 * @param p_fuel_benefit Identifies whether there is any additional fuel
271 * benefit for this allocation
272 * @param p_sliding_rates_info The Sliding rates table information.Valid values
273 * are defined by 'PQP_SLIDING_RATES' lookup type
274 * @param p_effective_start_date If p_validate is false, then set to the
275 * effective start date on the updated vehicle allocation row which now exists
276 * as of the effective date. If p_validate is true, then set to null
277 * @param p_effective_end_date If p_validate is false, then set to the
278 * effective end date on the updated vehicle allocation row which now exists
279 * as of the effective date. If p_validate is true, then set to null
280 * @rep:displayname Update Vehicle Allocation for Poland
281 * @rep:category BUSINESS_ENTITY PQP_VEHICLE_ALLOCATION
282 * @rep:lifecycle active
283 * @rep:scope public
284 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
285 */
286
287 --
288 -- {End Of Comments}
289 Procedure update_pl_vehicle_allocation
290 (p_validate in boolean default false
291 ,p_effective_date in date
292 ,p_datetrack_mode in varchar2
293 ,p_vehicle_allocation_id in number
294 ,p_object_version_number in out nocopy number
295 ,p_assignment_id in number default hr_api.g_number
296 ,p_business_group_id in number default hr_api.g_number
297 ,p_vehicle_repository_id in number default hr_api.g_number
298 ,p_across_assignments in varchar2 default hr_api.g_varchar2
299 ,p_usage_type in varchar2 default hr_api.g_varchar2
300 ,p_capital_contribution in number default hr_api.g_number
301 ,p_private_contribution in number default hr_api.g_number
302 ,p_default_vehicle in varchar2 default hr_api.g_varchar2
303 ,p_fuel_card in varchar2 default hr_api.g_varchar2
304 ,p_fuel_card_number in varchar2 default hr_api.g_varchar2
305 ,p_calculation_method in varchar2 default hr_api.g_varchar2
306 ,p_rates_table_id in number default hr_api.g_number
307 ,p_element_type_id in number default hr_api.g_number
308 ,p_private_use_flag in varchar2 default hr_api.g_varchar2
309 ,p_insurance_number in varchar2 default hr_api.g_varchar2
310 ,p_insurance_expiry_date in date default hr_api.g_date
311 ,p_val_attribute_category in varchar2 default hr_api.g_varchar2
312 ,p_val_attribute1 in varchar2 default hr_api.g_varchar2
313 ,p_val_attribute2 in varchar2 default hr_api.g_varchar2
314 ,p_val_attribute3 in varchar2 default hr_api.g_varchar2
315 ,p_val_attribute4 in varchar2 default hr_api.g_varchar2
316 ,p_val_attribute5 in varchar2 default hr_api.g_varchar2
317 ,p_val_attribute6 in varchar2 default hr_api.g_varchar2
318 ,p_val_attribute7 in varchar2 default hr_api.g_varchar2
319 ,p_val_attribute8 in varchar2 default hr_api.g_varchar2
320 ,p_val_attribute9 in varchar2 default hr_api.g_varchar2
321 ,p_val_attribute10 in varchar2 default hr_api.g_varchar2
322 ,p_val_attribute11 in varchar2 default hr_api.g_varchar2
323 ,p_val_attribute12 in varchar2 default hr_api.g_varchar2
324 ,p_val_attribute13 in varchar2 default hr_api.g_varchar2
325 ,p_val_attribute14 in varchar2 default hr_api.g_varchar2
326 ,p_val_attribute15 in varchar2 default hr_api.g_varchar2
327 ,p_val_attribute16 in varchar2 default hr_api.g_varchar2
328 ,p_val_attribute17 in varchar2 default hr_api.g_varchar2
329 ,p_val_attribute18 in varchar2 default hr_api.g_varchar2
330 ,p_val_attribute19 in varchar2 default hr_api.g_varchar2
331 ,p_val_attribute20 in varchar2 default hr_api.g_varchar2
335 ,p_month_mileage_limit_by_emp in varchar2 default hr_api.g_varchar2
332 ,p_val_information_category in varchar2 default hr_api.g_varchar2
333 ,p_agreement_description in varchar2 default hr_api.g_varchar2
334 ,p_month_mileage_limit_by_law in varchar2 default hr_api.g_varchar2
336 ,p_other_conditions in varchar2 default hr_api.g_varchar2
337 ,p_fuel_benefit in varchar2 default hr_api.g_varchar2
338 ,p_sliding_rates_info in varchar2 default hr_api.g_varchar2
339 ,p_effective_start_date out nocopy date
340 ,p_effective_end_date out nocopy date
341 );
342
343 END pqp_pl_vehicle_allocations_api;