1 Package hr_rating_scales_api AUTHID CURRENT_USER as
2 /* $Header: perscapi.pkh 120.1 2005/11/28 03:22:27 dsaxby noship $ */
3 /*#
4 * This package contains rating scale APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Rating Scale
8 */
9 --
10 -- package variable
11 --
12 g_ignore_df varchar2(1) := 'N';
13 --
14 -- ----------------------------------------------------------------------------
15 -- |------------------------< <create_rating_scale> >--------------------------|
16 -- ----------------------------------------------------------------------------
17 --
18 -- {Start Of Comments}
19 /*#
20 * This API creates a rating scale.
21 *
22 *
23 * <p><b>Licensing</b><br>
24 * This API is licensed for use with Oracle Human Resources.
25 *
26 * <p><b>Prerequisites</b><br>
27 * No known prerequisites.
28 *
29 * <p><b>Post Success</b><br>
30 * The rating scale will have been created.
31 *
32 * <p><b>Post Failure</b><br>
33 * The rating scale will not be created and an error will be raised.
34 *
35 * @param p_language_code Specifies to which language the translation values
36 * apply. You can set to the base or any installed language. The default value
37 * of hr_api.userenv_lang is equivalent to the RDBMS userenv('LANG') function
38 * value.
39 * @param p_validate If true, then validation alone will be performed and the
40 * database will remain unchanged. If false and all validation checks pass,
41 * then the database will be modified.
42 * @param p_effective_date Reference date for validating lookup values are
43 * applicable during the start to end active date range. This date does not
44 * determine when the changes take effect.
45 * @param p_name {@rep:casecolumn PER_RATING_SCALES.NAME}
46 * @param p_type {@rep:casecolumn PER_RATING_SCALES.TYPE}
47 * @param p_default_flag {@rep:casecolumn PER_RATING_SCALES.DEFAULT_FLAG}
48 * @param p_business_group_id {@rep:casecolumn
49 * PER_RATING_SCALES.BUSINESS_GROUP_ID}
50 * @param p_description {@rep:casecolumn PER_RATING_SCALES.DESCRIPTION}
51 * @param p_attribute_category This context value determines which flexfield
52 * structure to use with the descriptive flexfield segments.
53 * @param p_attribute1 Descriptive flexfield segment.
54 * @param p_attribute2 Descriptive flexfield segment.
55 * @param p_attribute3 Descriptive flexfield segment.
56 * @param p_attribute4 Descriptive flexfield segment.
57 * @param p_attribute5 Descriptive flexfield segment.
58 * @param p_attribute6 Descriptive flexfield segment.
59 * @param p_attribute7 Descriptive flexfield segment.
60 * @param p_attribute8 Descriptive flexfield segment.
61 * @param p_attribute9 Descriptive flexfield segment.
62 * @param p_attribute10 Descriptive flexfield segment.
63 * @param p_attribute11 Descriptive flexfield segment.
64 * @param p_attribute12 Descriptive flexfield segment.
65 * @param p_attribute13 Descriptive flexfield segment.
66 * @param p_attribute14 Descriptive flexfield segment.
67 * @param p_attribute15 Descriptive flexfield segment.
68 * @param p_attribute16 Descriptive flexfield segment.
69 * @param p_attribute17 Descriptive flexfield segment.
70 * @param p_attribute18 Descriptive flexfield segment.
71 * @param p_attribute19 Descriptive flexfield segment.
72 * @param p_attribute20 Descriptive flexfield segment.
73 * @param p_rating_scale_id If p_validate is false, uniquely identifies the
74 * rating scale created. If p_validate is true, set to null.
75 * @param p_object_version_number If p_validate is false, then set to the
76 * version number of the created rating scale. If p_validate is true, then the
77 * value will be null.
78 * @rep:displayname Create a Rating Scale
79 * @rep:category BUSINESS_ENTITY PER_COMPETENCE_RATING_SCALE
80 * @rep:lifecycle active
81 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
82 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
83 * @rep:scope public
84 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
85 */
86 --
87 -- {End Of Comments}
88 --
89 procedure create_rating_scale
90 (p_language_code in varchar2 default hr_api.userenv_lang,
91 p_validate in boolean default false,
92 p_effective_date in date,
93 p_name in varchar2,
94 p_type in varchar2,
95 p_default_flag in varchar2 default 'N',
96 p_business_group_id in number default null,
97 p_description in varchar2 default null,
98 p_attribute_category in varchar2 default null,
99 p_attribute1 in varchar2 default null,
100 p_attribute2 in varchar2 default null,
101 p_attribute3 in varchar2 default null,
102 p_attribute4 in varchar2 default null,
103 p_attribute5 in varchar2 default null,
104 p_attribute6 in varchar2 default null,
105 p_attribute7 in varchar2 default null,
106 p_attribute8 in varchar2 default null,
107 p_attribute9 in varchar2 default null,
108 p_attribute10 in varchar2 default null,
109 p_attribute11 in varchar2 default null,
110 p_attribute12 in varchar2 default null,
111 p_attribute13 in varchar2 default null,
112 p_attribute14 in varchar2 default null,
113 p_attribute15 in varchar2 default null,
114 p_attribute16 in varchar2 default null,
115 p_attribute17 in varchar2 default null,
116 p_attribute18 in varchar2 default null,
117 p_attribute19 in varchar2 default null,
118 p_attribute20 in varchar2 default null,
119 p_rating_scale_id out nocopy number,
120 p_object_version_number out nocopy number
121 );
122 --
123 -- ----------------------------------------------------------------------------
124 -- |------------------------< <update_rating_scales> >--------------------------|
125 -- ----------------------------------------------------------------------------
126 --
127 -- {Start Of Comments}
128 /*#
129 * This API updates the rating scale.
130 *
131 * This API updates a rating scale as identified by the in parameter
132 * p_rating_scale_id and the in out parameter p_object_version_number.
133 *
134 * <p><b>Licensing</b><br>
135 * This API is licensed for use with Oracle Human Resources.
136 *
137 * <p><b>Prerequisites</b><br>
138 * The rating scale must exist.
139 *
140 * <p><b>Post Success</b><br>
141 * The rating scale will have been updated.
142 *
143 * <p><b>Post Failure</b><br>
144 * The rating scale will not be updated and an error will be raised.
145 *
146 * @param p_language_code Specifies to which language the translation values
147 * apply. You can set to the base or any installed language. The default value
148 * of hr_api.userenv_lang is equivalent to the RDBMS userenv('LANG') function
149 * value.
150 * @param p_validate If true, then validation alone will be performed and the
151 * database will remain unchanged. If false and all validation checks pass,
152 * then the database will be modified.
153 * @param p_effective_date Reference date for validating lookup values are
154 * applicable during the start to end active date range. This date does not
155 * determine when the changes take effect.
156 * @param p_rating_scale_id {@rep:casecolumn PER_RATING_SCALES.RATING_SCALE_ID}
157 * @param p_object_version_number Pass in the current version number of the
158 * rating scale to be updated. When the API completes if p_validate is false,
159 * will be set to the new version number of the updated rating scale. If
160 * p_validate is true will be set to the same value which was passed in.
161 * @param p_name REF.PER_RATING_SCALES.NAME
162 * @param p_description REF.PER_RATING_SCALES.DESCRIPTION
163 * @param p_default_flag REF.PER_RATING_SCALES.DEFAULT_FLAG
164 * @param p_attribute_category This context value determines which flexfield
165 * structure to use with the descriptive flexfield segments.
166 * @param p_attribute1 Descriptive flexfield segment.
167 * @param p_attribute2 Descriptive flexfield segment.
168 * @param p_attribute3 Descriptive flexfield segment.
169 * @param p_attribute4 Descriptive flexfield segment.
170 * @param p_attribute5 Descriptive flexfield segment.
171 * @param p_attribute6 Descriptive flexfield segment.
172 * @param p_attribute7 Descriptive flexfield segment.
173 * @param p_attribute8 Descriptive flexfield segment.
174 * @param p_attribute9 Descriptive flexfield segment.
175 * @param p_attribute10 Descriptive flexfield segment.
176 * @param p_attribute11 Descriptive flexfield segment.
177 * @param p_attribute12 Descriptive flexfield segment.
178 * @param p_attribute13 Descriptive flexfield segment.
179 * @param p_attribute14 Descriptive flexfield segment.
180 * @param p_attribute15 Descriptive flexfield segment.
181 * @param p_attribute16 Descriptive flexfield segment.
182 * @param p_attribute17 Descriptive flexfield segment.
183 * @param p_attribute18 Descriptive flexfield segment.
184 * @param p_attribute19 Descriptive flexfield segment.
185 * @param p_attribute20 Descriptive flexfield segment.
186 * @rep:displayname Update a Rating Scale
187 * @rep:category BUSINESS_ENTITY PER_COMPETENCE_RATING_SCALE
188 * @rep:lifecycle active
189 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
190 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
191 * @rep:scope public
192 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
193 */
194 --
195 -- {End Of Comments}
196 --
197 procedure update_rating_scale
198 (p_language_code in varchar2 default hr_api.userenv_lang,
199 p_validate in boolean default false,
200 p_effective_date in date,
201 p_rating_scale_id in number,
202 p_object_version_number in out nocopy number,
203 p_name in varchar2 default hr_api.g_varchar2,
204 p_description in varchar2 default hr_api.g_varchar2,
205 p_default_flag in varchar2 default hr_api.g_varchar2,
206 p_attribute_category in varchar2 default hr_api.g_varchar2,
207 p_attribute1 in varchar2 default hr_api.g_varchar2,
208 p_attribute2 in varchar2 default hr_api.g_varchar2,
209 p_attribute3 in varchar2 default hr_api.g_varchar2,
210 p_attribute4 in varchar2 default hr_api.g_varchar2,
211 p_attribute5 in varchar2 default hr_api.g_varchar2,
212 p_attribute6 in varchar2 default hr_api.g_varchar2,
213 p_attribute7 in varchar2 default hr_api.g_varchar2,
214 p_attribute8 in varchar2 default hr_api.g_varchar2,
215 p_attribute9 in varchar2 default hr_api.g_varchar2,
216 p_attribute10 in varchar2 default hr_api.g_varchar2,
217 p_attribute11 in varchar2 default hr_api.g_varchar2,
218 p_attribute12 in varchar2 default hr_api.g_varchar2,
219 p_attribute13 in varchar2 default hr_api.g_varchar2,
220 p_attribute14 in varchar2 default hr_api.g_varchar2,
221 p_attribute15 in varchar2 default hr_api.g_varchar2,
222 p_attribute16 in varchar2 default hr_api.g_varchar2,
223 p_attribute17 in varchar2 default hr_api.g_varchar2,
224 p_attribute18 in varchar2 default hr_api.g_varchar2,
225 p_attribute19 in varchar2 default hr_api.g_varchar2,
226 p_attribute20 in varchar2 default hr_api.g_varchar2
227 );
228 --
229 -- ----------------------------------------------------------------------------
230 -- |------------------------< <delete_rating_scales> >--------------------------|
231 -- ----------------------------------------------------------------------------
232 --
233 -- {Start Of Comments}
234 /*#
235 * This API deletes the rating scale.
236 *
237 *
238 * <p><b>Licensing</b><br>
239 * This API is licensed for use with Oracle Human Resources.
240 *
241 * <p><b>Prerequisites</b><br>
242 * The rating scale must exist.
243 *
244 * <p><b>Post Success</b><br>
245 * The rating scale will have been deleted.
246 *
247 * <p><b>Post Failure</b><br>
248 * The rating scale will not be deleted and an error will be raised.
249 *
250 * @param p_validate If true, then validation alone will be performed and the
251 * database will remain unchanged. If false and all validation checks pass,
252 * then the database will be modified.
253 * @param p_rating_scale_id {@rep:casecolumn PER_RATING_SCALES.RATING_SCALE_ID}
254 * @param p_object_version_number Current version number of the rating scale to
255 * be deleted.
256 * @rep:displayname Delete a Rating Scale
257 * @rep:category BUSINESS_ENTITY PER_COMPETENCE_RATING_SCALE
258 * @rep:lifecycle active
259 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
260 * @rep:scope public
261 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
262 */
263 --
264 -- {End Of Comments}
265 --
266 procedure delete_rating_scale
267 (p_validate in boolean default false,
268 p_rating_scale_id in number,
269 p_object_version_number in number
270 );
271 -- ----------------------------------------------------------------------------
272 -- |-------------------< <create_or_update_rating_scale> >---------------------|
273 -- ----------------------------------------------------------------------------
274 --
275 -- {Start Of Comments}
276 /*#
277 * This Api creates a rating scale if the rating scale does not exist and
278 * updates the rating scale if the rating scale already exists.
279 *
280 * This API is used for skills vendor integration.
281 *
282 * <p><b>Licensing</b><br>
283 * This API is licensed for use with Oracle Human Resources.
284 *
285 * <p><b>Prerequisites</b><br>
286 * The rating scale must exist for update.
287 *
288 * <p><b>Post Success</b><br>
289 * The rating scale will have been created or updated.
290 *
291 * <p><b>Post Failure</b><br>
292 * The rating scale will not be created or updated and an error will be raised.
293 *
294 * @param p_language_code Specifies to which language the translation values
295 * apply. You can set to the base or any installed language. The default value
296 * of hr_api.userenv_lang is equivalent to the RDBMS userenv('LANG') function
297 * value.
298 * @param p_validate If true, then validation alone will be performed and the
299 * database will remain unchanged. If false and all validation checks pass,
300 * then the database will be modified.
301 * @param p_effective_date Reference date for validating lookup values are
302 * applicable during the start to end active date range. This date does not
303 * determine when the changes take effect.
304 * @param p_name {@rep:casecolumn PER_RATING_SCALES.NAME}
305 * @param p_type {@rep:casecolumn PER_RATING_SCALES.TYPE}
306 * @param p_description {@rep:casecolumn PER_RATING_SCALES.DESCRIPTION}
307 * @param p_default_flag {@rep:casecolumn PER_RATING_SCALES.DEFAULT_FLAG}
308 * @param p_translated_language If the name parameter is translated, this is
309 * the language code for the name
310 * @param p_source_rating_scale_name This is the rating scale name with the
311 * source language code
312 * @rep:displayname Create or Update a Rating Scale
313 * @rep:category BUSINESS_ENTITY PER_COMPETENCE_RATING_SCALE
314 * @rep:lifecycle active
315 * @rep:scope public
316 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
317 */
318 --
319 -- {End Of Comments}
320 --
321 procedure create_or_update_rating_scale
322 (p_language_code in varchar2 default hr_api.userenv_lang
323 ,p_validate in boolean default false
324 ,p_effective_date in date default trunc(sysdate)
325 ,p_name in varchar2 default null
326 ,p_type in varchar2 default null
327 ,p_description in varchar2 default null
328 ,p_default_flag in varchar2 default null
329 ,p_translated_language in varchar2 default null
330 ,p_source_rating_scale_name in varchar2 default null
331 );
332 --
333 end hr_rating_scales_api;
[Home] [Help]