1 Package ota_frm_notif_subscriber_api AUTHID CURRENT_USER as
2 /* $Header: otfnsapi.pkh 120.1 2006/07/12 11:14:25 niarora noship $ */
3 /*#
4 * This package contains forum notification subscriber-related APIs.
5 * @rep:scope public
6 * @rep:product OTA
7 * @rep:displayname Forum Notification Subscribers
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-----------------------< create_frm_notif_subscriber >--------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates the forum notification subscriber record.
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 to which the user is subscribing for notifications must exist.
24 *
25 * <p><b>Post Success</b><br>
26 * The forum notification subscriber record is created successfully.
27 *
28 * <p><b>Post Failure</b><br>
29 * The API does not create a forum notification subscriber 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 determine when the changes take effect.
36 * @param p_business_group_id The business group owning the notification subscriber record and the forum.
37 * @param p_forum_id Identifies the forum to which the user has subscribed for notifications.
38 * @param p_person_id Identifies the person who has subscribed for forum notifications.
39 * @param p_contact_id Identifies the external learner who has subscribed for forum notifications.
40 * @param p_object_version_number If p_validate is false, then set to the version number of the
41 * created forum notification subscriber record. If p_validate is true, then the value will be null.
42 * @rep:displayname Create Forum Notification Subscriber
43 * @rep:category BUSINESS_ENTITY OTA_FORUM
44 * @rep:lifecycle active
45 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
46 * @rep:scope public
47 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
48 */
49 --
50 -- {End Of Comments}
51 --
52 procedure create_frm_notif_subscriber
53 ( p_validate in boolean default false
54 ,p_effective_date in date
55 ,p_business_group_id in number
56 ,p_forum_id in number
57 ,p_person_id in number
58 ,p_contact_id in number
59 ,p_object_version_number out nocopy number
60 );
61 --
62 -- ----------------------------------------------------------------------------
63 -- |-----------------------< update_frm_notif_subscriber >--------------------|
64 -- ----------------------------------------------------------------------------
65 --
66 -- {Start Of Comments}
67 /*#
68 * This API updates the forum notification subscriber record.
69 *
70 *
71 * <p><b>Licensing</b><br>
72 * This API is licensed for use with Learning Management.
73 *
74 * <p><b>Prerequisites</b><br>
75 * The forum notification subscriber record with the given object version number should exist.
76 *
77 * <p><b>Post Success</b><br>
78 * The forum notification subscriber record is updated successfully.
79 *
80 * <p><b>Post Failure</b><br>
81 * The API does not update the forum notification subscriber record, and raises an error.
82 *
83 * @param p_validate If true, then validation alone will be performed and the
84 * database will remain unchanged. If false and all validation checks pass,
85 * then the database will be modified.
86 * @param p_effective_date Reference date for validating that lookup values are
87 * applicable during the start to end active date range. This date does not
88 * determine when the changes take effect.
89 * @param p_business_group_id The business group owning the notification subscriber record.
90 * @param p_forum_id Identifies the forum to which the user has subscribed for notifications.
91 * @param p_person_id Identifies the person who has subscribed for forum notifications.
92 * @param p_contact_id Identifies the external learner who has subscribed for forum notifications.
93 * @param p_object_version_number Pass in the current version number of the forum notification
94 * subscriber record to be updated. When the API completes if p_validate is false, will be
95 * set to the new version number of the forum notification subscriber record. If p_validate
96 * is true will be set to the same value which was passed in.
97 * @rep:displayname Update Forum Notification Subscriber
98 * @rep:category BUSINESS_ENTITY OTA_FORUM
99 * @rep:lifecycle active
100 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
101 * @rep:scope public
102 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
103 */
104 --
105 -- {End Of Comments}
106 --
107 procedure update_frm_notif_subscriber
108 (p_validate in boolean default false
109 ,p_effective_date in date
110 ,p_forum_id in number
111 ,p_person_id in number
112 ,p_contact_id in number
113 ,p_object_version_number in out nocopy number
114 ,p_business_group_id in number default hr_api.g_number
115 );
116 --
117 -- ----------------------------------------------------------------------------
118 -- |-----------------------< delete_frm_notif_subscriber >--------------------|
119 -- ----------------------------------------------------------------------------
120 --
121 -- {Start Of Comments}
122 /*#
123 * This API deletes the forum notification subscriber record.
124 *
125 *
126 * <p><b>Licensing</b><br>
127 * This API is licensed for use with Learning Management.
128 *
129 * <p><b>Prerequisites</b><br>
130 * The forum notification subscriber record with the given object version number should exist.
131 *
132 * <p><b>Post Success</b><br>
133 * The forum notification subscriber record is deleted successfully.
134 *
135 * <p><b>Post Failure</b><br>
136 * The API does not delete the forum notification subscriber record, and raises an error.
137 *
138 * @param p_validate If true, then validation alone will be performed and the
139 * database will remain unchanged. If false and all validation checks pass,
140 * then the database will be modified.
141 * @param p_forum_id Identifies the forum to which the user has subscribed for notifications.
142 * @param p_person_id Identifies the person who has subscribed for forum notifications.
143 * @param p_contact_id Identifies the external learner who has subscribed for forum notifications.
144 * @param p_object_version_number Current version number of the forum notification subscriber
145 * record to be deleted.
146 * @rep:displayname Delete Forum Notification Subscriber
147 * @rep:category BUSINESS_ENTITY OTA_FORUM
148 * @rep:lifecycle active
149 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
150 * @rep:scope public
151 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
152 */
153 --
154 -- {End Of Comments}
155 --
156
157 procedure delete_frm_notif_subscriber
158 ( p_validate in boolean default false
159 ,p_forum_id in number
160 ,p_person_id in number
161 ,p_contact_id in number
162 ,p_object_version_number in number
163 );
164 end ota_frm_notif_subscriber_api;
[Home] [Help]