1 Package ota_announcement_api AUTHID CURRENT_USER as
2 /* $Header: otancapi.pkh 120.1 2005/10/02 02:07:19 aroussel $ */
3 /*#
4 * This package contains the Announcement APIs.
5 * @rep:scope public
6 * @rep:product ota
7 * @rep:displayname Announcement
8 */
9 --
13 --
10 -- ----------------------------------------------------------------------------
11 -- |---------------------------< create_announcement >------------------------|
12 -- ----------------------------------------------------------------------------
14 -- {Start Of Comments}
15 /*#
16 * This API creates an announcement.
17 *
18 * This business process allows the user to create a record used within the
19 * Announcement functionality.
20 *
21 * <p><b>Licensing</b><br>
22 * This API is licensed for use with Learning Management.
23 *
24 * <p><b>Prerequisites</b><br>
25 * The business group that owns the announcement must exist.
26 *
27 * <p><b>Post Success</b><br>
28 * The announcement is created.
29 *
30 * <p><b>Post Failure</b><br>
31 * The API does not create a member record, and raises an error.
32 * @param p_validate If true, then validation alone will be performed and the
33 * database will remain unchanged. If false and all validation checks pass,
34 * then the database will be modified.
35 * @param p_effective_date Reference date for validating lookup values are
36 * applicable during the start to end active date range. This date does not
37 * determine when the changes take effect.
38 * @param p_announcement_title Announcement Title
39 * @param p_announcement_body Announcement Body
40 * @param p_business_group_id Business Group of the Announcement
41 * @param p_start_date_active Start Date
42 * @param p_end_date_active End Date
43 * @param p_owner_id Owner of the announcement
44 * @param p_attribute_category This context value determines which flexfield
45 * structure to use with the descriptive flexfield segments.
46 * @param p_attribute1 Descriptive flexfield segment.
47 * @param p_attribute2 Descriptive flexfield segment.
48 * @param p_attribute3 Descriptive flexfield segment.
49 * @param p_attribute4 Descriptive flexfield segment.
50 * @param p_attribute5 Descriptive flexfield segment.
51 * @param p_attribute6 Descriptive flexfield segment.
52 * @param p_attribute7 Descriptive flexfield segment.
53 * @param p_attribute8 Descriptive flexfield segment.
54 * @param p_attribute9 Descriptive flexfield segment.
55 * @param p_attribute10 Descriptive flexfield segment.
56 * @param p_attribute11 Descriptive flexfield segment.
57 * @param p_attribute12 Descriptive flexfield segment.
58 * @param p_attribute13 Descriptive flexfield segment.
59 * @param p_attribute14 Descriptive flexfield segment.
60 * @param p_attribute15 Descriptive flexfield segment.
61 * @param p_attribute16 Descriptive flexfield segment.
62 * @param p_attribute17 Descriptive flexfield segment.
63 * @param p_attribute18 Descriptive flexfield segment.
64 * @param p_attribute19 Descriptive flexfield segment.
65 * @param p_attribute20 Descriptive flexfield segment.
66 * @param p_announcement_id If p_validate is false, then this ID identifies the
67 * announcement created. If false, the ID is null.
68 * @param p_object_version_number If p_validate is false,then set to version
69 * number of the created announcement. If p_validate is true, then the value
70 * will be null.
71 * @rep:displayname Create Announcement
72 * @rep:category BUSINESS_ENTITY OTA_LEARNING_ANNOUNCEMENT
73 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
74 * @rep:scope public
75 * @rep:lifecycle active
76 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
77 */
78 --
79 -- {End Of Comments}
80 --
81 procedure create_announcement
82 (p_validate in boolean default false
83 ,p_effective_date in date
84 ,p_announcement_title in varchar2
85 ,p_announcement_body in varchar2
86 ,p_business_group_id in number
87 ,p_start_date_active in date default null
88 ,p_end_date_active in date default null
89 ,p_owner_id in number default null
90 ,p_attribute_category in varchar2 default null
91 ,p_attribute1 in varchar2 default null
92 ,p_attribute2 in varchar2 default null
93 ,p_attribute3 in varchar2 default null
94 ,p_attribute4 in varchar2 default null
95 ,p_attribute5 in varchar2 default null
96 ,p_attribute6 in varchar2 default null
97 ,p_attribute7 in varchar2 default null
98 ,p_attribute8 in varchar2 default null
99 ,p_attribute9 in varchar2 default null
100 ,p_attribute10 in varchar2 default null
101 ,p_attribute11 in varchar2 default null
102 ,p_attribute12 in varchar2 default null
103 ,p_attribute13 in varchar2 default null
104 ,p_attribute14 in varchar2 default null
105 ,p_attribute15 in varchar2 default null
106 ,p_attribute16 in varchar2 default null
107 ,p_attribute17 in varchar2 default null
108 ,p_attribute18 in varchar2 default null
109 ,p_attribute19 in varchar2 default null
110 ,p_attribute20 in varchar2 default null
111 ,p_announcement_id out nocopy number
112 ,p_object_version_number out nocopy number
113 );
114 --
115 -- ----------------------------------------------------------------------------
116 -- |---------------------------< update_announcement >------------------------|
117 -- ----------------------------------------------------------------------------
118 --
119 -- {Start Of Comments}
120 /*#
121 * This API updates an announcement.
122 *
123 * This business process allows the user to update a member record used within
124 * the Announcement functionality.
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 announcement must exist
131 *
132 * <p><b>Post Success</b><br>
133 * The announcement is updated.
134 *
135 * <p><b>Post Failure</b><br>
136 * The API does not update the announcement record and raises an error.
137 * @param p_validate If true, then validation alone will be performed and the
138 * database will remain unchanged. If false and all validation checks pass,
139 * then the database will be modified.
140 * @param p_effective_date Reference date for validating lookup values are
141 * applicable during the start to end active date range. This date does not
142 * determine when the changes take effect.
143 * @param p_announcement_title Announcement Title
144 * @param p_announcement_body Announcement Body
145 * @param p_business_group_id Business Group of the Announcement
146 * @param p_start_date_active Start Date
147 * @param p_end_date_active End Date
148 * @param p_owner_id Owner of the announcement
149 * @param p_attribute_category This context value determines which flexfield
150 * structure to use with the descriptive flexfield segments.
151 * @param p_attribute1 Descriptive flexfield segment.
152 * @param p_attribute2 Descriptive flexfield segment.
153 * @param p_attribute3 Descriptive flexfield segment.
154 * @param p_attribute4 Descriptive flexfield segment.
155 * @param p_attribute5 Descriptive flexfield segment.
156 * @param p_attribute6 Descriptive flexfield segment.
157 * @param p_attribute7 Descriptive flexfield segment.
158 * @param p_attribute8 Descriptive flexfield segment.
159 * @param p_attribute9 Descriptive flexfield segment.
160 * @param p_attribute10 Descriptive flexfield segment.
161 * @param p_attribute11 Descriptive flexfield segment.
162 * @param p_attribute12 Descriptive flexfield segment.
163 * @param p_attribute13 Descriptive flexfield segment.
164 * @param p_attribute14 Descriptive flexfield segment.
165 * @param p_attribute15 Descriptive flexfield segment.
166 * @param p_attribute16 Descriptive flexfield segment.
167 * @param p_attribute17 Descriptive flexfield segment.
168 * @param p_attribute18 Descriptive flexfield segment.
169 * @param p_attribute19 Descriptive flexfield segment.
170 * @param p_attribute20 Descriptive flexfield segment.
171 * @param p_announcement_id The unique identifier for the member record.
172 * @param p_object_version_number Pass in the current version number of the
173 * announcement to be updated. When the API completes, if p_validate is false,
174 * the number is set to the new version number of the updated version number.
175 * If p_validate is true it remains unchanged.
176 * @rep:displayname Update Announcement
177 * @rep:category BUSINESS_ENTITY OTA_LEARNING_ANNOUNCEMENT
178 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
179 * @rep:scope public
180 * @rep:lifecycle active
181 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
182 */
183 --
184 -- {End Of Comments}
185 --
186 procedure update_announcement
187 (p_validate in boolean default false
188 ,p_effective_date in date
189 ,p_announcement_title in varchar2
190 ,p_announcement_body in varchar2
191 ,p_business_group_id in number
192 ,p_start_date_active in date default hr_api.g_date
193 ,p_end_date_active in date default hr_api.g_date
194 ,p_owner_id in number default hr_api.g_number
195 ,p_attribute_category in varchar2 default hr_api.g_varchar2
196 ,p_attribute1 in varchar2 default hr_api.g_varchar2
197 ,p_attribute2 in varchar2 default hr_api.g_varchar2
198 ,p_attribute3 in varchar2 default hr_api.g_varchar2
199 ,p_attribute4 in varchar2 default hr_api.g_varchar2
200 ,p_attribute5 in varchar2 default hr_api.g_varchar2
201 ,p_attribute6 in varchar2 default hr_api.g_varchar2
202 ,p_attribute7 in varchar2 default hr_api.g_varchar2
203 ,p_attribute8 in varchar2 default hr_api.g_varchar2
204 ,p_attribute9 in varchar2 default hr_api.g_varchar2
205 ,p_attribute10 in varchar2 default hr_api.g_varchar2
206 ,p_attribute11 in varchar2 default hr_api.g_varchar2
207 ,p_attribute12 in varchar2 default hr_api.g_varchar2
208 ,p_attribute13 in varchar2 default hr_api.g_varchar2
209 ,p_attribute14 in varchar2 default hr_api.g_varchar2
210 ,p_attribute15 in varchar2 default hr_api.g_varchar2
211 ,p_attribute16 in varchar2 default hr_api.g_varchar2
212 ,p_attribute17 in varchar2 default hr_api.g_varchar2
213 ,p_attribute18 in varchar2 default hr_api.g_varchar2
214 ,p_attribute19 in varchar2 default hr_api.g_varchar2
215 ,p_attribute20 in varchar2 default hr_api.g_varchar2
216 ,p_announcement_id in number
217 ,p_object_version_number in out nocopy number);
218 --
219 -- ----------------------------------------------------------------------------
220 -- |---------------------------< delete_announcement >------------------------|
221 -- ----------------------------------------------------------------------------
222 --
223 -- {Start Of Comments}
224 /*#
225 * This API deletes an announcement.
226 *
227 * This business process allows the user to delete a member record used within
228 * the Announcement functionality.
229 *
230 * <p><b>Licensing</b><br>
231 * This API is licensed for use with Learning Management.
232 *
233 * <p><b>Prerequisites</b><br>
234 * The announcement record should exist
235 *
236 * <p><b>Post Success</b><br>
237 * The announcement record is deleted
238 *
239 * <p><b>Post Failure</b><br>
240 * The API does not delete the announcement record and raises an error.
241 * @param p_validate If true, then validation alone will be performed and the
242 * database will remain unchanged. If false and all validation checks pass,
243 * then the database will be modified.
244 * @param p_announcement_id {@rep:casecolumn OTA_ANNOUNCEMENTS.ANNOUNCEMENT_ID}
245 * @param p_object_version_number Pass in the current version number of the
246 * announcement to be deleted.
247 * @rep:displayname Delete Announcement
248 * @rep:category BUSINESS_ENTITY OTA_LEARNING_ANNOUNCEMENT
249 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
250 * @rep:scope public
251 * @rep:lifecycle active
252 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
253 */
254 --
255 -- {End Of Comments}
256 --
257 procedure delete_announcement
258 ( p_validate in boolean default false
259 ,p_announcement_id in number
260 ,p_object_version_number in number
261 );
262 end ota_announcement_api;
[Home] [Help]