1 Package ota_forum_api as
2 /* $Header: otfrmapi.pkh 120.2 2006/07/12 10:53:33 niarora noship $ */
3 /*#
4 * This package contains forum-related APIs.
5 * @rep:scope public
6 * @rep:product OTA
7 * @rep:displayname Forum
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-------------------------------< create_forum >---------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates the forum.
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 business group must exist.
24 *
25 * <p><b>Post Success</b><br>
26 * The forum is created successfully.
27 *
28 * <p><b>Post Failure</b><br>
29 * The API does not create a forum 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 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 The business group owning the forum.
38 * @param p_name The name of the forum.
39 * @param p_description The description for the forum.
40 * @param p_start_date_active The date on which the learners can begin to subscribe to
41 * the category forum and post messages to the category forum/class forum.
42 * @param p_end_date_active The date on which the forum becomes no longer available to learners.
43 * @param p_message_type_flag Indicates if public/private messages can be posted to the
44 * forum. Permissible values are 'P'(public messages'), 'V'(private messages), 'B'(both).
45 * @param p_allow_html_flag Indicates if html markup type is allowed. Permissible values are 'Y' and 'N'.
46 * @param p_allow_attachment_flag Indicates if attachments can be uploaded with messages.
47 * Permissible values are 'Y' and 'N'.
48 * @param p_auto_notification_flag Indicates if notifications should be automatically received
49 * when new messages are posted to the forum. Permissible values are 'Y' and 'N'.
50 * @param p_public_flag Indicates whether the forum is public. Permissible values are 'Y' and 'N'.
51 * @param p_forum_id The unique identifier for the forum.
52 * @param p_object_version_number If p_validate is false, then set to the version number of the
53 * created forum. If p_validate is true, then the value will be null.
54 * @rep:displayname Create Forum
55 * @rep:category BUSINESS_ENTITY OTA_FORUM
56 * @rep:lifecycle active
57 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
58 * @rep:scope public
59 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
60 */
61 --
62 -- {End Of Comments}
63 --
64 procedure create_forum
65 (p_validate in boolean default false
66 ,p_effective_date in date
67 ,p_name in varchar2
68 ,p_description in varchar2 default null
69 ,p_business_group_id in number
70 ,p_start_date_active in date default null
71 ,p_end_date_active in date default null
72 ,p_message_type_flag in varchar2 default 'P'
73 ,p_allow_html_flag in varchar2 default 'N'
74 ,p_allow_attachment_flag in varchar2 default 'N'
75 ,p_auto_notification_flag in varchar2 default 'N'
76 ,p_public_flag in varchar2 default 'N'
77 ,p_forum_id out nocopy number
78 ,p_object_version_number out nocopy number
79 );
80 --
81 -- ----------------------------------------------------------------------------
82 -- |-------------------------------< update_forum >---------------------------|
83 -- ----------------------------------------------------------------------------
84 --
85 -- {Start Of Comments}
86 /*#
87 * This API updates the forum.
88 *
89 *
90 * <p><b>Licensing</b><br>
91 * This API is licensed for use with Learning Management.
92 *
93 * <p><b>Prerequisites</b><br>
94 * The forum record with the given object version number should exist.
95 *
96 * <p><b>Post Success</b><br>
97 * The forum is updated successfully.
98 *
99 * <p><b>Post Failure</b><br>
100 * The API does not update the forum record, and raises an error.
101 *
102 * @param p_validate If true, then validation alone will be performed and the
103 * database will remain unchanged. If false and all validation checks pass,
104 * then the database will be modified.
105 * @param p_effective_date Reference date for validating lookup values are applicable
106 * during the start to end active date range. This date does not determine when
107 * the changes take effect.
108 * @param p_name The name of the forum.
109 * @param p_description The description for the forum.
110 * @param p_business_group_id The unique identifier of the business group that owns this forum.
111 * @param p_start_date_active The date on which the learners can begin to subscribe to
112 * the category forum and post messages to the category forum/class forum.
113 * @param p_end_date_active The date on which the forum becomes no longer available to learners.
114 * @param p_message_type_flag Indicates if public/private messages can be posted to the forum.
115 * Permissible values are 'P'(public messages'), 'V'(private messages), 'B'(both).
116 * @param p_allow_html_flag Indicates if html markup type is allowed. Permissible values
117 * are 'Y' and 'N'.
118 * @param p_allow_attachment_flag Indicates if attachments can be uploaded with messages.
119 * Permissible values are 'Y' and 'N'.
120 * @param p_auto_notification_flag Indicates if notifications should be automatically received
121 * when new messages are posted to the forum. Permissible values are 'Y' and 'N'.
122 * @param p_public_flag Indicates whether the forum is public. Permissible values are 'Y' and 'N'.
123 * @param p_forum_id The unique identifier for the forum.
124 * @param p_object_version_number Pass in the current version number of the forum to be updated.
125 * When the API completes if p_validate is false, will be set to the new version number of the
126 * updated forum. If p_validate is true will be set to the same value which was passed in.
127 * @rep:displayname Update Forum
128 * @rep:category BUSINESS_ENTITY OTA_FORUM
129 * @rep:lifecycle active
130 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
131 * @rep:scope public
132 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
133 */
134 --
135 -- {End Of Comments}
136 --
137 procedure update_forum
138 (p_validate in boolean default false
139 ,p_effective_date in date
140 ,p_name in varchar2
141 ,p_description in varchar2
142 ,p_business_group_id in number
143 ,p_start_date_active in date default hr_api.g_date
144 ,p_end_date_active in date default hr_api.g_date
145 ,p_message_type_flag in varchar2 default hr_api.g_varchar2
146 ,p_allow_html_flag in varchar2 default hr_api.g_varchar2
147 ,p_allow_attachment_flag in varchar2 default hr_api.g_varchar2
148 ,p_auto_notification_flag in varchar2 default hr_api.g_varchar2
149 ,p_public_flag in varchar2 default hr_api.g_varchar2
150 ,p_forum_id in number
151 ,p_object_version_number in out nocopy number);
152 --
153 -- ----------------------------------------------------------------------------
154 -- |-------------------------------< delete_forum >---------------------------|
155 -- ----------------------------------------------------------------------------
156 --
157 -- {Start Of Comments}
158 /*#
159 * This API deletes the forum.
160 *
161 *
162 * <p><b>Licensing</b><br>
163 * This API is licensed for use with Learning Management.
164 *
165 * <p><b>Prerequisites</b><br>
166 * The forum record with the given object version number should exist.
167 *
168 * <p><b>Post Success</b><br>
169 * The forum is deleted successfully.
170 *
171 * <p><b>Post Failure</b><br>
172 * The API does not delete the forum record, and raises an error.
173 *
174 * @param p_validate If true, then validation alone will be performed and the
175 * database will remain unchanged. If false and all validation checks pass,
176 * then the database will be modified.
177 * @param p_forum_id The unique identifier for the forum record.
178 * @param p_object_version_number Current version number of the forum to be deleted.
179 * @rep:displayname Delete Forum
180 * @rep:category BUSINESS_ENTITY OTA_FORUM
181 * @rep:lifecycle active
182 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
183 * @rep:scope public
184 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
185 */
186 --
187 -- {End Of Comments}
188 --
189
190 procedure delete_forum
191 (p_validate in boolean default false
192 ,p_forum_id in number
193 ,p_object_version_number in number
194 );
195 end ota_forum_api;
[Home] [Help]