DBA Data[Home] [Help]

PACKAGE: APPS.HR_IT_EMPLOYEE_API

Source


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