4 * This package contains Learning Path Component APIs.
1 Package ota_lp_member_api AUTHID CURRENT_USER as
2 /* $Header: otlpmapi.pkh 120.1 2005/10/02 02:07:38 aroussel $ */
3 /*#
5 * @rep:scope public
6 * @rep:product ota
7 * @rep:displayname Learning Path Component
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-----------------------< create_learning_path_member >--------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a learning path component.
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 Learning Path and the course must exist and the course must be valid
24 * within the Learning Path dates; i.e., the course should not start after the
25 * learning path end date and should not end before the learning path start
26 * date.
27 *
28 * <p><b>Post Success</b><br>
29 * The Learning Path Component will be successfully created.
30 *
31 * <p><b>Post Failure</b><br>
32 * The learning path component will not be created and an error will be raised.
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 Reference date for validating lookup values are
37 * applicable during the start to end active date range. This date does not
38 * determine when the changes take effect.
39 * @param p_business_group_id The unique idetifier of the business group that
40 * owns the learning path component record and the Learning Path.
41 * @param p_learning_path_id The unique identifier of the learning path in
42 * which the component is being created.
43 * @param p_activity_version_id The unique identifier of the course that is
44 * being added as component.
45 * @param p_course_sequence The sequence number of this component in the
46 * learning path.
47 * @param p_duration The estimated length of the learning path component.
48 * @param p_duration_units The completion target units of the learning path
49 * component. Valid values are defined by the 'OTA_DURATION_UNITS' lookup type.
50 * @param p_attribute_category This context value determines which flexfield
51 * structure to use with the descriptive flexfield segments.
52 * @param p_attribute1 Descriptive flexfield segment.
53 * @param p_attribute2 Descriptive flexfield segment.
54 * @param p_attribute3 Descriptive flexfield segment.
55 * @param p_attribute4 Descriptive flexfield segment.
56 * @param p_attribute5 Descriptive flexfield segment.
57 * @param p_attribute6 Descriptive flexfield segment.
58 * @param p_attribute7 Descriptive flexfield segment.
59 * @param p_attribute8 Descriptive flexfield segment.
60 * @param p_attribute9 Descriptive flexfield segment.
61 * @param p_attribute10 Descriptive flexfield segment.
62 * @param p_attribute11 Descriptive flexfield segment.
63 * @param p_attribute12 Descriptive flexfield segment.
64 * @param p_attribute13 Descriptive flexfield segment.
65 * @param p_attribute14 Descriptive flexfield segment.
66 * @param p_attribute15 Descriptive flexfield segment.
67 * @param p_attribute16 Descriptive flexfield segment.
68 * @param p_attribute17 Descriptive flexfield segment.
69 * @param p_attribute18 Descriptive flexfield segment.
70 * @param p_attribute19 Descriptive flexfield segment.
71 * @param p_attribute20 Descriptive flexfield segment.
72 * @param p_learning_path_member_id The unique identifier for the member
73 * record.
74 * @param p_object_version_number If p_validate is false, then the number is
75 * set to the version number of the created learning path member. If p_validate
76 * is true, then the value is null.
77 * @param p_notify_days_before_target New parameter, available on the latest
78 * version of this API.
79 * @param p_learning_path_section_id New parameter, available on the latest
80 * version of this API.
81 * @rep:displayname Create Learning Path Component
82 * @rep:category BUSINESS_ENTITY OTA_LEARNING_PATH_COMPONENT
83 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
84 * @rep:scope public
85 * @rep:lifecycle active
86 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
87 */
88 --
89 -- {End Of Comments}
90 --
91 procedure create_learning_path_member
92 (p_validate in boolean default false
93 ,p_effective_date in date
94 ,p_business_group_id in number
95 ,p_learning_path_id in number
96 ,p_activity_version_id in number
97 ,p_course_sequence in number
98 ,p_duration in number default null
99 ,p_duration_units in varchar2 default null
100 ,p_attribute_category in varchar2 default null
101 ,p_attribute1 in varchar2 default null
102 ,p_attribute2 in varchar2 default null
103 ,p_attribute3 in varchar2 default null
104 ,p_attribute4 in varchar2 default null
105 ,p_attribute5 in varchar2 default null
106 ,p_attribute6 in varchar2 default null
107 ,p_attribute7 in varchar2 default null
108 ,p_attribute8 in varchar2 default null
109 ,p_attribute9 in varchar2 default null
110 ,p_attribute10 in varchar2 default null
114 ,p_attribute14 in varchar2 default null
111 ,p_attribute11 in varchar2 default null
112 ,p_attribute12 in varchar2 default null
113 ,p_attribute13 in varchar2 default null
115 ,p_attribute15 in varchar2 default null
116 ,p_attribute16 in varchar2 default null
117 ,p_attribute17 in varchar2 default null
118 ,p_attribute18 in varchar2 default null
119 ,p_attribute19 in varchar2 default null
120 ,p_attribute20 in varchar2 default null
121 ,p_learning_path_section_id in number
122 ,p_notify_days_before_target in number default null
123 ,p_learning_path_member_id out nocopy number
124 ,p_object_version_number out nocopy number
125 );
126 --
127 -- ----------------------------------------------------------------------------
128 -- |-----------------------< update_learning_path_member >--------------------|
129 -- ----------------------------------------------------------------------------
130 --
131 -- {Start Of Comments}
132 /*#
133 * This API updates a learning path component.
134 *
135 *
136 * <p><b>Licensing</b><br>
137 * This API is licensed for use with Learning Management.
138 *
139 * <p><b>Prerequisites</b><br>
140 * The learning path component should exist.
141 *
142 * <p><b>Post Success</b><br>
143 * The learning path component will be successfully updated.
144 *
145 * <p><b>Post Failure</b><br>
146 * The learning path component will not be updated and an error will be raised.
147 * @param p_validate If true, then validation alone will be performed and the
148 * database will remain unchanged. If false and all validation checks pass,
149 * then the database will be modified.
150 * @param p_effective_date Reference date for validating lookup values are
151 * applicable during the start to end active date range. This date does not
152 * determine when the changes take effect.
153 * @param p_learning_path_member_id The unique identifier for the member
154 * record.
155 * @param p_object_version_number Pass in the current version number of the
156 * learning path component to be updated. When the API completes, if p_validate
157 * is false, the number is set to the new version number of the updated
158 * learning path component. If p_validate is true, the number remains
159 * unchanged.
160 * @param p_activity_version_id The unique identifier of the course that is
161 * added to the learning path as component.
162 * @param p_course_sequence The sequence number of this component in the
163 * learning path.
164 * @param p_duration The estimated length of the learning path component.
165 * @param p_duration_units The completion target units of the learning path
166 * component. Valid values are defined by the 'OTA_DURATION_UNITS' lookup type.
167 * @param p_attribute_category This context value determines which flexfield
168 * structure to use with the descriptive flexfield segments.
169 * @param p_attribute1 Descriptive flexfield segment.
170 * @param p_attribute2 Descriptive flexfield segment.
171 * @param p_attribute3 Descriptive flexfield segment.
172 * @param p_attribute4 Descriptive flexfield segment.
173 * @param p_attribute5 Descriptive flexfield segment.
174 * @param p_attribute6 Descriptive flexfield segment.
175 * @param p_attribute7 Descriptive flexfield segment.
176 * @param p_attribute8 Descriptive flexfield segment.
177 * @param p_attribute9 Descriptive flexfield segment.
178 * @param p_attribute10 Descriptive flexfield segment.
179 * @param p_attribute11 Descriptive flexfield segment.
180 * @param p_attribute12 Descriptive flexfield segment.
181 * @param p_attribute13 Descriptive flexfield segment.
182 * @param p_attribute14 Descriptive flexfield segment.
183 * @param p_attribute15 Descriptive flexfield segment.
184 * @param p_attribute16 Descriptive flexfield segment.
185 * @param p_attribute17 Descriptive flexfield segment.
186 * @param p_attribute18 Descriptive flexfield segment.
187 * @param p_attribute19 Descriptive flexfield segment.
188 * @param p_attribute20 Descriptive flexfield segment.
189 * @param p_notify_days_before_target New parameter, available on the latest
190 * version of this API.
191 * @rep:displayname Update Learning Path Component
192 * @rep:category BUSINESS_ENTITY OTA_LEARNING_PATH_COMPONENT
193 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
194 * @rep:scope public
195 * @rep:lifecycle active
196 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
197 */
198 --
199 -- {End Of Comments}
200 --
201 procedure update_learning_path_member
202 (p_validate in boolean default false
203 ,p_effective_date in date
204 ,p_learning_path_member_id in number
205 ,p_object_version_number in out nocopy number
206 ,p_activity_version_id in number default hr_api.g_number
207 ,p_course_sequence in number default hr_api.g_number
208 ,p_duration in number default hr_api.g_number
209 ,p_duration_units in varchar2 default hr_api.g_varchar2
210 ,p_attribute_category in varchar2 default hr_api.g_varchar2
211 ,p_attribute1 in varchar2 default hr_api.g_varchar2
212 ,p_attribute2 in varchar2 default hr_api.g_varchar2
213 ,p_attribute3 in varchar2 default hr_api.g_varchar2
214 ,p_attribute4 in varchar2 default hr_api.g_varchar2
215 ,p_attribute5 in varchar2 default hr_api.g_varchar2
216 ,p_attribute6 in varchar2 default hr_api.g_varchar2
217 ,p_attribute7 in varchar2 default hr_api.g_varchar2
221 ,p_attribute11 in varchar2 default hr_api.g_varchar2
218 ,p_attribute8 in varchar2 default hr_api.g_varchar2
219 ,p_attribute9 in varchar2 default hr_api.g_varchar2
220 ,p_attribute10 in varchar2 default hr_api.g_varchar2
222 ,p_attribute12 in varchar2 default hr_api.g_varchar2
223 ,p_attribute13 in varchar2 default hr_api.g_varchar2
224 ,p_attribute14 in varchar2 default hr_api.g_varchar2
225 ,p_attribute15 in varchar2 default hr_api.g_varchar2
226 ,p_attribute16 in varchar2 default hr_api.g_varchar2
227 ,p_attribute17 in varchar2 default hr_api.g_varchar2
228 ,p_attribute18 in varchar2 default hr_api.g_varchar2
229 ,p_attribute19 in varchar2 default hr_api.g_varchar2
230 ,p_attribute20 in varchar2 default hr_api.g_varchar2
231 ,p_notify_days_before_target in number default hr_api.g_number
232 );
233 --
234 -- ----------------------------------------------------------------------------
235 -- |-----------------------< delete_learning_path_member >--------------------|
236 -- ----------------------------------------------------------------------------
237 --
238 -- {Start Of Comments}
239 /*#
240 * This API deletes a learning path component.
241 *
242 * Warning: Learning Path components should not be deleted after a learner has
243 * subscribed to the catalog Learning Path.
244 *
245 * <p><b>Licensing</b><br>
246 * This API is licensed for use with Learning Management.
247 *
248 * <p><b>Prerequisites</b><br>
249 * There should not be any learners subscribed to the Learning Path.
250 *
251 * <p><b>Post Success</b><br>
252 * The learning path component will be deleted from the database.
253 *
254 * <p><b>Post Failure</b><br>
255 * The learning path component will not be deleted and an error will be raised.
256 * @param p_validate If true, then validation alone will be performed and the
257 * database will remain unchanged. If false and all validation checks pass,
258 * then the database will be modified.
259 * @param p_learning_path_member_id The unique identifier for the learning path
260 * component record.
261 * @param p_object_version_number Current version number of the learning path
262 * component to be deleted.
263 * @rep:displayname Delete Learning Path Component
264 * @rep:category BUSINESS_ENTITY OTA_LEARNING_PATH_COMPONENT
265 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
266 * @rep:scope public
267 * @rep:lifecycle active
268 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
269 */
270 --
271 -- {End Of Comments}
272 --
273 procedure delete_learning_path_member
274 (p_validate in boolean default false
275 ,p_learning_path_member_id in number
276 ,p_object_version_number in number
277 );
278 end ota_lp_member_api;
[Home] [Help]