4 * The APIs in this package create, update, and delete Personal and
1 Package ota_tpm_api AUTHID CURRENT_USER as
2 /* $Header: ottpmapi.pkh 120.1 2005/10/02 02:08:35 aroussel $ */
3 /*#
5 * Organization Training Plan components.
6 * @rep:scope public
7 * @rep:product ota
8 * @rep:displayname Training Plan Component
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |-----------------------< create_training_plan_member >--------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This business process creates a personal or organization training plan
18 * component record within a training plan.
19 *
20 * This API, called from Self-Service as well as PUI forms, inserts a record
21 * into the OTA_TRAINING_PLAN_MEMBERS 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 * A valid training plan should exist under which training plan components can
28 * be created.
29 *
30 * <p><b>Post Success</b><br>
31 * The training plan member record is created in the database.
32 *
33 * <p><b>Post Failure</b><br>
34 * The API does not create a training plan component record, and raises an
35 * error.
36 * @param p_validate If true, then validation alone will be performed and the
37 * database will remain unchanged. If false and all validation checks pass,
38 * then the database will be modified.
39 * @param p_effective_date Reference date for validating lookup values are
40 * applicable during the start to end active date range. This date does not
41 * determine when the changes take effect.
42 * @param p_business_group_id The business group owning the component record
43 * and the training plan.
44 * @param p_training_plan_id The target training plan.
45 * @param p_activity_version_id The Identifier of a course to be added to the
46 * plan. Either this or the activity (course) definition must be specified, not
47 * both. The default is null.
48 * @param p_activity_definition_id The Identifier of an activity (course)
49 * definition that is to be added to the plan. Either this or the course must
50 * be specified, not both. The default is null.
51 * @param p_member_status_type_id The Training Plan Component's Type. Valid
52 * values are defined by the 'OTA_MEMBER_USER_STATUS_TYPE' lookup type.
53 * @param p_target_completion_date The date at which the component is expected
54 * to be completed by. The default is null.
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_attribute21 Descriptive flexfield segment.
78 * @param p_attribute22 Descriptive flexfield segment.
79 * @param p_attribute23 Descriptive flexfield segment.
80 * @param p_attribute24 Descriptive flexfield segment.
81 * @param p_attribute25 Descriptive flexfield segment.
82 * @param p_attribute26 Descriptive flexfield segment.
83 * @param p_attribute27 Descriptive flexfield segment.
84 * @param p_attribute28 Descriptive flexfield segment.
85 * @param p_attribute29 Descriptive flexfield segment.
86 * @param p_attribute30 Descriptive flexfield segment.
87 * @param p_assignment_id Identifies the assignment for which you create the
88 * Ota_training_plan_members record.
89 * @param p_source_id Training Plan Component source identifier
90 * @param p_source_function Training Plan Component's source function. Valid
91 * values are defined by the 'OTA_PLAN_COMPONENT_SOURCE' lookup type.
92 * @param p_cancellation_reason Training Plan Component's cancellation reason.
93 * Valid values are defined by the 'OTA_PLAN_CANCELLATION_SOURCE' lookup type.
94 * @param p_earliest_start_date The Training Plan Component's start date.
95 * @param p_creator_person_id Person who creates the training plan component.
96 * @param p_training_plan_member_id The unique identifier for the component
97 * record.
98 * @param p_object_version_number If p_validate is false, then the number is
99 * set to the version number of the created training plan component. If
100 * p_validate is true, then the value is null.
101 * @rep:displayname Create Training Plan Component
102 * @rep:category BUSINESS_ENTITY OTA_TRAINING_PLAN
103 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
104 * @rep:scope public
105 * @rep:lifecycle active
106 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
107 */
108 --
109 -- {End Of Comments}
110 --
111 procedure create_training_plan_member
112 (p_validate in boolean default false
116 ,p_activity_version_id in number default null
113 ,p_effective_date in date
114 ,p_business_group_id in number
115 ,p_training_plan_id in number
117 ,p_activity_definition_id in number default null
118 ,p_member_status_type_id in varchar2
119 ,p_target_completion_date in date 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
143 ,p_attribute23 in varchar2 default null
144 ,p_attribute24 in varchar2 default null
145 ,p_attribute25 in varchar2 default null
146 ,p_attribute26 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_assignment_id in number default null
152 ,p_source_id in number default null
153 ,p_source_function in varchar2 default null
154 ,p_cancellation_reason in varchar2 default null
155 ,p_earliest_start_date in date default null
156 ,p_creator_person_id in number default null
157 ,p_training_plan_member_id out nocopy number
158 ,p_object_version_number out nocopy number
159 );
160 --
161 -- ----------------------------------------------------------------------------
162 -- |-----------------------< update_training_plan_member >--------------------|
163 -- ----------------------------------------------------------------------------
164 --
165 -- {Start Of Comments}
166 /*#
167 * This business process updates a personal or organization training plan
168 * component record.
169 *
170 * This API, called from Self-Service as well as PUI forms, updates a record in
171 * the OTA_TRAINING_PLAN_MEMBERS table.
172 *
173 * <p><b>Licensing</b><br>
174 * This API is licensed for use with Learning Management.
175 *
176 * <p><b>Prerequisites</b><br>
177 * A valid training plan component must exist.
178 *
179 * <p><b>Post Success</b><br>
180 * The training plan component record of the user is updated
181 *
182 * <p><b>Post Failure</b><br>
183 * The API does not update the training plan component record, and raises an
184 * 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_member_id The unique identifier for the component
192 * record.
193 * @param p_object_version_number Pass in the current version number of the
194 * training plan component to be updated. When the API completes, if p_validate
195 * is false, will be set to the new version number of the updated training plan
196 * component. If p_validate is true will be set to the same value which is
197 * passed in.
198 * @param p_activity_version_id The Identifier of a course that is to be added
199 * to the plan. Either this or an activity definition must be specified, not
200 * both. The default is null.
201 * @param p_activity_definition_id The Identifier of an activity definition
202 * that is to be added to the plan. Either this or a course must be specified,
203 * not both. The default is null.
204 * @param p_member_status_type_id Training Plan Component's Type. Valid values
205 * are defined by the 'OTA_MEMBER_USER_STATUS_TYPE' lookup type.
206 * @param p_target_completion_date The date by which the component is expected
207 * to be completed. The default is null.
208 * @param p_attribute_category This context value determines which flexfield
209 * structure to use with the descriptive flexfield segments.
210 * @param p_attribute1 Descriptive flexfield segment.
211 * @param p_attribute2 Descriptive flexfield segment.
212 * @param p_attribute3 Descriptive flexfield segment.
213 * @param p_attribute4 Descriptive flexfield segment.
214 * @param p_attribute5 Descriptive flexfield segment.
218 * @param p_attribute9 Descriptive flexfield segment.
215 * @param p_attribute6 Descriptive flexfield segment.
216 * @param p_attribute7 Descriptive flexfield segment.
217 * @param p_attribute8 Descriptive flexfield segment.
219 * @param p_attribute10 Descriptive flexfield segment.
220 * @param p_attribute11 Descriptive flexfield segment.
221 * @param p_attribute12 Descriptive flexfield segment.
222 * @param p_attribute13 Descriptive flexfield segment.
223 * @param p_attribute14 Descriptive flexfield segment.
224 * @param p_attribute15 Descriptive flexfield segment.
225 * @param p_attribute16 Descriptive flexfield segment.
226 * @param p_attribute17 Descriptive flexfield segment.
227 * @param p_attribute18 Descriptive flexfield segment.
228 * @param p_attribute19 Descriptive flexfield segment.
229 * @param p_attribute20 Descriptive flexfield segment.
230 * @param p_attribute21 Descriptive flexfield segment.
231 * @param p_attribute22 Descriptive flexfield segment.
232 * @param p_attribute23 Descriptive flexfield segment.
233 * @param p_attribute24 Descriptive flexfield segment.
234 * @param p_attribute25 Descriptive flexfield segment.
235 * @param p_attribute26 Descriptive flexfield segment.
236 * @param p_attribute27 Descriptive flexfield segment.
237 * @param p_attribute28 Descriptive flexfield segment.
238 * @param p_attribute29 Descriptive flexfield segment.
239 * @param p_attribute30 Descriptive flexfield segment.
240 * @param p_assignment_id Identifies the assignment for which you create the
241 * Ota_training_plan_members record.
242 * @param p_source_id Training Plan Component source identifier
243 * @param p_source_function Training Plan Component's source function.Valid
244 * values are defined by the 'OTA_PLAN_COMPONENT_SOURCE' lookup type.
245 * @param p_cancellation_reason Training Plan Component's cancellation
249 * @param p_creator_person_id Person who creates the training plan component.
246 * reason.Valid values are defined by the 'OTA_PLAN_CANCELLATION_SOURCE' lookup
247 * type.
248 * @param p_earliest_start_date Training Plan Component's start date.
250 * @rep:displayname Update Training Plan Component
251 * @rep:category BUSINESS_ENTITY OTA_TRAINING_PLAN
252 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
253 * @rep:scope public
254 * @rep:lifecycle active
255 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
256 */
257 --
258 -- {End Of Comments}
259 --
260 procedure update_training_plan_member
261 (p_validate in boolean default false
262 ,p_effective_date in date
263 ,p_training_plan_member_id in number
264 ,p_object_version_number in out nocopy number
265 ,p_activity_version_id in number default hr_api.g_number
266 ,p_activity_definition_id in number default hr_api.g_number
267 ,p_member_status_type_id in varchar2 default hr_api.g_varchar2
268 ,p_target_completion_date in date default hr_api.g_date
269 ,p_attribute_category in varchar2 default hr_api.g_varchar2
270 ,p_attribute1 in varchar2 default hr_api.g_varchar2
271 ,p_attribute2 in varchar2 default hr_api.g_varchar2
272 ,p_attribute3 in varchar2 default hr_api.g_varchar2
273 ,p_attribute4 in varchar2 default hr_api.g_varchar2
274 ,p_attribute5 in varchar2 default hr_api.g_varchar2
275 ,p_attribute6 in varchar2 default hr_api.g_varchar2
276 ,p_attribute7 in varchar2 default hr_api.g_varchar2
277 ,p_attribute8 in varchar2 default hr_api.g_varchar2
278 ,p_attribute9 in varchar2 default hr_api.g_varchar2
279 ,p_attribute10 in varchar2 default hr_api.g_varchar2
280 ,p_attribute11 in varchar2 default hr_api.g_varchar2
281 ,p_attribute12 in varchar2 default hr_api.g_varchar2
282 ,p_attribute13 in varchar2 default hr_api.g_varchar2
283 ,p_attribute14 in varchar2 default hr_api.g_varchar2
284 ,p_attribute15 in varchar2 default hr_api.g_varchar2
285 ,p_attribute16 in varchar2 default hr_api.g_varchar2
286 ,p_attribute17 in varchar2 default hr_api.g_varchar2
287 ,p_attribute18 in varchar2 default hr_api.g_varchar2
288 ,p_attribute19 in varchar2 default hr_api.g_varchar2
289 ,p_attribute20 in varchar2 default hr_api.g_varchar2
290 ,p_attribute21 in varchar2 default hr_api.g_varchar2
291 ,p_attribute22 in varchar2 default hr_api.g_varchar2
292 ,p_attribute23 in varchar2 default hr_api.g_varchar2
293 ,p_attribute24 in varchar2 default hr_api.g_varchar2
297 ,p_attribute28 in varchar2 default hr_api.g_varchar2
294 ,p_attribute25 in varchar2 default hr_api.g_varchar2
295 ,p_attribute26 in varchar2 default hr_api.g_varchar2
296 ,p_attribute27 in varchar2 default hr_api.g_varchar2
298 ,p_attribute29 in varchar2 default hr_api.g_varchar2
299 ,p_attribute30 in varchar2 default hr_api.g_varchar2
300 ,p_assignment_id in number default hr_api.g_number
301 ,p_source_id in number default hr_api.g_number
302 ,p_source_function in varchar2 default hr_api.g_varchar2
303 ,p_cancellation_reason in varchar2 default hr_api.g_varchar2
304 ,p_earliest_start_date in date default hr_api.g_date
305 ,p_creator_person_id in number default hr_api.g_number
306 );
307 --
308 -- ----------------------------------------------------------------------------
309 -- |-----------------------< delete_training_plan_member >--------------------|
310 -- ----------------------------------------------------------------------------
311 --
312 -- {Start Of Comments}
313 /*#
314 * This business process deletes a component record from a personal or
315 * organization training plan.
316 *
317 * This API, called from Self-Service as well as PUI forms, deletes a record in
318 * the OTA_TRAINING_PLAN_MEMBERS table.
319 *
320 * <p><b>Licensing</b><br>
321 * This API is licensed for use with Learning Management.
322 *
323 * <p><b>Prerequisites</b><br>
324 * A valid training plan component must exist.
325 *
326 * <p><b>Post Success</b><br>
327 * The training plan component record of the user is deleted.
328 *
329 * <p><b>Post Failure</b><br>
330 * The API does not delete the training plan component record, and raises an
331 * error.
332 * @param p_validate If true, then validation alone will be performed and the
333 * database will remain unchanged. If false and all validation checks pass,
334 * then the database will be modified.
335 * @param p_training_plan_member_id The unique identifier for the component
336 * record.
337 * @param p_object_version_number Current version number of the
338 * ota_training_plan_members to be deleted.
339 * @rep:displayname Delete Training Plan component
340 * @rep:category BUSINESS_ENTITY OTA_TRAINING_PLAN
341 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
342 * @rep:scope public
343 * @rep:lifecycle active
344 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
345 */
346 --
347 -- {End Of Comments}
348 --
349 procedure delete_training_plan_member
350 (p_validate in boolean default false
351 ,p_training_plan_member_id in number
352 ,p_object_version_number in number
353 );
354 end ota_tpm_api;
[Home] [Help]