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