DBA Data[Home] [Help]

PACKAGE: APPS.HR_DK_EMPLOYEE_API

Source


1 PACKAGE HR_DK_EMPLOYEE_API AS
2 /* $Header: peempdki.pkh 120.4 2006/10/11 07:27:01 saurai noship $ */
3 /*#
4  * This package contains employee APIs.
5  * @rep:scope public
6  * @rep:product PER
7  * @rep:displayname Employee For Denmark
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------------< create_dk_employee >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16  * This API creates a new employee including a default primary assignment and a
17  * period of service for the employee.
18  *
19  * This API is effectively an alternative to the API create_employee. If
20  * p_validate is set to false, an employee is created.
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  * The business group for Denmark legislation must already exist. Also a valid
27  * person_type_id, with a corresponding system type of 'EMP', must be active
28  * and should exist in the employee's business group.
29  *
30  * <p><b>Post Success</b><br>
31  * The person, primary assignment and period of service will be successfully
32  * inserted into the database.
33  *
34  * <p><b>Post Failure</b><br>
35  * The API does not create the person, primary assignment or period of service,
36  * and raises an error.
37  *
38  * @param p_validate If true, then validation alone will be performed and the
39  * database will remain unchanged. If false and all validation checks pass,
40  * then the database will be modified.
41  * @param p_hire_date The employee's hire date and thus the effective start
42  * date of the person, primary assignment and period of service.
43  * @param p_business_group_id The employee's business group.
44  * @param p_last_name The employee's last name.
45  * @param p_sex The employee's sex. Valid values are defined by 'SEX' lookup
46  * type.
47  * @param p_person_type_id Person type ID. If this value is omitted then the
48  * person_type_id of the default `EMP' system person type, in the employee's
49  * business group, is used.
50  * @param p_comments Employee comment text.
51  * @param p_date_employee_data_verified The date on which the employee's data
52  * was last verified.
53  * @param p_date_of_birth The employee's date of birth.
54  * @param p_email_address The employee's email address.
55  * @param p_employee_number The employee number. The parameter is mandatory if
56  * the number generation method is Manual, else the parameter must be NULL. If
57  * p_validate is false and the employee number generation method is Automatic,
58  * the parameter will be set to the generated employee number of the person
59  * created. If p_validate is false and the employee number generation method is
60  * manual, the parameter will be set to the same value passed in. If p_validate
61  * is true this will be set to the same value as passed in.
62  * @param p_expense_check_send_to_addres Address to use as mailing address.
63  * @param p_first_name The employee's first name.
64  * @param p_middle_names Person's middle name.
65  * @param p_known_as Alternative name.
66  * @param p_marital_status Marital status. Valid values are defined by
67  * 'MAR_STATUS' lookup type.
68  * @param p_nationality Employee's nationality.
69  * @param p_national_identifier National identifier.
70  * @param p_previous_last_name Previous last name.
71  * @param p_registered_disabled_flag Registered disabled flag.
72  * @param p_title Employee's title.
73  * @param p_vendor_id Foreign key to PO_VENDORS.
74  * @param p_work_telephone Work telephone.
75  * @param p_attribute_category This context value determines which flexfield
76  * structure to use with the descriptive flexfield segments.
77  * @param p_attribute1 Descriptive flexfield segment.
78  * @param p_attribute2 Descriptive flexfield segment.
79  * @param p_attribute3 Descriptive flexfield segment.
80  * @param p_attribute4 Descriptive flexfield segment.
81  * @param p_attribute5 Descriptive flexfield segment.
82  * @param p_attribute6 Descriptive flexfield segment.
83  * @param p_attribute7 Descriptive flexfield segment.
84  * @param p_attribute8 Descriptive flexfield segment.
85  * @param p_attribute9 Descriptive flexfield segment.
86  * @param p_attribute10 Descriptive flexfield segment.
87  * @param p_attribute11 Descriptive flexfield segment.
88  * @param p_attribute12 Descriptive flexfield segment.
89  * @param p_attribute13 Descriptive flexfield segment.
90  * @param p_attribute14 Descriptive flexfield segment.
91  * @param p_attribute15 Descriptive flexfield segment.
92  * @param p_attribute16 Descriptive flexfield segment.
93  * @param p_attribute17 Descriptive flexfield segment.
94  * @param p_attribute18 Descriptive flexfield segment.
95  * @param p_attribute19 Descriptive flexfield segment.
96  * @param p_attribute20 Descriptive flexfield segment.
97  * @param p_attribute21 Descriptive flexfield segment.
98  * @param p_attribute22 Descriptive flexfield segment.
99  * @param p_attribute23 Descriptive flexfield segment.
100  * @param p_attribute24 Descriptive flexfield segment.
101  * @param p_attribute25 Descriptive flexfield segment.
102  * @param p_attribute26 Descriptive flexfield segment.
103  * @param p_attribute27 Descriptive flexfield segment.
104  * @param p_attribute28 Descriptive flexfield segment.
105  * @param p_attribute29 Descriptive flexfield segment.
106  * @param p_attribute30 Descriptive flexfield segment.
107  * @param p_initials The employee's initials.
108  * @param p_jubilee_date Jubilee Date.
109  * @param p_trainee Trainee.
110  * @param p_date_of_death Date of death.
111  * @param p_background_check_status Y/N flag indicates whether background check
112  * has been performed.
113  * @param p_background_date_check Date background check was performed.
114  * @param p_blood_type Blood type.
115  * @param p_correspondence_language Preferred language for correspondence.
116  * @param p_fast_path_employee Currently unsupported.
117  * @param p_fte_capacity Full time/part time availability for work.
118  * @param p_honors Honors or degrees awarded.
119  * @param p_internal_location Internal location of office.
120  * @param p_last_medical_test_by Name of physician who performed last medical
121  * test.
122  * @param p_last_medical_test_date Date of last medical test.
123  * @param p_mailstop Office identifier for internal mail.
124  * @param p_office_number Number of office.
125  * @param p_on_military_service Y/N flag indicating whether person is employed
126  * in military service.
127  * @param p_projected_start_date Currently unsupported.
128  * @param p_resume_exists Y/N flag indicating whether the resume is on file.
129  * @param p_resume_last_updated Date resume last updated.
130  * @param p_second_passport_exists Y/N flag indicating whether person has
131  * multiple passports.
132  * @param p_student_status Full time/part time status of student.
133  * @param p_work_schedule Type of work schedule indicating the person's work
134  * days.
135  * @param p_benefit_group_id Benefit group ID.
136  * @param p_receipt_of_death_cert_date Date the death certificate is received.
137  * @param p_coord_ben_med_pln_no Coordinated benefit medical plan number.
138  * @param p_coord_ben_no_cvg_flag Coordinated benefit no other coverage flag.
139  * @param p_coord_ben_med_ext_er Secondary medical coverage external employer.
140  * @param p_coord_ben_med_pl_name Secondary medical coverage name.
141  * @param p_coord_ben_med_insr_crr_name Secondary medical coverage insurance
142  * carrier.
143  * @param p_coord_ben_med_insr_crr_ident Secondary medical coverage insurance
144  * carrier id.
145  * @param p_coord_ben_med_cvg_strt_dt Secondary medical coverage effective
146  * start date.
147  * @param p_coord_ben_med_cvg_end_dt Secondary medical coverage effective end
148  * date.
149  * @param p_uses_tobacco_flag Uses tobacco list of values.
150  * @param p_dpdnt_adoption_date Dependent's adoption date.
151  * @param p_dpdnt_vlntry_svce_flag Dependent's voluntary service flag.
152  * @param p_original_date_of_hire Original date of hire.
153  * @param p_adjusted_svc_date Adjusted service date.
154  * @param p_town_of_birth Town or city of birth.
155  * @param p_region_of_birth Geographical region of birth.
156  * @param p_country_of_birth Country of birth.
157  * @param p_global_person_id Global ID for the person.
158  * @param p_person_id If p_validate is false, then this uniquely identifies the
159  * person created. If p_validate is true, then set to null.
160  * @param p_assignment_id If p_validate is false, then this uniquely identifies
161  * the created assignment. If p_validate is true, then set to null.
162  * @param p_per_object_version_number If p_validate is false, then set to the
163  * version number of the created person. If p_validate is true, then the value
164  * will be null.
165  * @param p_asg_object_version_number If p_validate is false, then this
166  * parameter is set to the version number of the assignment created. If
167  * p_validate is true, then this parameter is null.
168  * @param p_per_effective_start_date If p_validate is false, this will be set
169  * to the effective start date of the person. If p_validate is true this will
170  * be null.
171  * @param p_per_effective_end_date If p_validate is false, this will be set to
172  * the effective end date of the person. If p_validate is true this will be
173  * null.
174  * @param p_full_name If p_validate is false, this will be set to the complete
175  * full name of the person. If p_validate is true this will be null.
176  * @param p_per_comment_id If p_validate is false this will be set to the ID of
177  * the corresponding person comment row, if any comment text exists. If
178  * p_validate is true this will be null.
179  * @param p_assignment_sequence If p_validate is false this will be set to the
180  * sequence number of the primary assignment. If p_validate is true this will
181  * be null.
182  * @param p_assignment_number If p_validate is false this will be set to the
183  * assignment number of the primary assignment. If p_validate is true this will
184  * be null.
185  * @param p_name_combination_warning If set to true, then the combination of
186  * last name, first name and date of birth existed prior to calling this API.
187  * @param p_assign_payroll_warning If set to true, then the date of birth is
188  * not entered. If set to false, then the date of birth has been entered.
189  * Indicates if it will be possible to set the payroll on any of this person's
190  * assignments.
191  * @param p_orig_hire_warning Set to true if the original hire date is not null
192  * and the person type is not EMP, EMP_APL, EX_EMP or EX_EMP_APL.
193  * @rep:displayname Create Employee for Denmark
194  * @rep:category BUSINESS_ENTITY PER_EMPLOYEE
195  * @rep:lifecycle active
196  * @rep:scope public
197  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
198 */
199 --
200 -- {End Of Comments}
201 --
202 PROCEDURE create_dk_employee
203   (p_validate                       in      boolean  default false
204   ,p_hire_date                      in      date
205   ,p_business_group_id              in      number
206   ,p_last_name                    in      varchar2
207   ,p_sex                            in      varchar2
208   ,p_person_type_id                 in      number   default null
209   ,p_comments                       in      varchar2 default null
210   ,p_date_employee_data_verified    in      date     default null
211   ,p_date_of_birth                  in      date     default null
212   ,p_email_address                  in      varchar2 default null
213   ,p_employee_number                in out  nocopy varchar2
214   ,p_expense_check_send_to_addres   in      varchar2 default null
215   ,p_first_name                     in      varchar2
216   -- Added for bug fix 4666216
217   ,p_middle_names                   in     varchar2 default null
218   ,p_known_as                       in      varchar2 default null
219   ,p_marital_status                 in      varchar2 default null
220   ,p_nationality                    in      varchar2
221   ,p_national_identifier            in      varchar2 default null
222   ,p_previous_last_name             in      varchar2 default null
223   ,p_registered_disabled_flag       in      varchar2 default null
224   ,p_title                          in      varchar2
225   ,p_vendor_id                      in      number   default null
226   ,p_work_telephone                 in      varchar2 default null
227   ,p_attribute_category             in      varchar2 default null
228   ,p_attribute1                     in      varchar2 default null
229   ,p_attribute2                     in      varchar2 default null
230   ,p_attribute3                     in      varchar2 default null
231   ,p_attribute4                     in      varchar2 default null
232   ,p_attribute5                     in      varchar2 default null
233   ,p_attribute6                     in      varchar2 default null
234   ,p_attribute7                     in      varchar2 default null
235   ,p_attribute8                     in      varchar2 default null
236   ,p_attribute9                     in      varchar2 default null
237   ,p_attribute10                    in      varchar2 default null
238   ,p_attribute11                    in      varchar2 default null
239   ,p_attribute12                    in      varchar2 default null
240   ,p_attribute13                    in      varchar2 default null
241   ,p_attribute14                    in      varchar2 default null
242   ,p_attribute15                    in      varchar2 default null
243   ,p_attribute16                    in      varchar2 default null
244   ,p_attribute17                    in      varchar2 default null
245   ,p_attribute18                    in      varchar2 default null
246   ,p_attribute19                    in      varchar2 default null
247   ,p_attribute20                    in      varchar2 default null
248   ,p_attribute21                    in      varchar2 default null
249   ,p_attribute22                    in      varchar2 default null
250   ,p_attribute23                    in      varchar2 default null
251   ,p_attribute24                    in      varchar2 default null
252   ,p_attribute25                    in      varchar2 default null
253   ,p_attribute26                    in      varchar2 default null
254   ,p_attribute27                    in      varchar2 default null
255   ,p_attribute28                    in      varchar2 default null
256   ,p_attribute29                    in      varchar2 default null
257   ,p_attribute30                    in      varchar2 default null
258   ,p_initials        	 	in      varchar2 default null
259   ,p_jubilee_date		   in		date default null
260   ,p_trainee			    IN      VARCHAR2 DEFAULT null
261   ,p_date_of_death                  in      date     default null
262   ,p_background_check_status        in      varchar2 default null
263   ,p_background_date_check          in      date     default null
264   ,p_blood_type                     in      varchar2 default null
265   ,p_correspondence_language        in      varchar2 default null
266   ,p_fast_path_employee             in      varchar2 default null
267   ,p_fte_capacity                   in      number   default null
268   ,p_honors                         in      varchar2 default null
269   ,p_internal_location              in      varchar2 default null
270   ,p_last_medical_test_by           in      varchar2 default null
271   ,p_last_medical_test_date         in      date     default null
272   ,p_mailstop                       in      varchar2 default null
273   ,p_office_number                  in      varchar2 default null
274   ,p_on_military_service            in      varchar2 default null
275   ,p_projected_start_date           in      date     default null
276   ,p_resume_exists                  in      varchar2 default null
277   ,p_resume_last_updated            in      date     default null
278   ,p_second_passport_exists         in      varchar2 default null
279   ,p_student_status                 in      varchar2 default null
280   ,p_work_schedule                  in      varchar2 default null
281   ,p_benefit_group_id               in      number   default null
282   ,p_receipt_of_death_cert_date     in      date     default null
283   ,p_coord_ben_med_pln_no           in      varchar2 default null
284   ,p_coord_ben_no_cvg_flag          in      varchar2 default 'N'
285   ,p_coord_ben_med_ext_er           in      varchar2 default null
289   ,p_coord_ben_med_cvg_strt_dt      in      date     default null
286   ,p_coord_ben_med_pl_name          in      varchar2 default null
287   ,p_coord_ben_med_insr_crr_name    in      varchar2 default null
288   ,p_coord_ben_med_insr_crr_ident   in      varchar2 default null
290   ,p_coord_ben_med_cvg_end_dt       in      date     default null
291   ,p_uses_tobacco_flag              in      varchar2 default null
292   ,p_dpdnt_adoption_date            in      date     default null
293   ,p_dpdnt_vlntry_svce_flag         in      varchar2 default 'N'
294   ,p_original_date_of_hire          in      date     default null
295   ,p_adjusted_svc_date              in      date     default null
296   ,p_town_of_birth                  in      varchar2 default null
297   ,p_region_of_birth                in      varchar2 default null
298   ,p_country_of_birth               in      varchar2 default null
299   ,p_global_person_id               in      varchar2 default null
300   ,p_person_id                      out     nocopy number
301   ,p_assignment_id                  out     nocopy number
302   ,p_per_object_version_number      out     nocopy number
303   ,p_asg_object_version_number      out     nocopy number
304   ,p_per_effective_start_date       out     nocopy date
305   ,p_per_effective_end_date         out     nocopy date
306   ,p_full_name                      out     nocopy varchar2
307   ,p_per_comment_id                 out     nocopy number
308   ,p_assignment_sequence            out     nocopy number
309   ,p_assignment_number              out     nocopy varchar2
310   ,p_name_combination_warning       out     nocopy boolean
311   ,p_assign_payroll_warning         out     nocopy boolean
312   ,p_orig_hire_warning              out     nocopy boolean);
313 --
314 
315 
316 
317 END HR_DK_EMPLOYEE_API;