DBA Data[Home] [Help]

PACKAGE: APPS.HR_SA_CONTACT_API

Source


1 Package hr_sa_contact_api as
2 /* $Header: peconsai.pkh 120.4 2005/10/02 02:13:36 aroussel $ */
3 /*#
4  * This package contains contact APIs for Saudi Arabia.
5  * @rep:scope public
6  * @rep:product per
7  * @rep:displayname Personal Contact for Saudi Arabia
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-----------------------------< create_sa_person >-------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16  * This API creates a contact for a person in a Saudi Arabia business group.
17  *
18  * The API calls the generic API create_person, with parameters set as
19  * appropriate for the Saudi person. As this API is effectively an alternative
20  * to the API create_person, see that API for further explanation.
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  * See API create_person
27  *
28  * <p><b>Post Success</b><br>
29  * The API successfully creates the contact record in the database.
30  *
31  * <p><b>Post Failure</b><br>
32  * The API does not create the contact record and raises an error.
33  * @param p_validate If true, then validation alone will be performed and the
34  * database will remain unchanged. If false and all validation checks pass,
35  * then the database will be modified.
36  * @param p_start_date Start Date.
37  * @param p_business_group_id Business group of the person.
38  * @param p_family_name Family Name
39  * @param p_sex Legal gender. Valid values are defined by the SEX lookup type.
40  * @param p_person_type_id Type of person being created.
41  * @param p_comments Comment text.
42  * @param p_date_employee_data_verified Date on which the person data was last
43  * verified.
44  * @param p_date_of_birth Date of birth.
45  * @param p_email_address Email address.
46  * @param p_expense_check_send_to_addres Mailing address.
47  * @param p_first_name First name.
48  * @param p_known_as Preferred name.
49  * @param p_marital_status Marital status. Valid values are defined by the
50  * MAR_STATUS lookup type.
51  * @param p_nationality Nationality. Valid values are defined by the
52  * NATIONALITY lookup type.
53  * @param p_national_identifier Number by which a person is identified in a
54  * given legislation.
55  * @param p_previous_last_name Previous last name.
56  * @param p_registered_disabled_flag Flag indicating whether the person is
57  * classified as disabled.
58  * @param p_title Title. Valid values are defined by the TITLE lookup type.
59  * @param p_vendor_id Obsolete parameter, do not use.
60  * @param p_work_telephone Obsolete parameter, do not use.
61  * @param p_attribute_category This context value determines which flexfield
62  * structure to use with the descriptive flexfield segments.
63  * @param p_attribute1 Descriptive flexfield segment.
64  * @param p_attribute2 Descriptive flexfield segment.
65  * @param p_attribute3 Descriptive flexfield segment.
66  * @param p_attribute4 Descriptive flexfield segment.
67  * @param p_attribute5 Descriptive flexfield segment.
68  * @param p_attribute6 Descriptive flexfield segment.
69  * @param p_attribute7 Descriptive flexfield segment.
70  * @param p_attribute8 Descriptive flexfield segment.
71  * @param p_attribute9 Descriptive flexfield segment.
72  * @param p_attribute10 Descriptive flexfield segment.
73  * @param p_attribute11 Descriptive flexfield segment.
74  * @param p_attribute12 Descriptive flexfield segment.
75  * @param p_attribute13 Descriptive flexfield segment.
76  * @param p_attribute14 Descriptive flexfield segment.
77  * @param p_attribute15 Descriptive flexfield segment.
78  * @param p_attribute16 Descriptive flexfield segment.
79  * @param p_attribute17 Descriptive flexfield segment.
80  * @param p_attribute18 Descriptive flexfield segment.
81  * @param p_attribute19 Descriptive flexfield segment.
82  * @param p_attribute20 Descriptive flexfield segment.
83  * @param p_attribute21 Descriptive flexfield segment.
84  * @param p_attribute22 Descriptive flexfield segment.
85  * @param p_attribute23 Descriptive flexfield segment.
86  * @param p_attribute24 Descriptive flexfield segment.
87  * @param p_attribute25 Descriptive flexfield segment.
88  * @param p_attribute26 Descriptive flexfield segment.
89  * @param p_attribute27 Descriptive flexfield segment.
90  * @param p_attribute28 Descriptive flexfield segment.
91  * @param p_attribute29 Descriptive flexfield segment.
92  * @param p_attribute30 Descriptive flexfield segment.
93  * @param p_father_name Father's Name
94  * @param p_grandfather_name Grandfather's Name
95  * @param p_alt_first_name Specifies First Name in alternative language
96  * @param p_alt_father_name Specifies Father's Name in alternative language
97  * @param p_alt_grandfather_name Specifies Grandfather's Name in alternative
98  * language
99  * @param p_alt_family_name Specifies Family Name in alternative language
100  * @param p_religion Religion
101  * @param p_hijrah_birth_date Date of birth using the Hijrah calendar.
102  * @param p_correspondence_language Preferred language for correspondence.
103  * @param p_honors Honors awarded.
104  * @param p_benefit_group_id Benefit group to which this person will belong.
105  * @param p_on_military_service Flag indicating whether the person is on
106  * military service.
107  * @param p_student_status If this person is a student, this field is used to
108  * capture their status. Valid values are defined by the STUDENT_STATUS lookup
109  * type.
110  * @param p_uses_tobacco_flag Flag indicating whether the person uses tobacco.
111  * @param p_coord_ben_no_cvg_flag No secondary medical plan coverage. Column
112  * used for external processing.
113  * @param p_town_of_birth Town or city of birth.
114  * @param p_region_of_birth Geographical region of birth.
115  * @param p_country_of_birth Country of birth.
116  * @param p_global_person_id Obsolete parameter, do not use.
117  * @param p_person_id If p_validate is false, then this uniquely identifies the
118  * person created. If p_validate is true, then set to null.
119  * @param p_object_version_number If p_validate is false, then set to the
120  * version number of the created person. If p_validate is true, then the value
121  * will be null.
122  * @param p_effective_start_date If p_validate is false, then set to the
123  * earliest effective start date for the created person, If p_validate is true,
124  * then set to null.
125  * @param p_effective_end_date If p_validate is false, then set to the
126  * effective end date for the created person. If p_validate is true, then set
127  * to null.
128  * @param p_full_name If p_validate is false, then set to the complete full
129  * name of the person. If p_validate is true, then set to null.
130  * @param p_comment_id If p_validate is false and comment text was provided,
131  * then will be set to the identifier of the created person comment record. If
132  * p_validate is true or no comment text was provided, then will be null.
133  * @param p_name_combination_warning If set to true, then the combination of
134  * last name, first name and date of birth existed prior to calling this API.
135  * @param p_orig_hire_warning If set to true, an orginal date of hire exists
136  * for a person who has never been an employee.
137  * @param p_education_level New parameter, available on the latest version of this API
138  * @rep:displayname Create Contact Person for Saudi Arabia
139  * @rep:category BUSINESS_ENTITY PER_PERSONAL_CONTACT
140  * @rep:scope public
141  * @rep:lifecycle active
142  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
143 */
144 --
145 -- {End Of Comments}
146 --
147 procedure create_sa_person
148   (p_validate                      in     boolean  default false
149   ,p_start_date                    in     date
150   ,p_business_group_id             in     number
151   ,p_family_name                   in     varchar2
152   ,p_sex                           in     varchar2
153   ,p_person_type_id                in     number   default null
154   ,p_comments                      in     varchar2 default null
155   ,p_date_employee_data_verified   in     date     default null
156   ,p_date_of_birth                 in     date     default null
157   ,p_email_address                 in     varchar2 default null
158   ,p_expense_check_send_to_addres  in     varchar2 default null
159   ,p_first_name                    in     varchar2 default null
160   ,p_known_as                      in     varchar2 default null
161   ,p_marital_status                in     varchar2 default null
162   ,p_nationality                   in     varchar2 default null
163   ,p_national_identifier           in     varchar2 default null
164   ,p_previous_last_name            in     varchar2 default null
165   ,p_registered_disabled_flag      in     varchar2 default null
166   ,p_title                         in     varchar2 default null
167   ,p_vendor_id                     in     number   default null
168   ,p_work_telephone                in     varchar2 default null
169   ,p_attribute_category            in     varchar2 default null
170   ,p_attribute1                    in     varchar2 default null
171   ,p_attribute2                    in     varchar2 default null
172   ,p_attribute3                    in     varchar2 default null
173   ,p_attribute4                    in     varchar2 default null
174   ,p_attribute5                    in     varchar2 default null
175   ,p_attribute6                    in     varchar2 default null
176   ,p_attribute7                    in     varchar2 default null
177   ,p_attribute8                    in     varchar2 default null
178   ,p_attribute9                    in     varchar2 default null
179   ,p_attribute10                   in     varchar2 default null
180   ,p_attribute11                   in     varchar2 default null
181   ,p_attribute12                   in     varchar2 default null
182   ,p_attribute13                   in     varchar2 default null
183   ,p_attribute14                   in     varchar2 default null
184   ,p_attribute15                   in     varchar2 default null
185   ,p_attribute16                   in     varchar2 default null
186   ,p_attribute17                   in     varchar2 default null
187   ,p_attribute18                   in     varchar2 default null
188   ,p_attribute19                   in     varchar2 default null
189   ,p_attribute20                   in     varchar2 default null
190   ,p_attribute21                   in     varchar2 default null
191   ,p_attribute22                   in     varchar2 default null
192   ,p_attribute23                   in     varchar2 default null
193   ,p_attribute24                   in     varchar2 default null
194   ,p_attribute25                   in     varchar2 default null
195   ,p_attribute26                   in     varchar2 default null
196   ,p_attribute27                   in     varchar2 default null
197   ,p_attribute28                   in     varchar2 default null
198   ,p_attribute29                   in     varchar2 default null
199   ,p_attribute30                   in     varchar2 default null
200   ,p_father_name             	   in     varchar2 default null
201   ,p_grandfather_name              in     varchar2 default null
202   ,p_alt_first_name                in     varchar2 default null
203   ,p_alt_father_name               in     varchar2 default null
204   ,p_alt_grandfather_name          in     varchar2 default null
205   ,p_alt_family_name           	   in     varchar2 default null
206   ,p_religion			   in     varchar2 default null
207   ,p_hijrah_birth_date             in     varchar2 default null
208   ,p_education_level               in     varchar2 default null
209   ,p_correspondence_language       in     varchar2 default null
210   ,p_honors                        in     varchar2 default null
211   ,p_benefit_group_id              in     number   default null
212   ,p_on_military_service           in     varchar2 default null
213   ,p_student_status                in     varchar2 default null
214   ,p_uses_tobacco_flag             in     varchar2 default null
215   ,p_coord_ben_no_cvg_flag         in     varchar2 default null
216   ,p_town_of_birth                 in     varchar2 default null
217   ,p_region_of_birth               in     varchar2 default null
218   ,p_country_of_birth              in     varchar2 default null
219   ,p_global_person_id              in     varchar2 default null
220   ,p_person_id                        out nocopy number
221   ,p_object_version_number            out nocopy number
222   ,p_effective_start_date             out nocopy date
223   ,p_effective_end_date               out nocopy date
224   ,p_full_name                        out nocopy varchar2
225   ,p_comment_id                       out nocopy number
226   ,p_name_combination_warning         out nocopy boolean
227   ,p_orig_hire_warning                out nocopy boolean
228   );
229 --
230 end hr_sa_contact_api;