1 Package HR_KI_OPTION_TYPES_API as
2 /* $Header: hrotyapi.pkh 120.1 2005/10/02 02:05:08 aroussel $ */
3 /*#
4 * This package contains APIs to maintain knowledge integration option types.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Knowledge Integration Option Type
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------------< create_option_type >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a knowledge integration option type.
17 *
18 * Creates a list of available option types with information to describe how
19 * they are displayed in the UI.
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 option types of Key, Display Type, Option Name and Source Language,
26 * should be entered.
27 *
28 * <p><b>Post Success</b><br>
29 * The knowledge integration option type definition will be successfully
30 * inserted into the database.
31 *
32 * <p><b>Post Failure</b><br>
33 * The knowledge integration option type definition will not be created and an
34 * error 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_option_type_key Unique key to identify the record.
43 * @param p_display_type The display name that will be visible in the UI.
44 * @param p_option_name Name of the option type to be created.
45 * @param p_option_type_id If p_validate is false, then this uniquely
46 * identifies the option type been created. If p_validate is true, then set to
47 * null.
48 * @param p_object_version_number If p_validate is false, then set to the
49 * version number of the option type definition record. If p_validate is true,
50 * then the value will be null.
51 * @rep:displayname Create Knowledge Integration Option Type
52 * @rep:category BUSINESS_ENTITY HR_KI_SYSTEM
53 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
54 * @rep:scope public
55 * @rep:lifecycle active
56 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
57 */
58 --
59 -- {End Of Comments}
60 --
61 procedure create_option_type
62 (p_validate in boolean default false
63 ,p_language_code in varchar2 default hr_api.userenv_lang
64 ,p_option_type_key in varchar2
65 ,p_display_type in varchar2
66 ,p_option_name in varchar2
67 ,p_option_type_id out nocopy number
68 ,p_object_version_number out nocopy number
69 );
70 --
71 -- ----------------------------------------------------------------------------
72 -- |----------------------------< update_option_type >------------------------|
73 -- ----------------------------------------------------------------------------
74 --
75 -- {Start Of Comments}
76 /*#
77 * This API updates a knowledge integration option type.
78 *
79 * Updates a list of available option types with information to describe how
80 * they are displayed in the UI.
81 *
82 * <p><b>Licensing</b><br>
83 * This API is licensed for use with all products in the HRMS Product Family.
84 *
85 * <p><b>Prerequisites</b><br>
86 * A valid option_type_id should be entered
87 *
88 * <p><b>Post Success</b><br>
89 * The knowledge integration option type definition will be successfully
90 * updated into the database.
91 *
92 * <p><b>Post Failure</b><br>
93 * The knowledge integration option type definition will not be updated and an
94 * error will be raised.
95 * @param p_validate If true, then validation alone will be performed and the
96 * database will remain unchanged. If false and all validation checks pass,
97 * then the database will be modified.
98 * @param p_language_code Specifies to which language the translation values
99 * apply. You can set to the base or any installed language. The default value
100 * of hr_api.userenv_lang is equivalent to the RDBMS userenv('LANG') function
101 * value.
102 * @param p_display_type The display name that will be visible in the UI.
103 * @param p_option_name Name of the option type to be updated.
104 * @param p_option_type_id Unique internal identifier for the record to be
105 * updated.
106 * @param p_object_version_number Pass in the current version number of the
107 * option type definition to be updated. When the API completes if p_validate
108 * is false, will be set to the new version number of the updated option type
109 * definition. If p_validate is true will be set to the same value which was
110 * passed in.
111 * @rep:displayname Update Knowledge Integration Option Type
112 * @rep:category BUSINESS_ENTITY HR_KI_SYSTEM
113 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
114 * @rep:scope public
115 * @rep:lifecycle active
116 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
117 */
118 --
119 -- {End Of Comments}
120 --
121 procedure update_option_type
122 (p_validate in boolean default false
123 ,p_language_code in varchar2 default hr_api.userenv_lang
124 ,p_display_type in varchar2 default hr_api.g_varchar2
125 ,p_option_name in varchar2 default hr_api.g_varchar2
126 ,p_option_type_id in number
127 ,p_object_version_number in out nocopy number
128 );
129 --
130 -- ----------------------------------------------------------------------------
131 -- |----------------------------< delete_option_type >------------------------|
132 -- ----------------------------------------------------------------------------
133 --
134 -- {Start Of Comments}
135 /*#
136 * This API deletes a knowledge integration option type.
137 *
138 * Deletes a list of available option types with information to describe how
139 * they are displayed in the UI.
140 *
141 * <p><b>Licensing</b><br>
142 * This API is licensed for use with all products in the HRMS Product Family.
143 *
144 * <p><b>Prerequisites</b><br>
145 * Option type id and object version number should be entered.
146 *
147 * <p><b>Post Success</b><br>
148 * The knowledge integration option type definition will be successfully
149 * deleted from the database.
150 *
151 * <p><b>Post Failure</b><br>
152 * The knowledge integration option type definition will not be deleted and an
153 * error will be raised.
154 * @param p_validate If true, then validation alone will be performed and the
155 * database will remain unchanged. If false and all validation checks pass,
156 * then the database will be modified.
157 * @param p_option_type_id Unique internal identifier for the record to be
158 * deleted.
159 * @param p_object_version_number Current version number of the option type
160 * definition to be deleted.
161 * @rep:displayname Delete Knowledge Integration Option Type
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_option_type
172 (
173 p_validate in boolean default false
174 ,p_option_type_id in number
175 ,p_object_version_number in number
176 );
177 --
178 end HR_KI_OPTION_TYPES_API;
[Home] [Help]