1 Package hr_personal_scorecard_api as
2 /* $Header: pepmsapi.pkh 120.5 2006/10/24 15:51:09 tpapired noship $ */
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 * @rep:displayname Create Personal Scorecard
86 * @rep:category BUSINESS_ENTITY PER_PERSONAL_SCORECARD
87 * @rep:lifecycle active
88 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
89 * @rep:scope public
90 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
91 */
92 --
93 -- {End Of Comments}
94 --
95 --
96 procedure create_scorecard
97 (p_validate in boolean default false
98 ,p_effective_date in date
99 ,p_scorecard_name in varchar2
100 ,p_assignment_id in number
101 ,p_start_date in date
102 ,p_end_date in date
103 ,p_plan_id in number default null
104 ,p_creator_type in varchar2 default 'MANUAL'
105 ,p_attribute_category in varchar2 default null
106 ,p_attribute1 in varchar2 default null
107 ,p_attribute2 in varchar2 default null
108 ,p_attribute3 in varchar2 default null
109 ,p_attribute4 in varchar2 default null
110 ,p_attribute5 in varchar2 default null
111 ,p_attribute6 in varchar2 default null
112 ,p_attribute7 in varchar2 default null
113 ,p_attribute8 in varchar2 default null
114 ,p_attribute9 in varchar2 default null
115 ,p_attribute10 in varchar2 default null
116 ,p_attribute11 in varchar2 default null
117 ,p_attribute12 in varchar2 default null
118 ,p_attribute13 in varchar2 default null
119 ,p_attribute14 in varchar2 default null
120 ,p_attribute15 in varchar2 default null
121 ,p_attribute16 in varchar2 default null
122 ,p_attribute17 in varchar2 default null
123 ,p_attribute18 in varchar2 default null
124 ,p_attribute19 in varchar2 default null
125 ,p_attribute20 in varchar2 default null
126 ,p_attribute21 in varchar2 default null
127 ,p_attribute22 in varchar2 default null
128 ,p_attribute23 in varchar2 default null
129 ,p_attribute24 in varchar2 default null
130 ,p_attribute25 in varchar2 default null
131 ,p_attribute26 in varchar2 default null
132 ,p_attribute27 in varchar2 default null
133 ,p_attribute28 in varchar2 default null
134 ,p_attribute29 in varchar2 default null
135 ,p_attribute30 in varchar2 default null
136 ,p_scorecard_id out nocopy number
137 ,p_object_version_number out nocopy number
138 ,p_status_code in varchar2
139 ,p_duplicate_name_warning out nocopy boolean
140 );
141 --
142 -- ----------------------------------------------------------------------------
143 -- |--------------------------< update_scorecard >----------------------------|
144 -- ----------------------------------------------------------------------------
145 --
146 -- {Start Of Comments}
147 /*#
148 * This API updates a personal scorecard for an HR assignment.
149 *
150 * <p><b>Licensing</b><br>
151 * This API is licensed for use with Human Resources.
152 *
153 * <p><b>Prerequisites</b><br>
154 * The personal scorecard must exist.
155 *
156 * <p><b>Post Success</b><br>
157 * The personal scorecard will have been updated.
158 *
159 * <p><b>Post Failure</b><br>
160 * The personal scorecard will not be updated and an error will be raised.
161 *
162 * @param p_validate If true, then validation alone will be performed and
163 * the database will remain unchanged. If false and all validation checks pass,
164 * then the database will be modified.
165 * @param p_effective_date Reference date for validating lookup values are
166 * applicable during the start to end active date range. This date does not
167 * determine when the changes take effect.
168 * @param p_scorecard_id Identifies the personal scorecard to be modified.
169 * @param p_object_version_number Pass in the current version number of
170 * the personal scorecard to be updated. When the API completes if p_validate is
171 * false, will be set to the new version number of the updated personal
172 * scorecard. If p_validate is true will be set to the same value which was
173 * passed in.
174 * @param p_scorecard_name Name of the scorecard..
175 * @param p_start_date Start date of this scorecard.
176 * @param p_end_date End date of this scorecard.
177 * @param p_plan_id Identifies the performance plan that holds this scorecard.
178 * @param p_attribute_category This context value determines which
179 * flexfield structure to use with the descriptive flexfield segments.
180 * @param p_attribute1 Descriptive flexfield segment.
181 * @param p_attribute2 Descriptive flexfield segment.
182 * @param p_attribute3 Descriptive flexfield segment.
183 * @param p_attribute4 Descriptive flexfield segment.
184 * @param p_attribute5 Descriptive flexfield segment.
185 * @param p_attribute6 Descriptive flexfield segment.
186 * @param p_attribute7 Descriptive flexfield segment.
187 * @param p_attribute8 Descriptive flexfield segment.
188 * @param p_attribute9 Descriptive flexfield segment.
189 * @param p_attribute10 Descriptive flexfield segment.
190 * @param p_attribute11 Descriptive flexfield segment.
191 * @param p_attribute12 Descriptive flexfield segment.
192 * @param p_attribute13 Descriptive flexfield segment.
193 * @param p_attribute14 Descriptive flexfield segment.
194 * @param p_attribute15 Descriptive flexfield segment.
195 * @param p_attribute16 Descriptive flexfield segment.
196 * @param p_attribute17 Descriptive flexfield segment.
197 * @param p_attribute18 Descriptive flexfield segment.
198 * @param p_attribute19 Descriptive flexfield segment.
199 * @param p_attribute20 Descriptive flexfield segment.
200 * @param p_attribute21 Descriptive flexfield segment.
201 * @param p_attribute22 Descriptive flexfield segment.
202 * @param p_attribute23 Descriptive flexfield segment.
203 * @param p_attribute24 Descriptive flexfield segment.
204 * @param p_attribute25 Descriptive flexfield segment.
205 * @param p_attribute26 Descriptive flexfield segment.
206 * @param p_attribute27 Descriptive flexfield segment.
207 * @param p_attribute28 Descriptive flexfield segment.
208 * @param p_attribute29 Descriptive flexfield segment.
209 * @param p_attribute30 Descriptive flexfield segment.
210 * @param p_status_code Indicates the status of the personal scorecard, valid values
211 * are identified by the lookup type HR_WPM_SCORECARD_STATUS
212 * @param p_duplicate_name_warning If set to true, then the assignment already
213 * has a scorecard with this name.
214 * @rep:displayname Update Personal Scorecard
215 * @rep:category BUSINESS_ENTITY PER_PERSONAL_SCORECARD
216 * @rep:lifecycle active
217 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
218 * @rep:scope public
219 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
220 */
221 --
222 -- {End Of Comments}
223 --
224 --
225 procedure update_scorecard
226 (p_validate in boolean default false
227 ,p_effective_date in date
228 ,p_scorecard_id in number
229 ,p_object_version_number in out nocopy number
230 ,p_scorecard_name in varchar2 default hr_api.g_varchar2
231 ,p_start_date in date default hr_api.g_date
232 ,p_end_date in date default hr_api.g_date
233 ,p_plan_id in number default hr_api.g_number
234 ,p_attribute_category in varchar2 default hr_api.g_varchar2
235 ,p_attribute1 in varchar2 default hr_api.g_varchar2
236 ,p_attribute2 in varchar2 default hr_api.g_varchar2
240 ,p_attribute6 in varchar2 default hr_api.g_varchar2
237 ,p_attribute3 in varchar2 default hr_api.g_varchar2
238 ,p_attribute4 in varchar2 default hr_api.g_varchar2
239 ,p_attribute5 in varchar2 default hr_api.g_varchar2
241 ,p_attribute7 in varchar2 default hr_api.g_varchar2
242 ,p_attribute8 in varchar2 default hr_api.g_varchar2
243 ,p_attribute9 in varchar2 default hr_api.g_varchar2
244 ,p_attribute10 in varchar2 default hr_api.g_varchar2
245 ,p_attribute11 in varchar2 default hr_api.g_varchar2
246 ,p_attribute12 in varchar2 default hr_api.g_varchar2
247 ,p_attribute13 in varchar2 default hr_api.g_varchar2
248 ,p_attribute14 in varchar2 default hr_api.g_varchar2
249 ,p_attribute15 in varchar2 default hr_api.g_varchar2
250 ,p_attribute16 in varchar2 default hr_api.g_varchar2
251 ,p_attribute17 in varchar2 default hr_api.g_varchar2
255 ,p_attribute21 in varchar2 default hr_api.g_varchar2
252 ,p_attribute18 in varchar2 default hr_api.g_varchar2
253 ,p_attribute19 in varchar2 default hr_api.g_varchar2
254 ,p_attribute20 in varchar2 default hr_api.g_varchar2
256 ,p_attribute22 in varchar2 default hr_api.g_varchar2
257 ,p_attribute23 in varchar2 default hr_api.g_varchar2
258 ,p_attribute24 in varchar2 default hr_api.g_varchar2
259 ,p_attribute25 in varchar2 default hr_api.g_varchar2
260 ,p_attribute26 in varchar2 default hr_api.g_varchar2
261 ,p_attribute27 in varchar2 default hr_api.g_varchar2
262 ,p_attribute28 in varchar2 default hr_api.g_varchar2
263 ,p_attribute29 in varchar2 default hr_api.g_varchar2
264 ,p_attribute30 in varchar2 default hr_api.g_varchar2
265 ,p_status_code in varchar2 default hr_api.g_varchar2
266 ,p_duplicate_name_warning out nocopy boolean
267 );
268 --
269 -- ----------------------------------------------------------------------------
270 -- |--------------------------< update_scorecard_status >---------------------|
274 /*#
271 -- ----------------------------------------------------------------------------
272 --
273 -- {Start Of Comments}
275 * This API updates the status of a personal scorecard.
276 *
277 * <p><b>Licensing</b><br>
278 * This API is licensed for use with Human Resources.
279 *
280 * <p><b>Prerequisites</b><br>
281 * The personal scorecard must exist.
282 *
283 * <p><b>Post Success</b><br>
284 * The personal scorecard's status will have been updated.
285 *
286 * <p><b>Post Failure</b><br>
287 * The personal scorecard's status will not be updated and an error will be
288 * raised.
289 *
290 * @param p_validate If true, then validation alone will be performed and
291 * the database will remain unchanged. If false and all validation checks pass,
292 * then the database will be modified.
293 * @param p_effective_date Reference date for validating lookup values are
294 * applicable during the start to end active date range. This date does not
295 * determine when the changes take effect.
296 * @param p_scorecard_id Identifies the personal scorecard to be modified.
297 * @param p_object_version_number Pass in the current version number of
298 * the personal scorecard to be updated. When the API completes if p_validate is
299 * false, will be set to the new version number of the updated personal
300 * scorecard. If p_validate is true will be set to the same value which was
301 * passed in.
302 * @param p_status_code Indicates the status of the personal scorecard, valid values
303 * are identified by the lookup type HR_WPM_SCORECARD_STATUS.
304 * @rep:displayname Update Personal Scorecard Status
305 * @rep:category BUSINESS_ENTITY PER_PERSONAL_SCORECARD
306 * @rep:lifecycle active
307 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
308 * @rep:scope public
309 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
310 */
311 --
312 -- {End Of Comments}
313 --
314 --
315 procedure update_scorecard_status
316 (p_validate in boolean default false
317 ,p_effective_date in date
318 ,p_scorecard_id in number
319 ,p_object_version_number in out nocopy number
320 ,p_status_code in varchar2
321 );
322 --
323 -- ----------------------------------------------------------------------------
324 -- |--------------------------< delete_scorecard >----------------------------|
325 -- ----------------------------------------------------------------------------
326 --
327 -- {Start Of Comments}
328 /*#
329 * This API deletes a personal scorecard for an HR assignment.
330 *
331 * <p><b>Licensing</b><br>
332 * This API is licensed for use with Human Resources.
333 *
334 * <p><b>Prerequisites</b><br>
335 * The personal scorecard must exist.
336 *
337 * <p><b>Post Success</b><br>
338 * The personal scorecard will have been deleted.
339 *
340 * <p><b>Post Failure</b><br>
341 * The personal scorecard will not be deleted and an error will be raised.
342 *
343 * @param p_validate If true, then validation alone will be performed and
344 * the database will remain unchanged. If false and all validation checks pass,
345 * then the database will be modified.
346 * @param p_scorecard_id Identifies the personal scorecard to be deleted.
347 * @param p_object_version_number Current version number of the personal
348 * scorecard to be deleted.
349 * @param p_created_by_plan_warning If set to true, then identifies that this
350 * scorecard was created automatically during plan publication.
351 * @rep:displayname Delete Personal Scorecard
352 * @rep:category BUSINESS_ENTITY PER_PERSONAL_SCORECARD
353 * @rep:lifecycle active
354 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
355 * @rep:scope public
356 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
357 */
358 --
359 -- {End Of Comments}
360 --
361 procedure delete_scorecard
362 (p_validate in boolean default false
363 ,p_scorecard_id in number
364 ,p_object_version_number in number
365 ,p_created_by_plan_warning out nocopy boolean
366 );
367 --
368 end hr_personal_scorecard_api;
[Home] [Help]