1 Package ota_forum_thread_api as
2 /* $Header: otftsapi.pkh 120.3 2006/07/12 10:58:33 niarora noship $ */
3 /*#
4 * This package contains forum thread-related APIs.
5 * @rep:scope public
6 * @rep:product OTA
7 * @rep:displayname Forum Threads
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |---------------------------< create_forum_thread >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates the forum thread.
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 under which the thread is being created must exist.
24 *
25 * <p><b>Post Success</b><br>
26 * The forum thread is created successfully.
27 *
28 * <p><b>Post Failure</b><br>
29 * The API does not create a forum thread 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_forum_id Identifies the forum under which the thread is being created.
38 * @param p_business_group_id The business group owning the forum thread and the forum.
39 * @param p_subject The subject of the discussion thread.
40 * @param p_private_thread_flag Indicates if this is a private thread between learners
41 * and instructors or public to all users subscribed to the forum.
42 * Permissible values are 'Y' and 'N'.
43 * @param p_last_post_date Indicates the date of posting of the most recent message under this thread.
44 * @param p_reply_count Indicates the number of replies that have been posted to the original
45 * thread and the message.
46 * @param p_forum_thread_id The unique identifier for the forum thread record.
47 * @param p_object_version_number If p_validate is false, then set to the version number of the created
48 * forum thread. If p_validate is true, then the value will be null.
49 * @rep:displayname Create Forum Thread
50 * @rep:category BUSINESS_ENTITY OTA_FORUM
51 * @rep:lifecycle active
52 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
53 * @rep:scope public
54 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
55 */
56 --
57 -- {End Of Comments}
58 --
59 procedure create_forum_thread
60 (p_validate in boolean default false
61 ,p_effective_date in date
62 ,p_forum_id in number
63 ,p_business_group_id in number
64 ,p_subject in varchar2
65 ,p_private_thread_flag in varchar2
66 ,p_last_post_date in date default null
67 ,p_reply_count in number default null
68 ,p_forum_thread_id out nocopy number
69 ,p_object_version_number out nocopy number
70 );
71 --
72 -- ----------------------------------------------------------------------------
73 -- |---------------------------< update_forum_thread >------------------------|
74 -- ----------------------------------------------------------------------------
75 --
76 -- {Start Of Comments}
77 /*#
78 * This API updates the forum thread.
79 *
80 *
81 * <p><b>Licensing</b><br>
82 * This API is licensed for use with Learning Management.
83 *
84 * <p><b>Prerequisites</b><br>
85 * The forum thread record with the given object version number should exist.
86 *
87 * <p><b>Post Success</b><br>
88 * The forum thread is updated successfully.
89 *
90 * <p><b>Post Failure</b><br>
91 * The API does not update the forum thread record, and raises an error.
92 *
93 * @param p_validate If true, then validation alone will be performed and the
94 * database will remain unchanged. If false and all validation checks pass,
95 * then the database will be modified.
96 * @param p_effective_date Reference date for validating that lookup values are
97 * applicable during the start to end active date range. This date does not
98 * determine when the changes take effect.
99 * @param p_forum_id Identifies the forum under which the thread is being created.
100 * @param p_business_group_id Identifies the business group owning the forum thread record.
101 * @param p_subject The subject of the discussion thread.
102 * @param p_private_thread_flag Indicates if this is a private thread between learners and
103 * instructors or public to all users subscribed to the forum.
104 * Permissible values are 'Y' and 'N'.
105 * @param p_last_post_date Indicates the date of posting of the most recent message under this thread.
106 * @param p_reply_count Indicates the number of replies that have been posted to the original
107 * thread and the message.
108 * @param p_forum_thread_id The unique identifier for the forum thread record.
109 * @param p_object_version_number Pass in the current version number of the forum thread to be updated.
110 * When the API completes if p_validate is false, will be set to the new version number of the
111 * updated forum thread. If p_validate is true will be set to the same value which was passed in.
112 * @rep:displayname Update Forum Thread
113 * @rep:category BUSINESS_ENTITY OTA_FORUM
114 * @rep:lifecycle active
115 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
116 * @rep:scope public
117 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
118 */
119 --
120 -- {End Of Comments}
121 --
122 procedure update_forum_thread
123 (p_validate in boolean default false
124 ,p_effective_date in date
125 ,p_forum_id in number
126 ,p_business_group_id in number
127 ,p_subject in varchar2
128 ,p_private_thread_flag in varchar2
129 ,p_last_post_date in date default null
130 ,p_reply_count in number default null
131 ,p_forum_thread_id in number
132 ,p_object_version_number in out nocopy number
133 );
134
135
136 --
137 -- ----------------------------------------------------------------------------
138 -- |---------------------------< delete_forum_thread >------------------------|
139 -- ----------------------------------------------------------------------------
140 --
141 -- {Start Of Comments}
142 /*#
143 * This API deletes the forum thread.
144 *
145 *
146 * <p><b>Licensing</b><br>
147 * This API is licensed for use with Learning Management.
148 *
149 * <p><b>Prerequisites</b><br>
150 * The forum thread record with the given object version number should exist.
151 *
152 * <p><b>Post Success</b><br>
153 * The forum thread is deleted successfully.
154 *
155 * <p><b>Post Failure</b><br>
156 * The API does not delete the forum thread record, and raises an error.
157 *
158 * @param p_validate If true, then validation alone will be performed and the
159 * database will remain unchanged. If false and all validation checks pass,
160 * then the database will be modified.
161 * @param p_forum_thread_id The unique identifier for the forum thread record.
162 * @param p_object_version_number Current version number of the forum thread to be deleted.
163 * @rep:displayname Delete Forum Thread
164 * @rep:category BUSINESS_ENTITY OTA_FORUM
165 * @rep:lifecycle active
166 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
167 * @rep:scope public
168 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
169 */
170 --
171 -- {End Of Comments}
172 --
173
174 procedure delete_forum_thread
175 (p_validate in boolean default false
176 ,p_forum_thread_id in number
177 ,p_object_version_number in number
178 );
179 end ota_forum_thread_api;
[Home] [Help]