1 Package hr_personal_scorecard_api AUTHID CURRENT_USER as
2 /* $Header: pepmsapi.pkh 120.7.12020000.3 2012/07/05 03:37:03 amnaraya ship $ */
3 /*#
4 * This package contains personal scorecard APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Personal Scorecard
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |--------------------------< create_scorecard >----------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a personal scorecard for an HR assignment.
17 *
18 * <p><b>Licensing</b><br>
19 * This API is licensed for use with Human Resources.
20 *
21 * <p><b>Prerequisites</b><br>
22 * The performance management plan and HR assignment must already exist.
23 *
24 * <p><b>Post Success</b><br>
25 * The personal scorecard will have been created.
26 *
27 * <p><b>Post Failure</b><br>
28 * The personal scorecard will not be created and an error will be raised.
29 *
30 * @param p_validate If true, then validation alone will be performed and
31 * the database will remain unchanged. If false and all validation checks pass,
32 * then the database will be modified.
33 * @param p_effective_date Reference date for validating lookup values are
34 * applicable during the start to end active date range. This date does not
35 * determine when the changes take effect.
36 * @param p_scorecard_name Name of the scorecard.
37 * @param p_assignment_id Identifies the assignment for which this scorecard belongs.
38 * @param p_start_date Start date of this scorecard.
39 * @param p_end_date End date of this scorecard.
40 * @param p_plan_id Identifies the performance plan that holds this scorecard.
41 * @param p_creator_type Indicates the type of process that created this scorecard
42 * whether an automatic process or manually created.
43 * @param p_attribute_category This context value determines which
44 * flexfield structure to use with the descriptive flexfield segments.
45 * @param p_attribute1 Descriptive flexfield segment.
46 * @param p_attribute2 Descriptive flexfield segment.
47 * @param p_attribute3 Descriptive flexfield segment.
48 * @param p_attribute4 Descriptive flexfield segment.
49 * @param p_attribute5 Descriptive flexfield segment.
50 * @param p_attribute6 Descriptive flexfield segment.
51 * @param p_attribute7 Descriptive flexfield segment.
52 * @param p_attribute8 Descriptive flexfield segment.
53 * @param p_attribute9 Descriptive flexfield segment.
54 * @param p_attribute10 Descriptive flexfield segment.
55 * @param p_attribute11 Descriptive flexfield segment.
56 * @param p_attribute12 Descriptive flexfield segment.
57 * @param p_attribute13 Descriptive flexfield segment.
58 * @param p_attribute14 Descriptive flexfield segment.
59 * @param p_attribute15 Descriptive flexfield segment.
60 * @param p_attribute16 Descriptive flexfield segment.
61 * @param p_attribute17 Descriptive flexfield segment.
62 * @param p_attribute18 Descriptive flexfield segment.
63 * @param p_attribute19 Descriptive flexfield segment.
64 * @param p_attribute20 Descriptive flexfield segment.
65 * @param p_attribute21 Descriptive flexfield segment.
66 * @param p_attribute22 Descriptive flexfield segment.
67 * @param p_attribute23 Descriptive flexfield segment.
68 * @param p_attribute24 Descriptive flexfield segment.
69 * @param p_attribute25 Descriptive flexfield segment.
70 * @param p_attribute26 Descriptive flexfield segment.
71 * @param p_attribute27 Descriptive flexfield segment.
72 * @param p_attribute28 Descriptive flexfield segment.
73 * @param p_attribute29 Descriptive flexfield segment.
74 * @param p_attribute30 Descriptive flexfield segment.
75 * @param p_scorecard_id If p_validate is false, then this uniquely
76 * identifies the personal scorecard created. If p_validate is true, then set to
77 * null.
78 * @param p_object_version_number If p_validate is false, then set to
79 * the version number of the created personal scorecard. If p_validate is true,
80 * then the value will be null.
81 * @param p_status_code Indicates the status of the personal scorecard, valid values
82 * are identified by the lookup type HR_WPM_SCORECARD_STATUS
83 * @param p_duplicate_name_warning If set to true, then the assignment already
84 * has a scorecard with this name.
85 * @param p_obj_setting_deadline Is the objective setting deadline date.
86 * @param p_supervisor_id Person Id of the supervisor.
87 * @param p_supervisor_assignment_id Assignment Id of the supervisor.
88 * @param p_eligibility_status Is the eligibility status of the person for the plan.
89 * @param p_eligibility_eval_date Is the eligibility evaluation date.
90 * @rep:displayname Create Personal Scorecard
91 * @rep:category BUSINESS_ENTITY PER_PERSONAL_SCORECARD
92 * @rep:lifecycle active
93 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
94 * @rep:scope public
95 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
96 */
97 --
98 -- {End Of Comments}
99 --
100 --
101 procedure create_scorecard
102 (p_validate in boolean default false
103 ,p_effective_date in date
104 ,p_scorecard_name in varchar2
105 ,p_assignment_id in number
106 ,p_start_date in date
107 ,p_end_date in date
108 ,p_plan_id in number default null
109 ,p_creator_type in varchar2 default 'MANUAL'
110 ,p_attribute_category in varchar2 default null
111 ,p_attribute1 in varchar2 default null
112 ,p_attribute2 in varchar2 default null
113 ,p_attribute3 in varchar2 default null
114 ,p_attribute4 in varchar2 default null
115 ,p_attribute5 in varchar2 default null
116 ,p_attribute6 in varchar2 default null
117 ,p_attribute7 in varchar2 default null
118 ,p_attribute8 in varchar2 default null
119 ,p_attribute9 in varchar2 default null
120 ,p_attribute10 in varchar2 default null
121 ,p_attribute11 in varchar2 default null
122 ,p_attribute12 in varchar2 default null
123 ,p_attribute13 in varchar2 default null
124 ,p_attribute14 in varchar2 default null
125 ,p_attribute15 in varchar2 default null
126 ,p_attribute16 in varchar2 default null
127 ,p_attribute17 in varchar2 default null
128 ,p_attribute18 in varchar2 default null
129 ,p_attribute19 in varchar2 default null
130 ,p_attribute20 in varchar2 default null
131 ,p_attribute21 in varchar2 default null
132 ,p_attribute22 in varchar2 default null
133 ,p_attribute23 in varchar2 default null
134 ,p_attribute24 in varchar2 default null
135 ,p_attribute25 in varchar2 default null
136 ,p_attribute26 in varchar2 default null
137 ,p_attribute27 in varchar2 default null
138 ,p_attribute28 in varchar2 default null
139 ,p_attribute29 in varchar2 default null
140 ,p_attribute30 in varchar2 default null
141 ,p_scorecard_id out nocopy number
142 ,p_object_version_number out nocopy number
143 ,p_status_code in varchar2
144 ,p_duplicate_name_warning out nocopy boolean
145 ,p_obj_setting_deadline in date default null
146 ,p_supervisor_id in number default null
147 ,p_supervisor_assignment_id in number default null
148 ,p_eligibility_status in varchar2 default null
149 ,p_eligibility_eval_date in date default null
150 );
151 --
152 -- ----------------------------------------------------------------------------
153 -- |--------------------------< update_scorecard >----------------------------|
154 -- ----------------------------------------------------------------------------
155 --
156 -- {Start Of Comments}
157 /*#
158 * This API updates a personal scorecard for an HR assignment.
159 *
160 * <p><b>Licensing</b><br>
161 * This API is licensed for use with Human Resources.
162 *
163 * <p><b>Prerequisites</b><br>
164 * The personal scorecard must exist.
165 *
166 * <p><b>Post Success</b><br>
167 * The personal scorecard will have been updated.
168 *
169 * <p><b>Post Failure</b><br>
170 * The personal scorecard will not be updated and an error will be raised.
171 *
172 * @param p_validate If true, then validation alone will be performed and
173 * the database will remain unchanged. If false and all validation checks pass,
174 * then the database will be modified.
175 * @param p_effective_date Reference date for validating lookup values are
176 * applicable during the start to end active date range. This date does not
177 * determine when the changes take effect.
178 * @param p_scorecard_id Identifies the personal scorecard to be modified.
179 * @param p_object_version_number Pass in the current version number of
180 * the personal scorecard to be updated. When the API completes if p_validate is
181 * false, will be set to the new version number of the updated personal
185 * @param p_start_date Start date of this scorecard.
182 * scorecard. If p_validate is true will be set to the same value which was
183 * passed in.
184 * @param p_scorecard_name Name of the scorecard..
186 * @param p_end_date End date of this scorecard.
187 * @param p_plan_id Identifies the performance plan that holds this scorecard.
188 * @param p_attribute_category This context value determines which
189 * flexfield structure to use with the descriptive flexfield segments.
190 * @param p_attribute1 Descriptive flexfield segment.
191 * @param p_attribute2 Descriptive flexfield segment.
192 * @param p_attribute3 Descriptive flexfield segment.
193 * @param p_attribute4 Descriptive flexfield segment.
194 * @param p_attribute5 Descriptive flexfield segment.
195 * @param p_attribute6 Descriptive flexfield segment.
196 * @param p_attribute7 Descriptive flexfield segment.
197 * @param p_attribute8 Descriptive flexfield segment.
198 * @param p_attribute9 Descriptive flexfield segment.
199 * @param p_attribute10 Descriptive flexfield segment.
200 * @param p_attribute11 Descriptive flexfield segment.
201 * @param p_attribute12 Descriptive flexfield segment.
202 * @param p_attribute13 Descriptive flexfield segment.
203 * @param p_attribute14 Descriptive flexfield segment.
204 * @param p_attribute15 Descriptive flexfield segment.
205 * @param p_attribute16 Descriptive flexfield segment.
206 * @param p_attribute17 Descriptive flexfield segment.
207 * @param p_attribute18 Descriptive flexfield segment.
208 * @param p_attribute19 Descriptive flexfield segment.
209 * @param p_attribute20 Descriptive flexfield segment.
210 * @param p_attribute21 Descriptive flexfield segment.
211 * @param p_attribute22 Descriptive flexfield segment.
212 * @param p_attribute23 Descriptive flexfield segment.
213 * @param p_attribute24 Descriptive flexfield segment.
214 * @param p_attribute25 Descriptive flexfield segment.
215 * @param p_attribute26 Descriptive flexfield segment.
216 * @param p_attribute27 Descriptive flexfield segment.
217 * @param p_attribute28 Descriptive flexfield segment.
218 * @param p_attribute29 Descriptive flexfield segment.
219 * @param p_attribute30 Descriptive flexfield segment.
220 * @param p_status_code Indicates the status of the personal scorecard, valid values
221 * are identified by the lookup type HR_WPM_SCORECARD_STATUS
222 * @param p_duplicate_name_warning If set to true, then the assignment already
223 * has a scorecard with this name.
224 * @param p_obj_setting_deadline Is the objective setting deadline date.
225 * @param p_supervisor_id Person Id of the supervisor.
226 * @param p_supervisor_assignment_id Assignment Id of the supervisor.
227 * @param p_eligibility_status Is the eligibility status of the person for the plan.
228 * @param p_eligibility_eval_date Is the eligibility evaluation date.
229 * @rep:displayname Update Personal Scorecard
230 * @rep:category BUSINESS_ENTITY PER_PERSONAL_SCORECARD
231 * @rep:lifecycle active
232 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
233 * @rep:scope public
234 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
235 */
236 --
237 -- {End Of Comments}
238 --
239 --
240 procedure update_scorecard
241 (p_validate in boolean default false
242 ,p_effective_date in date
243 ,p_scorecard_id in number
244 ,p_object_version_number in out nocopy number
245 ,p_scorecard_name in varchar2 default hr_api.g_varchar2
246 ,p_start_date in date default hr_api.g_date
247 ,p_end_date in date default hr_api.g_date
248 ,p_plan_id in number default hr_api.g_number
249 ,p_attribute_category in varchar2 default hr_api.g_varchar2
250 ,p_attribute1 in varchar2 default hr_api.g_varchar2
251 ,p_attribute2 in varchar2 default hr_api.g_varchar2
252 ,p_attribute3 in varchar2 default hr_api.g_varchar2
253 ,p_attribute4 in varchar2 default hr_api.g_varchar2
254 ,p_attribute5 in varchar2 default hr_api.g_varchar2
255 ,p_attribute6 in varchar2 default hr_api.g_varchar2
256 ,p_attribute7 in varchar2 default hr_api.g_varchar2
257 ,p_attribute8 in varchar2 default hr_api.g_varchar2
258 ,p_attribute9 in varchar2 default hr_api.g_varchar2
259 ,p_attribute10 in varchar2 default hr_api.g_varchar2
260 ,p_attribute11 in varchar2 default hr_api.g_varchar2
261 ,p_attribute12 in varchar2 default hr_api.g_varchar2
262 ,p_attribute13 in varchar2 default hr_api.g_varchar2
263 ,p_attribute14 in varchar2 default hr_api.g_varchar2
264 ,p_attribute15 in varchar2 default hr_api.g_varchar2
265 ,p_attribute16 in varchar2 default hr_api.g_varchar2
266 ,p_attribute17 in varchar2 default hr_api.g_varchar2
267 ,p_attribute18 in varchar2 default hr_api.g_varchar2
268 ,p_attribute19 in varchar2 default hr_api.g_varchar2
269 ,p_attribute20 in varchar2 default hr_api.g_varchar2
270 ,p_attribute21 in varchar2 default hr_api.g_varchar2
271 ,p_attribute22 in varchar2 default hr_api.g_varchar2
272 ,p_attribute23 in varchar2 default hr_api.g_varchar2
273 ,p_attribute24 in varchar2 default hr_api.g_varchar2
274 ,p_attribute25 in varchar2 default hr_api.g_varchar2
275 ,p_attribute26 in varchar2 default hr_api.g_varchar2
276 ,p_attribute27 in varchar2 default hr_api.g_varchar2
277 ,p_attribute28 in varchar2 default hr_api.g_varchar2
278 ,p_attribute29 in varchar2 default hr_api.g_varchar2
279 ,p_attribute30 in varchar2 default hr_api.g_varchar2
280 ,p_status_code in varchar2 default hr_api.g_varchar2
281 ,p_duplicate_name_warning out nocopy boolean
282 ,p_obj_setting_deadline in date default hr_api.g_date
283 ,p_supervisor_id in number default hr_api.g_number
284 ,p_supervisor_assignment_id in number default hr_api.g_number
285 ,p_eligibility_status in varchar2 default hr_api.g_varchar2
286 ,p_eligibility_eval_date in date default hr_api.g_date
287 );
288 --
289 -- ----------------------------------------------------------------------------
290 -- |--------------------------< update_scorecard_status >---------------------|
291 -- ----------------------------------------------------------------------------
292 --
293 -- {Start Of Comments}
294 /*#
295 * This API updates the status of a personal scorecard.
296 *
297 * <p><b>Licensing</b><br>
298 * This API is licensed for use with Human Resources.
299 *
300 * <p><b>Prerequisites</b><br>
301 * The personal scorecard must exist.
302 *
303 * <p><b>Post Success</b><br>
304 * The personal scorecard's status will have been updated.
305 *
306 * <p><b>Post Failure</b><br>
307 * The personal scorecard's status will not be updated and an error will be
308 * raised.
309 *
310 * @param p_validate If true, then validation alone will be performed and
311 * the database will remain unchanged. If false and all validation checks pass,
312 * then the database will be modified.
313 * @param p_effective_date Reference date for validating lookup values are
314 * applicable during the start to end active date range. This date does not
315 * determine when the changes take effect.
316 * @param p_scorecard_id Identifies the personal scorecard to be modified.
317 * @param p_object_version_number Pass in the current version number of
318 * the personal scorecard to be updated. When the API completes if p_validate is
319 * false, will be set to the new version number of the updated personal
320 * scorecard. If p_validate is true will be set to the same value which was
321 * passed in.
322 * @param p_status_code Indicates the status of the personal scorecard, valid values
323 * are identified by the lookup type HR_WPM_SCORECARD_STATUS.
324 * @rep:displayname Update Personal Scorecard Status
325 * @rep:category BUSINESS_ENTITY PER_PERSONAL_SCORECARD
326 * @rep:lifecycle active
327 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
328 * @rep:scope public
329 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
330 */
331 --
332 -- {End Of Comments}
333 --
334 --
335 procedure update_scorecard_status
336 (p_validate in boolean default false
337 ,p_effective_date in date
338 ,p_scorecard_id in number
339 ,p_object_version_number in out nocopy number
340 ,p_status_code in varchar2
341 );
342 --
343 -- ----------------------------------------------------------------------------
344 -- |--------------------------< delete_scorecard >----------------------------|
345 -- ----------------------------------------------------------------------------
346 --
347 -- {Start Of Comments}
348 /*#
349 * This API deletes a personal scorecard for an HR assignment.
350 *
351 * <p><b>Licensing</b><br>
352 * This API is licensed for use with Human Resources.
353 *
354 * <p><b>Prerequisites</b><br>
355 * The personal scorecard must exist.
356 *
357 * <p><b>Post Success</b><br>
358 * The personal scorecard will have been deleted.
359 *
360 * <p><b>Post Failure</b><br>
361 * The personal scorecard will not be deleted and an error will be raised.
362 *
363 * @param p_validate If true, then validation alone will be performed and
364 * the database will remain unchanged. If false and all validation checks pass,
365 * then the database will be modified.
366 * @param p_scorecard_id Identifies the personal scorecard to be deleted.
367 * @param p_object_version_number Current version number of the personal
368 * scorecard to be deleted.
369 * @param p_created_by_plan_warning If set to true, then identifies that this
370 * scorecard was created automatically during plan publication.
371 * @rep:displayname Delete Personal Scorecard
372 * @rep:category BUSINESS_ENTITY PER_PERSONAL_SCORECARD
373 * @rep:lifecycle active
374 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
375 * @rep:scope public
376 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
377 */
378 --
379 -- {End Of Comments}
380 --
381 procedure delete_scorecard
382 (p_validate in boolean default false
383 ,p_scorecard_id in number
384 ,p_object_version_number in number
385 ,p_created_by_plan_warning out nocopy boolean
386 );
387 --
388 end hr_personal_scorecard_api;
[Home] [Help]