DBA Data[Home] [Help]

PACKAGE: APPS.HR_SA_CONTINGENT_WORKER_API

Source


1 Package hr_sa_contingent_worker_api as
2 /* $Header: pecwksai.pkh 120.4 2005/10/02 02:14:41 aroussel $ */
3 /*#
4  * This package contains contingent worker APIs for Saudi Arabia.
5  * @rep:scope public
6  * @rep:product per
7  * @rep:displayname Contingent Worker for Saudi Arabia
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |------------------------------< create_sa_cwk >---------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16  * This API creates a contingent worker record for Saudi Arabia.
17  *
18  * The API calls the generic API create_cwk, with parameters set as appropriate
19  * for the Saudi person. As this API is effectively an alternative to the API
20  * create_cwk, see that API for further explanation.
21  *
22  * <p><b>Licensing</b><br>
23  * This API is licensed for use with Human Resources.
24  *
25  * <p><b>Prerequisites</b><br>
26  * See API create_cwk
27  *
28  * <p><b>Post Success</b><br>
29  * The API successfully creates the contingent worker record in the database.
30  *
31  * <p><b>Post Failure</b><br>
32  * The API does not create the contingent worker record and raises an error.
33  * @param p_validate If true, then validation alone will be performed and the
34  * database will remain unchanged. If false and all validation checks pass,
35  * then the database will be modified.
36  * @param p_start_date Start Date.
37  * @param p_business_group_id Business group of the person.
38  * @param p_family_name Family Name
39  * @param p_person_type_id Type of contingent worker being created.
40  * @param p_npw_number The business group's contingent worker number generation
41  * method determines when the API derives and passes out a contingent worker
42  * number or when the calling program should pass in a value. When the API call
43  * completes if p_validate is true then will be set to the contingent worker
44  * number. If p_validate is true then will be set to the passed value.
45  * @param p_background_check_status Flag indicating whether the person's
46  * background has been checked.
47  * @param p_background_date_check Date on which the background check was
48  * performed.
49  * @param p_blood_type Blood type.
50  * @param p_comments Comment text.
51  * @param p_correspondence_language Preferred language for correspondence.
52  * @param p_country_of_birth Country of birth.
53  * @param p_date_of_birth Date of birth.
54  * @param p_date_of_death Date of death.
55  * @param p_dpdnt_adoption_date Date on which the dependent was adopted.
56  * @param p_dpdnt_vlntry_svce_flag Flag indicating whether the dependent is on
57  * voluntary service.
58  * @param p_email_address Email address.
59  * @param p_first_name First name.
60  * @param p_fte_capacity Obsolete parameter, do not use.
61  * @param p_honors Honors awarded.
62  * @param p_internal_location Internal location of office.
63  * @param p_known_as Preferred name.
64  * @param p_last_medical_test_by Name of physician who performed last medical
65  * test.
66  * @param p_last_medical_test_date Date of last medical test.
67  * @param p_mailstop Internal mail location.
68  * @param p_marital_status Marital status. Valid values are defined by the
69  * MAR_STATUS lookup type.
70  * @param p_national_identifier Number by which a person is identified in a
71  * given legislation.
72  * @param p_nationality Nationality. Valid values are defined by the
73  * NATIONALITY lookup type.
74  * @param p_office_number Office number.
75  * @param p_on_military_service Flag indicating whether the person is on
76  * military service.
77  * @param p_party_id TCA party for whom you create the person record.
78  * @param p_previous_last_name Previous last name.
79  * @param p_projected_placement_end Obsolete parameter, do not use.
80  * @param p_receipt_of_death_cert_date Date death certificate was received.
81  * @param p_region_of_birth Geographical region of birth.
82  * @param p_registered_disabled_flag Flag indicating whether the person is
83  * classified as disabled.
84  * @param p_resume_exists Flag indicating whether the person's resume is on
85  * file.
86  * @param p_resume_last_updated Date on which the resume was last updated.
87  * @param p_second_passport_exists Flag indicating whether a person has
88  * multiple passports.
89  * @param p_sex Legal gender. Valid values are defined by the SEX lookup type.
90  * @param p_student_status If this contingent worker is a student, this field
91  * is used to capture their status. Valid values are defined by the
92  * STUDENT_STATUS lookup type.
93  * @param p_title Title. Valid values are defined by the TITLE lookup type.
94  * @param p_town_of_birth Town or city of birth.
95  * @param p_uses_tobacco_flag Flag indicating whether the person uses tobacco.
96  * @param p_vendor_id Obsolete parameter, do not use.
97  * @param p_work_schedule Days on which this person will work.
98  * @param p_work_telephone Obsolete parameter, do not use.
99  * @param p_exp_check_send_to_address Mailing address.
100  * @param p_hold_applicant_date_until Date until when the applicant's
101  * information is to be maintained.
102  * @param p_date_employee_data_verified Date on which the contingent worker
103  * data was last verified.
104  * @param p_benefit_group_id Benefit group to which this person will belong.
105  * @param p_coord_ben_med_pln_no Secondary medical plan name. Column used for
106  * external processing.
107  * @param p_coord_ben_no_cvg_flag No secondary medical plan coverage. Column
108  * used for external processing.
109  * @param p_original_date_of_hire Original date of hire.
110  * @param p_attribute_category This context value determines which flexfield
111  * structure to use with the descriptive flexfield segments.
112  * @param p_attribute1 Descriptive flexfield segment.
113  * @param p_attribute2 Descriptive flexfield segment.
114  * @param p_attribute3 Descriptive flexfield segment.
115  * @param p_attribute4 Descriptive flexfield segment.
116  * @param p_attribute5 Descriptive flexfield segment.
117  * @param p_attribute6 Descriptive flexfield segment.
118  * @param p_attribute7 Descriptive flexfield segment.
119  * @param p_attribute8 Descriptive flexfield segment.
120  * @param p_attribute9 Descriptive flexfield segment.
121  * @param p_attribute10 Descriptive flexfield segment.
122  * @param p_attribute11 Descriptive flexfield segment.
123  * @param p_attribute12 Descriptive flexfield segment.
124  * @param p_attribute13 Descriptive flexfield segment.
125  * @param p_attribute14 Descriptive flexfield segment.
126  * @param p_attribute15 Descriptive flexfield segment.
127  * @param p_attribute16 Descriptive flexfield segment.
128  * @param p_attribute17 Descriptive flexfield segment.
129  * @param p_attribute18 Descriptive flexfield segment.
130  * @param p_attribute19 Descriptive flexfield segment.
131  * @param p_attribute20 Descriptive flexfield segment.
132  * @param p_attribute21 Descriptive flexfield segment.
133  * @param p_attribute22 Descriptive flexfield segment.
134  * @param p_attribute23 Descriptive flexfield segment.
135  * @param p_attribute24 Descriptive flexfield segment.
136  * @param p_attribute25 Descriptive flexfield segment.
137  * @param p_attribute26 Descriptive flexfield segment.
138  * @param p_attribute27 Descriptive flexfield segment.
139  * @param p_attribute28 Descriptive flexfield segment.
140  * @param p_attribute29 Descriptive flexfield segment.
141  * @param p_attribute30 Descriptive flexfield segment.
142  * @param p_father_name Father's Name
143  * @param p_grandfather_name Grandfather's Name
144  * @param p_alt_first_name Specifies First Name in alternative language
145  * @param p_alt_father_name Specifies Father's Name in alternative language
146  * @param p_alt_grandfather_name Specifies Grandfather's Name in alternative
147  * language
148  * @param p_alt_family_name Specifies Family Name in alternative language
149  * @param p_religion Religion
150  * @param p_hijrah_birth_date Date of birth according to the Hijrah calendar.
151  * @param p_person_id If p_validate is false, then this uniquely identifies the
152  * person created. If p_validate is true, then set to null.
153  * @param p_per_object_version_number If p_validate is false, then set to the
154  * version number of the created person. If p_validate is true, then set to
155  * null.
156  * @param p_per_effective_start_date If p_validate is false, then set to the
157  * earliest effective start date for the created person. If p_validate is true,
158  * then set to null.
159  * @param p_per_effective_end_date If p_validate is false, then set to the
160  * effective end date for the created person. If p_validate is true, then set
161  * to null.
162  * @param p_pdp_object_version_number If p_validate is false, this will be set
163  * to the version number of the person created. If p_validate is true this
164  * parameter will be set to null.
165  * @param p_full_name If p_validate is false, then set to the complete full
166  * name of the person. If p_validate is true, then set to null.
167  * @param p_comment_id If p_validate is false and comment text was provided,
168  * then will be set to the identifier of the created person comment record. If
169  * p_validate is true or no comment text was provided, then will be null.
170  * @param p_assignment_id If p_validate is false, then this uniquely identifies
171  * the created assignment. If p_validate is true, then set to null.
172  * @param p_asg_object_version_number If p_validate is false, then this
173  * parameter is set to the version number of the assignment created. If
174  * p_validate is true, then this parameter is null.
175  * @param p_assignment_sequence If p_validate is false, then set to the
176  * sequence number of the default assignment. If p_validate is true, then set
177  * to null.
178  * @param p_assignment_number If p_validate is false, then set to the
179  * assignment number of the default assignment. If p_validate is true, then set
180  * to null.
181  * @param p_name_combination_warning If set to true, then the combination of
182  * last name, first name and date of birth existed prior to calling this API.
183  * @param p_education_level New parameter, available on the latest version of this API
184  * @rep:displayname Create Contingent Worker for Saudi Arabia
185  * @rep:category BUSINESS_ENTITY PER_CWK
186  * @rep:scope public
187  * @rep:lifecycle active
188  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
189 */
190 --
191 -- {End Of Comments}
192 --
193 procedure create_sa_cwk
194   (p_validate                      in     boolean  default false
195   ,p_start_date                    in     date
196   ,p_business_group_id             in     number
197   ,p_family_name                   in     varchar2
198   ,p_person_type_id                in     number   default null
199   ,p_npw_number                    in out nocopy varchar2
200   ,p_background_check_status       in     varchar2 default null
201   ,p_background_date_check         in     date     default null
202   ,p_blood_type                    in     varchar2 default null
203   ,p_comments                      in     varchar2 default null
204   ,p_correspondence_language       in     varchar2 default null
205   ,p_country_of_birth              in     varchar2 default null
206   ,p_date_of_birth                 in     date     default null
207   ,p_date_of_death                 in     date     default null
208   ,p_dpdnt_adoption_date           in     date     default null
209   ,p_dpdnt_vlntry_svce_flag        in     varchar2 default null
210   ,p_email_address                 in     varchar2 default null
211   ,p_first_name                    in     varchar2 default null
212   ,p_fte_capacity                  in     number   default null
213   ,p_honors                        in     varchar2 default null
214   ,p_internal_location             in     varchar2 default null
215   ,p_known_as                      in     varchar2 default null
216   ,p_last_medical_test_by          in     varchar2 default null
217   ,p_last_medical_test_date        in     date     default null
218   ,p_mailstop                      in     varchar2 default null
219   ,p_marital_status                in     varchar2 default null
220   ,p_national_identifier           in     varchar2 default null
221   ,p_nationality                   in     varchar2 default null
222   ,p_office_number                 in     varchar2 default null
223   ,p_on_military_service           in     varchar2 default null
224   ,p_party_id                      in     number   default null
225   ,p_previous_last_name            in     varchar2 default null
226   ,p_projected_placement_end       in     date     default null
227   ,p_receipt_of_death_cert_date    in     date     default null
228   ,p_region_of_birth               in     varchar2 default null
229   ,p_registered_disabled_flag      in     varchar2 default null
230   ,p_resume_exists                 in     varchar2 default null
231   ,p_resume_last_updated           in     date     default null
232   ,p_second_passport_exists        in     varchar2 default null
233   ,p_sex                           in     varchar2 default null
234   ,p_student_status                in     varchar2 default null
235   ,p_title                         in     varchar2 default null
236   ,p_town_of_birth                 in     varchar2 default null
237   ,p_uses_tobacco_flag             in     varchar2 default null
238   ,p_vendor_id                     in     number   default null
239   ,p_work_schedule                 in     varchar2 default null
240   ,p_work_telephone                in     varchar2 default null
241   ,p_exp_check_send_to_address     in     varchar2 default null
242   ,p_hold_applicant_date_until     in     date     default null
243   ,p_date_employee_data_verified   in     date     default null
244   ,p_benefit_group_id              in     number   default null
245   ,p_coord_ben_med_pln_no          in     varchar2 default null
246   ,p_coord_ben_no_cvg_flag         in     varchar2 default null
247   ,p_original_date_of_hire         in     date     default null
248   ,p_attribute_category            in     varchar2 default null
249   ,p_attribute1                    in     varchar2 default null
250   ,p_attribute2                    in     varchar2 default null
251   ,p_attribute3                    in     varchar2 default null
252   ,p_attribute4                    in     varchar2 default null
253   ,p_attribute5                    in     varchar2 default null
254   ,p_attribute6                    in     varchar2 default null
255   ,p_attribute7                    in     varchar2 default null
256   ,p_attribute8                    in     varchar2 default null
257   ,p_attribute9                    in     varchar2 default null
258   ,p_attribute10                   in     varchar2 default null
259   ,p_attribute11                   in     varchar2 default null
260   ,p_attribute12                   in     varchar2 default null
261   ,p_attribute13                   in     varchar2 default null
262   ,p_attribute14                   in     varchar2 default null
263   ,p_attribute15                   in     varchar2 default null
264   ,p_attribute16                   in     varchar2 default null
265   ,p_attribute17                   in     varchar2 default null
266   ,p_attribute18                   in     varchar2 default null
267   ,p_attribute19                   in     varchar2 default null
268   ,p_attribute20                   in     varchar2 default null
269   ,p_attribute21                   in     varchar2 default null
270   ,p_attribute22                   in     varchar2 default null
271   ,p_attribute23                   in     varchar2 default null
272   ,p_attribute24                   in     varchar2 default null
273   ,p_attribute25                   in     varchar2 default null
274   ,p_attribute26                   in     varchar2 default null
275   ,p_attribute27                   in     varchar2 default null
276   ,p_attribute28                   in     varchar2 default null
277   ,p_attribute29                   in     varchar2 default null
278   ,p_attribute30                   in     varchar2 default null
279   ,p_father_name             	   in     varchar2 default null
280   ,p_grandfather_name              in     varchar2 default null
281   ,p_alt_first_name                in     varchar2 default null
282   ,p_alt_father_name               in     varchar2 default null
283   ,p_alt_grandfather_name          in     varchar2 default null
284   ,p_alt_family_name           	   in     varchar2 default null
285   ,p_religion                      in     varchar2 default null
286   ,p_hijrah_birth_date             in     varchar2 default null
287   ,p_education_level               in     varchar2 default null
288   ,p_person_id                        out nocopy   number
289   ,p_per_object_version_number        out nocopy   number
290   ,p_per_effective_start_date         out nocopy   date
291   ,p_per_effective_end_date           out nocopy   date
292   ,p_pdp_object_version_number        out nocopy   number
293   ,p_full_name                        out nocopy   varchar2
294   ,p_comment_id                       out nocopy   number
298   ,p_assignment_number                out nocopy   varchar2
295   ,p_assignment_id                    out nocopy   number
296   ,p_asg_object_version_number        out nocopy   number
297   ,p_assignment_sequence              out nocopy   number
299   ,p_name_combination_warning         out nocopy   boolean
300   );
301 
302 end hr_sa_contingent_worker_api;