1 Package hr_assessment_types_api as
2 /* $Header: peastapi.pkh 120.2 2006/02/09 07:43:16 sansingh noship $ */
3 /*#
4 * This package contains APIs relating to assessment types.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Assessment Type
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |--------------------------< create_assessment_type >----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a new assessment type.
17 *
18 * An assessment type is used to define the set of competences that should be
19 * evaluated in any given assessment.
20 *
21 * <p><b>Licensing</b><br>
22 * This API is licensed for use with Human Resources.
23 *
24 * <p><b>Prerequisites</b><br>
25 * Business group must exist for which assessment type is being created.
26 *
27 * <p><b>Post Success</b><br>
28 * Assessment type is created.
29 *
30 * <p><b>Post Failure</b><br>
31 * Assessment type is not created and an error is raised.
32 * @param p_assessment_type_id If p_validate is false, uniquely identifies the
33 * assessment type created. If p_validate is true, set to null.
34 * @param p_name Name of the assessment type.
35 * @param p_business_group_id Business group in which assessment type is
36 * created.
37 * @param p_description Description of the assessment type.
38 * @param p_rating_scale_id Identifies the rating scale. This is mandatory if
39 * the assessment classification is PERFORMANCE or BOTH.
40 * @param p_weighting_scale_id Identifies the rating scale of type WEIGHTING
41 * @param p_rating_scale_comment Comment text for the rating scale. If the
42 * rating scale is null, this has to be null.
43 * @param p_weighting_scale_comment Comment text for the weighting scale. If
44 * weighting scale is null, then this has to null.
45 * @param p_assessment_classification Type of assessment. Valid values are
46 * defined by 'ASSESSMENT_CLASSIFICATION' lookup type.
47 * @param p_display_assessment_comments Indicates whether the comments item
48 * should be displayed on the questionnaire. Valid values are defined by
49 * 'YES_NO' lookup type.
50 * @param p_date_from Date when the assessment type is available for use.
51 * @param p_date_to Date when the assessment type becomes unavailable for use.
52 * @param p_comments Comment text.
53 * @param p_instructions General instructions to be displayed on assessment.
54 * @param p_weighting_classification Indicates whether the weighing value
55 * applies to the proficiency level or performance rating. Valid values are
56 * defined in ASSESSMENT_CLASSIFICATION lookup type. If the assessment
57 * classification is Both, and there is a weighting scale, this states whether
58 * to apply the weighting scale to the performance or proficient value.
59 * @param p_line_score_formula Formula to calculate the score for each
60 * assessment line. Valid values are defined by 'ASSESSMENT_LINE_FORMULA'
61 * lookup type.
62 * @param p_total_score_formula Formula to calculate total score. Valid values
63 * are defined by 'ASSESSMENT_TOTAL_FORMULA' lookup type.
64 * @param p_object_version_number If p_validate is false, then set to the
65 * version number of the created assessment type. If p_validate is true, then
66 * the value will be null.
67 * @param p_attribute_category This context value determines which flexfield
68 * structure to use with the descriptive flexfield segments.
69 * @param p_attribute1 Descriptive flexfield segment.
70 * @param p_attribute2 Descriptive flexfield segment.
71 * @param p_attribute3 Descriptive flexfield segment.
72 * @param p_attribute4 Descriptive flexfield segment.
73 * @param p_attribute5 Descriptive flexfield segment.
74 * @param p_attribute6 Descriptive flexfield segment.
75 * @param p_attribute7 Descriptive flexfield segment.
76 * @param p_attribute8 Descriptive flexfield segment.
77 * @param p_attribute9 Descriptive flexfield segment.
78 * @param p_attribute10 Descriptive flexfield segment.
79 * @param p_attribute11 Descriptive flexfield segment.
80 * @param p_attribute12 Descriptive flexfield segment.
81 * @param p_attribute13 Descriptive flexfield segment.
82 * @param p_attribute14 Descriptive flexfield segment.
83 * @param p_attribute15 Descriptive flexfield segment.
84 * @param p_attribute16 Descriptive flexfield segment.
85 * @param p_attribute17 Descriptive flexfield segment.
86 * @param p_attribute18 Descriptive flexfield segment.
87 * @param p_attribute19 Descriptive flexfield segment.
88 * @param p_attribute20 Descriptive flexfield segment.
89 * @param p_type newly added column for supporting Objective templates also
90 * Valid values are defined in lookup ASSESSMENT_TYPE
91 * @param p_line_score_formula_id newly added column for storing fast formula id for
92 * calculating line_score
93 * @param p_default_job_competencies newly added column , the column indicated whether
94 * the competency assessment template should default a person's job competencies or not
95 * @param p_available_flag indicates whether the template is published or unpublished
96 * Valid values are defined against lookup TEMPLATE_AVAILABILITY_FLAG
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_effective_date Reference date for validating lookup values are
101 * applicable during the start to end active date range. This date does not
102 * determine when the changes take effect.
103 * @rep:displayname Create Assessment Type
104 * @rep:category BUSINESS_ENTITY PER_ASSESSMENT
105 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
106 * @rep:scope public
107 * @rep:lifecycle active
108 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
109 */
110 --
111 -- {End Of Comments}
112 --
113 procedure create_assessment_type
114 (p_assessment_type_id out nocopy number,
115 p_name in varchar2,
116 p_business_group_id in number,
117 p_description in varchar2 default null,
118 p_rating_scale_id in number default null,
119 p_weighting_scale_id in number default null,
120 p_rating_scale_comment in varchar2 default null,
121 p_weighting_scale_comment in varchar2 default null,
122 p_assessment_classification in varchar2,
123 p_display_assessment_comments in varchar2 default 'Y',
124 p_date_from in date,
125 p_date_to in date,
126 p_comments in varchar2 default null,
127 p_instructions in varchar2 default null,
128 p_weighting_classification in varchar2 default null,
129 p_line_score_formula in varchar2 default null,
130 p_total_score_formula in varchar2 default null,
131 p_object_version_number out nocopy number,
132 p_attribute_category in varchar2 default null,
133 p_attribute1 in varchar2 default null,
134 p_attribute2 in varchar2 default null,
135 p_attribute3 in varchar2 default null,
136 p_attribute4 in varchar2 default null,
137 p_attribute5 in varchar2 default null,
138 p_attribute6 in varchar2 default null,
139 p_attribute7 in varchar2 default null,
140 p_attribute8 in varchar2 default null,
141 p_attribute9 in varchar2 default null,
142 p_attribute10 in varchar2 default null,
143 p_attribute11 in varchar2 default null,
144 p_attribute12 in varchar2 default null,
145 p_attribute13 in varchar2 default null,
146 p_attribute14 in varchar2 default null,
147 p_attribute15 in varchar2 default null,
148 p_attribute16 in varchar2 default null,
149 p_attribute17 in varchar2 default null,
150 p_attribute18 in varchar2 default null,
151 p_attribute19 in varchar2 default null,
152 p_attribute20 in varchar2 default null,
153 p_type in varchar2,
154 p_line_score_formula_id in number default null,
155 p_default_job_competencies in varchar2 default null,
156 p_available_flag in varchar2 default null,
157 p_validate in boolean default false,
158 p_effective_date in date
159 );
160 --
161 -- ----------------------------------------------------------------------------
162 -- |--------------------------< update_assessment_type >----------------------|
163 -- ----------------------------------------------------------------------------
164 --
165 -- {Start Of Comments}
166 /*#
167 * This API updates assessment type.
168 *
169 * An assessment type is used to define the set of competences that should be
170 * evaluated in any given assessment.
171 *
172 * <p><b>Licensing</b><br>
173 * This API is licensed for use with Human Resources.
174 *
175 * <p><b>Prerequisites</b><br>
176 * A valid assessment type must exist.
177 *
178 * <p><b>Post Success</b><br>
179 * Assessment type is updated.
180 *
181 * <p><b>Post Failure</b><br>
182 * Assessment type remains unchanged and an error is raised.
183 * @param p_assessment_type_id Identifies the assessment type record to be
184 * updated.
185 * @param p_name Name of the assessment type.
186 * @param p_description Description of the assessment type.
187 * @param p_rating_scale_id The rating scale used in the assessment template.
188 * This is mandatory if the assessment classification is PERFORMANCE or BOTH.
189 * @param p_weighting_scale_id Identifies the rating scale of type WEIGHTING
190 * @param p_rating_scale_comment Comment text about the rating scale. If the
191 * rating scale is null, this has to be null.
192 * @param p_weighting_scale_comment Comment text about the weighting scale. If
193 * weighting scale is null, then this has to be null.
194 * @param p_assessment_classification Type of assessment. Valid values are
195 * defined by 'ASSESSMENT_CLASSIFICATION' lookup type.
196 * @param p_display_assessment_comments Indicates whether the comments item
197 * should be displayed on the questionnaire. Valid values are defined by
198 * 'YES_NO' lookup type.
199 * @param p_date_from Date when the assessment type is available for use.
200 * @param p_date_to Date when the assessment type becomes unavailable for use.
201 * @param p_comments Comment text.
202 * @param p_instructions General instructions to be displayed on assessment.
203 * @param p_weighting_classification Indicates whether the weighing value
204 * applies to the proficiency level or performance rating. Valid values are
205 * defined in ASSESSMENT_CLASSIFICATION lookup type. If the assessment
206 * classification is Both, and there is a weighting scale, this states whether
207 * to apply the weighting scale to the performance or proficient value.
208 * @param p_line_score_formula Formula to calculate the score for each
209 * assessment line. Valid values are defined by 'ASSESSMENT_LINE_FORMULA'
210 * lookup type.
211 * @param p_total_score_formula Formula to calculate total score. Valid values
212 * are defined by 'ASSESSMENT_TOTAL_FORMULA' lookup type.
213 * @param p_object_version_number Pass in the current version number of the
214 * assessment type to be updated. When the API completes if p_validate is
215 * false, will be set to the new version number of the updated assessment type.
216 * If p_validate is true will be set to the same value which was passed in.
217 * @param p_attribute_category This context value determines which flexfield
218 * structure to use with the descriptive flexfield segments.
219 * @param p_attribute1 Descriptive flexfield segment.
220 * @param p_attribute2 Descriptive flexfield segment.
221 * @param p_attribute3 Descriptive flexfield segment.
222 * @param p_attribute4 Descriptive flexfield segment.
223 * @param p_attribute5 Descriptive flexfield segment.
224 * @param p_attribute6 Descriptive flexfield segment.
225 * @param p_attribute7 Descriptive flexfield segment.
226 * @param p_attribute8 Descriptive flexfield segment.
227 * @param p_attribute9 Descriptive flexfield segment.
228 * @param p_attribute10 Descriptive flexfield segment.
229 * @param p_attribute11 Descriptive flexfield segment.
230 * @param p_attribute12 Descriptive flexfield segment.
231 * @param p_attribute13 Descriptive flexfield segment.
232 * @param p_attribute14 Descriptive flexfield segment.
233 * @param p_attribute15 Descriptive flexfield segment.
234 * @param p_attribute16 Descriptive flexfield segment.
235 * @param p_attribute17 Descriptive flexfield segment.
236 * @param p_attribute18 Descriptive flexfield segment.
237 * @param p_attribute19 Descriptive flexfield segment.
238 * @param p_attribute20 Descriptive flexfield segment.
239 * @param p_type newly added column for supporting Objective templates also
240 * Valid values are defined in lookup ASSESSMENT_TYPE
241 * @param p_line_score_formula_id newly added column for storing fast formula id for
242 * calculating line_score
243 * @param p_default_job_competencies newly added column , the column indicated whether
244 * the competency assessment template should default a person's job competencies or not
245 * @param p_available_flag indicates whether the template is published or unpublished
246 * Valid values are defined against lookup TEMPLATE_AVAILABILITY_FLAG
247 * @param p_validate If true, then validation alone will be performed and the
248 * database will remain unchanged. If false and all validation checks pass,
249 * then the database will be modified.
250 * @param p_effective_date Reference date for validating lookup values are
251 * applicable during the start to end active date range. This date does not
252 * determine when the changes take effect.
253 * @rep:displayname Update Assessment Type
254 * @rep:category BUSINESS_ENTITY PER_ASSESSMENT
255 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
256 * @rep:scope public
257 * @rep:lifecycle active
258 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
259 */
260 --
261 -- {End Of Comments}
262 --
263 procedure update_assessment_type
264 (p_assessment_type_id in number,
265 p_name in varchar2 default hr_api.g_varchar2,
266 p_description in varchar2 default hr_api.g_varchar2,
267 p_rating_scale_id in number default hr_api.g_number,
268 p_weighting_scale_id in number default hr_api.g_number,
269 p_rating_scale_comment in varchar2 default hr_api.g_varchar2,
270 p_weighting_scale_comment in varchar2 default hr_api.g_varchar2,
271 p_assessment_classification in varchar2 default hr_api.g_varchar2,
272 p_display_assessment_comments in varchar2 default hr_api.g_varchar2,
273 p_date_from in date default hr_api.g_date,
274 p_date_to in date default hr_api.g_date,
275 p_comments in varchar2 default hr_api.g_varchar2,
276 p_instructions in varchar2 default hr_api.g_varchar2,
277 p_weighting_classification in varchar2 default hr_api.g_varchar2,
278 p_line_score_formula in varchar2 default hr_api.g_varchar2,
279 p_total_score_formula in varchar2 default hr_api.g_varchar2,
280 p_object_version_number in out nocopy number,
281 --
282 p_attribute_category in varchar2 default hr_api.g_varchar2,
283 p_attribute1 in varchar2 default hr_api.g_varchar2,
284 p_attribute2 in varchar2 default hr_api.g_varchar2,
285 p_attribute3 in varchar2 default hr_api.g_varchar2,
286 p_attribute4 in varchar2 default hr_api.g_varchar2,
287 p_attribute5 in varchar2 default hr_api.g_varchar2,
288 p_attribute6 in varchar2 default hr_api.g_varchar2,
289 p_attribute7 in varchar2 default hr_api.g_varchar2,
290 p_attribute8 in varchar2 default hr_api.g_varchar2,
291 p_attribute9 in varchar2 default hr_api.g_varchar2,
292 p_attribute10 in varchar2 default hr_api.g_varchar2,
293 p_attribute11 in varchar2 default hr_api.g_varchar2,
294 p_attribute12 in varchar2 default hr_api.g_varchar2,
295 p_attribute13 in varchar2 default hr_api.g_varchar2,
296 p_attribute14 in varchar2 default hr_api.g_varchar2,
297 p_attribute15 in varchar2 default hr_api.g_varchar2,
298 p_attribute16 in varchar2 default hr_api.g_varchar2,
299 p_attribute17 in varchar2 default hr_api.g_varchar2,
300 p_attribute18 in varchar2 default hr_api.g_varchar2,
301 p_attribute19 in varchar2 default hr_api.g_varchar2,
302 p_attribute20 in varchar2 default hr_api.g_varchar2,
303 p_type in varchar2 default hr_api.g_varchar2,
304 p_line_score_formula_id in number default hr_api.g_number,
305 p_default_job_competencies in varchar2 default hr_api.g_varchar2,
306 p_available_flag in varchar2 default hr_api.g_varchar2,
307 p_validate in boolean default false,
308 p_effective_date in date
309 );
310 --
311 -- ----------------------------------------------------------------------------
312 -- |--------------------------< delete_assessment_type >----------------------|
313 -- ----------------------------------------------------------------------------
314 --
315 -- {Start Of Comments}
316 /*#
317 * This API deletes assessment type.
318 *
319 * An assessment type is used to define the set of competences which should be
320 * evaluated in any given assessment.
321 *
322 * <p><b>Licensing</b><br>
323 * This API is licensed for use with Human Resources.
324 *
325 * <p><b>Prerequisites</b><br>
326 * A valid assessment type must exist.
327 *
328 * <p><b>Post Success</b><br>
329 * Assessment type is deleted.
330 *
331 * <p><b>Post Failure</b><br>
332 * Assessment type is not deleted and an error is raised.
333 * @param p_validate If true, then validation alone will be performed and the
334 * database will remain unchanged. If false and all validation checks pass,
335 * then the database will be modified.
336 * @param p_assessment_type_id Assessment type to be deleted. If p_validate is
337 * false, uniquely identifies the assessment type to be deleted. If p_validate
338 * is true, set to null.
339 * @param p_object_version_number Current version number of the assessment type
340 * to be deleted.
341 * @rep:displayname Delete Assessment Type
342 * @rep:category BUSINESS_ENTITY PER_ASSESSMENT
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 delete_assessment_type
352 (p_validate in boolean default false,
353 p_assessment_type_id in number,
354 p_object_version_number in number
355 );
356 --
357 end hr_assessment_types_api;
[Home] [Help]