1 Package ota_course_prerequisite_api AUTHID CURRENT_USER as
2 /* $Header: otcprapi.pkh 120.1 2006/07/12 10:59:32 niarora noship $ */
3 /*#
4 * This package contains course prerequisite APIs.
5 * @rep:scope public
6 * @rep:product OTA
7 * @rep:displayname Course Prerequisite
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |------------------------< create_course_prerequisite >--------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API identifies the prerequisite course for another course.
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 * Course and prerequisite course records must exist.
24 *
25 * <p><b>Post Success</b><br>
26 * Course prerequisite is created successfully.
27 *
28 * <p><b>Post Failure</b><br>
29 * The API does not create a course prerequisite 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 that lookup values
35 * are applicable during the start to end active date range. This date does
36 * not determine when the changes take effect.
37 * @param p_activity_version_id The Course for which prerequisite course needs to be added.
38 * @param p_prerequisite_course_id Prerequisite course that needs to be added.
39 * @param p_business_group_id The business group owning the course record.
40 * @param p_prerequisite_type Prerequisite type of the Prerequisite Course.
41 * Valid values are defined by 'OTA_CATALOG_PREREQUISITE_TYPE' lookup type.
42 * @param p_enforcement_mode Enforcement Mode for the Prerequisite Course.
43 * Valid values are defined by 'OTA_CATALOG_PREREQ_ENF_MODE' lookup type.
44 * @param p_object_version_number If p_validate is false, then set to the version number
45 * of the created prerequisite course. If p_validate is true, then the value will be null.
46 * @rep:displayname Create Course Prerequisite
47 * @rep:category BUSINESS_ENTITY OTA_COURSE_PREREQUISITE
48 * @rep:lifecycle active
49 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
50 * @rep:scope public
51 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
52 */
53 --
54 -- {End Of Comments}
55 --
56 procedure create_course_prerequisite
57 (p_validate in boolean default false
58 ,p_effective_date in date
59 ,p_activity_version_id in number
60 ,p_prerequisite_course_id in number
61 ,p_business_group_id in number
62 ,p_prerequisite_type in varchar2
63 ,p_enforcement_mode in varchar2
64 ,p_object_version_number out nocopy number
65 );
66 --
67 -- ----------------------------------------------------------------------------
68 -- |------------------------< update_course_prerequisite >--------------------|
69 -- ----------------------------------------------------------------------------
70 --
71 -- {Start Of Comments}
72 /*#
73 * This API updates the course prerequisite for another course.
74 *
75 *
76 * <p><b>Licensing</b><br>
77 * This API is licensed for use with Learning Management.
78 *
79 * <p><b>Prerequisites</b><br>
80 * The prerequisite record with the given object version number should exist.
81 *
82 * <p><b>Post Success</b><br>
83 * The course prerequisite is updated successfully.
84 *
85 * <p><b>Post Failure</b><br>
86 * The API does not update the course prerequisite record, and raises an error.
87 *
88 * @param p_validate If true, then validation alone will be performed and the
89 * database will remain unchanged. If false and all validation checks pass,
90 * then the database will be modified.
91 * @param p_effective_date Reference date for validating that lookup values are
92 * applicable during the start to end active date range. This date does not
93 * determine when the changes take effect.
94 * @param p_activity_version_id The Course for which the course prerequisite needs to be updated.
95 * @param p_prerequisite_course_id Courrse prerequisite that needs to be updated.
96 * @param p_business_group_id The business group owning the course record.
97 * @param p_prerequisite_type Prerequisite type of the Prerequisite Course.
98 * Valid values are defined by 'OTA_CATALOG_PREREQUISITE_TYPE' lookup type.
99 * @param p_enforcement_mode Enforcement Mode for the Prerequisite Course.
100 * Valid values are defined by 'OTA_CATALOG_PREREQ_ENF_MODE' lookup type.
101 * @param p_object_version_number Pass in the current version number of the prerequisite course
102 * to be updated. When the API completes if p_validate is false, will be set to the new
103 * version number of the updated prerequisite course. If p_validate is true will be set
104 * to the same value which was passed in.
105 * @rep:displayname Update Course Prerequisite
106 * @rep:category BUSINESS_ENTITY OTA_COURSE_PREREQUISITE
107 * @rep:lifecycle active
108 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
109 * @rep:scope public
110 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
111 */
112 --
113 -- {End Of Comments}
114 --
115 procedure update_course_prerequisite
116 (p_validate in boolean default false
117 ,p_effective_date in date
118 ,p_activity_version_id in number
119 ,p_prerequisite_course_id in number
120 ,p_business_group_id in number
121 ,p_prerequisite_type in varchar2
122 ,p_enforcement_mode in varchar2
123 ,p_object_version_number in out nocopy number
124 );
125 --
126 -- ----------------------------------------------------------------------------
127 -- |------------------------< delete_course_prerequisite >--------------------|
128 -- ----------------------------------------------------------------------------
129 --
130 -- {Start Of Comments}
131 /*#
132 * This API deletes the course prerequisite for another course.
133 *
134 *
135 * <p><b>Licensing</b><br>
136 * This API is licensed for use with Learning Management.
137 *
138 * <p><b>Prerequisites</b><br>
139 * The prerequisite course record with the given object version number should exist.
140 *
141 * <p><b>Post Success</b><br>
142 * The course prerequisite is deleted successfully.
143 *
144 * <p><b>Post Failure</b><br>
145 * The API does not delete the course prerequisite record, and raises an error.
146 *
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_activity_version_id The Course for which the course prerequisite needs to be deleted.
151 * @param p_prerequisite_course_id Course prerequisite to be deleted.
152 * @param p_object_version_number Current version number of the course prerequisite to be deleted.
153 * @rep:displayname Delete Course Prerequisite
154 * @rep:category BUSINESS_ENTITY OTA_COURSE_PREREQUISITE
155 * @rep:lifecycle active
156 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
157 * @rep:scope public
158 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
159 */
160 --
161 -- {End Of Comments}
162 --
163
164 procedure delete_course_prerequisite
165 (p_validate in boolean default false
166 ,p_activity_version_id in number
167 ,p_prerequisite_course_id in number
168 ,p_object_version_number in number
169 );
170 end ota_course_prerequisite_api;
[Home] [Help]