DBA Data[Home] [Help]

PACKAGE: APPS.OTA_CONFERENCE_SERVER_API

Source


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