1 Package HR_KI_TOPICS_API AUTHID CURRENT_USER as
2 /* $Header: hrtpcapi.pkh 120.1 2005/10/02 02:06:41 aroussel $ */
3 /*#
4 * This API maintains definitions of the knowledge integration topics used
5 * within integrations.
6 * @rep:scope public
7 * @rep:product per
8 * @rep:displayname Knowledge Integration -Topic
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |-------------------------------< create_topic >---------------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates a knowledge integration topic.
18 *
19 * The list of topics will be visible from the UI when accessing an
20 * integration.
21 *
22 * <p><b>Licensing</b><br>
23 * This API is licensed for use with all products in the HRMS Product Family.
24 *
25 * <p><b>Prerequisites</b><br>
26 * A valid integration must exist.
27 *
28 * <p><b>Post Success</b><br>
29 * The topic definition will be successfully inserted into the database.
30 *
31 * <p><b>Post Failure</b><br>
32 * The topic definition will not be created and an error will 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_language_code Specifies to which language the translation values
37 * apply. You can set to the base or any installed language. The default value
38 * of hr_api.userenv_lang is equivalent to the RDBMS userenv('LANG') function
39 * value.
40 * @param p_topic_key {@rep:casecolumn HR_KI_TOPICS.TOPIC_KEY}
41 * @param p_handler The java class file used to handle the topic.
42 * @param p_name Name of the topic.
43 * @param p_topic_id If p_validate is false, then this uniquely identifies the
44 * topic been created. If p_validate is true, then set to null.
45 * @param p_object_version_number If p_validate is false, then set to the
46 * version number of the topic definition record. If p_validate is true, then
47 * the value will be null.
48 * @rep:displayname Create Knowledge Integration Topic
49 * @rep:category BUSINESS_ENTITY HR_KI_SYSTEM
50 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
51 * @rep:scope public
52 * @rep:lifecycle active
53 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
54 */
55 --
56 -- {End Of Comments}
57 --
58 procedure create_topic
59 (p_validate in boolean default false
60 ,p_language_code in varchar2 default hr_api.userenv_lang
61 ,p_topic_key in varchar2
62 ,p_handler in varchar2
63 ,p_name in varchar2
64 ,p_topic_id out nocopy number
65 ,p_object_version_number out nocopy number
66 );
67 --
68 -- ----------------------------------------------------------------------------
69 -- |-------------------------------< update_topic >---------------------------|
70 -- ----------------------------------------------------------------------------
71 --
72 -- {Start Of Comments}
73 /*#
74 * This API updates a knowledge integration topic.
75 *
76 * The list of topics will be visible from the UI when accessing an
77 * integration.
78 *
79 * <p><b>Licensing</b><br>
80 * This API is licensed for use with all products in the HRMS Product Family.
81 *
82 * <p><b>Prerequisites</b><br>
83 * A valid topic id should be entered
84 *
85 * <p><b>Post Success</b><br>
86 * The topic definition will be successfully updated into the database.
87 *
88 * <p><b>Post Failure</b><br>
89 * The topic definition will not be updated and an error will be raised.
90 * @param p_validate If true, then validation alone will be performed and the
91 * database will remain unchanged. If false and all validation checks pass,
92 * then the database will be modified.
93 * @param p_language_code Specifies to which language the translation values
94 * apply. You can set to the base or any installed language. The default value
95 * of hr_api.userenv_lang is equivalent to the RDBMS userenv('LANG') function
96 * value.
97 * @param p_handler The java class file used to handle the topic.
98 * @param p_name Name of the topic.
99 * @param p_topic_id Unique internal identifier of the topic record to update.
100 * @param p_object_version_number Pass in the current version number of the
101 * topic definition to be updated. When the API completes if p_validate is
102 * false, will be set to the new version number of the topic definition. If
103 * p_validate is true will be set to the same value which was passed in.
104 * @rep:displayname Update Knowledge Integration Topic
105 * @rep:category BUSINESS_ENTITY HR_KI_SYSTEM
106 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
107 * @rep:scope public
108 * @rep:lifecycle active
109 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
110 */
111 --
112 -- {End Of Comments}
113 --
114 procedure update_topic
115 (p_validate in boolean default false
116 ,p_language_code in varchar2 default hr_api.userenv_lang
117 ,p_handler in varchar2 default hr_api.g_varchar2
118 ,p_name in varchar2 default hr_api.g_varchar2
119 ,p_topic_id in number
120 ,p_object_version_number in out nocopy number
121 );
122 --
123 -- ----------------------------------------------------------------------------
124 -- |-------------------------------< delete_topic >---------------------------|
125 -- ----------------------------------------------------------------------------
126 --
127 -- {Start Of Comments}
128 /*#
129 * This API deletes a knowledge integration topic.
130 *
131 * The list of topics will be visible from the UI when accessing an
132 * integration.
133 *
134 * <p><b>Licensing</b><br>
135 * This API is licensed for use with all products in the HRMS Product Family.
136 *
137 * <p><b>Prerequisites</b><br>
138 * A valid topic id should be entered.
139 *
140 * <p><b>Post Success</b><br>
141 * The topic definition will be successfully deleted from the database.
142 *
143 * <p><b>Post Failure</b><br>
144 * The topic definition will not be deleted and an error will be raised.
145 * @param p_validate If true, then validation alone will be performed and the
146 * database will remain unchanged. If false and all validation checks pass,
147 * then the database will be modified.
148 * @param p_topic_id Unique internal identifier of the topic record to delete.
149 * @param p_object_version_number Current version number of the topic
150 * definition to be deleted.
151 * @rep:displayname Delete Knowledge Integration Topic
152 * @rep:category BUSINESS_ENTITY HR_KI_SYSTEM
153 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
154 * @rep:scope public
155 * @rep:lifecycle active
156 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
157 */
158 --
159 -- {End Of Comments}
160 --
161 procedure delete_topic
162 (
163 P_VALIDATE in boolean default false
164 ,P_TOPIC_ID in number
165 ,P_OBJECT_VERSION_NUMBER in number
166 );
167
168 --
169 end HR_KI_TOPICS_API;
[Home] [Help]