1 Package hr_appraisal_period_api as
2 /* $Header: pepmaapi.pkh 120.7 2006/10/24 16:08:24 tpapired noship $ */
3 /*#
4 * This package contains appraisal period APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Appraisal Period
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-------------------------< create_appraisal_period >----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API defines an appraisal period for a performance management plan.
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 the appraisal template must exist.
23 *
24 * <p><b>Post Success</b><br>
25 * The appraisal period will have been created, and the status of the
26 * performance management plan will have been changed to Updated if its
27 * status was previously Published.
28 *
29 * <p><b>Post Failure</b><br>
30 * The appraisal period will not be created and an error will be raised.
31 *
32 * @param p_validate If true, then validation alone will be performed and
33 * the database will remain unchanged. If false and all validation checks pass,
34 * then the database will be modified.
35 * @param p_effective_date Reference date for validating lookup values are
36 * applicable during the start to end active date range. This date does not
37 * determine when the changes take effect.
38 * @param p_plan_id Identifies the performance plan for which this appraisal
39 * period belongs.
40 * @param p_appraisal_template_id Identifies the appraisal template to use.
41 * @param p_start_date Start date of this appraisal period.
42 * @param p_end_date Start date of this appraisal period.
43 * @param p_task_start_date Task start date for this appraisal period.
44 * @param p_task_end_date Task end date for this appraisal period.
45 * @param p_initiator_code Identifies the initiator of this appraisal period.
46 * Valid values are identified by HR_WPM_INITIATOR lookup type.
47 * @param p_appraisal_system_type Identifies appraisal system type of this appraisal period.
48 * Valid values are identified by APPRAISAL_SYSTEM_TYPE lookup type.
49 * @param p_appraisal_type Identifies appraisasl purpose of this appraisal period.
50 * Valid values are identified by APPRAISAL_TYPE lookup type.
51 * @param p_appraisal_assmt_status Identifies appraisal assessment status for this appraisal period.
52 * Valid values are identified by APPRAISAL_ASSESSMENT_STATUS lookup type.
53 * @param p_auto_conc_process Identifies whether mass appraisal creation concurrent
54 * process has to start automatically. Valid values are identified by YES_NO lookup type.
55 * @param p_days_before_task_st_dt Identifies number of days before task start date, to
56 * calculate the date on which the mass appraisal creation concurrent process has to run.
57 * @param p_attribute_category This context value determines which
58 * flexfield structure to use with the descriptive flexfield segments.
59 * @param p_attribute1 Descriptive flexfield segment.
60 * @param p_attribute2 Descriptive flexfield segment.
61 * @param p_attribute3 Descriptive flexfield segment.
62 * @param p_attribute4 Descriptive flexfield segment.
63 * @param p_attribute5 Descriptive flexfield segment.
64 * @param p_attribute6 Descriptive flexfield segment.
65 * @param p_attribute7 Descriptive flexfield segment.
66 * @param p_attribute8 Descriptive flexfield segment.
67 * @param p_attribute9 Descriptive flexfield segment.
68 * @param p_attribute10 Descriptive flexfield segment.
69 * @param p_attribute11 Descriptive flexfield segment.
70 * @param p_attribute12 Descriptive flexfield segment.
71 * @param p_attribute13 Descriptive flexfield segment.
72 * @param p_attribute14 Descriptive flexfield segment.
73 * @param p_attribute15 Descriptive flexfield segment.
74 * @param p_attribute16 Descriptive flexfield segment.
75 * @param p_attribute17 Descriptive flexfield segment.
76 * @param p_attribute18 Descriptive flexfield segment.
77 * @param p_attribute19 Descriptive flexfield segment.
78 * @param p_attribute20 Descriptive flexfield segment.
79 * @param p_attribute21 Descriptive flexfield segment.
80 * @param p_attribute22 Descriptive flexfield segment.
81 * @param p_attribute23 Descriptive flexfield segment.
82 * @param p_attribute24 Descriptive flexfield segment.
83 * @param p_attribute25 Descriptive flexfield segment.
84 * @param p_attribute26 Descriptive flexfield segment.
85 * @param p_attribute27 Descriptive flexfield segment.
86 * @param p_attribute28 Descriptive flexfield segment.
87 * @param p_attribute29 Descriptive flexfield segment.
88 * @param p_attribute30 Descriptive flexfield segment.
89 * @param p_appraisal_period_id If p_validate is false, then this uniquely
90 * identifies the appraisal period created. If p_validate is true, then set to
91 * null.
92 * @param p_object_version_number If p_validate is false, then set to
93 * the version number of the created appraisal period. If p_validate is true,
94 * then the value will be null.
95 * @rep:displayname Create Appraisal Period
96 * @rep:category BUSINESS_ENTITY PER_APPRAISAL_PERIOD
97 * @rep:lifecycle active
98 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
99 * @rep:scope public
100 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
101 */
102 --
103 -- {End Of Comments}
104 --
105 --
106 procedure create_appraisal_period
107 (p_validate in boolean default false
108 ,p_effective_date in date
109 ,p_plan_id in number
110 ,p_appraisal_template_id in number
111 ,p_start_date in date
112 ,p_end_date in date
113 ,p_task_start_date in date
114 ,p_task_end_date in date
115 ,p_initiator_code in varchar2 default null
116 ,p_appraisal_system_type in varchar2 default null
117 ,p_appraisal_type in varchar2 default null
118 ,p_appraisal_assmt_status in varchar2 default null
119 ,p_auto_conc_process in varchar2 default null
120 ,p_days_before_task_st_dt in number default null
121 ,p_attribute_category in varchar2 default null
122 ,p_attribute1 in varchar2 default null
123 ,p_attribute2 in varchar2 default null
124 ,p_attribute3 in varchar2 default null
125 ,p_attribute4 in varchar2 default null
126 ,p_attribute5 in varchar2 default null
127 ,p_attribute6 in varchar2 default null
128 ,p_attribute7 in varchar2 default null
129 ,p_attribute8 in varchar2 default null
130 ,p_attribute9 in varchar2 default null
131 ,p_attribute10 in varchar2 default null
132 ,p_attribute11 in varchar2 default null
133 ,p_attribute12 in varchar2 default null
134 ,p_attribute13 in varchar2 default null
135 ,p_attribute14 in varchar2 default null
136 ,p_attribute15 in varchar2 default null
137 ,p_attribute16 in varchar2 default null
138 ,p_attribute17 in varchar2 default null
139 ,p_attribute18 in varchar2 default null
140 ,p_attribute19 in varchar2 default null
141 ,p_attribute20 in varchar2 default null
142 ,p_attribute21 in varchar2 default null
143 ,p_attribute22 in varchar2 default null
144 ,p_attribute23 in varchar2 default null
145 ,p_attribute24 in varchar2 default null
146 ,p_attribute25 in varchar2 default null
147 ,p_attribute26 in varchar2 default null
148 ,p_attribute27 in varchar2 default null
149 ,p_attribute28 in varchar2 default null
150 ,p_attribute29 in varchar2 default null
151 ,p_attribute30 in varchar2 default null
152 ,p_appraisal_period_id out nocopy number
153 ,p_object_version_number out nocopy number
154 );
155 --
156 -- ----------------------------------------------------------------------------
157 -- |-------------------------< update_appraisal_period >----------------------|
158 -- ----------------------------------------------------------------------------
159 --
160 -- {Start Of Comments}
161 /*#
162 * This API updates an appraisal period for a performance management plan.
163 *
164 *
165 * <p><b>Licensing</b><br>
166 * This API is licensed for use with Human Resources.
167 *
168 * <p><b>Prerequisites</b><br>
169 * The appraisal period must exist.
170 *
171 * <p><b>Post Success</b><br>
172 * The appraisal period will have been updated, and the status of the
173 * performance management plan will have been changed to Updated if its
174 * status was previously Published.
175 *
176 * <p><b>Post Failure</b><br>
177 * The appraisal period will not be updated and an error will be raised.
178 *
179 * @param p_validate If true, then validation alone will be performed and
180 * the database will remain unchanged. If false and all validation checks pass,
181 * then the database will be modified.
182 * @param p_effective_date Reference date for validating lookup values are
183 * applicable during the start to end active date range. This date does not
184 * determine when the changes take effect.
185 * @param p_appraisal_period_id Identifies the appraisal period to be
186 * modified.
187 * @param p_object_version_number Pass in the current version number of
188 * the appraisal period to be updated. When the API completes if p_validate is
189 * false, will be set to the new version number of the updated appraisal
190 * period. If p_validate is true will be set to the same value which was
191 * passed in.
192 * @param p_start_date Start date of this appraisal period.
193 * @param p_end_date Start date of this appraisal period.
194 * @param p_task_start_date Task start date for this appraisal period.
195 * @param p_task_end_date Task end date for this appraisal period.
196 * @param p_initiator_code Identifies the initiator of this appraisal period.
197 * Valid values are identified by HR_WPM_INITIATOR lookup type.
198 * @param p_appraisal_system_type Identifies appraisal system type of this appraisal period.
199 * Valid values are identified by APPRAISAL_SYSTEM_TYPE lookup type.
200 * @param p_appraisal_type Identifies appraisasl purpose of this appraisal period.
201 * Valid values are identified by APPRAISAL_TYPE lookup type.
202 * @param p_appraisal_assmt_status Identifies appraisal assessment status for this appraisal period.
203 * Valid values are identified by APPRAISAL_ASSESSMENT_STATUS lookup type.
204 * @param p_auto_conc_process Identifies whether mass appraisal creation concurrent
205 * process has to start automatically. Valid values are identified by YES_NO lookup type.
206 * @param p_days_before_task_st_dt Identifies number of days before task start date, to
207 * calculate the date on which the mass appraisal creation concurrent process has to run.
208 * @param p_attribute_category This context value determines which
209 * flexfield structure to use with the descriptive flexfield segments.
210 * @param p_attribute1 Descriptive flexfield segment.
211 * @param p_attribute2 Descriptive flexfield segment.
212 * @param p_attribute3 Descriptive flexfield segment.
213 * @param p_attribute4 Descriptive flexfield segment.
214 * @param p_attribute5 Descriptive flexfield segment.
215 * @param p_attribute6 Descriptive flexfield segment.
216 * @param p_attribute7 Descriptive flexfield segment.
217 * @param p_attribute8 Descriptive flexfield segment.
218 * @param p_attribute9 Descriptive flexfield segment.
219 * @param p_attribute10 Descriptive flexfield segment.
220 * @param p_attribute11 Descriptive flexfield segment.
221 * @param p_attribute12 Descriptive flexfield segment.
222 * @param p_attribute13 Descriptive flexfield segment.
223 * @param p_attribute14 Descriptive flexfield segment.
224 * @param p_attribute15 Descriptive flexfield segment.
225 * @param p_attribute16 Descriptive flexfield segment.
226 * @param p_attribute17 Descriptive flexfield segment.
227 * @param p_attribute18 Descriptive flexfield segment.
228 * @param p_attribute19 Descriptive flexfield segment.
229 * @param p_attribute20 Descriptive flexfield segment.
230 * @param p_attribute21 Descriptive flexfield segment.
231 * @param p_attribute22 Descriptive flexfield segment.
232 * @param p_attribute23 Descriptive flexfield segment.
233 * @param p_attribute24 Descriptive flexfield segment.
234 * @param p_attribute25 Descriptive flexfield segment.
235 * @param p_attribute26 Descriptive flexfield segment.
236 * @param p_attribute27 Descriptive flexfield segment.
237 * @param p_attribute28 Descriptive flexfield segment.
238 * @param p_attribute29 Descriptive flexfield segment.
239 * @param p_attribute30 Descriptive flexfield segment.
240 * @rep:displayname Update Appraisal Period
241 * @rep:category BUSINESS_ENTITY PER_APPRAISAL_PERIOD
242 * @rep:lifecycle active
243 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
244 * @rep:scope public
245 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
246 */
247 --
248 -- {End Of Comments}
249 --
250 --
251 procedure update_appraisal_period
252 (p_validate in boolean default false
253 ,p_effective_date in date
254 ,p_appraisal_period_id in number
255 ,p_object_version_number in out nocopy number
256 ,p_start_date in date default hr_api.g_date
257 ,p_end_date in date default hr_api.g_date
258 ,p_task_start_date in date default hr_api.g_date
259 ,p_task_end_date in date default hr_api.g_date
260 ,p_initiator_code in varchar2 default hr_api.g_varchar2
261 ,p_appraisal_system_type in varchar2 default hr_api.g_varchar2
262 ,p_appraisal_type in varchar2 default hr_api.g_varchar2
263 ,p_appraisal_assmt_status in varchar2 default hr_api.g_varchar2
264 ,p_auto_conc_process in varchar2 default hr_api.g_varchar2
265 ,p_days_before_task_st_dt in number default hr_api.g_number
266 ,p_attribute_category in varchar2 default hr_api.g_varchar2
267 ,p_attribute1 in varchar2 default hr_api.g_varchar2
268 ,p_attribute2 in varchar2 default hr_api.g_varchar2
269 ,p_attribute3 in varchar2 default hr_api.g_varchar2
270 ,p_attribute4 in varchar2 default hr_api.g_varchar2
271 ,p_attribute5 in varchar2 default hr_api.g_varchar2
272 ,p_attribute6 in varchar2 default hr_api.g_varchar2
273 ,p_attribute7 in varchar2 default hr_api.g_varchar2
274 ,p_attribute8 in varchar2 default hr_api.g_varchar2
275 ,p_attribute9 in varchar2 default hr_api.g_varchar2
276 ,p_attribute10 in varchar2 default hr_api.g_varchar2
277 ,p_attribute11 in varchar2 default hr_api.g_varchar2
278 ,p_attribute12 in varchar2 default hr_api.g_varchar2
279 ,p_attribute13 in varchar2 default hr_api.g_varchar2
280 ,p_attribute14 in varchar2 default hr_api.g_varchar2
281 ,p_attribute15 in varchar2 default hr_api.g_varchar2
282 ,p_attribute16 in varchar2 default hr_api.g_varchar2
283 ,p_attribute17 in varchar2 default hr_api.g_varchar2
284 ,p_attribute18 in varchar2 default hr_api.g_varchar2
285 ,p_attribute19 in varchar2 default hr_api.g_varchar2
286 ,p_attribute20 in varchar2 default hr_api.g_varchar2
287 ,p_attribute21 in varchar2 default hr_api.g_varchar2
288 ,p_attribute22 in varchar2 default hr_api.g_varchar2
289 ,p_attribute23 in varchar2 default hr_api.g_varchar2
290 ,p_attribute24 in varchar2 default hr_api.g_varchar2
291 ,p_attribute25 in varchar2 default hr_api.g_varchar2
292 ,p_attribute26 in varchar2 default hr_api.g_varchar2
293 ,p_attribute27 in varchar2 default hr_api.g_varchar2
294 ,p_attribute28 in varchar2 default hr_api.g_varchar2
295 ,p_attribute29 in varchar2 default hr_api.g_varchar2
296 ,p_attribute30 in varchar2 default hr_api.g_varchar2
297 );
298 --
299 -- ----------------------------------------------------------------------------
300 -- |-------------------------< delete_appraisal_period >----------------------|
301 -- ----------------------------------------------------------------------------
302 --
303 -- {Start Of Comments}
304 /*#
305 * This API deletes an appraisal period for a performance management plan.
306 *
307 *
308 * <p><b>Licensing</b><br>
309 * This API is licensed for use with Human Resources.
310 *
311 * <p><b>Prerequisites</b><br>
312 * The appraisal period must exist.
313 *
314 * <p><b>Post Success</b><br>
315 * The appraisal period will have been deleted, and the status of the
316 * performance management plan will have been changed to Updated if its
317 * status was previously Published.
318 *
319 * <p><b>Post Failure</b><br>
320 * The appraisal period will not be deleted and an error will be raised.
321 *
322 * @param p_validate If true, then validation alone will be performed and
323 * the database will remain unchanged. If false and all validation checks pass,
324 * then the database will be modified.
325 * @param p_appraisal_period_id Identifies the appraisal period to be
326 * deleted.
327 * @param p_object_version_number Current version number of the appraisal
328 * period to be deleted.
329 * @rep:displayname Delete Appraisal Period
330 * @rep:category BUSINESS_ENTITY PER_APPRAISAL_PERIOD
331 * @rep:lifecycle active
332 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
333 * @rep:scope public
334 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
335 */
336 --
337 -- {End Of Comments}
338 --
339 procedure delete_appraisal_period
340 (p_validate in boolean default false
341 ,p_appraisal_period_id in number
342 ,p_object_version_number in number
343 );
344 --
345 end hr_appraisal_period_api;
[Home] [Help]