DBA Data[Home] [Help]

PACKAGE: APPS.HR_MX_CONTACT_API

Source


1 PACKAGE HR_MX_CONTACT_API AS
2 /* $Header: hrmxwrca.pkh 120.1 2005/10/02 02:36:14 aroussel $ */
3 /*#
4  * This API creates a new contact for Mexico.
5  * @rep:scope public
6  * @rep:product PER
7  * @rep:displayname Personal Contact for Mexico
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-----------------------------< create_mx_person >-------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16  * This API creates a new contact for Mexico.
17  *
18  * This API creates person details and adds the person to the security lists so
19  * that secure users can see the contact.
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 must exist on the effective date. A valid
26  * 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 details are created.
34  *
35  * <p><b>Post Failure</b><br>
36  * The contact is not created and an error is raised.
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_start_date Start date.
42  * @param p_business_group_id Business group of the person.
43  * @param p_paternal_last_name Paternal last name of the person.
44  * @param p_sex Legal gender. Valid values are defined by the SEX lookup type.
45  * @param p_person_type_id Type of person being created.
46  * @param p_comments Comment text.
47  * @param p_date_employee_data_verified Date on which the person data was last
48  * verified.
49  * @param p_date_of_birth Date of birth.
50  * @param p_email_address Email address.
51  * @param p_expense_check_send_to_addres Mailing address.
52  * @param p_first_name First name.
53  * @param p_known_as Preferred name.
54  * @param p_marital_status Marital status. Valid values are defined by the
55  * MAR_STATUS lookup type.
56  * @param p_second_name Second name of the person.
57  * @param p_nationality Nationality. Valid values are defined by the
58  * NATIONALITY lookup type.
59  * @param p_curp_id Mexican national identifier.
60  * @param p_previous_last_name Obsolete parameter, do not use.
61  * @param p_registered_disabled_flag Flag indicating whether the person is
62  * classified as disabled.
63  * @param p_title Title. Valid values are defined by the TITLE lookup type.
64  * @param p_vendor_id Obsolete parameter, do not use.
65  * @param p_work_telephone Obsolete parameter, do not use.
66  * @param p_attribute_category This context value determines which flexfield
67  * structure to use with the descriptive flexfield segments.
68  * @param p_attribute1 Descriptive flexfield segment.
69  * @param p_attribute2 Descriptive flexfield segment.
70  * @param p_attribute3 Descriptive flexfield segment.
71  * @param p_attribute4 Descriptive flexfield segment.
72  * @param p_attribute5 Descriptive flexfield segment.
73  * @param p_attribute6 Descriptive flexfield segment.
74  * @param p_attribute7 Descriptive flexfield segment.
75  * @param p_attribute8 Descriptive flexfield segment.
76  * @param p_attribute9 Descriptive flexfield segment.
77  * @param p_attribute10 Descriptive flexfield segment.
78  * @param p_attribute11 Descriptive flexfield segment.
79  * @param p_attribute12 Descriptive flexfield segment.
80  * @param p_attribute13 Descriptive flexfield segment.
81  * @param p_attribute14 Descriptive flexfield segment.
82  * @param p_attribute15 Descriptive flexfield segment.
83  * @param p_attribute16 Descriptive flexfield segment.
84  * @param p_attribute17 Descriptive flexfield segment.
85  * @param p_attribute18 Descriptive flexfield segment.
86  * @param p_attribute19 Descriptive flexfield segment.
87  * @param p_attribute20 Descriptive flexfield segment.
88  * @param p_attribute21 Descriptive flexfield segment.
89  * @param p_attribute22 Descriptive flexfield segment.
90  * @param p_attribute23 Descriptive flexfield segment.
91  * @param p_attribute24 Descriptive flexfield segment.
92  * @param p_attribute25 Descriptive flexfield segment.
93  * @param p_attribute26 Descriptive flexfield segment.
94  * @param p_attribute27 Descriptive flexfield segment.
95  * @param p_attribute28 Descriptive flexfield segment.
96  * @param p_attribute29 Descriptive flexfield segment.
97  * @param p_attribute30 Descriptive flexfield segment.
98  * @param p_maternal_last_name Maternal last name of the person.
99  * @param p_correspondence_language Preferred language for correspondence.
100  * @param p_honors Honors awarded.
101  * @param p_benefit_group_id Benefit group to which this person will belong.
102  * @param p_on_military_service Flag indicating whether the person is on
103  * military service.
104  * @param p_student_status If this person is a student, this field is used to
105  * capture their status. Valid values are defined by the STUDENT_STATUS lookup
106  * type.
107  * @param p_uses_tobacco_flag Flag indicating whether the person uses tobacco.
108  * @param p_coord_ben_no_cvg_flag No secondary medical plan coverage. Column
109  * used for external processing.
110  * @param p_pre_name_adjunct Prefix before the person's name.
111  * @param p_suffix Suffix after the person's last name.
112  * @param p_town_of_birth Town or city of birth.
113  * @param p_region_of_birth Geographical region of birth.
114  * @param p_country_of_birth Country of birth.
115  * @param p_global_person_id Obsolete parameter, do not use.
116  * @param p_person_id If p_validate is false, then this uniquely identifies the
117  * person created. If p_validate is true, then set to null.
118  * @param p_object_version_number If p_validate is false, then set to the
119  * version number of the created contact. If p_validate is true, then the value
120  * will be null.
121  * @param p_effective_start_date If p_validate is false, then set to the
122  * earliest effective start date for the created contact. If p_validate is
123  * true, then set to null.
124  * @param p_effective_end_date If p_validate is false, then set to the
125  * effective end date for the created contact. If p_validate is true, then set
126  * to null.
127  * @param p_full_name If p_validate is false, then set to the complete full
128  * name of the person. If p_validate is true, then set to null.
129  * @param p_comment_id If p_validate is false and comment text was provided,
130  * then will be set to the identifier of the created contact comment record. If
131  * p_validate is true or no comment text was provided, then will be null.
132  * @param p_name_combination_warning If set to true, then the combination of
133  * last name, first name and date of birth existed prior to calling this API.
134  * @param p_orig_hire_warning If set to true, an orginal date of hire exists
135  * for a person who has never been an employee.
136  * @rep:displayname Create Contact Person for Mexico
137  * @rep:category BUSINESS_ENTITY PER_PERSONAL_CONTACT
138  * @rep:lifecycle active
139  * @rep:category MISC_EXTENSIONS HR_DATAPUMP
140  * @rep:scope public
141 */
142 --
143 -- {End Of Comments}
144 --
145 PROCEDURE CREATE_MX_PERSON
146     (p_validate                      in     boolean  default false
147     ,p_start_date                    in     date
148     ,p_business_group_id             in     number
149     ,p_paternal_last_name            in     varchar2
150     ,p_sex                           in     varchar2
151     ,p_person_type_id                in     number   default null
152     ,p_comments                      in     varchar2 default null
153     ,p_date_employee_data_verified   in     date     default null
154     ,p_date_of_birth                 in     date     default null
155     ,p_email_address                 in     varchar2 default null
156     ,p_expense_check_send_to_addres  in     varchar2 default null
157     ,p_first_name                    in     varchar2 default null
158     ,p_known_as                      in     varchar2 default null
159     ,p_marital_status                in     varchar2 default null
160     ,p_second_name                   in     varchar2 default null
161     ,p_nationality                   in     varchar2 default null
162     ,p_curp_id                       in     varchar2 default null
163     ,p_previous_last_name            in     varchar2 default null
164     ,p_registered_disabled_flag      in     varchar2 default null
165     ,p_title                         in     varchar2 default null
166     ,p_vendor_id                     in     number   default null
167     ,p_work_telephone                in     varchar2 default null
168     ,p_attribute_category            in     varchar2 default null
169     ,p_attribute1                    in     varchar2 default null
170     ,p_attribute2                    in     varchar2 default null
171     ,p_attribute3                    in     varchar2 default null
172     ,p_attribute4                    in     varchar2 default null
173     ,p_attribute5                    in     varchar2 default null
174     ,p_attribute6                    in     varchar2 default null
175     ,p_attribute7                    in     varchar2 default null
176     ,p_attribute8                    in     varchar2 default null
177     ,p_attribute9                    in     varchar2 default null
178     ,p_attribute10                   in     varchar2 default null
179     ,p_attribute11                   in     varchar2 default null
180     ,p_attribute12                   in     varchar2 default null
181     ,p_attribute13                   in     varchar2 default null
182     ,p_attribute14                   in     varchar2 default null
183     ,p_attribute15                   in     varchar2 default null
184     ,p_attribute16                   in     varchar2 default null
185     ,p_attribute17                   in     varchar2 default null
186     ,p_attribute18                   in     varchar2 default null
187     ,p_attribute19                   in     varchar2 default null
188     ,p_attribute20                   in     varchar2 default null
189     ,p_attribute21                   in     varchar2 default null
190     ,p_attribute22                   in     varchar2 default null
191     ,p_attribute23                   in     varchar2 default null
192     ,p_attribute24                   in     varchar2 default null
193     ,p_attribute25                   in     varchar2 default null
194     ,p_attribute26                   in     varchar2 default null
195     ,p_attribute27                   in     varchar2 default null
196     ,p_attribute28                   in     varchar2 default null
197     ,p_attribute29                   in     varchar2 default null
198     ,p_attribute30                   in     varchar2 default null
199     ,p_maternal_last_name            in     varchar2 default null
200     ,p_correspondence_language       in     varchar2 default null
201     ,p_honors                        in     varchar2 default null
202     ,p_benefit_group_id              in     number   default null
203     ,p_on_military_service           in     varchar2 default null
204     ,p_student_status                in     varchar2 default null
205     ,p_uses_tobacco_flag             in     varchar2 default null
206     ,p_coord_ben_no_cvg_flag         in     varchar2 default null
207     ,p_pre_name_adjunct              in     varchar2 default null
208     ,p_suffix                        in     varchar2 default null
209     ,p_town_of_birth                 in     varchar2 default null
210     ,p_region_of_birth               in     varchar2 default null
211     ,p_country_of_birth              in     varchar2 default null
212     ,p_global_person_id              in     varchar2 default null
213     ,p_person_id                        out nocopy number
214     ,p_object_version_number            out nocopy number
215     ,p_effective_start_date             out nocopy date
216     ,p_effective_end_date               out nocopy date
217     ,p_full_name                        out nocopy varchar2
218     ,p_comment_id                       out nocopy number
219     ,p_name_combination_warning         out nocopy boolean
220     ,p_orig_hire_warning                out nocopy boolean
221     );
222 
223 END HR_MX_CONTACT_API;