1 Package ota_activity_category_api AUTHID CURRENT_USER as
2 /* $Header: otaciapi.pkh 120.1 2005/10/02 02:07:13 aroussel $ */
3 /*#
4 * This package contains the Course Category API.
5 * @rep:scope public
6 * @rep:product ota
7 * @rep:displayname Course Category
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-------------------------< create_act_cat_inclusion >---------------------|
15 /*#
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
16 * This API creates a course-to-category association.
17 *
18 * This business process allows the user to create a course-to-category
19 * association identified by a course identifier (p_activity_version_id ) and
20 * category identifier (p_category_usage_id)
21 *
22 * <p><b>Licensing</b><br>
23 * This API is licensed for use with Learning Management.
24 *
25 * <p><b>Prerequisites</b><br>
26 * The Course and the Category for which this association is being created must
27 * be defined
28 *
29 * <p><b>Post Success</b><br>
30 * An association between the course and category is created.
31 *
32 * <p><b>Post Failure</b><br>
33 * The API does not create a member record, 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_activity_version_id {@rep:casecolumn
41 * OTA_ACTIVITY_VERSIONS.ACTIVITY_VERSION_ID}
42 * @param p_activity_category Obsoleted.
43 * @param p_comments If the profile 'HR:Use Standard Attachments
44 * (PER_ATTACHMENT_USAGE)' is set to 'No', this text serves as HR-specific
45 * attachment text.
46 * @param p_object_version_number If p_validate is false, then set to the
47 * version number of the created course category inclusion. If p_validate is
48 * true, then the value will be null.
49 * @param p_aci_information_category This context value determines which
50 * Flexfield Structure to use with the Descriptive flexfield segments.
51 * @param p_aci_information1 Descriptive flexfield segment.
52 * @param p_aci_information2 Descriptive flexfield segment.
53 * @param p_aci_information3 Descriptive flexfield segment.
54 * @param p_aci_information4 Descriptive flexfield segment.
55 * @param p_aci_information5 Descriptive flexfield segment.
56 * @param p_aci_information6 Descriptive flexfield segment.
57 * @param p_aci_information7 Descriptive flexfield segment.
58 * @param p_aci_information8 Descriptive flexfield segment.
59 * @param p_aci_information9 Descriptive flexfield segment.
60 * @param p_aci_information10 Descriptive flexfield segment.
61 * @param p_aci_information11 Descriptive flexfield segment.
62 * @param p_aci_information12 Descriptive flexfield segment.
63 * @param p_aci_information13 Descriptive flexfield segment.
64 * @param p_aci_information14 Descriptive flexfield segment.
65 * @param p_aci_information15 Descriptive flexfield segment.
66 * @param p_aci_information16 Descriptive flexfield segment.
67 * @param p_aci_information17 Descriptive flexfield segment.
68 * @param p_aci_information18 Descriptive flexfield segment.
69 * @param p_aci_information19 Descriptive flexfield segment.
70 * @param p_aci_information20 Descriptive flexfield segment.
71 * @param p_start_date_active Start Date
72 * @param p_end_date_active End Date
73 * @param p_primary_flag Primary Indicator. Can be only 'Y' or 'N'
74 * @param p_category_usage_id {@rep:casecolumn
75 * OTA_CATEGORY_USAGES.CATEGORY_USAGE_ID}
76 * @rep:displayname Create Course Category Inclusion
77 * @rep:category BUSINESS_ENTITY OTA_CATALOG_CATEGORY
78 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
79 * @rep:scope public
80 * @rep:lifecycle active
81 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
82 */
83 --
84 -- {End Of Comments}
85 --
86 procedure create_act_cat_inclusion
87 (p_validate in boolean default false,
88 p_effective_date in date,
89 p_activity_version_id in number,
90 p_activity_category in varchar2,
91 p_comments in varchar2 default null,
92 p_object_version_number out nocopy number,
93 p_aci_information_category in varchar2 default null,
94 p_aci_information1 in varchar2 default null,
95 p_aci_information2 in varchar2 default null,
96 p_aci_information3 in varchar2 default null,
97 p_aci_information4 in varchar2 default null,
98 p_aci_information5 in varchar2 default null,
99 p_aci_information6 in varchar2 default null,
100 p_aci_information7 in varchar2 default null,
101 p_aci_information8 in varchar2 default null,
102 p_aci_information9 in varchar2 default null,
103 p_aci_information10 in varchar2 default null,
104 p_aci_information11 in varchar2 default null,
105 p_aci_information12 in varchar2 default null,
106 p_aci_information13 in varchar2 default null,
107 p_aci_information14 in varchar2 default null,
108 p_aci_information15 in varchar2 default null,
109 p_aci_information16 in varchar2 default null,
110 p_aci_information17 in varchar2 default null,
111 p_aci_information18 in varchar2 default null,
112 p_aci_information19 in varchar2 default null,
113 p_aci_information20 in varchar2 default null,
114 p_start_date_active in date default null,
115 p_end_date_active in date default null,
116 p_primary_flag in varchar2 default 'N',
117 p_category_usage_id in number
118 );
119 --
120 -- ----------------------------------------------------------------------------
124 -- {Start Of Comments}
121 -- |-------------------------< update_act_cat_inclusion >---------------------|
122 -- ----------------------------------------------------------------------------
123 --
125 /*#
126 * This API updates a course-to-category association.
127 *
128 * This business process allows the user to update a course-to-category
129 * association identified by a course identifier (p_activity_version_id ) and
130 * category identifier (p_category_usage_id).
131 *
132 * <p><b>Licensing</b><br>
133 * This API is licensed for use with Learning Management.
134 *
135 * <p><b>Prerequisites</b><br>
136 * The course and the category for which this association is being created must
137 * be defined.
138 *
139 * <p><b>Post Success</b><br>
140 * The Course Category Association is successfully updated.
141 *
142 * <p><b>Post Failure</b><br>
143 * The Course Category Association is not updated. An error is raised.
144 * @param p_validate If true, then validation alone will be performed and the
145 * database will remain unchanged. If false and all validation checks pass,
146 * then the database will be modified.
147 * @param p_effective_date Reference date for validating lookup values are
148 * applicable during the start to end active date range. This date does not
149 * determine when the changes take effect.
150 * @param p_activity_version_id {@rep:casecolumn
151 * OTA_ACTIVITY_VERSIONS.ACTIVITY_VERSION_ID}
152 * @param p_activity_category Obsoleted.
153 * @param p_comments If the profile 'HR:Use Standard Attachments
154 * (PER_ATTACHMENT_USAGE)' is set to 'No', this text serves as HR-specific
155 * attachment text.
156 * @param p_object_version_number Passes in the current version number of the
157 * Course category inclusion to be updated. When the API completes, if
158 * p_validate is false, the number is set to the new version number of the
159 * updated Course category inclusion. If p_validate is true, the number is set
160 * to the default value (null)
161 * @param p_aci_information_category This context value determines which
162 * Flexfield Structure to use with the Descriptive flexfield segments.
163 * @param p_aci_information1 Descriptive flexfield segment.
164 * @param p_aci_information2 Descriptive flexfield segment.
165 * @param p_aci_information3 Descriptive flexfield segment.
166 * @param p_aci_information4 Descriptive flexfield segment.
167 * @param p_aci_information5 Descriptive flexfield segment.
168 * @param p_aci_information6 Descriptive flexfield segment.
169 * @param p_aci_information7 Descriptive flexfield segment.
170 * @param p_aci_information8 Descriptive flexfield segment.
171 * @param p_aci_information9 Descriptive flexfield segment.
172 * @param p_aci_information10 Descriptive flexfield segment.
173 * @param p_aci_information11 Descriptive flexfield segment.
174 * @param p_aci_information12 Descriptive flexfield segment.
175 * @param p_aci_information13 Descriptive flexfield segment.
176 * @param p_aci_information14 Descriptive flexfield segment.
177 * @param p_aci_information15 Descriptive flexfield segment.
178 * @param p_aci_information16 Descriptive flexfield segment.
179 * @param p_aci_information17 Descriptive flexfield segment.
180 * @param p_aci_information18 Descriptive flexfield segment.
181 * @param p_aci_information19 Descriptive flexfield segment.
182 * @param p_aci_information20 Descriptive flexfield segment.
183 * @param p_start_date_active Start Date
184 * @param p_end_date_active End Date
185 * @param p_primary_flag Primary Indicator. Can be only 'Y' or 'N'
186 * @param p_category_usage_id {@rep:casecolumn
187 * OTA_CATEGORY_USAGES.CATEGORY_USAGE_ID}
188 * @rep:displayname Update Course Category Inclusion
189 * @rep:category BUSINESS_ENTITY OTA_CATALOG_CATEGORY
190 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
191 * @rep:scope public
192 * @rep:lifecycle active
193 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
194 */
195 --
196 -- {End Of Comments}
197 --
198 procedure update_act_cat_inclusion
199 (p_validate in boolean default false
200 ,p_effective_date in date
201 ,p_activity_version_id in number
202 ,p_activity_category in varchar2
203 ,p_comments in varchar2 default hr_api.g_varchar2
204 ,p_object_version_number in out nocopy number
205 ,p_aci_information_category in varchar2 default hr_api.g_varchar2
206 ,p_aci_information1 in varchar2 default hr_api.g_varchar2
207 ,p_aci_information2 in varchar2 default hr_api.g_varchar2
208 ,p_aci_information3 in varchar2 default hr_api.g_varchar2
209 ,p_aci_information4 in varchar2 default hr_api.g_varchar2
210 ,p_aci_information5 in varchar2 default hr_api.g_varchar2
211 ,p_aci_information6 in varchar2 default hr_api.g_varchar2
212 ,p_aci_information7 in varchar2 default hr_api.g_varchar2
213 ,p_aci_information8 in varchar2 default hr_api.g_varchar2
214 ,p_aci_information9 in varchar2 default hr_api.g_varchar2
215 ,p_aci_information10 in varchar2 default hr_api.g_varchar2
216 ,p_aci_information11 in varchar2 default hr_api.g_varchar2
217 ,p_aci_information12 in varchar2 default hr_api.g_varchar2
218 ,p_aci_information13 in varchar2 default hr_api.g_varchar2
219 ,p_aci_information14 in varchar2 default hr_api.g_varchar2
220 ,p_aci_information15 in varchar2 default hr_api.g_varchar2
221 ,p_aci_information16 in varchar2 default hr_api.g_varchar2
222 ,p_aci_information17 in varchar2 default hr_api.g_varchar2
223 ,p_aci_information18 in varchar2 default hr_api.g_varchar2
224 ,p_aci_information19 in varchar2 default hr_api.g_varchar2
228 ,p_primary_flag in varchar2 default hr_api.g_varchar2
225 ,p_aci_information20 in varchar2 default hr_api.g_varchar2
226 ,p_start_date_active in date default hr_api.g_date
227 ,p_end_date_active in date default hr_api.g_date
229 ,p_category_usage_id in number
230 );
231 --
232 -- ----------------------------------------------------------------------------
233 -- |-------------------------< delete_act_cat_inclusion >---------------------|
234 -- ----------------------------------------------------------------------------
235 --
236 -- {Start Of Comments}
237 /*#
238 * This API deletes a course-to-category association.
239 *
240 * This business process allows the user to delete a course-to-category
241 * association identified by a course identifier (p_activity_version_id ) and
242 * category identifier (p_category_usage_id).
243 *
244 * <p><b>Licensing</b><br>
245 * This API is licensed for use with Learning Management.
246 *
247 * <p><b>Prerequisites</b><br>
248 * The inclusion as well as the course and category must exist
249 *
250 * <p><b>Post Success</b><br>
251 * The course category inclusion is deleted.
252 *
253 * <p><b>Post Failure</b><br>
254 * The API does not delete the course category association record and raises an
255 * error.
256 * @param p_activity_version_id {@rep:casecolumn
257 * OTA_ACTIVITY_VERSIONS.ACTIVITY_VERSION_ID}
258 * @param p_category_usage_id {@rep:casecolumn
259 * OTA_CATEGORY_USAGES.CATEGORY_USAGE_ID}
263 * database will remain unchanged. If false and all validation checks pass,
260 * @param p_object_version_number Passes in the current version number of the
261 * course-to-category inclusion to be deleted.
262 * @param p_validate If true, then validation alone will be performed and the
264 * then the database will be modified.
265 * @rep:displayname Delete Course Category Inclusion
266 * @rep:category BUSINESS_ENTITY OTA_CATALOG_CATEGORY
267 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
268 * @rep:scope public
269 * @rep:lifecycle active
270 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
271 */
272 --
273 -- {End Of Comments}
274 --
275 procedure delete_act_cat_inclusion
276 ( p_activity_version_id in number,
277 p_category_usage_id in varchar2,
278 p_object_version_number in number,
279 p_validate in boolean default false
280 );
281 end ota_activity_category_api;
[Home] [Help]