1 Package ota_forum_message_api as
2 /* $Header: otfmsapi.pkh 120.2 2006/07/12 11:00:03 niarora noship $ */
3 /*#
4 * This package contains forum message-related APIs.
5 * @rep:scope public
6 * @rep:product OTA
7 * @rep:displayname Forum Messages
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |---------------------------< create_forum_message >-----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates the forum message.
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 and the topic under which the message is being posted must exist.
24 *
25 * <p><b>Post Success</b><br>
26 * The forum message is created successfully.
27 *
28 * <p><b>Post Failure</b><br>
29 * The API does not create a forum message 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 message record and the forum topic.
38 * @param p_forum_id Identifies the forum under which the message is being posted.
39 * @param p_forum_thread_id Identifies the topic to which the message is being posted. The topic
40 * belongs to the forum specified above.
41 * @param p_message_scope Indicates the scope/visibility of the message to the learners/instructors.
42 * Permissible values are 'P' (public message, viewable to all learners subscribed to the forum),
43 * 'T' (private to a group of learners/instructors, selected during the topic creation.
44 * It includes the author), 'U' (private reply between the author and learner/instructor).
45 * @param p_message_body The actual message that is being posted.
46 * @param p_parent_message_id Identifier of the message, to which the current message is being posted as a reply.
47 * @param p_person_id Identifies the person who posted the message.
48 * @param p_contact_id Identifies the external learner who posted the message.
49 * @param p_target_person_id Identifies the target person to whom the private message is being sent.
50 * If this value is not null and message_scope is 'U', it indicates a private message.
51 * @param p_target_contact_id Identifies the target external learner to whom the private message is being sent to.
52 * If this value is not null and message_scope is 'U', it indicates a private message.
53 * @param p_forum_message_id Unique identifier for the forum message record.
54 * @param p_object_version_number If p_validate is false, then set to the version number of the created forum
55 * message. If p_validate is true, then the value will be null.
56 * @rep:displayname Create Forum Message
57 * @rep:category BUSINESS_ENTITY OTA_FORUM
58 * @rep:lifecycle active
59 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
60 * @rep:scope public
61 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
62 */
63 --
64 -- {End Of Comments}
65 --
66
67 procedure create_forum_message
68 (p_validate in boolean default false
69 ,p_effective_date in date
70 ,p_forum_id in number
71 ,p_forum_thread_id in number
72 ,p_business_group_id in number
73 ,p_message_scope in varchar2
74 ,p_message_body in varchar2 default null
75 ,p_parent_message_id in number default null
76 ,p_person_id in number default null
77 ,p_contact_id in number default null
78 ,p_target_person_id in number default null
79 ,p_target_contact_id in number default null
80 ,p_forum_message_id out nocopy number
81 ,p_object_version_number out nocopy number
82 );
83 --
84 -- ----------------------------------------------------------------------------
85 -- |---------------------------< update_forum_message >-----------------------|
86 -- ----------------------------------------------------------------------------
87 --
88 -- {Start Of Comments}
89 /*#
90 * This API updates the forum message.
91 *
92 *
93 * <p><b>Licensing</b><br>
94 * This API is licensed for use with Learning Management.
95 *
96 * <p><b>Prerequisites</b><br>
97 * The forum message record with the given object version number should exist.
98 *
99 * <p><b>Post Success</b><br>
100 * The forum message is updated successfully.
101 *
102 * <p><b>Post Failure</b><br>
103 * The API does not update the forum message record, and raises an error.
104 *
105 * @param p_validate If true, then validation alone will be performed and the
106 * database will remain unchanged. If false and all validation checks pass,
107 * then the database will be modified.
108 * @param p_effective_date Reference date for validating that lookup values are
109 * applicable during the start to end active date range. This date does
110 * not determine when the changes take effect.
111 * @param p_forum_id Identifies the forum under which the message is being posted.
112 * @param p_forum_thread_id Identifies the topic to which the message is being posted.
113 * The topic belongs to the forum specified above.
114 * @param p_business_group_id The business group owning the forum message record.
115 * @param p_message_scope Indicates the scope/visibility of the message to the learners/instructors.
116 * Permissible values are 'P' (public message, viewable to all learners subscribed to the forum),
117 * 'T' (private to a group of learners/instructors, selected during the topic creation.
118 * It includes the author), 'U' (private reply between the author and learner/instructor).
119 * @param p_message_body The actual message that is being posted.
120 * @param p_parent_message_id Identifier of the message to which the current message is being posted as a reply.
121 * @param p_person_id Identifies the person who posted the message.
122 * @param p_contact_id Identifies the external learner who posted the message.
123 * @param p_target_person_id Identifies the target person to whom the private message is being sent.
124 * If this value is not null and message_scope is 'U', it indicates a private message.
125 * @param p_target_contact_id Identifies the target external learner to whom the private message is
126 * being sent. If this value is not null and message_scope is 'U', it indicates a private message.
127 * @param p_forum_message_id Unique identifier for the forum message record.
128 * @param p_object_version_number Pass in the current version number of the forum message to be updated.
129 * When the API completes if p_validate is false, will be set to the new version number of the updated forum
130 * message. If p_validate is true will be set to the same value which was passed in.
131 * @rep:displayname Update Forum Message
132 * @rep:category BUSINESS_ENTITY OTA_FORUM
133 * @rep:lifecycle active
134 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
135 * @rep:scope public
136 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
137 */
138 --
139 -- {End Of Comments}
140 --
141 procedure update_forum_message
142 (p_validate in boolean default false
143 ,p_effective_date in date
144 ,p_forum_id in number default hr_api.g_number
145 ,p_forum_thread_id in number default hr_api.g_number
146 ,p_business_group_id in number default hr_api.g_number
147 ,p_message_scope in varchar2 default hr_api.g_varchar2
148 ,p_message_body in varchar2 default hr_api.g_varchar2
149 ,p_parent_message_id in number default hr_api.g_number
150 ,p_person_id in number default hr_api.g_number
151 ,p_contact_id in number default hr_api.g_number
152 ,p_target_person_id in number default hr_api.g_number
153 ,p_target_contact_id in number default hr_api.g_number
154 ,p_forum_message_id in number
155 ,p_object_version_number in out nocopy number
156 );
157 --
158 -- ----------------------------------------------------------------------------
159 -- |---------------------------< delete_forum_message >-----------------------|
160 -- ----------------------------------------------------------------------------
161 --
162 -- {Start Of Comments}
163 /*#
164 * This API deletes the forum message.
165 *
166 *
167 * <p><b>Licensing</b><br>
168 * This API is licensed for use with Learning Management.
169 *
170 * <p><b>Prerequisites</b><br>
171 * The forum message record with the given object version number should exist.
172 *
173 * <p><b>Post Success</b><br>
174 * The forum message is deleted successfully.
175 *
176 * <p><b>Post Failure</b><br>
177 * The API does not delete the forum message record, and raises an error.
178 *
179 * @param p_validate If true, then validation alone will be performed and the
180 * database will remain unchanged. If false and all validation checks pass,
181 * then the database will be modified.
182 * @param p_forum_message_id The unique identifier for the forum message record.
183 * @param p_object_version_number Current version number of the forum message to be deleted.
184 * @rep:displayname Delete Forum Message
185 * @rep:category BUSINESS_ENTITY OTA_FORUM
186 * @rep:lifecycle active
187 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
188 * @rep:scope public
189 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
190 */
191 --
192 -- {End Of Comments}
193 --
194
195 procedure delete_forum_message
196 (p_validate in boolean default false
197 ,p_forum_message_id in number
198 ,p_object_version_number in number
199 );
200 end ota_forum_message_api;
[Home] [Help]