DBA Data[Home] [Help]

PACKAGE: APPS.HR_APPRAISAL_PERIOD_API

Source


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