1 Package hr_appraisal_templates_api as
2 /* $Header: peaptapi.pkh 120.4.12010000.2 2008/08/06 08:57:26 ubhat ship $*/
3 /*#
4 * This API contains Appraisal Template APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Appraisal Template
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |------------------------< create_appraisal_template >---------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a new appraisal template.
17 *
18 * An appraisal template is the header or group for a number of appraisal
19 * questions. Each appraisal template defines a type of appraisal.
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 * A valid assessment type and rating scale must exist for the business group
26 * of this template. A valid questionnaire template (proposal template) must
27 * also exist.
28 *
29 * <p><b>Post Success</b><br>
30 * An appraisal template is created.
31 *
32 * <p><b>Post Failure</b><br>
33 * The appraisal template is not created and an error is raised.
34 * @param p_validate If true, then validation alone will be performed and the
35 * database will remain unchanged. If false and all validation checks pass,
36 * then the database will be modified.
37 * @param p_effective_date Reference date for validating lookup values are
38 * applicable during the start to end active date range. This date does not
39 * determine when the changes take effect.
40 * @param p_business_group_id Business group for which the appraisal template
41 * is created.
42 * @param p_name Unique name or title of the template.
43 * @param p_description A description of the appraisal template
44 * @param p_instructions General Instructions on how to complete the appraisal
45 * @param p_date_from Date from which the template is valid
46 * @param p_date_to The date until which the appraisal template is valid.
47 * @param p_assessment_type_id The assessment type to be used in this template
48 * @param p_rating_scale_id Default rating scale to be used for this appraisal.
49 * @param p_questionnaire_template_id Appraisee Questionnaire template (proposal
50 * template) for this appraisal template
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_objective_asmnt_type_id The objective assessment type to be used in this template
74 * @param p_ma_quest_template_id MA Questionnaire template (proposal
75 * template) for this appraisal template
76 * @param p_link_appr_to_learning_path indicates if appraisal would be linked to learning path
77 * @param p_final_score_formula_id store fast formula id for calculating appraisal final score
78 * @param p_update_personal_comp_profile indicates whether appraisal competencies should be updating
79 * personal competencies or not
80 * @param p_comp_profile_source_type Value which will be passed to column source_of_proficiency_level
81 * @param p_show_competency_ratings indicates if appraisee can see competency ratings or not
82 * @param p_show_objective_ratings indicates if appraisee can see objective ratings or not
83 * @param p_show_overall_ratings indicates if appraisee can see overall ratings or not
84 * @param p_show_overall_comments indicates if appraisee can see objective comments or not
85 * @param p_provide_overall_feedback indicates if appraisee can provide overall feedback or not
86 * @param p_show_participant_details indicates if appraisee can see participant details on
87 * appraisal completion
88 * @param p_allow_add_participant indicates if appraisee can add participant or not
89 * @param p_show_additional_details indicates if appraisee can see additional details on
90 * appraisal completion
91 * @param p_show_participant_names indicates if appraisee can see participant names on
92 * appraisal completion
93 * @param p_show_participant_ratings indicates if appraisee can see participant ratings on
94 * appraisal completion
95 * @param p_available_flag indicates if template is Unpublished or published.Values are
96 * validated against lookup TEMPLATE_AVAILABILITY_FLAG
97 * @param p_show_questionnaire_info indicates if appraisee can see ma completed questionnaire on
98 * appraisal completion
99 * @param p_ma_off_template_code Excel template code (registered in XML Publisher Templates)
100 * for Main Appraiser.
101 * @param p_appraisee_off_template_code Excel template code (registered in XML Publisher
102 * Templates) for appraisee.
103 * @param p_other_part_off_template_code Excel template code (registered in XML Publisher
104 * Templates) for Other Participants.
105 * @param p_part_app_off_template_code Excel template code (registered in XML Publisher
106 * Templates) for participants of type appraiser.
107 * @param p_part_rev_off_template_code Excel template code (registered in XML Publisher
108 * Templates) for participants of type reviewer.
109 * @param p_appraisal_template_id If p_validate is false, then this uniquely
110 * identifies the appraisal template created. If p_validate is true, then set to
111 * null.
112 * @param p_object_version_number If p_validate is false, then set to
113 * the version number of the created appraisal period. If p_validate is true,
114 * then the value will be null.
115 * @rep:displayname Create Appraisal Template
116 * @rep:category BUSINESS_ENTITY PER_APPRAISAL
117 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
118 * @rep:scope public
119 * @rep:lifecycle active
120 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
121 */
122 --
123 -- {End Of Comments}
124 --
125 procedure create_appraisal_template
126 (p_validate in boolean default false,
127 p_effective_date in date,
128 p_business_group_id in number,
129 p_name in varchar2,
130 p_description in varchar2 default null,
131 p_instructions in varchar2 default null,
132 p_date_from in date default null,
133 p_date_to in date default null,
134 p_assessment_type_id in number default null,
135 p_rating_scale_id in number default null,
136 p_questionnaire_template_id in number default null,
137 p_attribute_category in varchar2 default null,
138 p_attribute1 in varchar2 default null,
139 p_attribute2 in varchar2 default null,
140 p_attribute3 in varchar2 default null,
141 p_attribute4 in varchar2 default null,
142 p_attribute5 in varchar2 default null,
143 p_attribute6 in varchar2 default null,
144 p_attribute7 in varchar2 default null,
145 p_attribute8 in varchar2 default null,
146 p_attribute9 in varchar2 default null,
147 p_attribute10 in varchar2 default null,
148 p_attribute11 in varchar2 default null,
149 p_attribute12 in varchar2 default null,
150 p_attribute13 in varchar2 default null,
151 p_attribute14 in varchar2 default null,
152 p_attribute15 in varchar2 default null,
153 p_attribute16 in varchar2 default null,
154 p_attribute17 in varchar2 default null,
155 p_attribute18 in varchar2 default null,
156 p_attribute19 in varchar2 default null,
157 p_attribute20 in varchar2 default null
158 ,p_objective_asmnt_type_id in number default null
159 ,p_ma_quest_template_id in number default null
160 ,p_link_appr_to_learning_path in varchar2 default null
161 ,p_final_score_formula_id in number default null
162 ,p_update_personal_comp_profile in varchar2 default null
163 ,p_comp_profile_source_type in varchar2 default null
164 ,p_show_competency_ratings in varchar2 default null
165 ,p_show_objective_ratings in varchar2 default null
166 ,p_show_overall_ratings in varchar2 default null
167 ,p_show_overall_comments in varchar2 default null
168 ,p_provide_overall_feedback in varchar2 default null
169 ,p_show_participant_details in varchar2 default null
170 ,p_allow_add_participant in varchar2 default null
171 ,p_show_additional_details in varchar2 default null
172 ,p_show_participant_names in varchar2 default null
173 ,p_show_participant_ratings in varchar2 default null
174 ,p_available_flag in varchar2 default null
175 ,p_show_questionnaire_info in varchar2 default null
176 ,p_ma_off_template_code in varchar2 default null
177 ,p_appraisee_off_template_code in varchar2 default null
178 ,p_other_part_off_template_code in varchar2 default null
179 ,p_part_app_off_template_code in varchar2 default null
180 ,p_part_rev_off_template_code in varchar2 default null,
181 p_appraisal_template_id out nocopy number,
182 p_object_version_number out nocopy number
183 );
184 --
185 -- ----------------------------------------------------------------------------
186 -- |------------------------< update_appraisal_template >---------------------|
187 -- ----------------------------------------------------------------------------
188 --
189 -- {Start Of Comments}
190 /*#
191 * This API updates appraisal template.
192 *
193 * An appraisal template is the header or group for a number of appraisal
194 * questions. Each appraisal template defines a type of appraisal.
195 *
196 * <p><b>Licensing</b><br>
197 * This API is licensed for use with Human Resources.
198 *
199 * <p><b>Prerequisites</b><br>
200 * A valid existing appraisal template must be passed to the API.
201 *
202 * <p><b>Post Success</b><br>
203 * Appraisal template is updated.
204 *
205 * <p><b>Post Failure</b><br>
206 * Appraisal template remains unchanged and an error is raised.
207 * @param p_validate If true, then only validation will be performed and the
208 * database remains unchanged. If false, then all validation checks pass the
209 * database will be modified.
210 * @param p_effective_date Reference date for validating lookup values are
211 * applicable during the start to end active date range. This date does not
212 * determine when the changes take effect.
213 * @param p_appraisal_template_id Identifier of the appraisal template to be
214 * updated.
215 * @param p_object_version_number Pass in the current version number of the
216 * appraisal template to be updated. When the API completes if p_validate is
217 * false, will be set to the new version number of the updated appraisal
218 * template. If p_validate is true will be set to the same value which was
219 * passed in.
220 * @param p_name Unique name or title of the template.
221 * @param p_description A description of the appraisal template
222 * @param p_instructions General Instructions on how to complete the appraisal
223 * @param p_date_from Date from which the template is valid
224 * @param p_date_to The date until which the appraisal template is valid.
225 * @param p_assessment_type_id The assessment type to be used in this template
226 * @param p_rating_scale_id Default rating scale to be used for this appraisal.
227 * @param p_questionnaire_template_id Questionnaire template (proposal
228 * template) for this appraisal template
229 * @param p_attribute_category This context value determines which flexfield
230 * structure to use with the descriptive flexfield segments.
231 * @param p_attribute1 Descriptive flexfield segment.
232 * @param p_attribute2 Descriptive flexfield segment.
233 * @param p_attribute3 Descriptive flexfield segment.
234 * @param p_attribute4 Descriptive flexfield segment.
235 * @param p_attribute5 Descriptive flexfield segment.
236 * @param p_attribute6 Descriptive flexfield segment.
237 * @param p_attribute7 Descriptive flexfield segment.
238 * @param p_attribute8 Descriptive flexfield segment.
239 * @param p_attribute9 Descriptive flexfield segment.
240 * @param p_attribute10 Descriptive flexfield segment.
241 * @param p_attribute11 Descriptive flexfield segment.
242 * @param p_attribute12 Descriptive flexfield segment.
243 * @param p_attribute13 Descriptive flexfield segment.
244 * @param p_attribute14 Descriptive flexfield segment.
245 * @param p_attribute15 Descriptive flexfield segment.
246 * @param p_attribute16 Descriptive flexfield segment.
247 * @param p_attribute17 Descriptive flexfield segment.
248 * @param p_attribute18 Descriptive flexfield segment.
249 * @param p_attribute19 Descriptive flexfield segment.
250 * @param p_attribute20 Descriptive flexfield segment.
251 * @param p_objective_asmnt_type_id The objective assessment type to be used in this template
252 * @param p_ma_quest_template_id MA Questionnaire template (proposal
253 * template) for this appraisal template
254 * @param p_link_appr_to_learning_path indicates if appraisal would be linked to learning path
255 * @param p_final_score_formula_id store fast formula id for calculating appraisal final score
256 * @param p_update_personal_comp_profile indicates whether appraisal competencies should be updating
257 * personal competencies or not
258 * @param p_comp_profile_source_type Value which will be passed to column source_of_proficiency_level
259 * @param p_show_competency_ratings indicates if appraisee can see competency ratings or not
260 * @param p_show_objective_ratings indicates if appraisee can see objective ratings or not
261 * @param p_show_overall_ratings indicates if appraisee can see overall ratings or not
262 * @param p_show_overall_comments indicates if appraisee can see objective comments or not
263 * @param p_provide_overall_feedback indicates if appraisee can provide overall feedback or not
264 * @param p_show_participant_details indicates if appraisee can see participant details on
265 * appraisal completion
266 * @param p_allow_add_participant indicates if appraisee can add participant or not
267 * @param p_show_additional_details indicates if appraisee can see additional details on
268 * appraisal completion
269 * @param p_show_participant_names indicates if appraisee can see participant names on
270 * appraisal completion
271 * @param p_show_participant_ratings indicates if appraisee can see participant ratings on
272 * appraisal completion
273 * @param p_available_flag indicates if template is Unpublished or published.Values are
274 * validated against lookup TEMPLATE_AVAILABILITY_FLAG
275 * @param p_show_questionnaire_info indicates if appraisee can see ma completed questionnaire on
276 * appraisal completion
277 * @param p_ma_off_template_code Excel template code (registered in XML Publisher Templates)
278 * for Main Appraiser.
279 * @param p_appraisee_off_template_code Excel template code (registered in XML Publisher
280 * Templates) for appraisee.
281 * @param p_other_part_off_template_code Excel template code (registered in XML Publisher
282 * Templates) for Other Participants.
283 * @param p_part_app_off_template_code Excel template code (registered in XML Publisher
284 * Templates) for participants of type appraiser.
285 * @param p_part_rev_off_template_code Excel template code (registered in XML Publisher
286 * Templates) for participants of type reviewer.
287 * @rep:displayname Update Appraisal Template
288 * @rep:category BUSINESS_ENTITY PER_APPRAISAL
289 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
290 * @rep:scope public
291 * @rep:lifecycle active
292 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
293 */
294 --
295 -- {End Of Comments}
296 --
297 procedure update_appraisal_template
298 (p_validate in boolean default false,
299 p_effective_date in date,
300 p_appraisal_template_id in number,
301 p_object_version_number in out nocopy number,
302 p_name in varchar2 default hr_api.g_varchar2,
303 p_description in varchar2 default hr_api.g_varchar2,
304 p_instructions in varchar2 default hr_api.g_varchar2,
305 p_date_from in date default hr_api.g_date,
306 p_date_to in date default hr_api.g_date,
307 p_assessment_type_id in number default hr_api.g_number,
308 p_rating_scale_id in number default hr_api.g_number,
309 p_questionnaire_template_id in number default hr_api.g_number,
310 p_attribute_category in varchar2 default hr_api.g_varchar2,
311 p_attribute1 in varchar2 default hr_api.g_varchar2,
312 p_attribute2 in varchar2 default hr_api.g_varchar2,
313 p_attribute3 in varchar2 default hr_api.g_varchar2,
314 p_attribute4 in varchar2 default hr_api.g_varchar2,
315 p_attribute5 in varchar2 default hr_api.g_varchar2,
316 p_attribute6 in varchar2 default hr_api.g_varchar2,
317 p_attribute7 in varchar2 default hr_api.g_varchar2,
318 p_attribute8 in varchar2 default hr_api.g_varchar2,
319 p_attribute9 in varchar2 default hr_api.g_varchar2,
320 p_attribute10 in varchar2 default hr_api.g_varchar2,
321 p_attribute11 in varchar2 default hr_api.g_varchar2,
322 p_attribute12 in varchar2 default hr_api.g_varchar2,
323 p_attribute13 in varchar2 default hr_api.g_varchar2,
324 p_attribute14 in varchar2 default hr_api.g_varchar2,
325 p_attribute15 in varchar2 default hr_api.g_varchar2,
326 p_attribute16 in varchar2 default hr_api.g_varchar2,
327 p_attribute17 in varchar2 default hr_api.g_varchar2,
328 p_attribute18 in varchar2 default hr_api.g_varchar2,
329 p_attribute19 in varchar2 default hr_api.g_varchar2,
330 p_attribute20 in varchar2 default hr_api.g_varchar2,
331 p_objective_asmnt_type_id in number default hr_api.g_number
332 ,p_ma_quest_template_id in number default hr_api.g_number
333 ,p_link_appr_to_learning_path in varchar2 default hr_api.g_varchar2
334 ,p_final_score_formula_id in number default hr_api.g_number
335 ,p_update_personal_comp_profile in varchar2 default hr_api.g_varchar2
336 ,p_comp_profile_source_type in varchar2 default hr_api.g_varchar2
337 ,p_show_competency_ratings in varchar2 default hr_api.g_varchar2
338 ,p_show_objective_ratings in varchar2 default hr_api.g_varchar2
339 ,p_show_overall_ratings in varchar2 default hr_api.g_varchar2
340 ,p_show_overall_comments in varchar2 default hr_api.g_varchar2
341 ,p_provide_overall_feedback in varchar2 default hr_api.g_varchar2
342 ,p_show_participant_details in varchar2 default hr_api.g_varchar2
343 ,p_allow_add_participant in varchar2 default hr_api.g_varchar2
344 ,p_show_additional_details in varchar2 default hr_api.g_varchar2
345 ,p_show_participant_names in varchar2 default hr_api.g_varchar2
346 ,p_show_participant_ratings in varchar2 default hr_api.g_varchar2
347 ,p_available_flag in varchar2 default hr_api.g_varchar2
348 ,p_show_questionnaire_info in varchar2 default hr_api.g_varchar2
349 ,p_ma_off_template_code in varchar2 default hr_api.g_varchar2
350 ,p_appraisee_off_template_code in varchar2 default hr_api.g_varchar2
351 ,p_other_part_off_template_code in varchar2 default hr_api.g_varchar2
352 ,p_part_app_off_template_code in varchar2 default hr_api.g_varchar2
353 ,p_part_rev_off_template_code in varchar2 default hr_api.g_varchar2
354 );
355 --
356 -- ----------------------------------------------------------------------------
357 -- |------------------------< delete_appraisal_template >---------------------|
358 -- ----------------------------------------------------------------------------
359 --
360 -- {Start Of Comments}
361 /*#
362 * This API deletes appraisal template.
363 *
364 * You can not delete an appraisal template if this template is used in any
365 * appraisal.
366 *
367 * <p><b>Licensing</b><br>
368 * This API is licensed for use with Human Resources.
369 *
370 * <p><b>Prerequisites</b><br>
371 * A valid appraisal template must already exist and this template must not be
372 * used in any appraisals.
373 *
374 * <p><b>Post Success</b><br>
375 * Appraisal template is deleted.
376 *
377 * <p><b>Post Failure</b><br>
378 * Appraisal template is not deleted and an error is raised.
379 * @param p_validate If true, then only validation will be performed and the
380 * database remains unchanged. If false, then all validation checks pass the
381 * database will be modified.
382 * @param p_appraisal_template_id Appraisal template to be deleted. If
383 * p_validate is false, uniquely identifies the appraisal template to be
384 * deleted. If p_validate is true, set to null.
385 * @param p_object_version_number Current version number of the appraisal
386 * template to be deleted.
387 * @rep:displayname Delete Appraisal Template
388 * @rep:category BUSINESS_ENTITY PER_APPRAISAL
389 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
390 * @rep:scope public
391 * @rep:lifecycle active
392 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
393 */
394 --
395 -- {End Of Comments}
396 --
397 procedure delete_appraisal_template
398 (p_validate in boolean default false,
399 p_appraisal_template_id in number,
400 p_object_version_number in number
401 );
402 --
403 end hr_appraisal_templates_api;
[Home] [Help]