1 Package hr_perf_review_api AUTHID CURRENT_USER as
2 /* $Header: peprvapi.pkh 120.1 2005/10/02 02:22:23 aroussel $ */
3 /*#
4 * This package contains performance review APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Performance Review
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------------< create_perf_review >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates performance review.
17 *
18 *
19 * <p><b>Licensing</b><br>
20 * This API is licensed for use with Human Resources.
21 *
22 * <p><b>Prerequisites</b><br>
23 * A person for whom performance review is created must exist.
24 *
25 * <p><b>Post Success</b><br>
26 * Performance review is created.
27 *
28 * <p><b>Post Failure</b><br>
29 * Performance review is not created and an error is raised.
30 * @param p_validate If true, then validation alone will be performed and the
31 * database will remain unchanged. If false and all validation checks pass,
32 * then the database will be modified.
33 * @param p_performance_review_id If p_validate is false, then this uniquely
34 * identifies the performance review created. If p_validate is true, then set
35 * to null.
36 * @param p_person_id Identifies the person record.
37 * @param p_event_id An optional event to associate with the review
38 * @param p_review_date Date of the review
39 * @param p_performance_rating Performance rating. Valid values are defined by
40 * PERFORMANCE_RATING lookup type.
41 * @param p_next_perf_review_date Next performance review date.
42 * @param p_attribute_category This context value determines which flexfield
43 * structure to use with the descriptive flexfield segments.
44 * @param p_attribute1 Descriptive flexfield segment.
45 * @param p_attribute2 Descriptive flexfield segment.
46 * @param p_attribute3 Descriptive flexfield segment.
47 * @param p_attribute4 Descriptive flexfield segment.
48 * @param p_attribute5 Descriptive flexfield segment.
49 * @param p_attribute6 Descriptive flexfield segment.
50 * @param p_attribute7 Descriptive flexfield segment.
51 * @param p_attribute8 Descriptive flexfield segment.
52 * @param p_attribute9 Descriptive flexfield segment.
53 * @param p_attribute10 Descriptive flexfield segment.
54 * @param p_attribute11 Descriptive flexfield segment.
55 * @param p_attribute12 Descriptive flexfield segment.
56 * @param p_attribute13 Descriptive flexfield segment.
57 * @param p_attribute14 Descriptive flexfield segment.
58 * @param p_attribute15 Descriptive flexfield segment.
59 * @param p_attribute16 Descriptive flexfield segment.
60 * @param p_attribute17 Descriptive flexfield segment.
61 * @param p_attribute18 Descriptive flexfield segment.
62 * @param p_attribute19 Descriptive flexfield segment.
63 * @param p_attribute20 Descriptive flexfield segment.
64 * @param p_attribute21 Descriptive flexfield segment.
65 * @param p_attribute22 Descriptive flexfield segment.
66 * @param p_attribute23 Descriptive flexfield segment.
67 * @param p_attribute24 Descriptive flexfield segment.
68 * @param p_attribute25 Descriptive flexfield segment.
69 * @param p_attribute26 Descriptive flexfield segment.
70 * @param p_attribute27 Descriptive flexfield segment.
71 * @param p_attribute28 Descriptive flexfield segment.
72 * @param p_attribute29 Descriptive flexfield segment.
73 * @param p_attribute30 Descriptive flexfield segment.
74 * @param p_object_version_number If p_validate is false, then set to the
75 * version number of the created performance review. If p_validate is true,
76 * then the value will be null.
77 * @param p_next_review_date_warning If set to true, then the next performance
78 * review date falls outside the scope of the effective employment dates of the
79 * person.
80 * @rep:displayname Create Performance Review
81 * @rep:category BUSINESS_ENTITY PER_PERFORMANCE_REVIEW
82 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
83 * @rep:scope public
84 * @rep:lifecycle active
85 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
86 */
87 --
88 -- {End Of Comments}
89 --
90 procedure create_perf_review
91 (
92 p_validate in boolean default false
93 ,p_performance_review_id out nocopy number
94 ,p_person_id in number
95 ,p_event_id in number default null
96 ,p_review_date in date
97 ,p_performance_rating in varchar2 default null
98 ,p_next_perf_review_date in date default null
99 ,p_attribute_category in varchar2 default null
100 ,p_attribute1 in varchar2 default null
101 ,p_attribute2 in varchar2 default null
102 ,p_attribute3 in varchar2 default null
103 ,p_attribute4 in varchar2 default null
104 ,p_attribute5 in varchar2 default null
105 ,p_attribute6 in varchar2 default null
106 ,p_attribute7 in varchar2 default null
107 ,p_attribute8 in varchar2 default null
108 ,p_attribute9 in varchar2 default null
109 ,p_attribute10 in varchar2 default null
110 ,p_attribute11 in varchar2 default null
111 ,p_attribute12 in varchar2 default null
112 ,p_attribute13 in varchar2 default null
113 ,p_attribute14 in varchar2 default null
114 ,p_attribute15 in varchar2 default null
115 ,p_attribute16 in varchar2 default null
116 ,p_attribute17 in varchar2 default null
117 ,p_attribute18 in varchar2 default null
118 ,p_attribute19 in varchar2 default null
119 ,p_attribute20 in varchar2 default null
120 ,p_attribute21 in varchar2 default null
121 ,p_attribute22 in varchar2 default null
122 ,p_attribute23 in varchar2 default null
123 ,p_attribute24 in varchar2 default null
124 ,p_attribute25 in varchar2 default null
125 ,p_attribute26 in varchar2 default null
126 ,p_attribute27 in varchar2 default null
127 ,p_attribute28 in varchar2 default null
128 ,p_attribute29 in varchar2 default null
129 ,p_attribute30 in varchar2 default null
130 ,p_object_version_number out nocopy number
131 ,p_next_review_date_warning out nocopy boolean
132 );
133 --
134 -- ----------------------------------------------------------------------------
135 -- |----------------------------< update_perf_review >------------------------|
136 -- ----------------------------------------------------------------------------
137 --
138 -- {Start Of Comments}
139 /*#
140 * This API updates performance review.
141 *
142 *
143 * <p><b>Licensing</b><br>
144 * This API is licensed for use with Human Resources.
145 *
146 * <p><b>Prerequisites</b><br>
147 * Existing performance review must exist.
148 *
149 * <p><b>Post Success</b><br>
150 * Performance review is updated.
151 *
152 * <p><b>Post Failure</b><br>
153 * Performance review is not updated and an error is raised.
154 * @param p_validate If true, then validation alone will be performed and the
155 * database will remain unchanged. If false and all validation checks pass,
156 * then the database will be modified.
157 * @param p_performance_review_id Identifies the performance record to be
158 * updated.
159 * @param p_event_id An optional event to associate with the review
160 * @param p_review_date Date of the review
161 * @param p_performance_rating Performance rating. Valid values are defined by
162 * PERFORMANCE_RATING lookup type.
163 * @param p_next_perf_review_date Next performance review date.
164 * @param p_attribute_category This context value determines which flexfield
165 * structure to use with the descriptive flexfield segments.
166 * @param p_attribute1 Descriptive flexfield segment.
167 * @param p_attribute2 Descriptive flexfield segment.
168 * @param p_attribute3 Descriptive flexfield segment.
169 * @param p_attribute4 Descriptive flexfield segment.
170 * @param p_attribute5 Descriptive flexfield segment.
171 * @param p_attribute6 Descriptive flexfield segment.
172 * @param p_attribute7 Descriptive flexfield segment.
173 * @param p_attribute8 Descriptive flexfield segment.
174 * @param p_attribute9 Descriptive flexfield segment.
175 * @param p_attribute10 Descriptive flexfield segment.
176 * @param p_attribute11 Descriptive flexfield segment.
177 * @param p_attribute12 Descriptive flexfield segment.
178 * @param p_attribute13 Descriptive flexfield segment.
179 * @param p_attribute14 Descriptive flexfield segment.
180 * @param p_attribute15 Descriptive flexfield segment.
181 * @param p_attribute16 Descriptive flexfield segment.
182 * @param p_attribute17 Descriptive flexfield segment.
183 * @param p_attribute18 Descriptive flexfield segment.
184 * @param p_attribute19 Descriptive flexfield segment.
185 * @param p_attribute20 Descriptive flexfield segment.
186 * @param p_attribute21 Descriptive flexfield segment.
187 * @param p_attribute22 Descriptive flexfield segment.
188 * @param p_attribute23 Descriptive flexfield segment.
189 * @param p_attribute24 Descriptive flexfield segment.
190 * @param p_attribute25 Descriptive flexfield segment.
191 * @param p_attribute26 Descriptive flexfield segment.
192 * @param p_attribute27 Descriptive flexfield segment.
193 * @param p_attribute28 Descriptive flexfield segment.
194 * @param p_attribute29 Descriptive flexfield segment.
195 * @param p_attribute30 Descriptive flexfield segment.
196 * @param p_object_version_number Pass in the current version number of the
197 * performance review to be updated. When the API completes if p_validate is
198 * false, will be set to the new version number of the updated performance
199 * review. If p_validate is true will be set to the same value which was passed
200 * in.
201 * @param p_next_review_date_warning If set to true, then next review date is
202 * not null, but the given person does not exist, and the warning flag has been
203 * set to 'Y' for Yes.
204 * @rep:displayname Update Performance Review
205 * @rep:category BUSINESS_ENTITY PER_PERFORMANCE_REVIEW
206 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
207 * @rep:scope public
208 * @rep:lifecycle active
209 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
210 */
211 --
212 -- {End Of Comments}
213 --
214 procedure update_perf_review
215 (
216 p_validate in boolean default false
217 ,p_performance_review_id in number
218 ,p_event_id in number default hr_api.g_number
219 ,p_review_date in date default hr_api.g_date
220 ,p_performance_rating in varchar2 default hr_api.g_varchar2
221 ,p_next_perf_review_date in date default hr_api.g_date
222 ,p_attribute_category in varchar2 default hr_api.g_varchar2
223 ,p_attribute1 in varchar2 default hr_api.g_varchar2
224 ,p_attribute2 in varchar2 default hr_api.g_varchar2
225 ,p_attribute3 in varchar2 default hr_api.g_varchar2
226 ,p_attribute4 in varchar2 default hr_api.g_varchar2
227 ,p_attribute5 in varchar2 default hr_api.g_varchar2
228 ,p_attribute6 in varchar2 default hr_api.g_varchar2
229 ,p_attribute7 in varchar2 default hr_api.g_varchar2
230 ,p_attribute8 in varchar2 default hr_api.g_varchar2
231 ,p_attribute9 in varchar2 default hr_api.g_varchar2
232 ,p_attribute10 in varchar2 default hr_api.g_varchar2
233 ,p_attribute11 in varchar2 default hr_api.g_varchar2
234 ,p_attribute12 in varchar2 default hr_api.g_varchar2
235 ,p_attribute13 in varchar2 default hr_api.g_varchar2
236 ,p_attribute14 in varchar2 default hr_api.g_varchar2
237 ,p_attribute15 in varchar2 default hr_api.g_varchar2
238 ,p_attribute16 in varchar2 default hr_api.g_varchar2
239 ,p_attribute17 in varchar2 default hr_api.g_varchar2
240 ,p_attribute18 in varchar2 default hr_api.g_varchar2
241 ,p_attribute19 in varchar2 default hr_api.g_varchar2
242 ,p_attribute20 in varchar2 default hr_api.g_varchar2
243 ,p_attribute21 in varchar2 default hr_api.g_varchar2
244 ,p_attribute22 in varchar2 default hr_api.g_varchar2
245 ,p_attribute23 in varchar2 default hr_api.g_varchar2
246 ,p_attribute24 in varchar2 default hr_api.g_varchar2
247 ,p_attribute25 in varchar2 default hr_api.g_varchar2
248 ,p_attribute26 in varchar2 default hr_api.g_varchar2
249 ,p_attribute27 in varchar2 default hr_api.g_varchar2
250 ,p_attribute28 in varchar2 default hr_api.g_varchar2
251 ,p_attribute29 in varchar2 default hr_api.g_varchar2
252 ,p_attribute30 in varchar2 default hr_api.g_varchar2
253 ,p_object_version_number in out nocopy number
254 ,p_next_review_date_warning out nocopy boolean
255 );
256 --
257 -- ----------------------------------------------------------------------------
258 -- |----------------------------< delete_perf_review >------------------------|
259 -- ----------------------------------------------------------------------------
260 --
261 -- {Start Of Comments}
262 /*#
263 * This API deletes performance review.
264 *
265 *
266 * <p><b>Licensing</b><br>
267 * This API is licensed for use with Human Resources.
268 *
269 * <p><b>Prerequisites</b><br>
270 * Performance review to be deleted must exist.
271 *
272 * <p><b>Post Success</b><br>
273 * Performance review is deleted.
274 *
275 * <p><b>Post Failure</b><br>
276 * Performance review is not deleted and an error is raised.
277 * @param p_validate If true, then validation alone will be performed and the
278 * database will remain unchanged. If false and all validation checks pass,
279 * then the database will be modified.
280 * @param p_performance_review_id Identifies the performance review to be
281 * deleted.
282 * @param p_object_version_number Current version number of the performance
283 * review to be deleted.
284 * @rep:displayname Delete Performance Review
285 * @rep:category BUSINESS_ENTITY PER_PERFORMANCE_REVIEW
286 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
287 * @rep:scope public
288 * @rep:lifecycle active
289 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
290 */
291 --
292 -- {End Of Comments}
293 --
294 procedure delete_perf_review
295 (
296 p_validate in boolean default false
297 ,p_performance_review_id in number
298 ,p_object_version_number in out nocopy number
299 );
300 --
301 -- ----------------------------------------------------------------------------
302 -- |----------------------------------< lck >---------------------------------|
303 -- ----------------------------------------------------------------------------
304 -- {Start Of Comments}
305 --
306 -- Description:
307 -- locks a row in the performance review table
308 --
309 -- Prerequisites:
310 -- the review must exist.
311 --
312 -- In Parameters:
313 -- Name Reqd Type Description
314 -- p_performance_review_id Yes number PK of record
315 -- p_object_version_number Yes number OVN of record
316 --
317 -- Post Success:
318 -- the row is locked
319 --
320 -- Post Failure:
321 -- a row is not locked
322 --
323 -- Access Status:
324 -- Public.
325 --
326 -- {End Of Comments}
327 --
328 procedure lck
329 (
330 p_performance_review_id in number
331 ,p_object_version_number in number
332 );
333 --
334 end hr_perf_review_api;