1 Package HR_KI_TOPIC_INTEGRATIONS_API AUTHID CURRENT_USER as
2 /* $Header: hrtisapi.pkh 120.2 2008/01/25 13:49:50 avarri ship $ */
3 /*#
4 * This package contains APIs that maintain definitions of the knowledge
5 * integration topics linked to integrations.
6 * @rep:scope public
7 * @rep:product per
8 * @rep:displayname Knowledge Integration - Topic Integration
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |-----------------------< create_topic_integration_key >-------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates the knowledge integration topic key.
18 *
19 *
20 * <p><b>Licensing</b><br>
21 * This API is licensed for use with all products in the HRMS Product Family.
22 *
23 * <p><b>Prerequisites</b><br>
24 * A valid topic and integration must exist.
25 *
26 * <p><b>Post Success</b><br>
27 * The integration and topic definition will be successfully inserted into the
28 * database.
29 *
30 * <p><b>Post Failure</b><br>
31 * The integration and topic definition will not be created and an error will
32 * be raised.
33 * @param p_validate If true, then validation alone will be performed and the
34 * database will remain unchanged. If false and all validation checks pass,
35 * then the database will be modified.
36 * @param p_topic_key {@rep:casecolumn HR_KI_TOPICS.TOPIC_ID}
37 * @param p_integration_key {@rep:casecolumn
38 * HR_KI_INTEGRATIONS.INTEGRATION_KEY}
39 * @param p_param_name1 Parameter1 Name for topic or integration.
40 * @param p_param_value1 Parameter1 Value for topic or integration.
41 * @param p_param_name2 Parameter2 Name for topic or integration.
42 * @param p_param_value2 Parameter2 Value for topic or integration.
43 * @param p_param_name3 Parameter3 Name for topic or integration.
44 * @param p_param_value3 Parameter3 Value for topic or integration.
45 * @param p_param_name4 Parameter4 Name for topic or integration.
46 * @param p_param_value4 Parameter4 Value for topic or integration.
47 * @param p_param_name5 Parameter5 Name for topic or integration.
48 * @param p_param_value5 Parameter5 Value for topic or integration.
49 * @param p_param_name6 Parameter6 Name for topic or integration.
50 * @param p_param_value6 Parameter6 Value for topic or integration.
51 * @param p_param_name7 Parameter7 Name for topic or integration.
52 * @param p_param_value7 Parameter7 Value for topic or integration.
53 * @param p_param_name8 Parameter8 Name for topic or integration.
54 * @param p_param_value8 Parameter8 Value for topic or integration.
55 * @param p_param_name9 Parameter9 Name for topic or integration.
56 * @param p_param_value9 Parameter9 Value for topic or integration.
57 * @param p_param_name10 Parameter10 Name for topic or integration.
58 * @param p_param_value10 Parameter10 Value for topic or integration.
59 * @param p_topic_integrations_id If p_validate is false, then this uniquely
60 * identifies the topic integration been created. If p_validate is true, then
61 * set to null.
62 * @param p_object_version_number If p_validate is false, then set to the
63 * version number of the integration and topic key definition record. If
64 * p_validate is true, then the value will be null.
65 * @rep:displayname Create Topic Integration Key
66 * @rep:category BUSINESS_ENTITY HR_KI_MAP
67 * @rep:scope public
68 * @rep:lifecycle active
69 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
70 */
71 --
72 -- {End Of Comments}
73 --
74 procedure create_topic_integration_key
75 (
76 p_validate in boolean default false
77 ,p_topic_key in varchar2
78 ,p_integration_key in varchar2
79 ,p_param_name1 in varchar2 default null
80 ,p_param_value1 in varchar2 default null
81 ,p_param_name2 in varchar2 default null
82 ,p_param_value2 in varchar2 default null
83 ,p_param_name3 in varchar2 default null
84 ,p_param_value3 in varchar2 default null
85 ,p_param_name4 in varchar2 default null
86 ,p_param_value4 in varchar2 default null
87 ,p_param_name5 in varchar2 default null
91 ,p_param_name7 in varchar2 default null
88 ,p_param_value5 in varchar2 default null
89 ,p_param_name6 in varchar2 default null
90 ,p_param_value6 in varchar2 default null
92 ,p_param_value7 in varchar2 default null
93 ,p_param_name8 in varchar2 default null
94 ,p_param_value8 in varchar2 default null
95 ,p_param_name9 in varchar2 default null
96 ,p_param_value9 in varchar2 default null
97 ,p_param_name10 in varchar2 default null
98 ,p_param_value10 in varchar2 default null
99 ,p_topic_integrations_id out nocopy number
100 ,p_object_version_number out nocopy number
101 );
102 --
103 -- ----------------------------------------------------------------------------
104 -- |-------------------------< create_topic_integration >---------------------|
105 -- ----------------------------------------------------------------------------
106 --
107 -- {Start Of Comments}
108 /*#
109 * This API creates a knowledge integration topic mapping.
110 *
111 * This information defines the link between an integration and a topic.
112 *
113 * <p><b>Licensing</b><br>
114 * This API is licensed for use with all products in the HRMS Product Family.
115 *
116 * <p><b>Prerequisites</b><br>
117 * A valid topic and integration must exist.
118 *
119 * <p><b>Post Success</b><br>
120 * The integration and topic definition will be successfully inserted into the
121 * database.
122 *
123 * <p><b>Post Failure</b><br>
124 * The integration and topic definition will not be created and an error will
125 * be raised.
126 * @param p_validate If true, then validation alone will be performed and the
127 * database will remain unchanged. If false and all validation checks pass,
128 * then the database will be modified.
129 * @param p_topic_id {@rep:casecolumn HR_KI_TOPICS.TOPIC_ID}
130 * @param p_integration_id {@rep:casecolumn HR_KI_INTEGRATIONS.INTEGRATION_ID}
131 * @param p_param_name1 Parameter1 Name for topic or integration.
132 * @param p_param_value1 Parameter1 Value for topic or integration.
133 * @param p_param_name2 Parameter2 Name for topic or integration.
134 * @param p_param_value2 Parameter2 Value for topic or integration.
135 * @param p_param_name3 Parameter3 Name for topic or integration.
136 * @param p_param_value3 Parameter3 Value for topic or integration.
137 * @param p_param_name4 Parameter4 Name for topic or integration.
138 * @param p_param_value4 Parameter4 Value for topic or integration.
139 * @param p_param_name5 Parameter5 Name for topic or integration.
140 * @param p_param_value5 Parameter5 Value for topic or integration.
141 * @param p_param_name6 Parameter6 Name for topic or integration.
142 * @param p_param_value6 Parameter6 Value for topic or integration.
143 * @param p_param_name7 Parameter7 Name for topic or integration.
144 * @param p_param_value7 Parameter7 Value for topic or integration.
145 * @param p_param_name8 Parameter8 Name for topic or integration.
146 * @param p_param_value8 Parameter8 Value for topic or integration.
147 * @param p_param_name9 Parameter9 Name for topic or integration.
148 * @param p_param_value9 Parameter9 Value for topic or integration.
149 * @param p_param_name10 Parameter10 Name for topic or integration.
150 * @param p_param_value10 Parameter10 Value for topic or integration.
151 * @param p_topic_integrations_id If p_validate is false, then this uniquely
152 * identifies the topic integration been created. If p_validate is true, then
153 * set to null.
154 * @param p_object_version_number If p_validate is false, then set to the
155 * version number of the integration and topic definition record. If p_validate
156 * is true, then the value will be null.
157 * @rep:displayname Create Topic Integration
158 * @rep:category BUSINESS_ENTITY HR_KI_MAP
159 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
160 * @rep:scope public
161 * @rep:lifecycle active
162 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
163 */
164 --
165 -- {End Of Comments}
166 --
167 procedure create_topic_integration
168 (
169 p_validate in boolean default false
170 ,p_topic_id in number
171 ,p_integration_id in number
172 ,p_param_name1 in varchar2 default null
173 ,p_param_value1 in varchar2 default null
174 ,p_param_name2 in varchar2 default null
175 ,p_param_value2 in varchar2 default null
176 ,p_param_name3 in varchar2 default null
177 ,p_param_value3 in varchar2 default null
178 ,p_param_name4 in varchar2 default null
179 ,p_param_value4 in varchar2 default null
180 ,p_param_name5 in varchar2 default null
181 ,p_param_value5 in varchar2 default null
182 ,p_param_name6 in varchar2 default null
183 ,p_param_value6 in varchar2 default null
184 ,p_param_name7 in varchar2 default null
185 ,p_param_value7 in varchar2 default null
186 ,p_param_name8 in varchar2 default null
187 ,p_param_value8 in varchar2 default null
188 ,p_param_name9 in varchar2 default null
189 ,p_param_value9 in varchar2 default null
190 ,p_param_name10 in varchar2 default null
191 ,p_param_value10 in varchar2 default null
192 ,p_topic_integrations_id out nocopy number
193 ,p_object_version_number out nocopy number
194 );
195 --
196 -- ----------------------------------------------------------------------------
200 -- {Start Of Comments}
197 -- |-----------------------< update_topic_integration_key >-------------------|
198 -- ----------------------------------------------------------------------------
199 --
201 /*#
202 * This API updates the knowledge integration topic key.
203 *
204 *
205 * <p><b>Licensing</b><br>
206 * This API is licensed for use with all products in the HRMS Product Family.
207 *
208 * <p><b>Prerequisites</b><br>
209 * A valid topic and integration must exist.
210 *
211 * <p><b>Post Success</b><br>
212 * The integration and topic key definition will be successfully updated into
213 * the database.
214 *
215 * <p><b>Post Failure</b><br>
216 * The integration and topic key definition will not be updated and an error
217 * will be raised.
218 * @param p_validate If true, then validation alone will be performed and the
219 * database will remain unchanged. If false and all validation checks pass,
220 * then the database will be modified.
221 * @param p_topic_integrations_id Unique internal identifier for the record.
222 * @param p_topic_key {@rep:casecolumn HR_KI_TOPICS.TOPIC_ID}
223 * @param p_integration_key {@rep:casecolumn
224 * HR_KI_INTEGRATIONS.INTEGRATION_KEY}
225 * @param p_param_name1 Parameter1 Name for topic or integration.
226 * @param p_param_value1 Parameter1 Value for topic or integration.
227 * @param p_param_name2 Parameter2 Name for topic or integration.
228 * @param p_param_value2 Parameter2 Value for topic or integration.
229 * @param p_param_name3 Parameter3 Name for topic or integration.
230 * @param p_param_value3 Parameter3 Value for topic or integration.
231 * @param p_param_name4 Parameter4 Name for topic or integration.
232 * @param p_param_value4 Parameter4 Value for topic or integration.
233 * @param p_param_name5 Parameter5 Name for topic or integration.
234 * @param p_param_value5 Parameter5 Value for topic or integration.
235 * @param p_param_name6 Parameter6 Name for topic or integration.
236 * @param p_param_value6 Parameter6 Value for topic or integration.
237 * @param p_param_name7 Parameter7 Name for topic or integration.
238 * @param p_param_value7 Parameter7 Value for topic or integration.
239 * @param p_param_name8 Parameter8 Name for topic or integration.
240 * @param p_param_value8 Parameter8 Value for topic or integration.
241 * @param p_param_name9 Parameter9 Name for topic or integration.
242 * @param p_param_value9 Parameter9 Value for topic or integration.
243 * @param p_param_name10 Parameter10 Name for topic or integration.
244 * @param p_param_value10 Parameter10 Value for topic or integration.
245 * @param p_object_version_number Pass in the current version number of the
246 * integration and topic key definition to be updated. When the API completes
247 * if p_validate is false, will be set to the new version number of the updated
248 * integration and topic key definition. If p_validate is true will be set to
249 * the same value which was passed in.
250 * @rep:displayname Update Topic Integration Key
251 * @rep:category BUSINESS_ENTITY HR_KI_MAP
252 * @rep:scope public
253 * @rep:lifecycle active
254 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
255 */
256 --
257 -- {End Of Comments}
258 --
259 procedure update_topic_integration_key
260 (
261 p_validate in boolean default false
262 ,p_topic_integrations_id in number
263 ,p_topic_key in varchar2 default hr_api.g_varchar2
264 ,p_integration_key in varchar2 default hr_api.g_varchar2
265 ,p_param_name1 in varchar2 default hr_api.g_varchar2
266 ,p_param_value1 in varchar2 default hr_api.g_varchar2
267 ,p_param_name2 in varchar2 default hr_api.g_varchar2
268 ,p_param_value2 in varchar2 default hr_api.g_varchar2
269 ,p_param_name3 in varchar2 default hr_api.g_varchar2
270 ,p_param_value3 in varchar2 default hr_api.g_varchar2
271 ,p_param_name4 in varchar2 default hr_api.g_varchar2
272 ,p_param_value4 in varchar2 default hr_api.g_varchar2
273 ,p_param_name5 in varchar2 default hr_api.g_varchar2
274 ,p_param_value5 in varchar2 default hr_api.g_varchar2
275 ,p_param_name6 in varchar2 default hr_api.g_varchar2
276 ,p_param_value6 in varchar2 default hr_api.g_varchar2
277 ,p_param_name7 in varchar2 default hr_api.g_varchar2
278 ,p_param_value7 in varchar2 default hr_api.g_varchar2
279 ,p_param_name8 in varchar2 default hr_api.g_varchar2
280 ,p_param_value8 in varchar2 default hr_api.g_varchar2
281 ,p_param_name9 in varchar2 default hr_api.g_varchar2
282 ,p_param_value9 in varchar2 default hr_api.g_varchar2
283 ,p_param_name10 in varchar2 default hr_api.g_varchar2
284 ,p_param_value10 in varchar2 default hr_api.g_varchar2
285 ,p_object_version_number in out nocopy number
286 );
287 --
288 -- ----------------------------------------------------------------------------
289 -- |-------------------------< update_topic_integration >---------------------|
290 -- ----------------------------------------------------------------------------
291 --
292 -- {Start Of Comments}
293 /*#
294 * This API updates a knowledge integration topic mapping.
295 *
296 *
297 * <p><b>Licensing</b><br>
298 * This API is licensed for use with all products in the HRMS Product Family.
299 *
300 * <p><b>Prerequisites</b><br>
301 * A valid topic_integrations_id should be entered.
302 *
303 * <p><b>Post Success</b><br>
304 * The integration and topic definition will be successfully updated into the
305 * database.
306 *
307 * <p><b>Post Failure</b><br>
308 * The integration and topic definition will not be updated and an error will
309 * be raised.
310 * @param p_validate If true, then validation alone will be performed and the
311 * database will remain unchanged. If false and all validation checks pass,
312 * then the database will be modified.
313 * @param p_topic_integrations_id Unique internal identifier for the record.
314 * @param p_topic_id {@rep:casecolumn HR_KI_TOPICS.TOPIC_ID}
315 * @param p_integration_id {@rep:casecolumn HR_KI_INTEGRATIONS.INTEGRATION_ID}
316 * @param p_param_name1 Parameter1 Name for topic or integration.
317 * @param p_param_value1 Parameter1 Value for topic or integration.
318 * @param p_param_name2 Parameter2 Name for topic or integration.
319 * @param p_param_value2 Parameter2 Value for topic or integration.
320 * @param p_param_name3 Parameter3 Name for topic or integration.
321 * @param p_param_value3 Parameter3 Value for topic or integration.
322 * @param p_param_name4 Parameter4 Name for topic or integration.
323 * @param p_param_value4 Parameter4 Value for topic or integration.
324 * @param p_param_name5 Parameter5 Name for topic or integration.
325 * @param p_param_value5 Parameter5 Value for topic or integration.
326 * @param p_param_name6 Parameter6 Name for topic or integration.
327 * @param p_param_value6 Parameter6 Value for topic or integration.
328 * @param p_param_name7 Parameter7 Name for topic or integration.
329 * @param p_param_value7 Parameter7 Value for topic or integration.
330 * @param p_param_name8 Parameter8 Name for topic or integration.
331 * @param p_param_value8 Parameter8 Value for topic or integration.
332 * @param p_param_name9 Parameter9 Name for topic or integration.
333 * @param p_param_value9 Parameter9 Value for topic or integration.
334 * @param p_param_name10 Parameter10 Name for topic or integration.
335 * @param p_param_value10 Parameter10 Value for topic or integration.
336 * @param p_object_version_number Pass in the current version number of the
337 * integration and topic definition to be updated. When the API completes if
338 * p_validate is false, will be set to the new version number of the updated
339 * integration and topic definition. If p_validate is true will be set to the
340 * same value which was passed in.
341 * @rep:displayname Update Topic Integration
342 * @rep:category BUSINESS_ENTITY HR_KI_MAP
343 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
344 * @rep:scope public
345 * @rep:lifecycle active
346 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
347 */
348 --
349 -- {End Of Comments}
350 --
351 procedure update_topic_integration
352 (
353 p_validate in boolean default false
354 ,p_topic_integrations_id in number
355 ,p_topic_id in number default hr_api.g_number
356 ,p_integration_id in number default hr_api.g_number
357 ,p_param_name1 in varchar2 default hr_api.g_varchar2
358 ,p_param_value1 in varchar2 default hr_api.g_varchar2
359 ,p_param_name2 in varchar2 default hr_api.g_varchar2
360 ,p_param_value2 in varchar2 default hr_api.g_varchar2
361 ,p_param_name3 in varchar2 default hr_api.g_varchar2
362 ,p_param_value3 in varchar2 default hr_api.g_varchar2
363 ,p_param_name4 in varchar2 default hr_api.g_varchar2
364 ,p_param_value4 in varchar2 default hr_api.g_varchar2
365 ,p_param_name5 in varchar2 default hr_api.g_varchar2
366 ,p_param_value5 in varchar2 default hr_api.g_varchar2
367 ,p_param_name6 in varchar2 default hr_api.g_varchar2
368 ,p_param_value6 in varchar2 default hr_api.g_varchar2
369 ,p_param_name7 in varchar2 default hr_api.g_varchar2
370 ,p_param_value7 in varchar2 default hr_api.g_varchar2
371 ,p_param_name8 in varchar2 default hr_api.g_varchar2
372 ,p_param_value8 in varchar2 default hr_api.g_varchar2
373 ,p_param_name9 in varchar2 default hr_api.g_varchar2
374 ,p_param_value9 in varchar2 default hr_api.g_varchar2
375 ,p_param_name10 in varchar2 default hr_api.g_varchar2
376 ,p_param_value10 in varchar2 default hr_api.g_varchar2
377 ,p_object_version_number in out nocopy number
378 );
379 --
380 -- ----------------------------------------------------------------------------
381 -- |-------------------------< delete_topic_integration >---------------------|
382 -- ----------------------------------------------------------------------------
383 --
384 -- {Start Of Comments}
385 /*#
386 * This API deletes a knowledge integration topic mapping.
387 *
388 *
389 * <p><b>Licensing</b><br>
390 * This API is licensed for use with all products in the HRMS Product Family.
391 *
392 * <p><b>Prerequisites</b><br>
393 * Enter topic integrations id and object version numbers.
394 *
395 * <p><b>Post Success</b><br>
396 * The integration and topic definition will be successfully deleted from the
397 * database.
398 *
399 * <p><b>Post Failure</b><br>
400 * The integration and topic definition will not be deleted and an error will
401 * be raised.
402 * @param p_validate If true, then validation alone will be performed and the
403 * database will remain unchanged. If false and all validation checks pass,
404 * then the database will be modified.
405 * @param p_topic_integrations_id Unique internal identifier for the record.
406 * @param p_object_version_number Current version number of the integration and
407 * topic mapping definition to be deleted.
408 * @rep:displayname Delete Topic Integration
409 * @rep:category BUSINESS_ENTITY HR_KI_MAP
410 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
411 * @rep:scope public
412 * @rep:lifecycle active
413 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
414 */
415 --
416 -- {End Of Comments}
417 --
418 procedure delete_topic_integration
419 (
420 P_VALIDATE in boolean default false
421 ,P_TOPIC_INTEGRATIONS_ID in number
422 ,P_OBJECT_VERSION_NUMBER in number
423 );
424 --
425 end HR_KI_TOPIC_INTEGRATIONS_API;
[Home] [Help]