[Home] [Help]
PACKAGE: APPS.OTA_TPC_API
Source
1 Package ota_tpc_api as
2 /* $Header: ottpcapi.pkh 120.1 2005/10/02 02:08:30 aroussel $ */
3 /*#
4 * This package contains the Organization Training Plan Cost APIs.
5 * @rep:scope public
6 * @rep:product ota
7 * @rep:displayname Training Plan Cost
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-------------------------------< create_cost >----------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates an Organization Training Plan cost.
17 *
18 *
19 * <p><b>Licensing</b><br>
20 * This API is licensed for use with Learning Management.
21 *
22 * <p><b>Prerequisites</b><br>
23 * The training plan and measurement type must exist
24 *
25 * <p><b>Post Success</b><br>
26 * The cost row is successfully inserted.
27 *
28 * <p><b>Post Failure</b><br>
29 * The API does not create a cost record, and raises an error.
30 * @param p_validate If true, then validation alone will be performed and the
31 * database will remain unchanged. If false and all validation checks pass,
32 * then the database will be modified.
33 * @param p_effective_date Reference date for validating lookup values are
34 * applicable during the start to end active date range. This date does not
35 * determine when the changes take effect.
36 * @param p_business_group_id The business group owning the cost record.
37 * @param p_tp_measurement_type_id The unique identifier for the measurement
38 * type, identifying the type of cost.
39 * @param p_training_plan_id The training plan against which the cost record is
40 * stored.
41 * @param p_amount The amount of the cost
42 * @param p_booking_id If this is a learner cost, the learner booking
43 * identifier.
44 * @param p_event_id If this is a class cost, the unique class identifier.
45 * @param p_currency_code The currency for money type measure values. Valid
46 * values exist in FND_CURRENCIES.
47 * @param p_attribute_category This context value determines which flexfield
48 * structure to use with the descriptive flexfield segments.
49 * @param p_attribute1 Descriptive flexfield segment.
50 * @param p_attribute2 Descriptive flexfield segment.
51 * @param p_attribute3 Descriptive flexfield segment.
52 * @param p_attribute4 Descriptive flexfield segment.
53 * @param p_attribute5 Descriptive flexfield segment.
54 * @param p_attribute6 Descriptive flexfield segment.
55 * @param p_attribute7 Descriptive flexfield segment.
56 * @param p_attribute8 Descriptive flexfield segment.
57 * @param p_attribute9 Descriptive flexfield segment.
58 * @param p_attribute10 Descriptive flexfield segment.
59 * @param p_attribute11 Descriptive flexfield segment.
60 * @param p_attribute12 Descriptive flexfield segment.
61 * @param p_attribute13 Descriptive flexfield segment.
62 * @param p_attribute14 Descriptive flexfield segment.
63 * @param p_attribute15 Descriptive flexfield segment.
64 * @param p_attribute16 Descriptive flexfield segment.
65 * @param p_attribute17 Descriptive flexfield segment.
66 * @param p_attribute18 Descriptive flexfield segment.
67 * @param p_attribute19 Descriptive flexfield segment.
68 * @param p_attribute20 Descriptive flexfield segment.
69 * @param p_attribute21 Descriptive flexfield segment.
70 * @param p_attribute22 Descriptive flexfield segment.
71 * @param p_attribute23 Descriptive flexfield segment.
72 * @param p_attribute24 Descriptive flexfield segment.
73 * @param p_attribute25 Descriptive flexfield segment.
74 * @param p_attribute26 Descriptive flexfield segment.
75 * @param p_attribute27 Descriptive flexfield segment.
76 * @param p_attribute28 Descriptive flexfield segment.
77 * @param p_attribute29 Descriptive flexfield segment.
78 * @param p_attribute30 Descriptive flexfield segment.
79 * @param p_information_category This context value determines which flexfield
80 * structure to use with the developer descriptive flexfield segments.
81 * @param p_tp_cost_information1 Descriptive Flexfield
82 * @param p_tp_cost_information2 Descriptive Flexfield
83 * @param p_tp_cost_information3 Descriptive Flexfield
84 * @param p_tp_cost_information4 Descriptive Flexfield
85 * @param p_tp_cost_information5 Descriptive Flexfield
86 * @param p_tp_cost_information6 Descriptive Flexfield
87 * @param p_tp_cost_information7 Descriptive Flexfield
88 * @param p_tp_cost_information8 Descriptive Flexfield
89 * @param p_tp_cost_information9 Descriptive Flexfield
90 * @param p_tp_cost_information10 Descriptive Flexfield
91 * @param p_tp_cost_information11 Descriptive Flexfield
92 * @param p_tp_cost_information12 Descriptive Flexfield
93 * @param p_tp_cost_information13 Descriptive Flexfield
94 * @param p_tp_cost_information14 Descriptive Flexfield
95 * @param p_tp_cost_information15 Descriptive Flexfield
96 * @param p_tp_cost_information16 Descriptive Flexfield
97 * @param p_tp_cost_information17 Descriptive Flexfield
98 * @param p_tp_cost_information18 Descriptive Flexfield
99 * @param p_tp_cost_information19 Descriptive Flexfield
100 * @param p_tp_cost_information20 Descriptive Flexfield
101 * @param p_tp_cost_information21 Descriptive Flexfield
102 * @param p_tp_cost_information22 Descriptive Flexfield
103 * @param p_tp_cost_information23 Descriptive Flexfield
104 * @param p_tp_cost_information24 Descriptive Flexfield
105 * @param p_tp_cost_information25 Descriptive Flexfield
106 * @param p_tp_cost_information26 Descriptive Flexfield
107 * @param p_tp_cost_information27 Descriptive Flexfield
108 * @param p_tp_cost_information28 Descriptive Flexfield
109 * @param p_tp_cost_information29 Descriptive Flexfield
110 * @param p_tp_cost_information30 Descriptive Flexfield
111 * @param p_training_plan_cost_id If p_validate is false, then the ID is set to
112 * the unique identifier of the created training plan cost. If p_validate is
113 * true, then the value is null.
114 * @param p_object_version_number If p_validate is false, then set to the
115 * version number of the created training plan cost. If p_validate is true,
116 * then the value will be null.
117 * @rep:displayname Create Organization Training Plan Cost
118 * @rep:category BUSINESS_ENTITY OTA_TRAINING_PLAN
119 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
120 * @rep:scope public
121 * @rep:lifecycle active
122 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
123 */
124 --
125 -- {End Of Comments}
126 --
127 procedure create_cost
128 (p_validate in boolean default false
129 ,p_effective_date in date
130 ,p_business_group_id in number
131 ,p_tp_measurement_type_id in number
132 ,p_training_plan_id in number
133 ,p_amount in number
134 ,p_booking_id in number default null
135 ,p_event_id in number default null
136 ,p_currency_code in varchar2 default null
137 ,p_attribute_category in varchar2 default null
138 ,p_attribute1 in varchar2 default null
139 ,p_attribute2 in varchar2 default null
140 ,p_attribute3 in varchar2 default null
141 ,p_attribute4 in varchar2 default null
142 ,p_attribute5 in varchar2 default null
143 ,p_attribute6 in varchar2 default null
144 ,p_attribute7 in varchar2 default null
145 ,p_attribute8 in varchar2 default null
146 ,p_attribute9 in varchar2 default null
147 ,p_attribute10 in varchar2 default null
148 ,p_attribute11 in varchar2 default null
149 ,p_attribute12 in varchar2 default null
150 ,p_attribute13 in varchar2 default null
151 ,p_attribute14 in varchar2 default null
152 ,p_attribute15 in varchar2 default null
153 ,p_attribute16 in varchar2 default null
154 ,p_attribute17 in varchar2 default null
155 ,p_attribute18 in varchar2 default null
156 ,p_attribute19 in varchar2 default null
157 ,p_attribute20 in varchar2 default null
158 ,p_attribute21 in varchar2 default null
159 ,p_attribute22 in varchar2 default null
160 ,p_attribute23 in varchar2 default null
161 ,p_attribute24 in varchar2 default null
162 ,p_attribute25 in varchar2 default null
163 ,p_attribute26 in varchar2 default null
164 ,p_attribute27 in varchar2 default null
165 ,p_attribute28 in varchar2 default null
166 ,p_attribute29 in varchar2 default null
167 ,p_attribute30 in varchar2 default null
168 ,p_information_category in varchar2 default null
169 ,p_tp_cost_information1 in varchar2 default null
170 ,p_tp_cost_information2 in varchar2 default null
171 ,p_tp_cost_information3 in varchar2 default null
172 ,p_tp_cost_information4 in varchar2 default null
173 ,p_tp_cost_information5 in varchar2 default null
174 ,p_tp_cost_information6 in varchar2 default null
175 ,p_tp_cost_information7 in varchar2 default null
176 ,p_tp_cost_information8 in varchar2 default null
177 ,p_tp_cost_information9 in varchar2 default null
178 ,p_tp_cost_information10 in varchar2 default null
179 ,p_tp_cost_information11 in varchar2 default null
180 ,p_tp_cost_information12 in varchar2 default null
181 ,p_tp_cost_information13 in varchar2 default null
182 ,p_tp_cost_information14 in varchar2 default null
183 ,p_tp_cost_information15 in varchar2 default null
184 ,p_tp_cost_information16 in varchar2 default null
185 ,p_tp_cost_information17 in varchar2 default null
186 ,p_tp_cost_information18 in varchar2 default null
187 ,p_tp_cost_information19 in varchar2 default null
188 ,p_tp_cost_information20 in varchar2 default null
189 ,p_tp_cost_information21 in varchar2 default null
190 ,p_tp_cost_information22 in varchar2 default null
191 ,p_tp_cost_information23 in varchar2 default null
192 ,p_tp_cost_information24 in varchar2 default null
193 ,p_tp_cost_information25 in varchar2 default null
194 ,p_tp_cost_information26 in varchar2 default null
195 ,p_tp_cost_information27 in varchar2 default null
196 ,p_tp_cost_information28 in varchar2 default null
197 ,p_tp_cost_information29 in varchar2 default null
198 ,p_tp_cost_information30 in varchar2 default null
199 ,p_training_plan_cost_id out nocopy number
200 ,p_object_version_number out nocopy number
201 );
202 --
203 -- ----------------------------------------------------------------------------
204 -- |-------------------------------< update_cost >----------------------------|
205 -- ----------------------------------------------------------------------------
206 --
207 -- {Start Of Comments}
208 /*#
209 * This API updates a cost record that records a cost value against a training
210 * plan.
211 *
212 *
213 * <p><b>Licensing</b><br>
214 * This API is licensed for use with Learning Management.
215 *
216 * <p><b>Prerequisites</b><br>
217 * The cost record to be updated must exist.
218 *
219 * <p><b>Post Success</b><br>
220 * The cost record is successfully updated.
221 *
222 * <p><b>Post Failure</b><br>
223 * The API does not update the cost record, and raises an error.
224 * @param p_validate If true, then validation alone will be performed and the
225 * database will remain unchanged. If false and all validation checks pass,
226 * then the database will be modified.
227 * @param p_effective_date Reference date for validating lookup values are
228 * applicable during the start to end active date range. This date does not
229 * determine when the changes take effect.
230 * @param p_training_plan_cost_id The unique identifier of the cost record to
231 * be updated
232 * @param p_object_version_number Pass in the current version number of the
233 * training plan cost to be updated. When the API completes, if p_validate is
234 * false, will be set to the new version number of the updated training plan
235 * cost. If p_validate is true will be set to the same value which is passed
236 * in.
237 * @param p_amount The amount of the cost.
238 * @param p_currency_code The currency for money type measure values. Valid
239 * values exist in FND_CURRENCIES.
240 * @param p_attribute_category This context value determines which flexfield
241 * structure to use with the descriptive flexfield segments.
242 * @param p_attribute1 Descriptive flexfield segment.
243 * @param p_attribute2 Descriptive flexfield segment.
244 * @param p_attribute3 Descriptive flexfield segment.
245 * @param p_attribute4 Descriptive flexfield segment.
246 * @param p_attribute5 Descriptive flexfield segment.
247 * @param p_attribute6 Descriptive flexfield segment.
248 * @param p_attribute7 Descriptive flexfield segment.
249 * @param p_attribute8 Descriptive flexfield segment.
250 * @param p_attribute9 Descriptive flexfield segment.
251 * @param p_attribute10 Descriptive flexfield segment.
252 * @param p_attribute11 Descriptive flexfield segment.
253 * @param p_attribute12 Descriptive flexfield segment.
254 * @param p_attribute13 Descriptive flexfield segment.
255 * @param p_attribute14 Descriptive flexfield segment.
256 * @param p_attribute15 Descriptive flexfield segment.
257 * @param p_attribute16 Descriptive flexfield segment.
258 * @param p_attribute17 Descriptive flexfield segment.
259 * @param p_attribute18 Descriptive flexfield segment.
260 * @param p_attribute19 Descriptive flexfield segment.
261 * @param p_attribute20 Descriptive flexfield segment.
262 * @param p_attribute21 Descriptive flexfield segment.
263 * @param p_attribute22 Descriptive flexfield segment.
264 * @param p_attribute23 Descriptive flexfield segment.
265 * @param p_attribute24 Descriptive flexfield segment.
266 * @param p_attribute25 Descriptive flexfield segment.
267 * @param p_attribute26 Descriptive flexfield segment.
268 * @param p_attribute27 Descriptive flexfield segment.
269 * @param p_attribute28 Descriptive flexfield segment.
270 * @param p_attribute29 Descriptive flexfield segment.
271 * @param p_attribute30 Descriptive flexfield segment.
272 * @param p_information_category This context value determines which flexfield
273 * structure to use with the developer descriptive flexfield segments.
274 * @param p_tp_cost_information1 Descriptive Flexfield
275 * @param p_tp_cost_information2 Descriptive Flexfield
276 * @param p_tp_cost_information3 Descriptive Flexfield
277 * @param p_tp_cost_information4 Descriptive Flexfield
278 * @param p_tp_cost_information5 Descriptive Flexfield
279 * @param p_tp_cost_information6 Descriptive Flexfield
280 * @param p_tp_cost_information7 Descriptive Flexfield
281 * @param p_tp_cost_information8 Descriptive Flexfield
282 * @param p_tp_cost_information9 Descriptive Flexfield
283 * @param p_tp_cost_information10 Descriptive Flexfield
284 * @param p_tp_cost_information11 Descriptive Flexfield
288 * @param p_tp_cost_information15 Descriptive Flexfield
285 * @param p_tp_cost_information12 Descriptive Flexfield
286 * @param p_tp_cost_information13 Descriptive Flexfield
287 * @param p_tp_cost_information14 Descriptive Flexfield
289 * @param p_tp_cost_information16 Descriptive Flexfield
290 * @param p_tp_cost_information17 Descriptive Flexfield
291 * @param p_tp_cost_information18 Descriptive Flexfield
292 * @param p_tp_cost_information19 Descriptive Flexfield
293 * @param p_tp_cost_information20 Descriptive Flexfield
294 * @param p_tp_cost_information21 Descriptive Flexfield
295 * @param p_tp_cost_information22 Descriptive Flexfield
296 * @param p_tp_cost_information23 Descriptive Flexfield
297 * @param p_tp_cost_information24 Descriptive Flexfield
298 * @param p_tp_cost_information25 Descriptive Flexfield
299 * @param p_tp_cost_information26 Descriptive Flexfield
300 * @param p_tp_cost_information27 Descriptive Flexfield
301 * @param p_tp_cost_information28 Descriptive Flexfield
302 * @param p_tp_cost_information29 Descriptive Flexfield
303 * @param p_tp_cost_information30 Descriptive Flexfield
304 * @rep:displayname Update Organization Training Plan Cost
305 * @rep:category BUSINESS_ENTITY OTA_TRAINING_PLAN
306 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
307 * @rep:scope public
308 * @rep:lifecycle active
309 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
310 */
311 --
312 -- {End Of Comments}
313 --
314 procedure Update_cost
315 (p_validate in boolean default false
316 ,p_effective_date in date
317 ,p_training_plan_cost_id in number
318 ,p_object_version_number in out nocopy number
319 ,p_amount in number default hr_api.g_number
320 ,p_currency_code in varchar2 default hr_api.g_varchar2
321 ,p_attribute_category in varchar2 default hr_api.g_varchar2
322 ,p_attribute1 in varchar2 default hr_api.g_varchar2
323 ,p_attribute2 in varchar2 default hr_api.g_varchar2
324 ,p_attribute3 in varchar2 default hr_api.g_varchar2
325 ,p_attribute4 in varchar2 default hr_api.g_varchar2
326 ,p_attribute5 in varchar2 default hr_api.g_varchar2
327 ,p_attribute6 in varchar2 default hr_api.g_varchar2
328 ,p_attribute7 in varchar2 default hr_api.g_varchar2
329 ,p_attribute8 in varchar2 default hr_api.g_varchar2
330 ,p_attribute9 in varchar2 default hr_api.g_varchar2
331 ,p_attribute10 in varchar2 default hr_api.g_varchar2
332 ,p_attribute11 in varchar2 default hr_api.g_varchar2
333 ,p_attribute12 in varchar2 default hr_api.g_varchar2
334 ,p_attribute13 in varchar2 default hr_api.g_varchar2
335 ,p_attribute14 in varchar2 default hr_api.g_varchar2
336 ,p_attribute15 in varchar2 default hr_api.g_varchar2
337 ,p_attribute16 in varchar2 default hr_api.g_varchar2
338 ,p_attribute17 in varchar2 default hr_api.g_varchar2
339 ,p_attribute18 in varchar2 default hr_api.g_varchar2
340 ,p_attribute19 in varchar2 default hr_api.g_varchar2
341 ,p_attribute20 in varchar2 default hr_api.g_varchar2
342 ,p_attribute21 in varchar2 default hr_api.g_varchar2
343 ,p_attribute22 in varchar2 default hr_api.g_varchar2
344 ,p_attribute23 in varchar2 default hr_api.g_varchar2
345 ,p_attribute24 in varchar2 default hr_api.g_varchar2
346 ,p_attribute25 in varchar2 default hr_api.g_varchar2
347 ,p_attribute26 in varchar2 default hr_api.g_varchar2
348 ,p_attribute27 in varchar2 default hr_api.g_varchar2
349 ,p_attribute28 in varchar2 default hr_api.g_varchar2
350 ,p_attribute29 in varchar2 default hr_api.g_varchar2
351 ,p_attribute30 in varchar2 default hr_api.g_varchar2
352 ,p_information_category in varchar2 default hr_api.g_varchar2
353 ,p_tp_cost_information1 in varchar2 default hr_api.g_varchar2
354 ,p_tp_cost_information2 in varchar2 default hr_api.g_varchar2
355 ,p_tp_cost_information3 in varchar2 default hr_api.g_varchar2
356 ,p_tp_cost_information4 in varchar2 default hr_api.g_varchar2
357 ,p_tp_cost_information5 in varchar2 default hr_api.g_varchar2
358 ,p_tp_cost_information6 in varchar2 default hr_api.g_varchar2
359 ,p_tp_cost_information7 in varchar2 default hr_api.g_varchar2
360 ,p_tp_cost_information8 in varchar2 default hr_api.g_varchar2
361 ,p_tp_cost_information9 in varchar2 default hr_api.g_varchar2
362 ,p_tp_cost_information10 in varchar2 default hr_api.g_varchar2
363 ,p_tp_cost_information11 in varchar2 default hr_api.g_varchar2
364 ,p_tp_cost_information12 in varchar2 default hr_api.g_varchar2
365 ,p_tp_cost_information13 in varchar2 default hr_api.g_varchar2
366 ,p_tp_cost_information14 in varchar2 default hr_api.g_varchar2
367 ,p_tp_cost_information15 in varchar2 default hr_api.g_varchar2
368 ,p_tp_cost_information16 in varchar2 default hr_api.g_varchar2
369 ,p_tp_cost_information17 in varchar2 default hr_api.g_varchar2
370 ,p_tp_cost_information18 in varchar2 default hr_api.g_varchar2
374 ,p_tp_cost_information22 in varchar2 default hr_api.g_varchar2
371 ,p_tp_cost_information19 in varchar2 default hr_api.g_varchar2
372 ,p_tp_cost_information20 in varchar2 default hr_api.g_varchar2
373 ,p_tp_cost_information21 in varchar2 default hr_api.g_varchar2
375 ,p_tp_cost_information23 in varchar2 default hr_api.g_varchar2
376 ,p_tp_cost_information24 in varchar2 default hr_api.g_varchar2
377 ,p_tp_cost_information25 in varchar2 default hr_api.g_varchar2
378 ,p_tp_cost_information26 in varchar2 default hr_api.g_varchar2
379 ,p_tp_cost_information27 in varchar2 default hr_api.g_varchar2
380 ,p_tp_cost_information28 in varchar2 default hr_api.g_varchar2
381 ,p_tp_cost_information29 in varchar2 default hr_api.g_varchar2
382 ,p_tp_cost_information30 in varchar2 default hr_api.g_varchar2
383 );
384 --
385 -- ----------------------------------------------------------------------------
386 -- |-------------------------------< delete_cost >----------------------------|
387 -- ----------------------------------------------------------------------------
388 --
389 -- {Start Of Comments}
390 /*#
391 * This API deletes a cost record used for recording cost values within an OTA
392 * organization training plan.
393 *
394 *
395 * <p><b>Licensing</b><br>
396 * This API is licensed for use with Learning Management.
397 *
398 * <p><b>Prerequisites</b><br>
399 * The cost record to be deleted must exist in the database.
400 *
401 * <p><b>Post Success</b><br>
402 * The cost record is successfully deleted from the database.
403 *
404 * <p><b>Post Failure</b><br>
405 * The API does not delete the cost record, and raises an error.
406 * @param p_validate If true, then validation alone will be performed and the
407 * database will remain unchanged. If false and all validation checks pass,
408 * then the database will be modified.
409 * @param p_training_plan_cost_id The unique identifier for the cost record to
410 * be deleted
411 * @param p_object_version_number Current version number of the cost to be
412 * deleted.
413 * @rep:displayname Delete Organization Training Plan Cost
414 * @rep:category BUSINESS_ENTITY OTA_TRAINING_PLAN
415 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
416 * @rep:scope public
417 * @rep:lifecycle active
418 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
419 */
420 --
421 -- {End Of Comments}
422 --
423 procedure delete_cost
424 (p_validate in boolean default false
425 ,p_training_plan_cost_id in number
426 ,p_object_version_number in number
427 );
428 end ota_tpc_api;