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