1 Package ota_tps_api AUTHID CURRENT_USER as
2 /* $Header: ottpsapi.pkh 120.1 2005/10/02 02:08:40 aroussel $ */
3 /*#
4 * The APIs in this package create, update, and delete personal or organization
5 * training plans.
6 * @rep:scope public
7 * @rep:product ota
8 * @rep:displayname Training Plan
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |---------------------------< create_training_plan >-----------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This business process creates a personal training plan or an organization
18 * training plan for using against budget or cost values.
19 *
20 * This API, called from Self-Service as well as PUI forms, creates a record in
21 * the OTA_TRAINING_PLANS table.
22 *
23 * <p><b>Licensing</b><br>
24 * This API is licensed for use with Learning Management.
25 *
26 * <p><b>Prerequisites</b><br>
27 * User should be a valid employee on effective date
28 *
29 * <p><b>Post Success</b><br>
30 * Training Plan record for the user is created in the database
31 *
32 * <p><b>Post Failure</b><br>
33 * The API does not create a training plan, and raises an error.
34 * @param p_validate If true, then validation alone will be performed and the
35 * database will remain unchanged. If false and all validation checks pass,
36 * then the database will be modified.
37 * @param p_effective_date Reference date for validating lookup values are
38 * applicable during the start to end active date range. This date does not
39 * determine when the changes take effect.
40 * @param p_business_group_id The businees group owning the plan.
44 * defined by 'OTA_PLAN_USER_STATUS_TYPE' lookup type.
41 * @param p_time_period_id The time period within the calendar. Defines the
42 * start and end date of the period.
43 * @param p_plan_status_type_id Training Plan's status. Valid values are
45 * @param p_organization_id Foreign key to HR_ALL_ORGANIZATIONS. The
46 * organization to which this plan applies.
47 * @param p_person_id Identifies the person for whom you create the training
48 * plan record.
49 * @param p_budget_currency The currency for monetary budget values, and the
50 * default currency for monetary cost values.
51 * @param p_name The name of the training plan.
52 * @param p_description Description of the training plan.
53 * @param p_attribute_category This context value determines which flexfield
54 * structure to use with the descriptive flexfield segments.
55 * @param p_attribute1 Descriptive flexfield segment.
56 * @param p_attribute2 Descriptive flexfield segment.
57 * @param p_attribute3 Descriptive flexfield segment.
58 * @param p_attribute4 Descriptive flexfield segment.
59 * @param p_attribute5 Descriptive flexfield segment.
60 * @param p_attribute6 Descriptive flexfield segment.
61 * @param p_attribute7 Descriptive flexfield segment.
62 * @param p_attribute8 Descriptive flexfield segment.
63 * @param p_attribute9 Descriptive flexfield segment.
64 * @param p_attribute10 Descriptive flexfield segment.
65 * @param p_attribute11 Descriptive flexfield segment.
66 * @param p_attribute12 Descriptive flexfield segment.
67 * @param p_attribute13 Descriptive flexfield segment.
68 * @param p_attribute14 Descriptive flexfield segment.
69 * @param p_attribute15 Descriptive flexfield segment.
70 * @param p_attribute16 Descriptive flexfield segment.
71 * @param p_attribute17 Descriptive flexfield segment.
72 * @param p_attribute18 Descriptive flexfield segment.
73 * @param p_attribute19 Descriptive flexfield segment.
74 * @param p_attribute20 Descriptive flexfield segment.
75 * @param p_attribute21 Descriptive flexfield segment.
76 * @param p_attribute22 Descriptive flexfield segment.
77 * @param p_attribute23 Descriptive flexfield segment.
78 * @param p_attribute24 Descriptive flexfield segment.
79 * @param p_attribute25 Descriptive flexfield segment.
80 * @param p_attribute26 Descriptive flexfield segment.
81 * @param p_attribute27 Descriptive flexfield segment.
82 * @param p_attribute28 Descriptive flexfield segment.
83 * @param p_attribute29 Descriptive flexfield segment.
84 * @param p_attribute30 Descriptive flexfield segment.
85 * @param p_plan_source Training Plan's source. Valid values are defined by
86 * 'OTA_TRAINING_PLAN_SOURCE' lookup type.
87 * @param p_start_date Training Plan's start date.
88 * @param p_end_date Training Plan's end date.
89 * @param p_creator_person_id The person who has created the training plan
90 * @param p_additional_member_flag Flag to identify if new components can be
91 * added to a training plan. Value of 'N' means no new component can be added.
92 * @param p_learning_path_id Learning path associated with the training plan.
93 * @param p_contact_id Contact person for external Learners for whom training
94 * plan(Learning path) has been created
95 * @param p_training_plan_id The unique identifier for the training plan.
96 * @param p_object_version_number If p_validate is false, then set to the
97 * version number of the created ota training plan. If p_validate is true, then
98 * the value will be null.
99 * @rep:displayname Create Training Plan
100 * @rep:category BUSINESS_ENTITY OTA_TRAINING_PLAN
101 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
102 * @rep:scope public
103 * @rep:lifecycle active
104 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
105 */
106 --
107 -- {End Of Comments}
108 --
109 procedure Create_training_plan
110 (p_validate in boolean default false
111 ,p_effective_date in date
112 ,p_business_group_id in number
113 ,p_time_period_id in number
114 ,p_plan_status_type_id in varchar2
115 ,p_organization_id in number default null
116 ,p_person_id in number default null
117 ,p_budget_currency in varchar2
118 ,p_name in varchar2
119 ,p_description in varchar2 default null
120 ,p_attribute_category in varchar2 default null
121 ,p_attribute1 in varchar2 default null
122 ,p_attribute2 in varchar2 default null
123 ,p_attribute3 in varchar2 default null
124 ,p_attribute4 in varchar2 default null
125 ,p_attribute5 in varchar2 default null
126 ,p_attribute6 in varchar2 default null
127 ,p_attribute7 in varchar2 default null
128 ,p_attribute8 in varchar2 default null
129 ,p_attribute9 in varchar2 default null
130 ,p_attribute10 in varchar2 default null
131 ,p_attribute11 in varchar2 default null
132 ,p_attribute12 in varchar2 default null
133 ,p_attribute13 in varchar2 default null
134 ,p_attribute14 in varchar2 default null
135 ,p_attribute15 in varchar2 default null
136 ,p_attribute16 in varchar2 default null
137 ,p_attribute17 in varchar2 default null
138 ,p_attribute18 in varchar2 default null
139 ,p_attribute19 in varchar2 default null
140 ,p_attribute20 in varchar2 default null
141 ,p_attribute21 in varchar2 default null
142 ,p_attribute22 in varchar2 default null
146 ,p_attribute26 in varchar2 default null
143 ,p_attribute23 in varchar2 default null
144 ,p_attribute24 in varchar2 default null
145 ,p_attribute25 in varchar2 default null
147 ,p_attribute27 in varchar2 default null
148 ,p_attribute28 in varchar2 default null
149 ,p_attribute29 in varchar2 default null
150 ,p_attribute30 in varchar2 default null
151 ,p_plan_source in varchar2 default null --changed
152 ,p_start_date in date default null
153 ,p_end_date in date default null
154 ,p_creator_person_id in number default null
155 ,p_additional_member_flag in varchar2 default null
156 ,p_learning_path_id in number default null
157 -- Modified for Bug#3479186
158 ,p_contact_id in number default null
159 ,p_training_plan_id out nocopy number
160 ,p_object_version_number out nocopy number
161 );
162 --
163 -- ----------------------------------------------------------------------------
164 -- |---------------------------< update_training_plan >-----------------------|
165 -- ----------------------------------------------------------------------------
166 --
167 -- {Start Of Comments}
168 /*#
169 * This business process updates a personal or organization training plan.
170 *
171 * This API, called from Self Service as well as PUI forms, updates a record in
172 * the OTA_TRAINING_PLANS table.
173 *
174 * <p><b>Licensing</b><br>
175 * This API is licensed for use with Learning Management.
176 *
177 * <p><b>Prerequisites</b><br>
178 * A valid training plan should exist
179 *
180 * <p><b>Post Success</b><br>
181 * Training plan record is updated in the database
182 *
183 * <p><b>Post Failure</b><br>
184 * The API does not update the training plan, and raises an error.
185 * @param p_validate If true, then validation alone will be performed and the
186 * database will remain unchanged. If false and all validation checks pass,
187 * then the database will be modified.
188 * @param p_effective_date Reference date for validating lookup values are
189 * applicable during the start to end active date range. This date does not
190 * determine when the changes take effect.
191 * @param p_training_plan_id The unique identifier for the training plan record
192 * @param p_object_version_number Pass in the current version number of the
193 * training plan to be updated. When the API completes if p_validate is false,
194 * will be set to the new version number of the updated training plan. If
195 * p_validate is true will be set to the same value which was passed in.
196 * @param p_time_period_id The time period within the calendar. Defines the
197 * start and end date of the period.
198 * @param p_plan_status_type_id Training Plan's status. Valid values are
199 * defined by 'OTA_PLAN_USER_STATUS_TYPE' lookup type.
200 * @param p_budget_currency The currency for monetary budget values, and the
201 * default currency for monetary cost values.
202 * @param p_name The name of the training plan.
203 * @param p_description Description of the training plan.
204 * @param p_attribute_category This context value determines which flexfield
205 * structure to use with the descriptive flexfield segments.
206 * @param p_attribute1 Descriptive flexfield segment.
207 * @param p_attribute2 Descriptive flexfield segment.
208 * @param p_attribute3 Descriptive flexfield segment.
209 * @param p_attribute4 Descriptive flexfield segment.
210 * @param p_attribute5 Descriptive flexfield segment.
211 * @param p_attribute6 Descriptive flexfield segment.
212 * @param p_attribute7 Descriptive flexfield segment.
213 * @param p_attribute8 Descriptive flexfield segment.
214 * @param p_attribute9 Descriptive flexfield segment.
215 * @param p_attribute10 Descriptive flexfield segment.
216 * @param p_attribute11 Descriptive flexfield segment.
217 * @param p_attribute12 Descriptive flexfield segment.
218 * @param p_attribute13 Descriptive flexfield segment.
219 * @param p_attribute14 Descriptive flexfield segment.
220 * @param p_attribute15 Descriptive flexfield segment.
221 * @param p_attribute16 Descriptive flexfield segment.
222 * @param p_attribute17 Descriptive flexfield segment.
223 * @param p_attribute18 Descriptive flexfield segment.
224 * @param p_attribute19 Descriptive flexfield segment.
225 * @param p_attribute20 Descriptive flexfield segment.
226 * @param p_attribute21 Descriptive flexfield segment.
227 * @param p_attribute22 Descriptive flexfield segment.
228 * @param p_attribute23 Descriptive flexfield segment.
229 * @param p_attribute24 Descriptive flexfield segment.
230 * @param p_attribute25 Descriptive flexfield segment.
231 * @param p_attribute26 Descriptive flexfield segment.
232 * @param p_attribute27 Descriptive flexfield segment.
233 * @param p_attribute28 Descriptive flexfield segment.
234 * @param p_attribute29 Descriptive flexfield segment.
235 * @param p_attribute30 Descriptive flexfield segment.
236 * @param p_plan_source Training Plan's source. Valid values are defined by the
237 * 'OTA_TRAINING_PLAN_SOURCE' lookup type.
238 * @param p_start_date Training Plan's start date.
239 * @param p_end_date Training Plan's end date.
240 * @param p_creator_person_id The person who has created the training plan.
241 * @param p_additional_member_flag Flag to identify if new components can be
242 * added to a training plan. Value of 'N' means no new component can be added.
243 * @param p_learning_path_id Learning path associated with the training plan.
244 * @param p_contact_id Contact person for external Learners for whom training
245 * plan(Learning path) has been updated
246 * @rep:displayname Update Training Plan
247 * @rep:category BUSINESS_ENTITY OTA_TRAINING_PLAN
248 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
249 * @rep:scope public
250 * @rep:lifecycle active
251 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
252 */
253 --
254 -- {End Of Comments}
255 --
256 procedure Update_training_plan
257 (p_validate in boolean default false
258 ,p_effective_date in date
259 ,p_training_plan_id in number
260 ,p_object_version_number in out nocopy number
261 ,p_time_period_id in number
262 ,p_plan_status_type_id in varchar2
263 ,p_budget_currency in varchar2
264 ,p_name in varchar2
265 ,p_description in varchar2 default hr_api.g_varchar2
266 ,p_attribute_category in varchar2 default hr_api.g_varchar2
267 ,p_attribute1 in varchar2 default hr_api.g_varchar2
268 ,p_attribute2 in varchar2 default hr_api.g_varchar2
269 ,p_attribute3 in varchar2 default hr_api.g_varchar2
270 ,p_attribute4 in varchar2 default hr_api.g_varchar2
271 ,p_attribute5 in varchar2 default hr_api.g_varchar2
272 ,p_attribute6 in varchar2 default hr_api.g_varchar2
273 ,p_attribute7 in varchar2 default hr_api.g_varchar2
274 ,p_attribute8 in varchar2 default hr_api.g_varchar2
275 ,p_attribute9 in varchar2 default hr_api.g_varchar2
276 ,p_attribute10 in varchar2 default hr_api.g_varchar2
277 ,p_attribute11 in varchar2 default hr_api.g_varchar2
278 ,p_attribute12 in varchar2 default hr_api.g_varchar2
279 ,p_attribute13 in varchar2 default hr_api.g_varchar2
280 ,p_attribute14 in varchar2 default hr_api.g_varchar2
281 ,p_attribute15 in varchar2 default hr_api.g_varchar2
282 ,p_attribute16 in varchar2 default hr_api.g_varchar2
283 ,p_attribute17 in varchar2 default hr_api.g_varchar2
284 ,p_attribute18 in varchar2 default hr_api.g_varchar2
285 ,p_attribute19 in varchar2 default hr_api.g_varchar2
286 ,p_attribute20 in varchar2 default hr_api.g_varchar2
287 ,p_attribute21 in varchar2 default hr_api.g_varchar2
288 ,p_attribute22 in varchar2 default hr_api.g_varchar2
289 ,p_attribute23 in varchar2 default hr_api.g_varchar2
290 ,p_attribute24 in varchar2 default hr_api.g_varchar2
291 ,p_attribute25 in varchar2 default hr_api.g_varchar2
292 ,p_attribute26 in varchar2 default hr_api.g_varchar2
293 ,p_attribute27 in varchar2 default hr_api.g_varchar2
294 ,p_attribute28 in varchar2 default hr_api.g_varchar2
295 ,p_attribute29 in varchar2 default hr_api.g_varchar2
296 ,p_attribute30 in varchar2 default hr_api.g_varchar2
297 ,p_plan_source in varchar2 default hr_api.g_varchar2 --changed
298 ,p_start_date in date default hr_api.g_date
299 ,p_end_date in date default hr_api.g_date
300 ,p_creator_person_id in number default hr_api.g_number
301 ,p_additional_member_flag in varchar2 default hr_api.g_varchar2
302 ,p_learning_path_id in number default hr_api.g_number
303 ,p_contact_id in number default hr_api.g_number
304 );
305 --
306 -- ----------------------------------------------------------------------------
307 -- |---------------------------< delete_training_plan >-----------------------|
308 -- ----------------------------------------------------------------------------
309 --
310 -- {Start Of Comments}
311 /*#
312 * This business process deletes a training plan record.
313 *
314 * This API, called from Self Service as well as PUI forms, deletes a record
315 * from the OTA_TRAINING_PLANS table.
316 *
317 * <p><b>Licensing</b><br>
318 * This API is licensed for use with Learning Management.
319 *
320 * <p><b>Prerequisites</b><br>
321 * A valid training plan should exist for the user with no components under it.
322 *
323 * <p><b>Post Success</b><br>
324 * Training plan record of the user is deleted
325 *
326 * <p><b>Post Failure</b><br>
327 * The API does not delete the training plan record, and raises an error.
328 * @param p_validate If true, then validation alone will be performed and the
329 * database will remain unchanged. If false and all validation checks pass,
330 * then the database will be modified.
331 * @param p_training_plan_id The unique identifier for the training plan
332 * record.
333 * @param p_object_version_number Current version number of the
334 * ota_training_plan to be deleted.
335 * @rep:displayname Delete Training Plan
336 * @rep:category BUSINESS_ENTITY OTA_TRAINING_PLAN
337 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
338 * @rep:scope public
339 * @rep:lifecycle active
340 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
341 */
342 --
343 -- {End Of Comments}
344 --
345 procedure delete_training_plan
346 (p_validate in boolean default false
347 ,p_training_plan_id in number
348 ,p_object_version_number in number
349 );
350 end ota_tps_api;
[Home] [Help]