DBA Data[Home] [Help]

PACKAGE: APPS.OTA_LP_CATEGORY_API

Source


1 Package ota_lp_category_api AUTHID CURRENT_USER as
2 /* $Header: otlciapi.pkh 120.1 2005/10/02 02:07:34 aroussel $ */
3 /*#
4  * This package contains Learning Path Category Inclusion APIs.
5  * @rep:scope public
6  * @rep:product ota
7  * @rep:displayname Learning Path Category Inclusion
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-------------------------< create_lp_cat_inclusion >----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16  * This API creates a Learning Path Category Inclusion that associates a
17  * learning path with 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 Learning Path and the Category must exist.
25  *
26  * <p><b>Post Success</b><br>
27  * The Learning Path is associated to the given Category.
28  *
29  * <p><b>Post Failure</b><br>
30  * The learning path category inclusion will not be created and an error will
31  * be raised.
32  * @param p_validate If true, then validation alone will be performed and the
33  * database will remain unchanged. If false and all validation checks pass,
34  * then the database will be modified.
35  * @param p_effective_date Reference date for validating lookup values are
36  * applicable during the start to end active date range. This date does not
37  * determine when the changes take effect.
38  * @param p_learning_path_id The unique identifier of the learning path to
39  * which the category is being attached.
40  * @param p_category_usage_id The unique identifier of the category to which
41  * the learning path is being attached.
42  * @param p_object_version_number If p_validate is false, then the number is
43  * set to the version number of the created learning path category Inclusion
44  * record. If p_validate is true, then the value is null.
45  * @param p_start_date_active {@rep:casecolumn
46  * OTA_LP_CAT_INCLUSIONS.START_DATE_ACTIVE}
47  * @param p_end_date_active {@rep:casecolumn
48  * OTA_LP_CAT_INCLUSIONS.END_DATE_ACTIVE}
49  * @param p_primary_flag {@rep:casecolumn OTA_LP_CAT_INCLUSIONS.PRIMARY_FLAG}
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  * @rep:displayname Create Learning Path Category Inclusion
73  * @rep:category BUSINESS_ENTITY OTA_LEARNING_PATH_CATEGORY
74  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
75  * @rep:scope public
76  * @rep:lifecycle active
77  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
78 */
79 --
80 -- {End Of Comments}
81 --
82 procedure create_lp_cat_inclusion
83   (p_validate               in  boolean  default false,
84   p_effective_date          in  date,
85   p_learning_path_id        in  number,
86    p_category_usage_id      in  number ,
87   p_object_version_number   out nocopy number,
88   p_start_date_active      in  date      default null,
89   p_end_date_active        in  date      default null,
90   p_primary_flag           in  varchar2  default 'N',
91   p_attribute_category     in  varchar2  default null,
92   p_attribute1             in  varchar2  default null,
93   p_attribute2             in  varchar2  default null,
94   p_attribute3             in  varchar2  default null,
95   p_attribute4             in  varchar2  default null,
96   p_attribute5             in  varchar2  default null,
97   p_attribute6             in  varchar2  default null,
98   p_attribute7             in  varchar2  default null,
99   p_attribute8             in  varchar2  default null,
100   p_attribute9             in  varchar2  default null,
101   p_attribute10            in  varchar2  default null,
102   p_attribute11            in  varchar2  default null,
103   p_attribute12            in  varchar2  default null,
104   p_attribute13            in  varchar2  default null,
105   p_attribute14            in  varchar2  default null,
106   p_attribute15            in  varchar2  default null,
107   p_attribute16            in  varchar2  default null,
108   p_attribute17            in  varchar2  default null,
109   p_attribute18            in  varchar2  default null,
110   p_attribute19            in  varchar2  default null,
111   p_attribute20            in  varchar2  default null
112   );
113 --
114 -- ----------------------------------------------------------------------------
115 -- |-------------------------< update_lp_cat_inclusion >----------------------|
116 -- ----------------------------------------------------------------------------
117 --
118 -- {Start Of Comments}
119 /*#
120  * This API updates a Learning Path Category Inclusion.
121  *
122  *
123  * <p><b>Licensing</b><br>
124  * This API is licensed for use with Learning Management.
125  *
126  * <p><b>Prerequisites</b><br>
127  * The learning path category inclusion should exist.
128  *
129  * <p><b>Post Success</b><br>
130  * The Learning path category inclusion will have been updated.
131  *
132  * <p><b>Post Failure</b><br>
133  * The learning path category inclusion will not be updated and an error will
134  * be raised.
135  * @param p_validate If true, then validation alone will be performed and the
136  * database will remain unchanged. If false and all validation checks pass,
137  * then the database will be modified.
138  * @param p_effective_date Reference date for validating lookup values are
139  * applicable during the start to end active date range. This date does not
140  * determine when the changes take effect.
141  * @param p_learning_path_id The Identifier of a Learning Path that is to be
142  * added to the plan.
143  * @param p_object_version_number Pass in the current version number of the
144  * learning path category Inclusion record to be updated. When the API
145  * completes, if p_validate is false, the number is set to the new version
146  * number of the updated learning path category Inclusion record. If p_validate
147  * is true, the number remains unchanged.
148  * @param p_attribute_category This context value determines which flexfield
149  * structure to use with the descriptive flexfield segments.
150  * @param p_attribute1 Descriptive flexfield segment.
151  * @param p_attribute2 Descriptive flexfield segment.
152  * @param p_attribute3 Descriptive flexfield segment.
153  * @param p_attribute4 Descriptive flexfield segment.
154  * @param p_attribute5 Descriptive flexfield segment.
155  * @param p_attribute6 Descriptive flexfield segment.
156  * @param p_attribute7 Descriptive flexfield segment.
157  * @param p_attribute8 Descriptive flexfield segment.
158  * @param p_attribute9 Descriptive flexfield segment.
159  * @param p_attribute10 Descriptive flexfield segment.
160  * @param p_attribute11 Descriptive flexfield segment.
161  * @param p_attribute12 Descriptive flexfield segment.
162  * @param p_attribute13 Descriptive flexfield segment.
163  * @param p_attribute14 Descriptive flexfield segment.
164  * @param p_attribute15 Descriptive flexfield segment.
165  * @param p_attribute16 Descriptive flexfield segment.
166  * @param p_attribute17 Descriptive flexfield segment.
167  * @param p_attribute18 Descriptive flexfield segment.
168  * @param p_attribute19 Descriptive flexfield segment.
169  * @param p_attribute20 Descriptive flexfield segment.
170  * @param p_start_date_active {@rep:casecolumn
171  * OTA_LP_CAT_INCLUSIONS.START_DATE_ACTIVE}
172  * @param p_end_date_active {@rep:casecolumn
173  * OTA_LP_CAT_INCLUSIONS.END_DATE_ACTIVE}
174  * @param p_primary_flag {@rep:casecolumn OTA_LP_CAT_INCLUSIONS.PRIMARY_FLAG}
175  * @param p_category_usage_id The unique identifier of the category to which
176  * the learning path is being attached.
177  * @rep:displayname Update Learning Path Category Inclusion
178  * @rep:category BUSINESS_ENTITY OTA_LEARNING_PATH_CATEGORY
179  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
180  * @rep:scope public
181  * @rep:lifecycle active
182  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
183 */
184 --
185 -- {End Of Comments}
186 --
187 procedure update_lp_cat_inclusion
188   (p_validate                      in     boolean  default false
189   ,p_effective_date                in     date
190   ,p_learning_path_id          in number
191   ,p_object_version_number        in out nocopy number
192   ,p_attribute_category     in varchar2     default hr_api.g_varchar2
193   ,p_attribute1             in varchar2     default hr_api.g_varchar2
194   ,p_attribute2             in varchar2     default hr_api.g_varchar2
195   ,p_attribute3             in varchar2     default hr_api.g_varchar2
196   ,p_attribute4             in varchar2     default hr_api.g_varchar2
197   ,p_attribute5             in varchar2     default hr_api.g_varchar2
198   ,p_attribute6             in varchar2     default hr_api.g_varchar2
199   ,p_attribute7             in varchar2     default hr_api.g_varchar2
200   ,p_attribute8             in varchar2     default hr_api.g_varchar2
201   ,p_attribute9             in varchar2     default hr_api.g_varchar2
202   ,p_attribute10            in varchar2     default hr_api.g_varchar2
203   ,p_attribute11            in varchar2     default hr_api.g_varchar2
204   ,p_attribute12            in varchar2     default hr_api.g_varchar2
205   ,p_attribute13            in varchar2     default hr_api.g_varchar2
206   ,p_attribute14            in varchar2     default hr_api.g_varchar2
207   ,p_attribute15            in varchar2     default hr_api.g_varchar2
208   ,p_attribute16            in varchar2     default hr_api.g_varchar2
209   ,p_attribute17            in varchar2     default hr_api.g_varchar2
210   ,p_attribute18            in varchar2     default hr_api.g_varchar2
211   ,p_attribute19            in varchar2     default hr_api.g_varchar2
212   ,p_attribute20            in varchar2     default hr_api.g_varchar2
213   ,p_start_date_active            in date         default hr_api.g_date
214   ,p_end_date_active              in date         default hr_api.g_date
215   ,p_primary_flag                 in varchar2     default hr_api.g_varchar2
216   ,p_category_usage_id            in number
217   );
218 --
219 -- ----------------------------------------------------------------------------
220 -- |-------------------------< delete_lp_cat_inclusion >----------------------|
221 -- ----------------------------------------------------------------------------
222 --
223 -- {Start Of Comments}
224 /*#
225  * This API deletes the Inclusion of a Learning Path into a Category.
226  *
227  *
228  * <p><b>Licensing</b><br>
229  * This API is licensed for use with Learning Management.
230  *
231  * <p><b>Prerequisites</b><br>
232  * The learning path category inclusion should exist.
233  *
234  * <p><b>Post Success</b><br>
235  * The inclusion of the learning path into the category is successfully
236  * deleted.
237  *
238  * <p><b>Post Failure</b><br>
239  * The learning path category inclusion is not deleted and an error is raised.
240  * @param p_learning_path_id The unique identifier of the learning path to
241  * which the category is being attached.
242  * @param p_category_usage_id The unique identifier of the category to which
243  * the learning path is being attached.
244  * @param p_object_version_number The current version number of the learning
245  * path category Inclusion record to be deleted.
246  * @param p_validate If true, then validation alone will be performed and the
247  * database will remain unchanged. If false and all validation checks pass,
248  * then the database will be modified.
249  * @rep:displayname Delete Learning Path Category Inclusion
250  * @rep:category BUSINESS_ENTITY OTA_LEARNING_PATH_CATEGORY
251  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
252  * @rep:scope public
253  * @rep:lifecycle active
254  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
255 */
256 --
257 -- {End Of Comments}
258 --
259 procedure delete_lp_cat_inclusion
260   ( p_learning_path_id                in number,
261   p_category_usage_id                   in varchar2,
262   p_object_version_number              in number,
263   p_validate                           in boolean default false
264   );
265 end ota_lp_category_api;