1 Package ota_open_fc_enrollment_api AUTHID CURRENT_USER as
2 /* $Header: otfceapi.pkh 120.2 2006/07/12 10:55:20 niarora noship $ */
3 /*#
4 * This package contains category-forum and category-chat enrollments related APIs.
5 * @rep:scope public
6 * @rep:product OTA
7 * @rep:displayname Open Forum Chat Enrollments
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |------------------------< create_open_fc_enrollment >---------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a forum or chat enrollment.
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 * The forum or chat for which the enrollment is being created must exist.
24 *
25 * <p><b>Post Success</b><br>
26 * The forum/chat enrollment record is created successfully.
27 *
28 * <p><b>Post Failure</b><br>
29 * The API does not create a forum/chat enrollment 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_business_group_id The business group owning the forum/chat
38 * enrollment record as well as the forum/chat correspondingly.
39 * @param p_forum_id Identifies the category forum to which the learner is subscribing.
40 * @param p_person_id Identifies the person who is subscribing to the forum or chat.
41 * @param p_contact_id Identifies the external learner who is subscribing to the forum or chat.
42 * @param p_chat_id Identifies the category chat to which the learner is subscribing.
43 * @param p_enrollment_id The unique identifier for the enrollment/subscription record.
44 * @param p_object_version_number If p_validate is false, then set to the version number
45 * of the created enrollment record. If p_validate is true, then the value will be null.
46 * @rep:displayname Create Forum Chat Enrollment
47 * @rep:category BUSINESS_ENTITY OTA_FORUM
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_open_fc_enrollment
57 ( p_validate in boolean default false
58 ,p_effective_date in date
59 ,p_business_group_id in number
60 ,p_forum_id in number default null
61 ,p_person_id in number default null
62 ,p_contact_id in number default null
63 ,p_chat_id in number default null
64 ,p_enrollment_id out nocopy number
65 ,p_object_version_number out nocopy number
66 );
67 --
68 -- ----------------------------------------------------------------------------
69 -- |------------------------< update_open_fc_enrollment >---------------------|
70 -- ----------------------------------------------------------------------------
71 --
72 -- {Start Of Comments}
73 /*#
74 * This API updates the corresponding forum or chat enrollment record.
75 *
76 *
77 * <p><b>Licensing</b><br>
78 * This API is licensed for use with Learning Management.
79 *
80 * <p><b>Prerequisites</b><br>
81 * The enrollment record with the given object version number should exist.
82 *
83 * <p><b>Post Success</b><br>
84 * The enrollment record is updated successfully.
85 *
86 * <p><b>Post Failure</b><br>
87 * The API does not update the forum/chat enrollment record, and raises an error.
88 *
89 * @param p_validate If true, then validation alone will be performed and the
90 * database will remain unchanged. If false and all validation checks pass,
91 * then the database will be modified.
92 * @param p_effective_date Reference date for validating that lookup values are
93 * applicable during the start to end active date range. This date does not
94 * determine when the changes take effect.
95 * @param p_enrollment_id The unique identifier for the enrollment record.
96 * @param p_business_group_id The business group owning the enrollment record.
97 * @param p_forum_id Identifies the category forum to which the learner is subscribing.
98 * @param p_person_id Identifies the person who is subscribing to the forum or chat.
99 * @param p_contact_id Identifies the external learner who is subscribing to the forum or chat.
100 * @param p_chat_id Identifies the category chat to which the learner is subscribing.
101 * @param p_object_version_number Pass in the current version number of the enrollment record
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 enrollment. If p_validate is true will be set to the same
104 * value which was passed in.
105 * @rep:displayname Update Forum Chat Enrollment
106 * @rep:category BUSINESS_ENTITY OTA_FORUM
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_open_fc_enrollment
116 (p_validate in boolean default false
117 ,p_effective_date in date
118 ,p_enrollment_id in number
119 ,p_business_group_id in number default hr_api.g_number
120 ,p_forum_id in number default hr_api.g_number
121 ,p_person_id in number default hr_api.g_number
122 ,p_contact_id in number default hr_api.g_number
123 ,p_chat_id in number default hr_api.g_number
124 ,p_object_version_number in out nocopy number
125 );
126 --
127 -- ----------------------------------------------------------------------------
128 -- |------------------------< delete_open_fc_enrollment >---------------------|
129 -- ----------------------------------------------------------------------------
130 --
131 -- {Start Of Comments}
132 /*#
133 * This API deletes the forum or chat enrollment record.
134 *
135 *
136 * <p><b>Licensing</b><br>
137 * This API is licensed for use with Learning Management.
138 *
139 * <p><b>Prerequisites</b><br>
140 * The forum/chat enrollment record with the given object version number should exist.
141 *
142 * <p><b>Post Success</b><br>
143 * The forum/chat enrollment record is deleted successfully.
144 *
145 * <p><b>Post Failure</b><br>
146 * The API does not delete the forum/chat enrollment record, and raises an error.
147 *
148 * @param p_validate If true, then validation alone will be performed and the
149 * database will remain unchanged. If false and all validation checks pass,
150 * then the database will be modified.
151 * @param p_enrollment_id The unique identifier for the enrollment record.
152 * @param p_object_version_number Current version number of the enrollment record to be deleted.
153 * @rep:displayname Delete Forum Chat Enrollment
154 * @rep:category BUSINESS_ENTITY OTA_FORUM
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_open_fc_enrollment
165 (p_validate in boolean default false
166 ,p_enrollment_id in number
167 ,p_object_version_number in number
168 );
169 end ota_open_fc_enrollment_api;
[Home] [Help]