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