1 Package hr_objectives_api as
2 /* $Header: peobjapi.pkh 120.6 2006/05/05 07:17:16 tpapired noship $*/
3 /*#
4 * This package contains objective APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Objective
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-----------------------------< create_objective >-------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a new objective. An objective is a target or goal which
17 * may be evaluated during an appraisal (performance review). An objective is
18 * for a specific person. An objective may change over time.
19 *
20 * <p><b>Licensing</b><br>
21 * This API is licensed for use with Human Resources.
22 *
23 * <p><b>Prerequisites</b><br>
24 * The person for whom the objective is created must exist.
25 *
26 * <p><b>Post Success</b><br>
27 * Objective is created.
28 *
29 * <p><b>Post Failure</b><br>
30 * Objective is not created and an error is raised.
31 * @param p_validate If true, then validation alone will be performed and the
32 * database will remain unchanged. If false and all validation checks pass,
33 * then the database will be modified.
34 * @param p_effective_date Reference date for validating lookup values are
35 * applicable during the start to end active date range. This date does not
36 * determine when the changes take effect.
37 * @param p_business_group_id Business group of the person who owns this
38 * objective.
39 * @param p_name Objective name.
40 * @param p_start_date Start date of the objective.
41 * @param p_owning_person_id Person for whom the objective is being created.
42 * @param p_target_date Target date for this objective to be achieved.
43 * @param p_achievement_date Date when objective is achieved.
44 * @param p_detail Detailed definition of the objective.
45 * @param p_comments Comments text.
46 * @param p_success_criteria Success criteria or performance matrices used for
47 * this objective.
48 * @param p_appraisal_id Identifies the appraisal record.
49 * @param p_attribute_category This context value determines which flexfield
50 * structure to use with the descriptive flexfield segments.
51 * @param p_attribute1 Descriptive flexfield segment.
52 * @param p_attribute2 Descriptive flexfield segment.
53 * @param p_attribute3 Descriptive flexfield segment.
54 * @param p_attribute4 Descriptive flexfield segment.
55 * @param p_attribute5 Descriptive flexfield segment.
56 * @param p_attribute6 Descriptive flexfield segment.
57 * @param p_attribute7 Descriptive flexfield segment.
58 * @param p_attribute8 Descriptive flexfield segment.
59 * @param p_attribute9 Descriptive flexfield segment.
60 * @param p_attribute10 Descriptive flexfield segment.
61 * @param p_attribute11 Descriptive flexfield segment.
62 * @param p_attribute12 Descriptive flexfield segment.
63 * @param p_attribute13 Descriptive flexfield segment.
64 * @param p_attribute14 Descriptive flexfield segment.
65 * @param p_attribute15 Descriptive flexfield segment.
66 * @param p_attribute16 Descriptive flexfield segment.
67 * @param p_attribute17 Descriptive flexfield segment.
68 * @param p_attribute18 Descriptive flexfield segment.
69 * @param p_attribute19 Descriptive flexfield segment.
70 * @param p_attribute20 Descriptive flexfield segment.
71 * @param p_attribute21 Descriptive flexfield segment.
72 * @param p_attribute22 Descriptive flexfield segment.
73 * @param p_attribute23 Descriptive flexfield segment.
74 * @param p_attribute24 Descriptive flexfield segment.
75 * @param p_attribute25 Descriptive flexfield segment.
76 * @param p_attribute26 Descriptive flexfield segment.
77 * @param p_attribute27 Descriptive flexfield segment.
78 * @param p_attribute28 Descriptive flexfield segment.
79 * @param p_attribute29 Descriptive flexfield segment.
80 * @param p_attribute30 Descriptive flexfield segment.
81 * @param p_scorecard_id Identifies the personal scorecard to which
82 * the objective belongs.
83 * @param p_copied_from_library_id Identifies the library objective from which this objective
84 * is copied.
85 * @param p_copied_from_objective_id Identifies the objective from which this objective was
86 * copied.
87 * @param p_aligned_with_objective_id Identifies the objective to which this objective
88 * is aligned.
89 * @param p_next_review_date Indicates when the objective should next be reviewed.
90 * @param p_group_code Group to which this objective belongs. Valid values are
91 * defined by "HR_WPM_GROUP" lookup type
92 * @param p_priority_code Priority of the objective. Valid values are defined by
93 * "HR_WPM_PRIORITY" lookup type.
94 * @param p_appraise_flag Indicates whether this objective should be appraised.
95 * Valid values are defined by "YES_NO" lookup type.
96 * @param p_verified_flag Indicates whether the objective's achievement has been verified
97 * against the measure. Valid values are defined by "YES_NO" lookup type.
98 * @param p_target_value The target measure, either a maximum or minimum target, depending
99 * on the measure type.
100 * @param p_actual_value The actual quantity achieved against the target measure.
101 * @param p_weighting_percent Weighting for this objective, used to score overall
102 * appraisal ratings.
103 * @param p_complete_percent The percentage complete.
104 * @param p_uom_code Determine the measure's unit of measure. Valid values are defined by
105 * "HR_WPM_MEASURE_UOM" lookup type.
106 * @param p_measurement_style_code Measurement style of this objective's measure. Valid
107 * values are defined by "HR_WPM_MEASUREMENT_STYLE" lookup type.
108 * @param p_measure_name The measure by which this objective's completion should be
109 * scored against
110 * @param p_measure_type_code Measure type for this measure to determine whether the target
111 * measure is a minimum or maximum. Valid values are defined by "HR_WPM_MEASURE_TYPE" lookup type
112 * @param p_measure_comments Comments regarding the measure and target.
113 * @param p_sharing_access_code Access permissions on this objective. Valid values are
114 * defined by "HR_WPM_OBJECTIVE_SHARING" lookup type.
115 * @param p_weighting_over_100_warning If set to true, then the combined weighting of
116 * objective in the scorecard is greater than 100%
117 * @param p_weighting_appraisal_warning If set to true, then weighting of this objective
118 * is not marked to be included in the appraisals
119 * @param p_objective_id If p_validate is false, uniquely identifies the
120 * objective created. If p_validate is true, set to null.
121 * @param p_object_version_number If p_validate is false, then set to the
122 * version number of the created objective. If p_validate is true, then the
123 * value will be null.
124 * @rep:displayname Create Objective
125 * @rep:category BUSINESS_ENTITY PER_APPRAISAL
126 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
127 * @rep:scope public
128 * @rep:lifecycle active
129 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
130 */
131 --
132 -- {End Of Comments}
133 --
134 procedure create_objective
135 (p_validate in boolean default false,
136 p_effective_date in date,
137 p_business_group_id in number,
138 p_name in varchar2,
139 p_start_date in date,
140 p_owning_person_id in number,
141 p_target_date in date default null,
142 p_achievement_date in date default null,
143 p_detail in varchar2 default null,
144 p_comments in varchar2 default null,
145 p_success_criteria in varchar2 default null,
146 p_appraisal_id in number default null,
147 p_attribute_category in varchar2 default null,
148 p_attribute1 in varchar2 default null,
149 p_attribute2 in varchar2 default null,
150 p_attribute3 in varchar2 default null,
151 p_attribute4 in varchar2 default null,
152 p_attribute5 in varchar2 default null,
153 p_attribute6 in varchar2 default null,
154 p_attribute7 in varchar2 default null,
155 p_attribute8 in varchar2 default null,
156 p_attribute9 in varchar2 default null,
157 p_attribute10 in varchar2 default null,
158 p_attribute11 in varchar2 default null,
159 p_attribute12 in varchar2 default null,
160 p_attribute13 in varchar2 default null,
161 p_attribute14 in varchar2 default null,
162 p_attribute15 in varchar2 default null,
163 p_attribute16 in varchar2 default null,
164 p_attribute17 in varchar2 default null,
165 p_attribute18 in varchar2 default null,
166 p_attribute19 in varchar2 default null,
167 p_attribute20 in varchar2 default null,
168
169 p_attribute21 in varchar2 default null,
170 p_attribute22 in varchar2 default null,
171 p_attribute23 in varchar2 default null,
172 p_attribute24 in varchar2 default null,
173 p_attribute25 in varchar2 default null,
174 p_attribute26 in varchar2 default null,
175 p_attribute27 in varchar2 default null,
176 p_attribute28 in varchar2 default null,
177 p_attribute29 in varchar2 default null,
178 p_attribute30 in varchar2 default null,
179
180 p_scorecard_id in number default null,
181 p_copied_from_library_id in number default null,
182 p_copied_from_objective_id in number default null,
183 p_aligned_with_objective_id in number default null,
184
185 p_next_review_date in date default null,
186 p_group_code in varchar2 default null,
187 p_priority_code in varchar2 default null,
188 p_appraise_flag in varchar2 default null,
189 p_verified_flag in varchar2 default null,
190
191 p_target_value in number default null,
192 p_actual_value in number default null,
193 p_weighting_percent in number default null,
194 p_complete_percent in number default null,
195 p_uom_code in varchar2 default null,
196
197 p_measurement_style_code in varchar2 default null,
198 p_measure_name in varchar2 default null,
199 p_measure_type_code in varchar2 default null,
200 p_measure_comments in varchar2 default null,
201 p_sharing_access_code in varchar2 default null,
202
203 p_weighting_over_100_warning out nocopy boolean,
204 p_weighting_appraisal_warning out nocopy boolean,
205
206 p_objective_id out nocopy number,
207 p_object_version_number out nocopy number
208 );
209 --
210 -- ----------------------------------------------------------------------------
211 -- |-----------------------------< update_objective >-------------------------|
212 -- ----------------------------------------------------------------------------
213 --
214 -- {Start Of Comments}
215 /*#
216 * This API updates an existing objective. An objective is a target or
217 * goal which may be evaluated during an appraisal (performance review).
218 * An objective is for a specific person. An objective may change over time.
219 *
220 * <p><b>Licensing</b><br>
221 * This API is licensed for use with Human Resources.
222 *
223 * <p><b>Prerequisites</b><br>
224 * A valid objective to be modified must exist.
225 *
226 * <p><b>Post Success</b><br>
227 * Objective is updated.
228 *
229 * <p><b>Post Failure</b><br>
230 * Objective remains unchanged and an error is raised.
231 * @param p_validate If true, then validation alone will be performed and the
232 * database will remain unchanged. If false and all validation checks pass,
233 * then the database will be modified.
234 * @param p_effective_date Reference date for validating lookup values are
235 * applicable during the start to end active date range. This date does not
236 * determine when the changes take effect.
237 * @param p_objective_id Identifies the objective to be updated.
238 * @param p_object_version_number Pass in the current version number of the
239 * objective to be updated. When the API completes if p_validate is false, will
240 * be set to the new version number of the updated objective If p_validate is
241 * true will be set to the same value which was passed in.
242 * @param p_name Objective name.
243 * @param p_target_date Target date for this objective to be achieved.
244 * @param p_start_date Start date of the objective.
245 * @param p_achievement_date Date when objective is achieved.
246 * @param p_detail Detailed definition of the objective.
247 * @param p_comments Comments text.
248 * @param p_success_criteria Success criteria or performance matrices used for
249 * this objective.
250 * @param p_attribute_category This context value determines which flexfield
251 * structure to use with the descriptive flexfield segments.
252 * @param p_attribute1 Descriptive flexfield segment.
253 * @param p_attribute2 Descriptive flexfield segment.
254 * @param p_attribute3 Descriptive flexfield segment.
255 * @param p_attribute4 Descriptive flexfield segment.
256 * @param p_attribute5 Descriptive flexfield segment.
257 * @param p_attribute6 Descriptive flexfield segment.
258 * @param p_attribute7 Descriptive flexfield segment.
259 * @param p_attribute8 Descriptive flexfield segment.
260 * @param p_attribute9 Descriptive flexfield segment.
261 * @param p_attribute10 Descriptive flexfield segment.
262 * @param p_attribute11 Descriptive flexfield segment.
263 * @param p_attribute12 Descriptive flexfield segment.
264 * @param p_attribute13 Descriptive flexfield segment.
265 * @param p_attribute14 Descriptive flexfield segment.
266 * @param p_attribute15 Descriptive flexfield segment.
267 * @param p_attribute16 Descriptive flexfield segment.
268 * @param p_attribute17 Descriptive flexfield segment.
269 * @param p_attribute18 Descriptive flexfield segment.
270 * @param p_attribute19 Descriptive flexfield segment.
271 * @param p_attribute20 Descriptive flexfield segment.
272 * @param p_attribute21 Descriptive flexfield segment.
273 * @param p_attribute22 Descriptive flexfield segment.
274 * @param p_attribute23 Descriptive flexfield segment.
275 * @param p_attribute24 Descriptive flexfield segment.
276 * @param p_attribute25 Descriptive flexfield segment.
277 * @param p_attribute26 Descriptive flexfield segment.
278 * @param p_attribute27 Descriptive flexfield segment.
279 * @param p_attribute28 Descriptive flexfield segment.
280 * @param p_attribute29 Descriptive flexfield segment.
281 * @param p_attribute30 Descriptive flexfield segment.
282 * @param p_scorecard_id Identifies the personal scorecard to which
283 * the objective belongs.
284 * @param p_copied_from_library_id Identifies the library objective from which
285 * this objective is copied.
286 * @param p_copied_from_objective_id Identifies the objective from which this
287 * objective was copied.
288 * @param p_aligned_with_objective_id Identifies the objective to which this objective
289 * is aligned.
290 * @param p_next_review_date Indicates when the objective should next be reviewed.
291 * @param p_group_code Group to which this objective belongs. Valid values are
292 * defined by "HR_WPM_GROUP" lookup type
293 * @param p_priority_code Priority of the objective. Valid values are defined by
294 * "HR_WPM_PRIORITY" lookup type.
295 * @param p_appraise_flag Indicates whether this objective should be appraised.
296 * Valid values are defined by "YES_NO" lookup type
297 * @param p_verified_flag Indicates whether the objective's achievement has been
298 * verified against the measure. Valid values are defined by "YES_NO" lookup type.
299 * @param p_target_value The target measure, either a maximum or minimum target,
300 * depending on the measure type.
301 * @param p_actual_value The actual quantity achieved against the target measure.
302 * @param p_weighting_percent Weighting for this objective, used to score overall
303 * appraisal ratings.
304 * @param p_complete_percent The percentage complete.
305 * @param p_uom_code Determine the measure's unit of measure. Valid values are
306 * defined by "HR_WPM_MEASURE_UOM" lookup type.
307 * @param p_measurement_style_code Measurement style of this objective's measure.
308 * Valid values are defined by "HR_WPM_MEASUREMENT_STYLE" lookup type.
309 * @param p_measure_name The measure by which this objective's completion should be
310 * scored against
311 * @param p_measure_type_code Measure type for this measure to determine whether the target
312 * measure is a minimum or maximum. Valid values are defined by "HR_WPM_MEASURE_TYPE" lookup type
313 * @param p_measure_comments Comments regarding the measure and target.
314 * @param p_sharing_access_code Access permissions on this objective. Valid values
315 * are defined by "HR_WPM_OBJECTIVE_SHARING" lookup type.
316 * @param p_weighting_over_100_warning If set to true, then the combined weighting of
317 * objective in the scorecard is greater than 100%
318 * @param p_weighting_appraisal_warning If set to true, then weighting of this objective
319 * is not marked to be included in the appraisals
320 * @param p_appraisal_id Identifies the appraisal record.
321 * @rep:displayname Update Objective
322 * @rep:category BUSINESS_ENTITY PER_APPRAISAL
323 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
324 * @rep:scope public
325 * @rep:lifecycle active
326 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
327 */
328 --
329 -- {End Of Comments}
330 --
331 procedure update_objective
332 (p_validate in boolean default false,
333 p_effective_date in date,
334 p_objective_id in number,
335 p_object_version_number in out nocopy number,
336 p_name in varchar2 default hr_api.g_varchar2,
337 p_target_date in date default hr_api.g_date,
338 p_start_date in date default hr_api.g_date,
339 p_achievement_date in date default hr_api.g_date,
340 p_detail in varchar2 default hr_api.g_varchar2,
341 p_comments in varchar2 default hr_api.g_varchar2,
342 p_success_criteria in varchar2 default hr_api.g_varchar2,
343 p_attribute_category in varchar2 default hr_api.g_varchar2,
344 p_attribute1 in varchar2 default hr_api.g_varchar2,
345 p_attribute2 in varchar2 default hr_api.g_varchar2,
346 p_attribute3 in varchar2 default hr_api.g_varchar2,
347 p_attribute4 in varchar2 default hr_api.g_varchar2,
348 p_attribute5 in varchar2 default hr_api.g_varchar2,
349 p_attribute6 in varchar2 default hr_api.g_varchar2,
350 p_attribute7 in varchar2 default hr_api.g_varchar2,
351 p_attribute8 in varchar2 default hr_api.g_varchar2,
352 p_attribute9 in varchar2 default hr_api.g_varchar2,
353 p_attribute10 in varchar2 default hr_api.g_varchar2,
354 p_attribute11 in varchar2 default hr_api.g_varchar2,
355 p_attribute12 in varchar2 default hr_api.g_varchar2,
356 p_attribute13 in varchar2 default hr_api.g_varchar2,
357 p_attribute14 in varchar2 default hr_api.g_varchar2,
358 p_attribute15 in varchar2 default hr_api.g_varchar2,
359 p_attribute16 in varchar2 default hr_api.g_varchar2,
360 p_attribute17 in varchar2 default hr_api.g_varchar2,
361 p_attribute18 in varchar2 default hr_api.g_varchar2,
362 p_attribute19 in varchar2 default hr_api.g_varchar2,
363 p_attribute20 in varchar2 default hr_api.g_varchar2,
364
365 p_attribute21 in varchar2 default hr_api.g_varchar2,
366 p_attribute22 in varchar2 default hr_api.g_varchar2,
367 p_attribute23 in varchar2 default hr_api.g_varchar2,
368 p_attribute24 in varchar2 default hr_api.g_varchar2,
369 p_attribute25 in varchar2 default hr_api.g_varchar2,
370 p_attribute26 in varchar2 default hr_api.g_varchar2,
371 p_attribute27 in varchar2 default hr_api.g_varchar2,
372 p_attribute28 in varchar2 default hr_api.g_varchar2,
373 p_attribute29 in varchar2 default hr_api.g_varchar2,
374 p_attribute30 in varchar2 default hr_api.g_varchar2,
375
376 p_scorecard_id in number default hr_api.g_number,
377 p_copied_from_library_id in number default hr_api.g_number,
378 p_copied_from_objective_id in number default hr_api.g_number,
379 p_aligned_with_objective_id in number default hr_api.g_number,
380
381 p_next_review_date in date default hr_api.g_date,
382 p_group_code in varchar2 default hr_api.g_varchar2,
383 p_priority_code in varchar2 default hr_api.g_varchar2,
384 p_appraise_flag in varchar2 default hr_api.g_varchar2,
385 p_verified_flag in varchar2 default hr_api.g_varchar2,
386
387 p_target_value in number default hr_api.g_number,
388 p_actual_value in number default hr_api.g_number,
389 p_weighting_percent in number default hr_api.g_number,
390 p_complete_percent in number default hr_api.g_number,
391 p_uom_code in varchar2 default hr_api.g_varchar2,
392
393 p_measurement_style_code in varchar2 default hr_api.g_varchar2,
394 p_measure_name in varchar2 default hr_api.g_varchar2,
395 p_measure_type_code in varchar2 default hr_api.g_varchar2,
396 p_measure_comments in varchar2 default hr_api.g_varchar2,
397 p_sharing_access_code in varchar2 default hr_api.g_varchar2,
398
399 p_weighting_over_100_warning out nocopy boolean,
400 p_weighting_appraisal_warning out nocopy boolean,
401 p_appraisal_id in number default hr_api.g_number
402
403 );
404 --
405 -- ----------------------------------------------------------------------------
406 -- |-----------------------------< delete_objective >-------------------------|
407 -- ----------------------------------------------------------------------------
408 --
409 -- {Start Of Comments}
410 /*#
411 * This API deletes an existing objective. An objective is a target or
412 * goal which may be evaluated during an appraisal (performance review).
413 * An objective is for a specific person. An objective may change over
414 * time.
415 *
416 * <p><b>Licensing</b><br>
417 * This API is licensed for use with Human Resources.
418 *
419 * <p><b>Prerequisites</b><br>
420 * A valid objective must already exist.
421 *
422 * <p><b>Post Success</b><br>
423 * Objective is deleted.
424 *
425 * <p><b>Post Failure</b><br>
426 * Objective is not deleted and an error is raised.
427 * @param p_validate If true, then validation alone will be performed and the
428 * database will remain unchanged. If false and all validation checks pass,
429 * then the database will be modified.
430 * @param p_objective_id Objective to be deleted. If p_validate is false,
431 * uniquely identifies the objective to be deleted. If p_validate is true, set
432 * to null.
433 * @param p_object_version_number Current version number of the objective to be
434 * deleted.
435 * @rep:displayname Delete Objective
436 * @rep:category BUSINESS_ENTITY PER_APPRAISAL
437 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
438 * @rep:scope public
439 * @rep:lifecycle active
440 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
441 */
442 --
443 -- {End Of Comments}
444 --
445 procedure delete_objective
446 (p_validate in boolean default false,
447 p_objective_id in number,
448 p_object_version_number in number
449 );
450 --
451 end hr_objectives_api;
[Home] [Help]