1 Package hr_assessments_api as
2 /* $Header: peasnapi.pkh 120.1 2005/10/02 02:11:35 aroussel $ */
3 /*#
4 * This package contains APIs that maintain assessments.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Assessment
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------------< create_assessment >-------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a new assessment.
17 *
18 * The assessment may hold the overall assessment score that is a sum of the
19 * scores on each of the constituent assessment elements.
20 *
21 * <p><b>Licensing</b><br>
22 * This API is licensed for use with Human Resources.
23 *
24 * <p><b>Prerequisites</b><br>
25 * Assessment type must exist.
26 *
27 * <p><b>Post Success</b><br>
28 * Assessment is created.
29 *
30 * <p><b>Post Failure</b><br>
31 * Assessment is not created and an error is raised.
32 * @param p_assessment_id If p_validate is false, then this uniquely identifies
33 * the assessment created. If p_validate is true, then set to null.
34 * @param p_object_version_number If p_validate is false, then set to the
35 * version number of the created assessment. If p_validate is true, then the
36 * value will be null.
37 * @param p_assessment_type_id Identifies the assessment type.
38 * @param p_business_group_id Business group for which the assessment is
39 * created.
40 * @param p_person_id Identifies the person.
41 * @param p_assessment_group_id Identifies the assessment group.
42 * @param p_assessment_period_start_date Start date of the period to which the
43 * assessment applies. This is mandatory if end date is not null.
44 * @param p_assessment_period_end_date End date of the period to which the
45 * competence assessment applies
46 * @param p_assessment_date The date of the competence assessment.
47 * @param p_assessor_person_id Person who is performing this assessment.
48 * @param p_appraisal_id Identifies the appraisal.
49 * @param p_group_date The date the group was created.
50 * @param p_group_initiator_id Person who created the 360 degree assessment.
51 * @param p_comments Comment text.
52 * @param p_total_score Overall score derived from the sum of the individual
53 * assessment line scores
54 * @param p_status Status of the competence assessment. Valid values are
55 * defined by the APPRAISAL_ASSESSMENT_STATUS lookup type.
56 * @param p_attribute_category This context value determines which flexfield
57 * structure to use with the descriptive flexfield segments.
58 * @param p_attribute1 Descriptive flexfield segment.
59 * @param p_attribute2 Descriptive flexfield segment.
60 * @param p_attribute3 Descriptive flexfield segment.
61 * @param p_attribute4 Descriptive flexfield segment.
62 * @param p_attribute5 Descriptive flexfield segment.
63 * @param p_attribute6 Descriptive flexfield segment.
64 * @param p_attribute7 Descriptive flexfield segment.
65 * @param p_attribute8 Descriptive flexfield segment.
66 * @param p_attribute9 Descriptive flexfield segment.
67 * @param p_attribute10 Descriptive flexfield segment.
68 * @param p_attribute11 Descriptive flexfield segment.
69 * @param p_attribute12 Descriptive flexfield segment.
70 * @param p_attribute13 Descriptive flexfield segment.
71 * @param p_attribute14 Descriptive flexfield segment.
72 * @param p_attribute15 Descriptive flexfield segment.
73 * @param p_attribute16 Descriptive flexfield segment.
74 * @param p_attribute17 Descriptive flexfield segment.
75 * @param p_attribute18 Descriptive flexfield segment.
76 * @param p_attribute19 Descriptive flexfield segment.
77 * @param p_attribute20 Descriptive flexfield segment.
78 * @param p_validate If true, then validation alone will be performed and the
79 * database will remain unchanged. If false and all validation checks pass,
80 * then the database will be modified.
81 * @param p_effective_date Reference date for validating lookup values are
82 * applicable during the start to end active date range. This date does not
83 * determine when the changes take effect.
84 * @rep:displayname Create Assessment
85 * @rep:category BUSINESS_ENTITY PER_ASSESSMENT
86 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
87 * @rep:scope public
88 * @rep:lifecycle active
89 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
90 */
91 --
92 -- {End Of Comments}
93 --
94 procedure create_assessment
95 (
96 p_assessment_id out nocopy number,
97 p_assessment_type_id in number,
98 p_business_group_id in number,
99 p_person_id in number,
100 p_assessment_group_id in number default null,
101 p_assessment_period_start_date in date default null,
102 p_assessment_period_end_date in date default null,
103 p_assessment_date in date,
104 p_assessor_person_id in number,
105 p_appraisal_id in number default null,
106 p_group_date in date default null,
107 p_group_initiator_id in number default null,
108 p_comments in varchar2 default null,
109 p_total_score in number default null,
110 p_status in varchar2 default null,
111 p_attribute_category in varchar2 default null,
112 p_attribute1 in varchar2 default null,
113 p_attribute2 in varchar2 default null,
114 p_attribute3 in varchar2 default null,
115 p_attribute4 in varchar2 default null,
116 p_attribute5 in varchar2 default null,
117 p_attribute6 in varchar2 default null,
118 p_attribute7 in varchar2 default null,
119 p_attribute8 in varchar2 default null,
120 p_attribute9 in varchar2 default null,
121 p_attribute10 in varchar2 default null,
122 p_attribute11 in varchar2 default null,
123 p_attribute12 in varchar2 default null,
124 p_attribute13 in varchar2 default null,
125 p_attribute14 in varchar2 default null,
126 p_attribute15 in varchar2 default null,
127 p_attribute16 in varchar2 default null,
128 p_attribute17 in varchar2 default null,
129 p_attribute18 in varchar2 default null,
130 p_attribute19 in varchar2 default null,
131 p_attribute20 in varchar2 default null,
132 p_object_version_number out nocopy number,
133 p_validate in boolean default false,
134 p_effective_date in date
135 );
136 --
137 -- ----------------------------------------------------------------------------
138 -- |----------------------------< update_assessment >-------------------------|
139 -- ----------------------------------------------------------------------------
140 --
141 -- {Start Of Comments}
142 /*#
143 * This API updates an assessment.
144 *
145 * The assessment may hold the overall assessment score which is a sum of the
146 * scores on each of the constituent assessment elements.
147 *
148 * <p><b>Licensing</b><br>
149 * This API is licensed for use with Human Resources.
150 *
151 * <p><b>Prerequisites</b><br>
152 * A valid assessment must exist.
153 *
154 * <p><b>Post Success</b><br>
155 * Assessment is updated.
156 *
157 * <p><b>Post Failure</b><br>
158 * Assessment remains unchanged, and an error is raised.
159 * @param p_assessment_id Identifies the assessment record to be updated.
160 * @param p_assessment_type_id Identifies the assessment type.
161 * @param p_assessment_group_id Identifies the assessment group.
162 * @param p_assessment_period_start_date Start date of the period to which the
163 * assessment applies. This is mandatory if end date is not null.
164 * @param p_assessment_period_end_date End date of the period to which the
165 * competence assessment applies
166 * @param p_assessment_date The date of the competence assessment.
167 * @param p_comments Comment text.
168 * @param p_total_score Overall score derived from the sum of the individual
169 * assessment line scores
170 * @param p_status Status of the competence assessment. Valid values are
171 * defined by the APPRAISAL_ASSESSMENT_STATUS lookup type.
172 * @param p_attribute_category This context value determines which flexfield
173 * structure to use with the descriptive flexfield segments.
174 * @param p_attribute1 Descriptive flexfield segment.
175 * @param p_attribute2 Descriptive flexfield segment.
176 * @param p_attribute3 Descriptive flexfield segment.
177 * @param p_attribute4 Descriptive flexfield segment.
178 * @param p_attribute5 Descriptive flexfield segment.
179 * @param p_attribute6 Descriptive flexfield segment.
180 * @param p_attribute7 Descriptive flexfield segment.
181 * @param p_attribute8 Descriptive flexfield segment.
182 * @param p_attribute9 Descriptive flexfield segment.
183 * @param p_attribute10 Descriptive flexfield segment.
184 * @param p_attribute11 Descriptive flexfield segment.
185 * @param p_attribute12 Descriptive flexfield segment.
186 * @param p_attribute13 Descriptive flexfield segment.
187 * @param p_attribute14 Descriptive flexfield segment.
188 * @param p_attribute15 Descriptive flexfield segment.
189 * @param p_attribute16 Descriptive flexfield segment.
190 * @param p_attribute17 Descriptive flexfield segment.
191 * @param p_attribute18 Descriptive flexfield segment.
192 * @param p_attribute19 Descriptive flexfield segment.
193 * @param p_attribute20 Descriptive flexfield segment.
194 * @param p_object_version_number Pass in the current version number of the
195 * assessment to be updated. When the API completes if p_validate is false,
196 * will be set to the new version number of the updated assessment. If
197 * p_validate is true will be set to the same value which was passed in.
198 * @param p_validate If true, then validation alone will be performed and the
199 * database will remain unchanged. If false and all validation checks pass,
200 * then the database will be modified.
201 * @param p_effective_date Reference date for validating lookup values are
202 * applicable during the start to end active date range. This date does not
203 * determine when the changes take effect.
204 * @rep:displayname Update Assessment
205 * @rep:category BUSINESS_ENTITY PER_ASSESSMENT
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_assessment
215 (
216 p_assessment_id in number,
217 p_assessment_type_id in number default hr_api.g_number,
218 p_assessment_group_id in number default hr_api.g_number,
219 p_assessment_period_start_date in date default hr_api.g_date,
220 p_assessment_period_end_date in date default hr_api.g_date,
221 p_assessment_date in date default hr_api.g_date,
222 p_comments in varchar2 default hr_api.g_varchar2,
223 p_total_score in number default hr_api.g_number,
224 p_status in varchar2 default hr_api.g_varchar2,
225 --
226 p_attribute_category in varchar2 default hr_api.g_varchar2,
227 p_attribute1 in varchar2 default hr_api.g_varchar2,
228 p_attribute2 in varchar2 default hr_api.g_varchar2,
229 p_attribute3 in varchar2 default hr_api.g_varchar2,
230 p_attribute4 in varchar2 default hr_api.g_varchar2,
231 p_attribute5 in varchar2 default hr_api.g_varchar2,
232 p_attribute6 in varchar2 default hr_api.g_varchar2,
233 p_attribute7 in varchar2 default hr_api.g_varchar2,
234 p_attribute8 in varchar2 default hr_api.g_varchar2,
235 p_attribute9 in varchar2 default hr_api.g_varchar2,
236 p_attribute10 in varchar2 default hr_api.g_varchar2,
237 p_attribute11 in varchar2 default hr_api.g_varchar2,
238 p_attribute12 in varchar2 default hr_api.g_varchar2,
239 p_attribute13 in varchar2 default hr_api.g_varchar2,
240 p_attribute14 in varchar2 default hr_api.g_varchar2,
241 p_attribute15 in varchar2 default hr_api.g_varchar2,
242 p_attribute16 in varchar2 default hr_api.g_varchar2,
243 p_attribute17 in varchar2 default hr_api.g_varchar2,
244 p_attribute18 in varchar2 default hr_api.g_varchar2,
245 p_attribute19 in varchar2 default hr_api.g_varchar2,
246 p_attribute20 in varchar2 default hr_api.g_varchar2,
247 p_object_version_number in out nocopy number,
248 p_validate in boolean default false,
249 p_effective_date in date
250 );
251 --
252 -- ----------------------------------------------------------------------------
253 -- |----------------------------< delete_assessment >-------------------------|
254 -- ----------------------------------------------------------------------------
255 --
256 -- {Start Of Comments}
257 /*#
258 * This API deletes an assessment.
259 *
260 * The assessment may hold the overall assessment score which is a sum of the
261 * scores on each of the constituent assessment elements.
262 *
263 * <p><b>Licensing</b><br>
264 * This API is licensed for use with Human Resources.
265 *
266 * <p><b>Prerequisites</b><br>
267 * A valid assessment must exist.
268 *
269 * <p><b>Post Success</b><br>
270 * Assessment is deleted.
271 *
272 * <p><b>Post Failure</b><br>
273 * Assessment is not deleted and an error is raised.
274 * @param p_validate If true, then validation alone will be performed and the
275 * database will remain unchanged. If false and all validation checks pass,
276 * then the database will be modified.
277 * @param p_assessment_id Assessment to be deleted. If p_validate is false,
278 * uniquely identifies the assessment to be deleted. If p_validate is true, set
279 * to null.
280 * @param p_object_version_number Current version number of the assessment to
281 * be deleted
282 * @rep:displayname Delete Assessment
283 * @rep:category BUSINESS_ENTITY PER_ASSESSMENT
284 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
285 * @rep:scope public
286 * @rep:lifecycle active
287 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
288 */
289 --
290 -- {End Of Comments}
291 --
292 procedure delete_assessment
293 (p_validate in boolean default false,
294 p_assessment_id in number,
295 p_object_version_number in number
296 );
297 --
298 end hr_assessments_api;
[Home] [Help]