1 Package ota_category_usage_api as
2 /* $Header: otctuapi.pkh 120.1 2005/10/02 02:07:23 aroussel $ */
3 /*#
4 * This package contains the category usage APIs that create or update a
5 * Category or Delivery Mode.
6 * @rep:scope public
7 * @rep:product ota
8 * @rep:displayname Category Usage
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |-----------------------------< create_category >--------------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates a category.
18 *
19 *
20 * <p><b>Licensing</b><br>
21 * This API is licensed for use with Learning Management.
22 *
23 * <p><b>Prerequisites</b><br>
24 * The business group that owns this category should exist.
25 *
26 * <p><b>Post Success</b><br>
27 * Record for category created
28 *
29 * <p><b>Post Failure</b><br>
30 * Record for category is not created and an error is raised
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 {@rep:casecolumn
38 * OTA_CATEGORY_USAGES.BUSINESS_GROUP_ID}
39 * @param p_category {@rep:casecolumn OTA_CATEGORY_USAGES_TL.CATEGORY}
40 * @param p_type The category's type. Valid values are defined in the
41 * 'CATEGORY_TYPE' lookup type.
42 * @param p_description {@rep:casecolumn OTA_CATEGORY_USAGES_TL.DESCRIPTION}
43 * @param p_parent_cat_usage_id Since a category can be created within a
44 * category, this value determines the category_usage_id of the parent
45 * category. It should be a valid category_usage_id within the same business
46 * group.
47 * @param p_synchronous_flag This flag is used only for categories of type 'DM'
48 * (Delivery Modes). Valid values are defined in the 'YES_NO' lookup type.
49 * @param p_online_flag This flag is used only for category of type 'DM'
50 * (Delivery Modes). Valid values are defined in the 'YES_NO' lookup type.
51 * @param p_attribute_category This context value determines which flexfield
52 * structure to use with the descriptive flexfield segments.
53 * @param p_attribute1 Descriptive flexfield segment.
54 * @param p_attribute2 Descriptive flexfield segment.
55 * @param p_attribute3 Descriptive flexfield segment.
56 * @param p_attribute4 Descriptive flexfield segment.
57 * @param p_attribute5 Descriptive flexfield segment.
58 * @param p_attribute6 Descriptive flexfield segment.
59 * @param p_attribute7 Descriptive flexfield segment.
60 * @param p_attribute8 Descriptive flexfield segment.
61 * @param p_attribute9 Descriptive flexfield segment.
62 * @param p_attribute10 Descriptive flexfield segment.
63 * @param p_attribute11 Descriptive flexfield segment.
64 * @param p_attribute12 Descriptive flexfield segment.
65 * @param p_attribute13 Descriptive flexfield segment.
66 * @param p_attribute14 Descriptive flexfield segment.
67 * @param p_attribute15 Descriptive flexfield segment.
68 * @param p_attribute16 Descriptive flexfield segment.
69 * @param p_attribute17 Descriptive flexfield segment.
70 * @param p_attribute18 Descriptive flexfield segment.
71 * @param p_attribute19 Descriptive flexfield segment.
72 * @param p_attribute20 Descriptive flexfield segment.
73 * @param p_data_source {@rep:casecolumn OTA_CATEGORY_USAGES.DATA_SOURCE}
74 * @param p_start_date_active {@rep:casecolumn
75 * OTA_CATEGORY_USAGES.START_DATE_ACTIVE}
76 * @param p_end_date_active {@rep:casecolumn
77 * OTA_CATEGORY_USAGES.END_DATE_ACTIVE}
78 * @param p_category_usage_id {@rep:casecolumn
79 * OTA_CATEGORY_USAGES.CATEGORY_USAGE_ID}
80 * @param p_object_version_number If p_validate is false, then it is set to the
81 * version number of the created external learning. If p_validate is true, then
82 * the value is null.
83 * @param p_comments If profile 'HR:Use Standard Attachments
84 * (PER_ATTACHMENT_USAGE)' is set to 'No', this text serves as HR-specific
85 * attachment text.
86 * @rep:displayname Create Category
87 * @rep:category BUSINESS_ENTITY OTA_LEARNING_CATALOG_CAT_USE
88 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
89 * @rep:scope public
90 * @rep:lifecycle active
91 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
92 */
93 --
94 -- {End Of Comments}
95 --
96 procedure Create_category
97 (p_validate in boolean default false
98 ,p_effective_date in date
99 ,p_business_group_id in number
100 ,p_category in varchar2
101 ,p_type in varchar2
102 ,p_description in varchar2
103 ,p_parent_cat_usage_id in number
104 ,p_synchronous_flag in varchar2
105 ,p_online_flag in varchar2 default null
106 ,p_attribute_category in varchar2 default null
107 ,p_attribute1 in varchar2 default null
108 ,p_attribute2 in varchar2 default null
109 ,p_attribute3 in varchar2 default null
110 ,p_attribute4 in varchar2 default null
111 ,p_attribute5 in varchar2 default null
112 ,p_attribute6 in varchar2 default null
113 ,p_attribute7 in varchar2 default null
114 ,p_attribute8 in varchar2 default null
115 ,p_attribute9 in varchar2 default null
116 ,p_attribute10 in varchar2 default null
117 ,p_attribute11 in varchar2 default null
118 ,p_attribute12 in varchar2 default null
119 ,p_attribute13 in varchar2 default null
120 ,p_attribute14 in varchar2 default null
121 ,p_attribute15 in varchar2 default null
122 ,p_attribute16 in varchar2 default null
123 ,p_attribute17 in varchar2 default null
124 ,p_attribute18 in varchar2 default null
125 ,p_attribute19 in varchar2 default null
126 ,p_attribute20 in varchar2 default null
127 ,p_data_source in varchar2 default null
128 ,p_start_date_active in date
129 ,p_end_date_active in date default null
130 ,p_category_usage_id out nocopy number
131 ,p_object_version_number out nocopy number
132 ,p_comments in varchar2 default null
133
134 );
135 --
136 -- ----------------------------------------------------------------------------
137 -- |-----------------------------< update_category >--------------------------|
138 -- ----------------------------------------------------------------------------
139 --
140 -- {Start Of Comments}
141 /*#
142 * This API updates a category.
143 *
144 *
145 * <p><b>Licensing</b><br>
146 * This API is licensed for use with Learning Management.
147 *
148 * <p><b>Prerequisites</b><br>
149 * Category record must exist for the user.
150 *
151 * <p><b>Post Success</b><br>
152 * Record for category is updated
153 *
154 * <p><b>Post Failure</b><br>
155 * Record for category is not update and an error is raised
156 * @param p_validate If true, then validation alone will be performed and the
157 * database will remain unchanged. If false and all validation checks pass,
158 * then the database will be modified.
159 * @param p_effective_date Reference date for validating lookup values are
160 * applicable during the start to end active date range. This date does not
161 * determine when the changes take effect.
162 * @param p_category_usage_id {@rep:casecolumn
163 * OTA_CATEGORY_USAGES.CATEGORY_USAGE_ID}
164 * @param p_object_version_number Pass in the current version number of the
165 * category to be updated. When the API completes, if p_validate is false, the
166 * number is set to the new version number of the updated category. If
167 * p_validate is true the number remains unchanged.
168 * @param p_category {@rep:casecolumn OTA_CATEGORY_USAGES_TL.CATEGORY}
169 * @param p_type The category's type. Valid values are defined in the
170 * 'CATEGORY_TYPE' lookup type.
171 * @param p_description {@rep:casecolumn OTA_CATEGORY_USAGES_TL.DESCRIPTION}
172 * @param p_parent_cat_usage_id Since a category can be created within a
173 * category, this value determines the category_usage_id of the parent
174 * category. It should be a valid category_usage_id within the same business
175 * group.
176 * @param p_synchronous_flag This flag is used only for categories of type 'DM'
177 * (Delivery Mode). Valid values are defined in the 'YES_NO' lookup type.
178 * @param p_online_flag This flag is used only for categories of type 'DM'
179 * (Delivery Mode). Valid values are defined in the 'YES_NO' lookup type.
180 * @param p_attribute_category This context value determines which flexfield
181 * structure to use with the descriptive flexfield segments.
182 * @param p_attribute1 Descriptive flexfield segment.
183 * @param p_attribute2 Descriptive flexfield segment.
184 * @param p_attribute3 Descriptive flexfield segment.
185 * @param p_attribute4 Descriptive flexfield segment.
186 * @param p_attribute5 Descriptive flexfield segment.
187 * @param p_attribute6 Descriptive flexfield segment.
191 * @param p_attribute10 Descriptive flexfield segment.
188 * @param p_attribute7 Descriptive flexfield segment.
189 * @param p_attribute8 Descriptive flexfield segment.
190 * @param p_attribute9 Descriptive flexfield segment.
192 * @param p_attribute11 Descriptive flexfield segment.
193 * @param p_attribute12 Descriptive flexfield segment.
194 * @param p_attribute13 Descriptive flexfield segment.
195 * @param p_attribute14 Descriptive flexfield segment.
196 * @param p_attribute15 Descriptive flexfield segment.
197 * @param p_attribute16 Descriptive flexfield segment.
198 * @param p_attribute17 Descriptive flexfield segment.
199 * @param p_attribute18 Descriptive flexfield segment.
200 * @param p_attribute19 Descriptive flexfield segment.
201 * @param p_attribute20 Descriptive flexfield segment.
202 * @param p_data_source {@rep:casecolumn OTA_CATEGORY_USAGES.DATA_SOURCE}
203 * @param p_start_date_active {@rep:casecolumn
204 * OTA_CATEGORY_USAGES.START_DATE_ACTIVE}
205 * @param p_end_date_active {@rep:casecolumn
206 * OTA_CATEGORY_USAGES.END_DATE_ACTIVE}
207 * @param p_comments If the profile 'HR:Use Standard Attachments
208 * (PER_ATTACHMENT_USAGE)' is set to 'No', this text serves as HR-specific
209 * attachment text.
210 * @rep:displayname Update Category
211 * @rep:category BUSINESS_ENTITY OTA_LEARNING_CATALOG_CAT_USE
212 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
213 * @rep:scope public
214 * @rep:lifecycle active
215 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
216 */
217 --
218 -- {End Of Comments}
219 --
220 procedure Update_category
221 (p_validate in boolean default false
222 ,p_effective_date in date
223 ,p_category_usage_id in number
224 ,p_object_version_number in out nocopy number
225 ,p_category in varchar2
226 ,p_type in varchar2
227 ,p_description in varchar2
228 ,p_parent_cat_usage_id in number
229 ,p_synchronous_flag in varchar2
230 ,p_online_flag in varchar2 default null
231 ,p_attribute_category in varchar2 default null
232 ,p_attribute1 in varchar2 default null
233 ,p_attribute2 in varchar2 default null
234 ,p_attribute3 in varchar2 default null
235 ,p_attribute4 in varchar2 default null
236 ,p_attribute5 in varchar2 default null
237 ,p_attribute6 in varchar2 default null
238 ,p_attribute7 in varchar2 default null
239 ,p_attribute8 in varchar2 default null
240 ,p_attribute9 in varchar2 default null
241 ,p_attribute10 in varchar2 default null
242 ,p_attribute11 in varchar2 default null
243 ,p_attribute12 in varchar2 default null
244 ,p_attribute13 in varchar2 default null
245 ,p_attribute14 in varchar2 default null
246 ,p_attribute15 in varchar2 default null
247 ,p_attribute16 in varchar2 default null
248 ,p_attribute17 in varchar2 default null
249 ,p_attribute18 in varchar2 default null
250 ,p_attribute19 in varchar2 default null
251 ,p_attribute20 in varchar2 default null
252 ,p_data_source in varchar2 default null
253 ,p_start_date_active in date
254 ,p_end_date_active in date default null
255 ,p_comments in varchar2 default null
256
257 );
258 --
259 -- ----------------------------------------------------------------------------
260 -- |-----------------------------< delete_category >--------------------------|
261 -- ----------------------------------------------------------------------------
262 --
263 -- {Start Of Comments}
264 /*#
265 * This API deletes a category.
266 *
267 *
268 * <p><b>Licensing</b><br>
269 * This API is licensed for use with Learning Management.
270 *
271 * <p><b>Prerequisites</b><br>
272 * Category record must exist for the user.
273 *
274 * <p><b>Post Success</b><br>
275 * Record for category is deleted.
276 *
277 * <p><b>Post Failure</b><br>
278 * Record for category is not deleted and an error is raised.
279 * @param p_validate If true, then validation alone will be performed and the
280 * database will remain unchanged. If false and all validation checks pass,
281 * then the database will be modified.
282 * @param p_category_usage_id {@rep:casecolumn
283 * OTA_CATEGORY_USAGES.CATEGORY_USAGE_ID}
284 * @param p_object_version_number Pass in the current version number of the
285 * category to be deleted.
286 * @rep:displayname Delete Category
287 * @rep:category BUSINESS_ENTITY OTA_LEARNING_CATALOG_CAT_USE
288 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
289 * @rep:scope public
290 * @rep:lifecycle active
291 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
292 */
293 --
294 -- {End Of Comments}
295 --
296 procedure delete_category
297 (p_validate in boolean default false
298 ,p_category_usage_id in number
299 ,p_object_version_number in number
300 );
301
302 end ota_category_usage_api;
[Home] [Help]