DBA Data[Home] [Help]

PACKAGE: APPS.HR_FI_QUALIFICATION_API

Source


1 PACKAGE HR_FI_QUALIFICATION_API AS
2 /* $Header: pequafii.pkh 120.1 2005/10/02 02:44 aroussel $ */
3 /*#
4  * This package contains qualification APIs for Finland.
5  * @rep:scope public
6  * @rep:product PER
7  * @rep:displayname Qualification for Finland
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-------------------------< create_fi_qualification >----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16  * This API creates qualifications for a person.
17  *
18  * This API is an alternative to the API create_qualification. If p_validate is
19  * set to false, a qualification is created.
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  * The person must exist at the effective start date of the qualification. Also
26  * a valid qualification_type_id must exist in PER_QUALIFICATION_TYPES.
27  *
28  * <p><b>Post Success</b><br>
29  * A new qualification will be created for the person.
30  *
31  * <p><b>Post Failure</b><br>
32  * The API does not create a qualification for the employee and raises an
33  * error.
34  *
35  * @param p_validate If true, then validation alone will be performed and the
36  * database will remain unchanged. If false and all validation checks pass,
37  * then the database will be modified.
38  * @param p_effective_date Determines when the DateTrack operation comes into
39  * force.
40  * @param p_qualification_type_id The type of qualification. Valid values are
41  * defined by 'PER_QUALIFICATION_TYPES' lookup type.
42  * @param p_language_code Specifies to which language the translation values
43  * apply. You can set to the base or any installed language. The default value
44  * of hr_api.userenv_lang is equivalent to the RDBMS userenv('LANG') function
45  * value.
46  * @param p_business_group_id The business group of the person.
47  * @param p_person_id Identifies the person for whom you create the
48  * qualification record.
49  * @param p_title Title of the qualification.
50  * @param p_grade_attained Level of qualification.
51  * @param p_status Status of the qualification. Valid values are defined by
52  * 'PER_SUBJECT_STATUSES' lookup type.
53  * @param p_awarded_date Date qualification awarded.
54  * @param p_fee Cost of qualification (tuition fee).
55  * @param p_fee_currency Currency fee paid in.
56  * @param p_training_completed_amount Amount of training completed.
57  * @param p_reimbursement_arrangements Details of arrangements.
58  * @param p_training_completed_units Holds the current unit of training
59  * @param p_total_training_amount Total number of training units
60  * @param p_start_date Start date of training.
61  * @param p_end_date End date of training.
62  * @param p_license_number Number of license.
63  * @param p_expiry_date Date license expires.
64  * @param p_license_restrictions License restrictions.
65  * @param p_projected_completion_date Projected completion date.
66  * @param p_awarding_body Awarding body.
67  * @param p_tuition_method Method of tuition. Valid values are defined by
68  * 'PER_TUITION_METHODS' lookup type.
69  * @param p_group_ranking Ranking within study group.
70  * @param p_comments Qualification comment text.
71  * @param p_attendance_id Attendance ID.
72  * @param p_attribute_category This context value determines which flexfield
73  * structure to use with the descriptive flexfield segments.
74  * @param p_attribute1 Descriptive flexfield segment.
75  * @param p_attribute2 Descriptive flexfield segment.
76  * @param p_attribute3 Descriptive flexfield segment.
77  * @param p_attribute4 Descriptive flexfield segment.
78  * @param p_attribute5 Descriptive flexfield segment.
79  * @param p_attribute6 Descriptive flexfield segment.
80  * @param p_attribute7 Descriptive flexfield segment.
81  * @param p_attribute8 Descriptive flexfield segment.
82  * @param p_attribute9 Descriptive flexfield segment.
83  * @param p_attribute10 Descriptive flexfield segment.
84  * @param p_attribute11 Descriptive flexfield segment.
85  * @param p_attribute12 Descriptive flexfield segment.
86  * @param p_attribute13 Descriptive flexfield segment.
87  * @param p_attribute14 Descriptive flexfield segment.
88  * @param p_attribute15 Descriptive flexfield segment.
89  * @param p_attribute16 Descriptive flexfield segment.
90  * @param p_attribute17 Descriptive flexfield segment.
91  * @param p_attribute18 Descriptive flexfield segment.
92  * @param p_attribute19 Descriptive flexfield segment.
93  * @param p_attribute20 Descriptive flexfield segment.
94  * @param p_party_id Party identifier.
95  * @param p_education_code Education code.
96  * @param p_preferred_level Preferred level. Valid values are defined by
97  * 'YES_NO' lookup type.
98  * @param p_professional_body_name Professional body name.
99  * @param p_membership_number Membership number.
100  * @param p_membership_category Membership category.
101  * @param p_subscription_payment_method Payment method.
102  * @param p_qualification_id Identifier for the qualification.
103  * @param p_object_version_number If p_validate is false, then set to the
104  * version number of the created qualification. If p_validate is true, then the
105  * value will be null.
106  * @rep:displayname Create Qualification for Finland
107  * @rep:category BUSINESS_ENTITY PER_QUALIFICATION
108  * @rep:lifecycle active
109  * @rep:scope public
110  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
111 */
112 --
113 -- {End Of Comments}
114 --
115 procedure CREATE_FI_QUALIFICATION
116   (p_validate                      in     boolean  default false
117   ,p_effective_date                in     date
118   ,p_qualification_type_id         in     number
119   ,p_language_code                 in     varchar2 default hr_api.userenv_lang
120   ,p_business_group_id             in     number   default null
121   ,p_person_id                     in     number   default null
122   ,p_title                         in     varchar2 default null
123   ,p_grade_attained                in     varchar2 default null
124   ,p_status                        in     varchar2 default null
125   ,p_awarded_date                  in     date     default null
126   ,p_fee                           in     number   default null
127   ,p_fee_currency                  in     varchar2 default null
128   ,p_training_completed_amount     in     number   default null
129   ,p_reimbursement_arrangements    in     varchar2 default null
130   ,p_training_completed_units      in     varchar2 default null
131   ,p_total_training_amount         in     number   default null
132   ,p_start_date                    in     date     default null
133   ,p_end_date                      in     date     default null
134   ,p_license_number                in     varchar2 default null
135   ,p_expiry_date                   in     date     default null
136   ,p_license_restrictions          in     varchar2 default null
137   ,p_projected_completion_date     in     date     default null
138   ,p_awarding_body                 in     varchar2 default null
139   ,p_tuition_method                in     varchar2 default null
140   ,p_group_ranking                 in     varchar2 default null
141   ,p_comments                      in     varchar2 default null
142   ,p_attendance_id                 in     number   default null
143   ,p_attribute_category            in     varchar2 default null
144   ,p_attribute1                    in     varchar2 default null
145   ,p_attribute2                    in     varchar2 default null
146   ,p_attribute3                    in     varchar2 default null
147   ,p_attribute4                    in     varchar2 default null
148   ,p_attribute5                    in     varchar2 default null
149   ,p_attribute6                    in     varchar2 default null
150   ,p_attribute7                    in     varchar2 default null
151   ,p_attribute8                    in     varchar2 default null
152   ,p_attribute9                    in     varchar2 default null
153   ,p_attribute10                   in     varchar2 default null
154   ,p_attribute11                   in     varchar2 default null
155   ,p_attribute12                   in     varchar2 default null
156   ,p_attribute13                   in     varchar2 default null
157   ,p_attribute14                   in     varchar2 default null
158   ,p_attribute15                   in     varchar2 default null
159   ,p_attribute16                   in     varchar2 default null
160   ,p_attribute17                   in     varchar2 default null
161   ,p_attribute18                   in     varchar2 default null
162   ,p_attribute19                   in     varchar2 default null
163   ,p_attribute20                   in     varchar2 default null
164   ,p_party_id                      in     number   default null
165   ,p_education_code                in     varchar2 default null
166   ,p_preferred_level      	   in    varchar2 default null
167   ,p_professional_body_name        in     varchar2 default null
168   ,p_membership_number             in     varchar2 default null
169   ,p_membership_category           in     varchar2 default null
170   ,p_subscription_payment_method   in     varchar2 default null
171   ,p_qualification_id                 out nocopy number
172   ,p_object_version_number            out nocopy number
173   );
174 --
175 -- ----------------------------------------------------------------------------
176 -- |-------------------------< update_fi_qualification >----------------------|
177 -- ----------------------------------------------------------------------------
178 --
179 -- {Start Of Comments}
180 /*#
181  * This API updates a qualification for a person.
182  *
183  * This API is an alternative to the API update_qualification. If p_validate is
184  * set to false, a qualification is updated.
185  *
186  * <p><b>Licensing</b><br>
187  * This API is licensed for use with Human Resources.
188  *
189  * <p><b>Prerequisites</b><br>
190  * The person must exist at the effective start date of the qualification. Also
191  * a valid qualification_type_id must exist in PER_QUALIFICATION_TYPES.The
192  * qualification_id must exist in PER_QUALIFICATIONS.
193  *
194  * <p><b>Post Success</b><br>
195  * The qualification will be updated for the person.
196  *
197  * <p><b>Post Failure</b><br>
198  * The API does not increment the Object Version Number (OVN), the details
199  * relating to the qualification remain unchanged, and an error is raised.
200  *
201  * @param p_validate If true, then validation alone will be performed and the
202  * database will remain unchanged. If false and all validation checks pass,
203  * then the database will be modified.
204  * @param p_effective_date Determines when the DateTrack operation comes into
205  * force.
206  * @param p_qualification_id Identifier for the qualification.
207  * @param p_language_code Specifies to which language the translation values
208  * apply. You can set to the base or any installed language. The default value
209  * of hr_api.userenv_lang is equivalent to the RDBMS userenv('LANG') function
210  * value.
211  * @param p_qualification_type_id The type of qualification. Valid values are
212  * defined by 'PER_QUALIFICATION_TYPES' lookup type.
213  * @param p_title Title of the qualification.
214  * @param p_grade_attained Level of qualification.
215  * @param p_status Status of the qualification. Valid values are defined by
216  * 'PER_SUBJECT_STATUSES' lookup type.
217  * @param p_awarded_date Date qualification awarded.
218  * @param p_fee Cost of qualification (tuition fee).
219  * @param p_fee_currency Currency fee paid in.
220  * @param p_training_completed_amount Amount of training completed.
221  * @param p_reimbursement_arrangements Details of arrangements.
222  * @param p_training_completed_units Holds the current unit of training
223  * @param p_total_training_amount Total number of training units.
224  * @param p_start_date Start date of training.
225  * @param p_end_date End date of training.
226  * @param p_license_number Number of license.
227  * @param p_expiry_date Date license expires.
228  * @param p_license_restrictions License restrictions.
229  * @param p_projected_completion_date Projected completion date.
230  * @param p_awarding_body Awarding body.
231  * @param p_tuition_method Method of tuition. Valid values are defined by
232  * 'PER_TUITION_METHODS' lookup type.
233  * @param p_group_ranking Ranking within study group.
234  * @param p_comments Qualification comment text.
235  * @param p_attendance_id Attendance id. Valid values are defined by
236  * 'PER_ESTABLISHMENT_ATTENDANCES' lookup type.
237  * @param p_attribute_category This context value determines which flexfield
238  * structure to use with the descriptive flexfield segments.
239  * @param p_attribute1 Descriptive flexfield segment.
240  * @param p_attribute2 Descriptive flexfield segment.
244  * @param p_attribute6 Descriptive flexfield segment.
241  * @param p_attribute3 Descriptive flexfield segment.
242  * @param p_attribute4 Descriptive flexfield segment.
243  * @param p_attribute5 Descriptive flexfield segment.
245  * @param p_attribute7 Descriptive flexfield segment.
246  * @param p_attribute8 Descriptive flexfield segment.
247  * @param p_attribute9 Descriptive flexfield segment.
248  * @param p_attribute10 Descriptive flexfield segment.
249  * @param p_attribute11 Descriptive flexfield segment.
250  * @param p_attribute12 Descriptive flexfield segment.
251  * @param p_attribute13 Descriptive flexfield segment.
252  * @param p_attribute14 Descriptive flexfield segment.
253  * @param p_attribute15 Descriptive flexfield segment.
254  * @param p_attribute16 Descriptive flexfield segment.
255  * @param p_attribute17 Descriptive flexfield segment.
256  * @param p_attribute18 Descriptive flexfield segment.
257  * @param p_attribute19 Descriptive flexfield segment.
258  * @param p_attribute20 Descriptive flexfield segment.
259  * @param p_education_code Education code.
260  * @param p_preferred_level Preferred level. Valid values are defined by
261  * 'YES_NO' lookup type.
262  * @param p_professional_body_name Professional body name.
263  * @param p_membership_number Membership number.
264  * @param p_membership_category Membership category.
265  * @param p_subscription_payment_method Payment method.
266  * @param p_object_version_number Pass in the current version number of the
267  * qualification to be updated. When the API completes if p_validate is false,
268  * will be set to the new version number of the updated qualification. If
269  * p_validate is true will be set to the same value which was passed in.
270  * @rep:displayname Update Qualification for Finland
271  * @rep:category BUSINESS_ENTITY PER_QUALIFICATION
272  * @rep:lifecycle active
273  * @rep:scope public
274  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
275 */
276 --
277 -- {End Of Comments}
278 --
279 procedure UPDATE_FI_QUALIFICATION
280   (p_validate                      in     boolean  default false
281   ,p_effective_date                in     date
282   ,p_qualification_id              in     number
283   ,p_language_code                 in     varchar2 default hr_api.userenv_lang
284   ,p_qualification_type_id         in     number   default hr_api.g_number
285   ,p_title                         in     varchar2 default hr_api.g_varchar2
286   ,p_grade_attained                in     varchar2 default hr_api.g_varchar2
287   ,p_status                        in     varchar2 default hr_api.g_varchar2
288   ,p_awarded_date                  in     date     default hr_api.g_date
289   ,p_fee                           in     number   default hr_api.g_number
290   ,p_fee_currency                  in     varchar2 default hr_api.g_varchar2
291   ,p_training_completed_amount     in     number   default hr_api.g_number
292   ,p_reimbursement_arrangements    in     varchar2 default hr_api.g_varchar2
293   ,p_training_completed_units      in     varchar2 default hr_api.g_varchar2
294   ,p_total_training_amount         in     number   default hr_api.g_number
295   ,p_start_date                    in     date     default hr_api.g_date
296   ,p_end_date                      in     date     default hr_api.g_date
297   ,p_license_number                in     varchar2 default hr_api.g_varchar2
298   ,p_expiry_date                   in     date     default hr_api.g_date
299   ,p_license_restrictions          in     varchar2 default hr_api.g_varchar2
300   ,p_projected_completion_date     in     date     default hr_api.g_date
301   ,p_awarding_body                 in     varchar2 default hr_api.g_varchar2
302   ,p_tuition_method                in     varchar2 default hr_api.g_varchar2
303   ,p_group_ranking                 in     varchar2 default hr_api.g_varchar2
304   ,p_comments                      in     varchar2 default hr_api.g_varchar2
305   ,p_attendance_id                 in     number   default hr_api.g_number
306   ,p_attribute_category            in     varchar2 default hr_api.g_varchar2
307   ,p_attribute1                    in     varchar2 default hr_api.g_varchar2
308   ,p_attribute2                    in     varchar2 default hr_api.g_varchar2
309   ,p_attribute3                    in     varchar2 default hr_api.g_varchar2
310   ,p_attribute4                    in     varchar2 default hr_api.g_varchar2
311   ,p_attribute5                    in     varchar2 default hr_api.g_varchar2
312   ,p_attribute6                    in     varchar2 default hr_api.g_varchar2
313   ,p_attribute7                    in     varchar2 default hr_api.g_varchar2
314   ,p_attribute8                    in     varchar2 default hr_api.g_varchar2
315   ,p_attribute9                    in     varchar2 default hr_api.g_varchar2
316   ,p_attribute10                   in     varchar2 default hr_api.g_varchar2
317   ,p_attribute11                   in     varchar2 default hr_api.g_varchar2
318   ,p_attribute12                   in     varchar2 default hr_api.g_varchar2
319   ,p_attribute13                   in     varchar2 default hr_api.g_varchar2
320   ,p_attribute14                   in     varchar2 default hr_api.g_varchar2
321   ,p_attribute15                   in     varchar2 default hr_api.g_varchar2
322   ,p_attribute16                   in     varchar2 default hr_api.g_varchar2
323   ,p_attribute17                   in     varchar2 default hr_api.g_varchar2
324   ,p_attribute18                   in     varchar2 default hr_api.g_varchar2
325   ,p_attribute19                   in     varchar2 default hr_api.g_varchar2
326   ,p_attribute20                   in     varchar2 default hr_api.g_varchar2
327   ,p_education_code                in     varchar2 default hr_api.g_varchar2
328   ,p_preferred_level      	   in    varchar2  default hr_api.g_varchar2
329   ,p_professional_body_name        in     varchar2 default hr_api.g_varchar2
330   ,p_membership_number             in     varchar2 default hr_api.g_varchar2
331   ,p_membership_category           in     varchar2 default hr_api.g_varchar2
332   ,p_subscription_payment_method   in     varchar2 default hr_api.g_varchar2
333   ,p_object_version_number         in out nocopy number
334   );
335 
336 END HR_FI_QUALIFICATION_API;