DBA Data[Home] [Help]

PACKAGE: APPS.HR_FR_PQH_EMPLOYEE_API

Source


1 Package  hr_fr_pqh_employee_api as
2 /* $Header: pqhpefri.pkh 120.1 2005/10/02 02:26:53 aroussel $ */
3 /*#
4  * This package contains APIs to create employee records in Public Sector
5  * France.
6  * @rep:scope public
7  * @rep:product per
8  * @rep:displayname Employee for Public Sector France
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |----------------------------< create_fr_employee >------------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17  * This API creates a new employee for a French Public Sector legislation.
18  *
19  * Details recorded by this API include a default primary assignment and a
20  * period of service for the employee. The API calls the generic HRMS API
21  * create_employee, with the parameters set as appropriate for a France Public
22  * Sector employee. Secure user functionality is not included in this version
23  * of the API. As this API is effectively an alternative to the API
24  * create_employee, see the HRMS Employee API for further explanation.
25  *
26  * <p><b>Licensing</b><br>
27  * This API is licensed for use with Human Resources.
28  *
29  * <p><b>Prerequisites</b><br>
30  * The business group must exist on the effective date. If person_type_id is
31  * supplied, it must have a corresponding system person type of EMP and must be
32  * active in the same business group as the employee being created.
33  *
34  * <p><b>Post Success</b><br>
35  * The person, primary assignment and period of service records will be
36  * created.
37  *
38  * <p><b>Post Failure</b><br>
39  * The API does not create the employee, default assignment or period of
40  * service and raises an error.
41  * @param p_validate If true, then validation alone will be performed and the
42  * database will remain unchanged. If false and all validation checks pass,
43  * then the database will be modified.
44  * @param p_hire_date The employee hire date and thus the effective start date
45  * of the person, primary assignment and period of service.
46  * @param p_business_group_id The employee's business group.
47  * @param p_last_name Employee's last name.
48  * @param p_sex Employee's gender..
49  * @param p_person_type_id Person type id. If this value is omitted then the
50  * person_type_id of the active default `EMP' system person type in the
51  * employee's business group is used.
52  * @param p_comments Comment text
53  * @param p_date_employee_data_verified The date on which the employee data was
54  * last verified.
55  * @param p_date_of_birth Date of birth.
56  * @param p_email_address Email address.
57  * @param p_employee_number The business group's employee number generation
58  * method determines when the API derives and passes out an employee number or
59  * when the calling program should pass in a value. When the API call completes
60  * if p_validate is false then will be set to the employee number. If
61  * p_validate is true then will be set to the passed value.
62  * @param p_expense_check_send_to_addres Address to use as mailing address.
63  * @param p_first_name Employee's first name.
64  * @param p_known_as Alternative name.
65  * @param p_marital_status Marital status.
66  * @param p_middle_names Employee's middle names.
67  * @param p_nationality Employee's nationality.
68  * @param p_ni_number National Identifier Number.
69  * @param p_previous_last_name Previous last name.
70  * @param p_title Employee's title.
71  * @param p_vendor_id Foreign key to PO_VENDORS.
72  * @param p_work_telephone Work telephone.
73  * @param p_attribute_category This context value determines which flexfield
74  * structure to use with the descriptive flexfield segments.
75  * @param p_attribute1 Descriptive flexfield segment.
76  * @param p_attribute2 Descriptive flexfield segment.
77  * @param p_attribute3 Descriptive flexfield segment.
78  * @param p_attribute4 Descriptive flexfield segment.
79  * @param p_attribute5 Descriptive flexfield segment.
80  * @param p_attribute6 Descriptive flexfield segment.
81  * @param p_attribute7 Descriptive flexfield segment.
82  * @param p_attribute8 Descriptive flexfield segment.
83  * @param p_attribute9 Descriptive flexfield segment.
84  * @param p_attribute10 Descriptive flexfield segment.
85  * @param p_attribute11 Descriptive flexfield segment.
86  * @param p_attribute12 Descriptive flexfield segment.
87  * @param p_attribute13 Descriptive flexfield segment.
88  * @param p_attribute14 Descriptive flexfield segment.
89  * @param p_attribute15 Descriptive flexfield segment.
90  * @param p_attribute16 Descriptive flexfield segment.
91  * @param p_attribute17 Descriptive flexfield segment.
92  * @param p_attribute18 Descriptive flexfield segment.
93  * @param p_attribute19 Descriptive flexfield segment.
94  * @param p_attribute20 Descriptive flexfield segment.
95  * @param p_attribute21 Descriptive flexfield segment.
96  * @param p_attribute22 Descriptive flexfield segment.
97  * @param p_attribute23 Descriptive flexfield segment.
98  * @param p_attribute24 Descriptive flexfield segment.
99  * @param p_attribute25 Descriptive flexfield segment.
100  * @param p_attribute26 Descriptive flexfield segment.
101  * @param p_attribute27 Descriptive flexfield segment.
102  * @param p_attribute28 Descriptive flexfield segment.
103  * @param p_attribute29 Descriptive flexfield segment.
104  * @param p_attribute30 Descriptive flexfield segment.
105  * @param p_maiden_name Maiden name
106  * @param p_department_of_birth Department of birth
107  * @param p_town_of_birth Town of birth
108  * @param p_country_of_birth Country of birth
109  * @param p_number_of_dependents Number of dependents
110  * @param p_military_status Military status
111  * @param p_date_last_school_certificate Date of the last school certificate
112  * @param p_school_name Name of the school that issued the certificate
113  * @param p_level_of_education Level of education
114  * @param p_date_first_entry_into_france Date first entry into France
115  * @param p_cpam_name CPAM name
116  * @param p_personal_mail_id Personal email ID
117  * @param p_correspondence_language Preferred language for correspondence
118  * @param p_fast_path_employee Currently unsupported
119  * @param p_fte_capacity Full time or part time availability for work
120  * @param p_honors Honors or degrees awarded
121  * @param p_internal_location Internal location of office
122  * @param p_mailstop Office identifier for internal mail
123  * @param p_office_number Number of office
124  * @param p_pre_name_adjunct First part of surname such as Van or De
125  * @param p_projected_start_date Currently unsupported
126  * @param p_resume_exists Y/N flag indicating whether resume is on file
127  * @param p_resume_last_updated Date resume last updated
128  * @param p_student_status Full time/part time status of student
129  * @param p_work_schedule Type of work schedule indicating which days person
130  * works
131  * @param p_suffix Employee's suffix
132  * @param p_person_id If p_validate is false, the process returns the unique
133  * identifier of the person. If p_validate is true, it returns null.
134  * @param p_assignment_id If p_validate is false, the process returns the
135  * unique identifier of the created assignment. If p_validate is true, it
136  * returns null.
137  * @param p_per_object_version_number If p_validate is false, the process
138  * returns the version number of the created Employee record . If p_validate is
139  * true, it returns null.
140  * @param p_asg_object_version_number If p_validate is false, then this
141  * parameter is set to the version number of the assignment created. If
142  * p_validate is true, then this parameter is null.
143  * @param p_per_effective_start_date If p_validate is false, the process
144  * returns the effective start date of the person. If p_validate is true, it
145  * returns null.
146  * @param p_per_effective_end_date If p_validate is false, the process returns
147  * the effective end date of the person. If p_validate is true, it returns
148  * null.
149  * @param p_full_name If p_validate is false, the process returns the complete
150  * full name of the person. If p_validate is true, it returns null.
151  * @param p_per_comment_id If p_validate is false, the process returns the
152  * identifier of the corresponding person comment row, if any comment text
153  * exists. If p_validate is true, it returns null.
154  * @param p_assignment_sequence If p_validate is false, the process returns the
155  * sequence number of the primary assignment. If p_validate is true, it returns
156  * null.
157  * @param p_assignment_number If p_validate is false, the process returns the
158  * assignment number of the primary assignment. If p_validate is true, it
159  * returns null.
160  * @param p_name_combination_warning If set to true, then the combination of
161  * last name, first name and date of birth existed prior to calling this API.
162  * @param p_assign_payroll_warning If set to true, then the date of birth is
163  * not entered. If set to false, then the date of birth has been entered.
164  * Indicates if it will be possible to set the payroll on any of this person's
165  * assignments.
166  * @rep:displayname Create Employee for Public Sector France
167  * @rep:category BUSINESS_ENTITY PER_EMPLOYEE
168  * @rep:scope public
169  * @rep:lifecycle active
170  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
171 */
172 --
173 -- {End Of Comments}
174 --
175 procedure create_fr_employee
176   (p_validate                      in     boolean  default false
177   ,p_hire_date                     in     date
178   ,p_business_group_id             in     number
179   ,p_last_name                     in     varchar2
180   ,p_sex                           in     varchar2
181   ,p_person_type_id                in     number   default null
182   ,p_comments                      in     varchar2 default null
183   ,p_date_employee_data_verified   in     date     default null
184   ,p_date_of_birth                 in     date     default null
185   ,p_email_address                 in     varchar2 default null
186   ,p_employee_number               in out nocopy varchar2
187   ,p_expense_check_send_to_addres  in     varchar2 default null
188   ,p_first_name                    in     varchar2 default null
189   ,p_known_as                      in     varchar2 default null
190   ,p_marital_status                in     varchar2 default null
191   ,p_middle_names                  in     varchar2 default null
192   ,p_nationality                   in     varchar2 default null
193   ,p_ni_number                     in     varchar2 default null
194   ,p_previous_last_name            in     varchar2 default null
195   ,p_title                         in     varchar2 default null
196   ,p_vendor_id                     in     number   default null
197   ,p_work_telephone                in     varchar2 default null
198   ,p_attribute_category            in     varchar2 default null
199   ,p_attribute1                    in     varchar2 default null
200   ,p_attribute2                    in     varchar2 default null
201   ,p_attribute3                    in     varchar2 default null
202   ,p_attribute4                    in     varchar2 default null
203   ,p_attribute5                    in     varchar2 default null
204   ,p_attribute6                    in     varchar2 default null
205   ,p_attribute7                    in     varchar2 default null
206   ,p_attribute8                    in     varchar2 default null
207   ,p_attribute9                    in     varchar2 default null
208   ,p_attribute10                   in     varchar2 default null
209   ,p_attribute11                   in     varchar2 default null
210   ,p_attribute12                   in     varchar2 default null
211   ,p_attribute13                   in     varchar2 default null
212   ,p_attribute14                   in     varchar2 default null
213   ,p_attribute15                   in     varchar2 default null
214   ,p_attribute16                   in     varchar2 default null
215   ,p_attribute17                   in     varchar2 default null
216   ,p_attribute18                   in     varchar2 default null
217   ,p_attribute19                   in     varchar2 default null
218   ,p_attribute20                   in     varchar2 default null
219   ,p_attribute21                   in     varchar2 default null
220   ,p_attribute22                   in     varchar2 default null
221   ,p_attribute23                   in     varchar2 default null
222   ,p_attribute24                   in     varchar2 default null
223   ,p_attribute25                   in     varchar2 default null
224   ,p_attribute26                   in     varchar2 default null
225   ,p_attribute27                   in     varchar2 default null
226   ,p_attribute28                   in     varchar2 default null
227   ,p_attribute29                   in     varchar2 default null
228   ,p_attribute30                   in     varchar2 default null
229   ,p_maiden_name                   in     varchar2 default null
230   ,p_department_of_birth           in     varchar2 default null
231   ,p_town_of_birth                 in     varchar2 default null
232   ,p_country_of_birth              in     varchar2 default null
233   ,p_number_of_dependents          in     varchar2 default null
234   ,p_military_status               in     varchar2 default null
235   ,p_date_last_school_certificate  in     varchar2 default null
236   ,p_school_name                   in     varchar2 default null
237   ,p_level_of_education            in     varchar2 default null
238   ,p_date_first_entry_into_france  in     varchar2 default null
239   ,p_cpam_name                     in     varchar2 default null
240   ,p_personal_mail_id 		   in 	  varchar2 default null
241   ,p_correspondence_language       in     varchar2 default null
242   ,p_fast_path_employee            in     varchar2 default null
243   ,p_fte_capacity                  in     number   default null
244   ,p_honors                        in     varchar2 default null
245   ,p_internal_location             in     varchar2 default null
246   ,p_mailstop                      in     varchar2 default null
247   ,p_office_number                 in     varchar2 default null
248   ,p_pre_name_adjunct              in     varchar2 default null
249   ,p_projected_start_date          in     date     default null
250   ,p_resume_exists                 in     varchar2 default null
251   ,p_resume_last_updated           in     date     default null
252   ,p_student_status                in     varchar2 default null
253   ,p_work_schedule                 in     varchar2 default null
254   ,p_suffix                        in     varchar2 default null
255   ,p_person_id                        out nocopy number
256   ,p_assignment_id                    out nocopy number
257   ,p_per_object_version_number        out nocopy number
258   ,p_asg_object_version_number        out nocopy number
259   ,p_per_effective_start_date         out nocopy date
260   ,p_per_effective_end_date           out nocopy date
261   ,p_full_name                        out nocopy varchar2
262   ,p_per_comment_id                   out nocopy number
263   ,p_assignment_sequence              out nocopy number
264   ,p_assignment_number                out nocopy varchar2
265   ,p_name_combination_warning         out nocopy boolean
266   ,p_assign_payroll_warning           out nocopy boolean
267   );
268 --
269 end hr_fr_pqh_employee_api;