DBA Data[Home] [Help]

PACKAGE: APPS.HR_AE_CONTACT_API

Source


1 Package hr_ae_contact_api as
2 /* $Header: peconaei.pkh 120.5 2006/04/25 22:57:18 spendhar noship $ */
3 /*#
4  * This package contains contact APIs.
5  * @rep:scope public
6  * @rep:product PER
7  * @rep:displayname Contact for UAE
8 */
9 
10 --
11 -- ----------------------------------------------------------------------------
12 -- |---------------------------< create_ae_person  >-----------------------------|
13 -- ----------------------------------------------------------------------------
14 -- {Start Of Comments}
15 /*#
16  * This API creates a UAE contact.
17  *
18  * The API creates a person record in PER_PEOPLE_F for a person of type
19  * 'OTHER'. No information is stored in any other tables.
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  * The business group for UAE legislation must exist on the effective date.
26  * A valid business_group_id, a valid person_type_id (if specified), and a
27  * corresponding system type of 'OTHER' are required. The 'OTHER' type must be
28  * active in the same business group as the contact you are creating. If you do
29  * not specify a person_type_id, the API uses the default 'OTHER' type for the
30  * business group.
31  *
32  * <p><b>Post Success</b><br>
33  * The contact person will be successfully inserted into the database.
34  *
35  * <p><b>Post Failure</b><br>
36  * The contact person will not be created and an error will be raised.
37  *
38  * @param p_validate If true, the database remains unchanged. If false
39  * then the person will be created in the database.
40  * @param p_start_date The effective start date of the person
41  * @param p_business_group_id The person's business group.
42  * @param p_family_name Person's last name.
43  * @param p_sex Person's sex.
44  * @param p_person_type_id Person type id. If this value is omitted then the
45  * person_type_id of the default `OTHER' system person type in the person's business
46  * group is used.
47  * @param p_comments Comments for person record.
48  * @param p_date_employee_data_verified Date when the contact last verified the data.
49  * @param p_date_of_birth Date of birth.
50  * @param p_email_address Email address.
51  * @param p_expense_check_send_to_addres Address to use as mailing address.
52  * @param p_first_name Person's first name.
53  * @param p_known_as Alternative name.
54  * @param p_marital_status Marital status.
55  * @param p_national_identifier National identifier.
56  * @param p_previous_last_name Previous last name.
57  * @param p_registered_disabled_flag Registered disabled flag.
58  * @param p_title Person's title.
59  * @param p_vendor_id Foreign key to PO_VENDORS.
60  * @param p_work_telephone Work telephone.
61  * @param p_attribute_category Determines the context of the descriptive flexfield
62  * in the parameter list.
63  * @param p_attribute1 Descriptive flexfield.
64  * @param p_attribute2 Descriptive flexfield.
65  * @param p_attribute3 Descriptive flexfield.
66  * @param p_attribute4 Descriptive flexfield.
67  * @param p_attribute5 Descriptive flexfield.
68  * @param p_attribute6 Descriptive flexfield.
69  * @param p_attribute7 Descriptive flexfield.
70  * @param p_attribute8 Descriptive flexfield.
71  * @param p_attribute9 Descriptive flexfield.
72  * @param p_attribute10 Descriptive flexfield.
73  * @param p_attribute11 Descriptive flexfield.
74  * @param p_attribute12 Descriptive flexfield.
75  * @param p_attribute13 Descriptive flexfield.
76  * @param p_attribute14 Descriptive flexfield.
77  * @param p_attribute15 Descriptive flexfield.
78  * @param p_attribute16 Descriptive flexfield.
79  * @param p_attribute17 Descriptive flexfield.
80  * @param p_attribute18 Descriptive flexfield.
81  * @param p_attribute19 Descriptive flexfield.
82  * @param p_attribute20 Descriptive flexfield.
83  * @param p_attribute21 Descriptive flexfield.
84  * @param p_attribute22 Descriptive flexfield.
85  * @param p_attribute23 Descriptive flexfield.
86  * @param p_attribute24 Descriptive flexfield.
87  * @param p_attribute25 Descriptive flexfield.
88  * @param p_attribute26 Descriptive flexfield.
89  * @param p_attribute27 Descriptive flexfield.
90  * @param p_attribute28 Descriptive flexfield.
91  * @param p_attribute29 Descriptive flexfield.
92  * @param p_attribute30 Descriptive flexfield.
93  * @param p_father_name Father's Name.
94  * @param p_grandfather_name Grandfather's Name.
95  * @param p_mother_name Mother's Name.
96  * @param p_alt_first_name Alternate first name.
97  * @param p_alt_father_name Father's alternate name.
98  * @param p_alt_grandfather_name Grandfather's alternate name.
99  * @param p_alt_family_name Alternate family name.
100  * @param p_alt_mother_name Alternate mother name.
101  * @param p_previous_nationality Previous Nationality.
102  * @param p_religion Religion.
103  * @param p_education_level Education level.
104  * @param p_alt_place_of_birth Alternate place of birth.
105  * @param p_date_of_change Date of change of nationality.
106  * @param p_reason_for_change Reason for change of nationality.
107  * @param p_nationality Person's nationality.
108  * @param p_correspondence_language Correspondence language
109  * @param p_honors Honors
110  * @param p_benefit_group_id The identification for the benefit group.
111  * @param p_on_military_service The type of military service.
112  * @param p_student_status The type of student status.
113  * @param p_uses_tobacco_flag The person's tobacco usage details. The valid
114  * values are defined by 'TOBACCO_USER' lookup type.
115  * @param p_coord_ben_no_cvg_flag The coordination of benefits with no other
116  * coverage flag.
117  * @param p_place_of_birth Town or city of birth
118  * @param p_region_of_birth Geographical region of birth
119  * @param p_country_of_birth varchar2 Country of birth
120  * @param p_global_person_id varchar2 Global ID for the person
121  * @param p_person_id If p_validate is false, then this uniquely identifies the
122  * person created. If p_validate is true, then set to null.
123  * @param p_object_version_number If p_validate is false, then set to the
124  * version number of the created person. If p_validate is true, then the value
125  * will be null.
126  * @param p_effective_start_date If p_validate is false, then set to the
127  * earliest effective start date for the created person. If p_validate is true,
128  * then set to null.
129  * @param p_effective_end_date If p_validate is false, then set to the
130  * effective end date for the created person. If p_validate is true, then set
131  * to null.
132  * @param p_full_name If p_validate is false, this will be set to the complete
133  * full name of the person. If p_validate is true, this will be null.
134  * @param p_comment_id If p_validate is false and comment text was provided,
135  * then will be set to the identifier of the created person comment record. If
136  * p_validate is true or no comment text was provided, then will be null.
137  * @param p_name_combination_warning If set to true, then the combination of
138  * last name, first name and date of birth existed prior to calling this API.
139  * @param p_orig_hire_warning Set to true if the person type is not EMP,
140  * EMP_APL, EX_EMP, or EX_EMP_APL and the original_date_of_hire is not null.
141  * @rep:displayname Create Person for UAE
142  * @rep:category BUSINESS_ENTITY PER_PERSONAL_CONTACT
143  * @rep:lifecycle active
144  * @rep:scope public
145  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
146 */
147 --
148 -- {End Of Comments}
149 
150 --
151 procedure create_ae_person
152   (p_validate                      in     boolean  default false
153   ,p_start_date                    in     date
154   ,p_business_group_id             in     number
155   ,p_family_name                   in     varchar2
156   ,p_sex                           in     varchar2
157   ,p_person_type_id                in     number   default null
158   ,p_comments                      in     varchar2 default null
159   ,p_date_employee_data_verified   in     date     default null
160   ,p_date_of_birth                 in     date     default null
161   ,p_email_address                 in     varchar2 default null
162   ,p_expense_check_send_to_addres  in     varchar2 default null
163   ,p_first_name                    in     varchar2 default null
164   ,p_known_as                      in     varchar2 default null
165   ,p_marital_status                in     varchar2 default null
166   ,p_national_identifier           in     varchar2 default null
167   ,p_previous_last_name            in     varchar2 default null
168   ,p_registered_disabled_flag      in     varchar2 default null
169   ,p_title                         in     varchar2 default null
170   ,p_vendor_id                     in     number   default null
171   ,p_work_telephone                in     varchar2 default null
172   ,p_attribute_category            in     varchar2 default null
173   ,p_attribute1                    in     varchar2 default null
174   ,p_attribute2                    in     varchar2 default null
175   ,p_attribute3                    in     varchar2 default null
176   ,p_attribute4                    in     varchar2 default null
177   ,p_attribute5                    in     varchar2 default null
178   ,p_attribute6                    in     varchar2 default null
179   ,p_attribute7                    in     varchar2 default null
180   ,p_attribute8                    in     varchar2 default null
181   ,p_attribute9                    in     varchar2 default null
182   ,p_attribute10                   in     varchar2 default null
183   ,p_attribute11                   in     varchar2 default null
184   ,p_attribute12                   in     varchar2 default null
185   ,p_attribute13                   in     varchar2 default null
186   ,p_attribute14                   in     varchar2 default null
187   ,p_attribute15                   in     varchar2 default null
188   ,p_attribute16                   in     varchar2 default null
189   ,p_attribute17                   in     varchar2 default null
190   ,p_attribute18                   in     varchar2 default null
191   ,p_attribute19                   in     varchar2 default null
192   ,p_attribute20                   in     varchar2 default null
193   ,p_attribute21                   in     varchar2 default null
194   ,p_attribute22                   in     varchar2 default null
195   ,p_attribute23                   in     varchar2 default null
196   ,p_attribute24                   in     varchar2 default null
197   ,p_attribute25                   in     varchar2 default null
198   ,p_attribute26                   in     varchar2 default null
199   ,p_attribute27                   in     varchar2 default null
200   ,p_attribute28                   in     varchar2 default null
201   ,p_attribute29                   in     varchar2 default null
202   ,p_attribute30                   in     varchar2 default null
203   ,p_father_name                   in     varchar2 default null
204   ,p_grandfather_name              in     varchar2 default null
205   ,p_mother_name                   in     varchar2 default null
206   ,p_alt_first_name                in     varchar2 default null
207   ,p_alt_father_name               in     varchar2 default null
208   ,p_alt_grandfather_name          in     varchar2 default null
209   ,p_alt_family_name               in     varchar2 default null
210   ,p_alt_mother_name               in     varchar2 default null
211   ,p_previous_nationality          in     varchar2 default null
212   ,p_religion                      in     varchar2 default null
213   ,p_education_level               in     varchar2 default null
214   ,p_alt_place_of_birth            in     varchar2 default null
215   ,p_date_of_change                in     varchar2 default null
216   ,p_reason_for_change             in     varchar2 default null
217   ,p_nationality                   in     varchar2 default null
218   ,p_correspondence_language       in     varchar2 default null
219   ,p_honors                        in     varchar2 default null
220   ,p_benefit_group_id              in     number   default null
221   ,p_on_military_service           in     varchar2 default null
222   ,p_student_status                in     varchar2 default null
223   ,p_uses_tobacco_flag             in     varchar2 default null
224   ,p_coord_ben_no_cvg_flag         in     varchar2 default null
225   ,p_place_of_birth                in     varchar2 default null
226   ,p_region_of_birth               in     varchar2 default null
227   ,p_country_of_birth              in     varchar2 default null
228   ,p_global_person_id              in     varchar2 default null
229   ,p_person_id                        out nocopy number
230   ,p_object_version_number            out nocopy number
231   ,p_effective_start_date             out nocopy date
232   ,p_effective_end_date               out nocopy date
233   ,p_full_name                        out nocopy varchar2
234   ,p_comment_id                       out nocopy number
235   ,p_name_combination_warning         out nocopy boolean
236   ,p_orig_hire_warning                out nocopy boolean
237   );
238 --
239 end hr_ae_contact_api;