DBA Data[Home] [Help]

PACKAGE: APPS.HR_KW_CONTACT_API

Source


1 Package hr_kw_contact_api as
2 /* $Header: peconkwi.pkh 120.2 2005/10/02 02:39:13 aroussel $ */
3 /*#
4  * This package contains contact APIs.
5  * @rep:scope public
6  * @rep:product PER
7  * @rep:displayname Contact for Kuwait
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-----------------------------< create_kw_person >-------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16  * This API creates a Kuwaiti 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 Kuwait 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, 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 The effective start date of the person.
42  * @param p_business_group_id The person's business group.
43  * @param p_family_name The person's last name.
44  * @param p_sex The person's sex.
45  * @param p_person_type_id The person type id. If this value is omitted, then
46  * the person_type_id of the default system person type, 'OTHER,' in the
47  * person's business group is used.
48  * @param p_comments Person comment text.
49  * @param p_date_employee_data_verified Date when the contact last verified the
50  * data.
51  * @param p_date_of_birth The person's date of birth.
52  * @param p_email_address The person's email address.
53  * @param p_expense_check_send_to_addres The person's address to be used as
54  * mailing address.
55  * @param p_first_name The person's first name.
56  * @param p_known_as The person's preferred name.
57  * @param p_marital_status The person's marital status.
58  * @param p_nationality The person's nationality.
59  * @param p_national_identifier The person's national identifier.
60  * @param p_previous_last_name The person's previous last name.
61  * @param p_registered_disabled_flag The registered disabled flag.
62  * @param p_title The person's title.
63  * @param p_vendor_id The foreign key to PO_VENDORS.
64  * @param p_work_telephone The person's work telephone number.
65  * @param p_attribute_category This context value determines which flexfield
66  * structure to use with the descriptive flexfield segments.
67  * @param p_attribute1 Descriptive flexfield segment.
68  * @param p_attribute2 Descriptive flexfield segment.
69  * @param p_attribute3 Descriptive flexfield segment.
70  * @param p_attribute4 Descriptive flexfield segment.
71  * @param p_attribute5 Descriptive flexfield segment.
72  * @param p_attribute6 Descriptive flexfield segment.
73  * @param p_attribute7 Descriptive flexfield segment.
74  * @param p_attribute8 Descriptive flexfield segment.
75  * @param p_attribute9 Descriptive flexfield segment.
76  * @param p_attribute10 Descriptive flexfield segment.
77  * @param p_attribute11 Descriptive flexfield segment.
78  * @param p_attribute12 Descriptive flexfield segment.
79  * @param p_attribute13 Descriptive flexfield segment.
80  * @param p_attribute14 Descriptive flexfield segment.
81  * @param p_attribute15 Descriptive flexfield segment.
82  * @param p_attribute16 Descriptive flexfield segment.
83  * @param p_attribute17 Descriptive flexfield segment.
84  * @param p_attribute18 Descriptive flexfield segment.
85  * @param p_attribute19 Descriptive flexfield segment.
86  * @param p_attribute20 Descriptive flexfield segment.
87  * @param p_attribute21 Descriptive flexfield segment.
88  * @param p_attribute22 Descriptive flexfield segment.
89  * @param p_attribute23 Descriptive flexfield segment.
90  * @param p_attribute24 Descriptive flexfield segment.
91  * @param p_attribute25 Descriptive flexfield segment.
92  * @param p_attribute26 Descriptive flexfield segment.
93  * @param p_attribute27 Descriptive flexfield segment.
94  * @param p_attribute28 Descriptive flexfield segment.
95  * @param p_attribute29 Descriptive flexfield segment.
96  * @param p_attribute30 Descriptive flexfield segment.
97  * @param p_father_name The father's name.
98  * @param p_grandfather_name The grandfather's name.
99  * @param p_alt_first_name The person's alternate first name.
100  * @param p_alt_father_name The father's alternate name.
101  * @param p_alt_grandfather_name The grandfather's alternate name.
102  * @param p_alt_family_name The person's alternate family name.
103  * @param p_previous_nationality The person's previous nationality.
104  * @param p_religion The person's religion.
105  * @param p_correspondence_language The person's correspondence language.
106  * @param p_honors Honors or degrees the person holds.
107  * @param p_benefit_group_id The identification for the benefit group.
108  * @param p_on_military_service The type of military service.
109  * @param p_student_status The type of student status.
110  * @param p_uses_tobacco_flag The person's tobacco usage details. The valid
111  * values are defined by 'TOBACCO_USER' lookup type.
112  * @param p_coord_ben_no_cvg_flag The coordination of benefits with no other
113  * coverage flag.
114  * @param p_town_of_birth The town or city of birth.
115  * @param p_region_of_birth The geographical region of birth.
116  * @param p_country_of_birth The country of birth.
117  * @param p_global_person_id The global ID for the person.
118  * @param p_person_id If p_validate is false, then this uniquely identifies the
119  * person created. If p_validate is true, then set to null.
120  * @param p_object_version_number If p_validate is false, then set to the
121  * version number of the created person. If p_validate is true, then the value
122  * will be null.
123  * @param p_effective_start_date If p_validate is false, then set to the
124  * earliest effective start date for the created person. If p_validate is true,
125  * then set to null.
126  * @param p_effective_end_date If p_validate is false, then set to the
127  * effective end date for the created person. If p_validate is true, then set
128  * to null.
129  * @param p_full_name If p_validate is false, this will be set to the complete
130  * full name of the person. If p_validate is true, this will be null.
131  * @param p_comment_id If p_validate is false and comment text was provided,
132  * then will be set to the identifier of the created person comment record. If
133  * p_validate is true or no comment text was provided, then will be null.
134  * @param p_name_combination_warning If set to true, then the combination of
135  * last name, first name and date of birth existed prior to calling this API.
136  * @param p_orig_hire_warning Set to true if the person type is not EMP,
137  * EMP_APL, EX_EMP, or EX_EMP_APL and the original_date_of_hire is not null.
138  * @rep:displayname Create Person for Kuwait
139  * @rep:category BUSINESS_ENTITY PER_PERSONAL_CONTACT
140  * @rep:lifecycle active
141  * @rep:scope public
142  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
143 */
144 --
145 -- {End Of Comments}
146 --
147 procedure create_kw_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_previous_nationality          in     varchar2 default null
207   ,p_religion			   in     varchar2 default null
208   ,p_correspondence_language       in     varchar2 default null
209   ,p_honors                        in     varchar2 default null
210   ,p_benefit_group_id              in     number   default null
211   ,p_on_military_service           in     varchar2 default null
212   ,p_student_status                in     varchar2 default null
213   ,p_uses_tobacco_flag             in     varchar2 default null
214   ,p_coord_ben_no_cvg_flag         in     varchar2 default null
215   ,p_town_of_birth                 in     varchar2 default null
216   ,p_region_of_birth               in     varchar2 default null
217   ,p_country_of_birth              in     varchar2 default null
218   ,p_global_person_id              in     varchar2 default null
219   ,p_person_id                        out nocopy number
220   ,p_object_version_number            out nocopy number
221   ,p_effective_start_date             out nocopy date
222   ,p_effective_end_date               out nocopy date
223   ,p_full_name                        out nocopy varchar2
224   ,p_comment_id                       out nocopy number
225   ,p_name_combination_warning         out nocopy boolean
226   ,p_orig_hire_warning                out nocopy boolean
227   );
228 --
229 end hr_kw_contact_api;