DBA Data[Home] [Help]

PACKAGE: APPS.HR_IN_CONTINGENT_WORKER_API

Source


1 PACKAGE hr_in_contingent_worker_api AUTHID CURRENT_USER as
2 /* $Header: pecwkini.pkh 120.1 2005/10/02 02:40 aroussel $ */
3 /*#
4  * This package contains contingent worker APIs.
5  * @rep:scope public
6  * @rep:product PER
7  * @rep:displayname Contingent Worker for India
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |------------------------------< create_in_cwk >---------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16  * This API creates a contingent worker.
17  *
18  * The API creates a person record and a default contingent worker assignment
19  * for a new non-payrolled worker.
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  * If person_type_id is supplied, it must have a corresponding system person
26  * type of 'CWK', must be active and be in the same business group as that of
27  * the employee being created.
28  *
29  * <p><b>Post Success</b><br>
30  * Creates a contingent worker.
31  *
32  * <p><b>Post Failure</b><br>
33  * The API does not create a contingent worker and raises an 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_start_date Start date for person, default assignment and placement
39  * record.
40  * @param p_business_group_id The contingent worker's business group.
41  * @param p_last_name Last name of the contingent worker.
42  * @param p_person_type_id This is the identifier corrresponding to the type of
43  * person. If an identification number is not specified, then the API will use
44  * the default 'CWK' type for the business group.
45  * @param p_npw_number If p_validate is false then the parameter value passed
46  * is used as the number of non-payrolled worker. If no value is passed the
47  * number of non-payrolled worker is generated. If p_validate is true null is
48  * returned.
49  * @param p_background_check_status Indicates whether background check has been
50  * performed. Valid values are defined by 'Yes_No' lookup type.
51  * @param p_background_date_check Date background check was performed.
52  * @param p_blood_type Blood type of the contingent worker. Valid values are
53  * defined by 'BLOOD_TYPE' lookup type.
54  * @param p_comments Contingent worker comment text.
55  * @param p_correspondence_language Preferred language for correspondance.
56  * @param p_country_of_birth Country of birth of the contingent worker. Valid
57  * values are defined in FND_TERRITORIES
58  * @param p_date_of_birth Date of birth of the contingent worker.
59  * @param p_date_of_death Date of death of the contingent worker.
60  * @param p_dpdnt_adoption_date Date dependent was adopted.
61  * @param p_dpdnt_vlntry_svce_flag Indicates whether the dependent is on
62  * voluntary service.
63  * @param p_email_address Email address of the contingent worker.
64  * @param p_first_name First name of the contingent worker.
65  * @param p_fte_capacity Full-time employment capacity of the contingent
66  * worker.
67  * @param p_honors Honors or degrees awarded.
68  * @param p_internal_location Internal location of office of the contingent
69  * worker.
70  * @param p_alias_name Alias name of the contingent worker.
71  * @param p_last_medical_test_by Name of physician who performed last medical
72  * test.
73  * @param p_last_medical_test_date Date of last medical test.
74  * @param p_mailstop Internal mail location for the contingent worker.
75  * @param p_marital_status Marital status of the contingent worker. Valid
76  * values are defined by 'MAR_STATUS' lookup type.
77  * @param p_middle_name Contingent worker's middle name(s).
78  * @param p_national_identifier National identifier of the contingent worker.
79  * @param p_nationality Contingent worker's nationality. Valid values are
80  * defined by 'NATIONALITY' lookup type.
81  * @param p_office_number Office Number of the contingent worker.
82  * @param p_on_military_service Y/N flag indicating whether the contingent
83  * worker is employed in military service.
84  * @param p_party_id Identifier for the party.
85  * @param p_pre_name_adjunct Name prefix of the contingent worker.
86  * @param p_previous_last_name Previous last name of the contingent worker.
87  * @param p_projected_placement_end Obsolete parameter, do not use.
88  * @param p_receipt_of_death_cert_date Date when the death certificate is
89  * received.
90  * @param p_region_of_birth Geographical region of birth of the contingent
91  * worker.
92  * @param p_registered_disabled_flag Indicates whether person is classified as
93  * disabled. Valid values are defined by 'REGISTERED_DISABLED' lookup type.
94  * @param p_resume_exists Y/N flag indicating whether resume is on file.
95  * @param p_resume_last_updated Date when the resume was last updated.
96  * @param p_second_passport_exists Y/N flag indicaing whether the person has
97  * multiple passports.
98  * @param p_sex Contingent worker's sex.
99  * @param p_student_status Full time/part time status of the contingent worker.
100  * @param p_suffix Name Suffix of the contingent worker.
101  * @param p_title Title of the contingent worker. Valid values are defined by
102  * 'TITLE' lookup type.
103  * @param p_place_of_birth Town or city of birth of the contingent worker.
104  * @param p_uses_tobacco_flag Tobacco type used by the contingent worker. Valid
105  * values are defined by 'TOBACCO_USER' lookup type.
106  * @param p_vendor_id Identifier of workers supplying organization.
107  * @param p_work_schedule Type of work schedule indicating which days the
108  * contingent worker works. Valid values are defined by 'WORK_SCHEDULE' lookup
109  * type.
110  * @param p_work_telephone Work telephone of the contingent worker.
111  * @param p_exp_check_send_to_address Mailing address of the contingent worker.
112  * @param p_hold_applicant_date_until Date until which the applicant should be
113  * put on hold.
114  * @param p_date_employee_data_verified Date when the employee last verified
115  * the data.
116  * @param p_benefit_group_id Identification for benefit group.
117  * @param p_coord_ben_med_pln_no Coordination of benefits medical group plan
118  * number.
119  * @param p_coord_ben_no_cvg_flag Coordination of benefits no other coverage
120  * flag.
121  * @param p_original_date_of_hire Original date of hire of the contingent
122  * worker.
123  * @param p_attribute_category This context value determines which flexfield
124  * structure to use with the descriptive flexfield segments.
125  * @param p_attribute1 Descriptive flexfield segment.
126  * @param p_attribute2 Descriptive flexfield segment.
127  * @param p_attribute3 Descriptive flexfield segment.
128  * @param p_attribute4 Descriptive flexfield segment.
129  * @param p_attribute5 Descriptive flexfield segment.
130  * @param p_attribute6 Descriptive flexfield segment.
131  * @param p_attribute7 Descriptive flexfield segment.
132  * @param p_attribute8 Descriptive flexfield segment.
133  * @param p_attribute9 Descriptive flexfield segment.
134  * @param p_attribute10 Descriptive flexfield segment.
135  * @param p_attribute11 Descriptive flexfield segment.
136  * @param p_attribute12 Descriptive flexfield segment.
137  * @param p_attribute13 Descriptive flexfield segment.
138  * @param p_attribute14 Descriptive flexfield segment.
139  * @param p_attribute15 Descriptive flexfield segment.
140  * @param p_attribute16 Descriptive flexfield segment.
141  * @param p_attribute17 Descriptive flexfield segment.
142  * @param p_attribute18 Descriptive flexfield segment.
143  * @param p_attribute19 Descriptive flexfield segment.
144  * @param p_attribute20 Descriptive flexfield segment.
145  * @param p_attribute21 Descriptive flexfield segment.
146  * @param p_attribute22 Descriptive flexfield segment.
147  * @param p_attribute23 Descriptive flexfield segment.
148  * @param p_attribute24 Descriptive flexfield segment.
149  * @param p_attribute25 Descriptive flexfield segment.
150  * @param p_attribute26 Descriptive flexfield segment.
151  * @param p_attribute27 Descriptive flexfield segment.
152  * @param p_attribute28 Descriptive flexfield segment.
153  * @param p_attribute29 Descriptive flexfield segment.
154  * @param p_attribute30 Descriptive flexfield segment.
155  * @param p_pan PAN of the person. Should be in correct format (XXXXX9999X).
156  * @param p_pan_af PAN Applied for Flag. Valid values are defined by 'YES_NO'
157  * lookup type. Has to be null if p_pan is populated.
158  * @param p_ex_serviceman Military Status. Valid values are defined by 'YES_NO'
159  * lookup type.
160  * @param p_resident_status Residential Status of the person. Valid values are
161  * defined by 'IN_RESIDENTIAL_STATUS' lookup type.
162  * @param p_pf_number PF Number of the contingent worker.
163  * @param p_esi_number ESI Nnumber of the contingent worker.
164  * @param p_superannuation_number Superannuation Number of the contingent
165  * worker.
166  * @param p_gi_number Group Insurance Number of the contingent worker.
167  * @param p_gratuity_number Gratuity Number of the contingent worker.
168  * @param p_pension_number Pension Number of the contingent worker.
169  * @param p_person_id If p_validate is false, then this uniquely identifies the
170  * person created. If p_validate is true, then set to null.
171  * @param p_per_object_version_number If p_validate is false, then set to the
172  * version number of the created person. If p_validate is true, then the value
173  * will be null.
174  * @param p_per_effective_start_date If p_validate is false, this will be set
175  * to the effective start date of the person. If p_validate is true this will
176  * be null.
177  * @param p_per_effective_end_date If p_validate is false, this will be set to
178  * the effective end date of the person. If p_validate is true this will be
179  * null.
180  * @param p_pdp_object_version_number If p_validate is false, this will be set
181  * to the version number of the person created. If p_validate is true this
182  * parameter will be set to null.
183  * @param p_full_name If p_validate is false, this will be set to the complete
184  * full name of the person. If p_validate is true this will be null.
185  * @param p_comment_id If p_validate is false and comment text was provided,
186  * then will be set to the identifier of the created contingent worker comment
187  * record. If p_validate is true or no comment text was provided, then will be
188  * null.
189  * @param p_assignment_id If p_validate is false, then this uniquely identifies
190  * the created assignment. If p_validate is true, then set to null.
191  * @param p_asg_object_version_number If p_validate is false, then this
192  * parameter is set to the version number of the assignment created. If
193  * p_validate is true, then this parameter is null.
194  * @param p_assignment_sequence If p_validate is false, this will be set to the
195  * sequence number of the default assignment created. If p_validate is true
196  * this parameter will be set to null.
197  * @param p_assignment_number If p_validate is false this will be set to the
198  * assignment number of the primary assignment. If p_validate is true this will
199  * be null.
200  * @param p_name_combination_warning If set to true, then the combination of
201  * last name, first name and date of birth existed prior to calling this API.
202  * @rep:displayname Create Contingent Worker for India
203  * @rep:category BUSINESS_ENTITY PER_CWK
204  * @rep:lifecycle active
205  * @rep:category MISC_EXTENSIONS HR_DATAPUMP
206  * @rep:scope public
207  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
208 */
209 --
210 -- {End Of Comments}
211 --
212 procedure create_in_cwk
213   (p_validate                      IN     BOOLEAN  DEFAULT FALSE
214   ,p_start_date                    IN     DATE
215   ,p_business_group_id             IN     NUMBER
216   ,p_last_name                     IN     VARCHAR2
217   ,p_person_type_id                IN     NUMBER   DEFAULT NULL
218   ,p_npw_number                    IN OUT NOCOPY VARCHAR2
219   ,p_background_check_status       IN     VARCHAR2 DEFAULT NULL
220   ,p_background_date_check         IN     DATE     DEFAULT NULL
221   ,p_blood_type                    IN     VARCHAR2 DEFAULT NULL
222   ,p_comments                      IN     VARCHAR2 DEFAULT NULL
223   ,p_correspondence_language       IN     VARCHAR2 DEFAULT NULL
224   ,p_country_of_birth              IN     VARCHAR2 DEFAULT NULL
225   ,p_date_of_birth                 IN     DATE     DEFAULT NULL
226   ,p_date_of_death                 IN     DATE     DEFAULT NULL
227   ,p_dpdnt_adoption_date           IN     DATE     DEFAULT NULL
228   ,p_dpdnt_vlntry_svce_flag        IN     VARCHAR2 DEFAULT NULL
229   ,p_email_address                 IN     VARCHAR2 DEFAULT NULL
230   ,p_first_name                    IN     VARCHAR2 DEFAULT NULL
231   ,p_fte_capacity                  IN     NUMBER   DEFAULT NULL
232   ,p_honors                        IN     VARCHAR2 DEFAULT NULL
233   ,p_internal_location             IN     VARCHAR2 DEFAULT NULL
234   ,p_alias_name                    IN     VARCHAR2 DEFAULT NULL
235   ,p_last_medical_test_by          IN     VARCHAR2 DEFAULT NULL
236   ,p_last_medical_test_date        IN     DATE     DEFAULT NULL
237   ,p_mailstop                      IN     VARCHAR2 DEFAULT NULL
238   ,p_marital_status                IN     VARCHAR2 DEFAULT NULL
239   ,p_middle_name                   IN     VARCHAR2 DEFAULT NULL
240   ,p_national_identifier           IN     VARCHAR2 DEFAULT NULL
241   ,p_nationality                   IN     VARCHAR2 DEFAULT NULL
242   ,p_office_number                 IN     VARCHAR2 DEFAULT NULL
243   ,p_on_military_service           IN     VARCHAR2 DEFAULT NULL
244   ,p_party_id                      IN     NUMBER   DEFAULT NULL
245   ,p_pre_name_adjunct              IN     VARCHAR2 DEFAULT NULL
246   ,p_previous_last_name            IN     VARCHAR2 DEFAULT NULL
247   ,p_projected_placement_end       IN     DATE     DEFAULT NULL
248   ,p_receipt_of_death_cert_date    IN     DATE     DEFAULT NULL
249   ,p_region_of_birth               IN     VARCHAR2 DEFAULT NULL
250   ,p_registered_disabled_flag      IN     VARCHAR2 DEFAULT NULL
251   ,p_resume_exists                 IN     VARCHAR2 DEFAULT NULL
252   ,p_resume_last_updated           IN     DATE     DEFAULT NULL
253   ,p_second_passport_exists        IN     VARCHAR2 DEFAULT NULL
254   ,p_sex                           IN     VARCHAR2 DEFAULT NULL
255   ,p_student_status                IN     VARCHAR2 DEFAULT NULL
256   ,p_suffix                        IN     VARCHAR2 DEFAULT NULL
257   ,p_title                         IN     VARCHAR2 DEFAULT NULL
258   ,p_place_of_birth                IN     VARCHAR2 DEFAULT NULL
259   ,p_uses_tobacco_flag             IN     VARCHAR2 DEFAULT NULL
260   ,p_vendor_id                     IN     NUMBER   DEFAULT NULL
261   ,p_work_schedule                 IN     VARCHAR2 DEFAULT NULL
262   ,p_work_telephone                IN     VARCHAR2 DEFAULT NULL
263   ,p_exp_check_send_to_address     IN     VARCHAR2 DEFAULT NULL
264   ,p_hold_applicant_date_until     IN     DATE     DEFAULT NULL
265   ,p_date_employee_data_verified   IN     DATE     DEFAULT NULL
266   ,p_benefit_group_id              IN     NUMBER   DEFAULT NULL
267   ,p_coord_ben_med_pln_no          IN     VARCHAR2 DEFAULT NULL
268   ,p_coord_ben_no_cvg_flag         IN     VARCHAR2 DEFAULT NULL
269   ,p_original_date_of_hire         IN     DATE     DEFAULT NULL
270   ,p_attribute_category            IN     VARCHAR2 DEFAULT NULL
271   ,p_attribute1                    IN     VARCHAR2 DEFAULT NULL
272   ,p_attribute2                    IN     VARCHAR2 DEFAULT NULL
273   ,p_attribute3                    IN     VARCHAR2 DEFAULT NULL
274   ,p_attribute4                    IN     VARCHAR2 DEFAULT NULL
275   ,p_attribute5                    IN     VARCHAR2 DEFAULT NULL
276   ,p_attribute6                    IN     VARCHAR2 DEFAULT NULL
277   ,p_attribute7                    IN     VARCHAR2 DEFAULT NULL
278   ,p_attribute8                    IN     VARCHAR2 DEFAULT NULL
279   ,p_attribute9                    IN     VARCHAR2 DEFAULT NULL
280   ,p_attribute10                   IN     VARCHAR2 DEFAULT NULL
281   ,p_attribute11                   IN     VARCHAR2 DEFAULT NULL
282   ,p_attribute12                   IN     VARCHAR2 DEFAULT NULL
283   ,p_attribute13                   IN     VARCHAR2 DEFAULT NULL
284   ,p_attribute14                   IN     VARCHAR2 DEFAULT NULL
285   ,p_attribute15                   IN     VARCHAR2 DEFAULT NULL
286   ,p_attribute16                   IN     VARCHAR2 DEFAULT NULL
287   ,p_attribute17                   IN     VARCHAR2 DEFAULT NULL
288   ,p_attribute18                   IN     VARCHAR2 DEFAULT NULL
289   ,p_attribute19                   IN     VARCHAR2 DEFAULT NULL
290   ,p_attribute20                   IN     VARCHAR2 DEFAULT NULL
291   ,p_attribute21                   IN     VARCHAR2 DEFAULT NULL
292   ,p_attribute22                   IN     VARCHAR2 DEFAULT NULL
293   ,p_attribute23                   IN     VARCHAR2 DEFAULT NULL
294   ,p_attribute24                   IN     VARCHAR2 DEFAULT NULL
295   ,p_attribute25                   IN     VARCHAR2 DEFAULT NULL
296   ,p_attribute26                   IN     VARCHAR2 DEFAULT NULL
297   ,p_attribute27                   IN     VARCHAR2 DEFAULT NULL
298   ,p_attribute28                   IN     VARCHAR2 DEFAULT NULL
299   ,p_attribute29                   IN     VARCHAR2 DEFAULT NULL
300   ,p_attribute30                   IN     VARCHAR2 DEFAULT NULL
301   ,p_pan                           IN     VARCHAR2 DEFAULT NULL
302   ,p_pan_af                        IN     VARCHAR2 DEFAULT NULL
303   ,p_ex_serviceman                 IN     VARCHAR2 DEFAULT NULL
304   ,p_resident_status               IN     VARCHAR2 DEFAULT NULL
305   ,p_pf_number                     IN     VARCHAR2 DEFAULT NULL
306   ,p_esi_number                    IN     VARCHAR2 DEFAULT NULL
307   ,p_superannuation_number         IN     VARCHAR2 DEFAULT NULL
308   ,p_gi_number                     IN     VARCHAR2 DEFAULT NULL
309   ,p_gratuity_number               IN     VARCHAR2 DEFAULT NULL
310   ,p_pension_number                IN     VARCHAR2 DEFAULT NULL
311   ,p_person_id                        OUT NOCOPY   NUMBER
312   ,p_per_object_version_number        OUT NOCOPY   NUMBER
313   ,p_per_effective_start_date         OUT NOCOPY   DATE
314   ,p_per_effective_end_date           OUT NOCOPY   DATE
315   ,p_pdp_object_version_number        OUT NOCOPY   NUMBER
316   ,p_full_name                        OUT NOCOPY   VARCHAR2
317   ,p_comment_id                       OUT NOCOPY   NUMBER
318   ,p_assignment_id                    OUT NOCOPY   NUMBER
319   ,p_asg_object_version_number        OUT NOCOPY   NUMBER
320   ,p_assignment_sequence              OUT NOCOPY   NUMBER
321   ,p_assignment_number                OUT NOCOPY   VARCHAR2
322   ,p_name_combination_warning         OUT NOCOPY   BOOLEAN
323   )  ;
324 END hr_in_contingent_worker_api;