DBA Data[Home] [Help]

PACKAGE: APPS.HR_FI_CONTACT_API

Source


1 Package HR_FI_CONTACT_API as
2 /* $Header: peconfii.pkh 120.6.12010000.1 2008/07/28 04:24:38 appldev ship $ */
3 /*#
4  * This package contains contact APIs.
5  * @rep:scope public
6  * @rep:product PER
7  * @rep:displayname Contact for Finland
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-----------------------------< create_fi_person >-------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16  * This API creates a Finnish contact.
17  *
18  * This is effectively an alternative to the API create_person. No information
19  * 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 Finland legislation must exist already. Also a valid
26  * person_type_id, with a corresponding system type of 'OTHER', must be active
27  * and in the same business group as that of the contact being created.
28  *
29  * <p><b>Post Success</b><br>
30  * The contact details are created.
31  *
32  * <p><b>Post Failure</b><br>
33   * The contact is not created and an error is raised.
34  *
35  * @param p_validate If true, then validation alone will be performed and the
36  * database will remain unchanged. If false and all validation checks pass,
37  * then the database will be modified.
38  * @param p_start_date The effective start date of the person.
39  * @param p_business_group_id The person's business group.
40  * @param p_last_name The person's last name.
41  * @param p_sex Legal gender. Valid values are defined by the SEX lookup type.
42  * @param p_person_type_id The person type id. If this value is omitted then
43  * the person_type_id of the default `OTHER' system person type in the person's
44  * business group is used.
45  * @param p_comments Contact comment text.
46  * @param p_date_employee_data_verified Date when the person last verified the
47  * data.
48  * @param p_date_of_birth The person's date of birth.
49  * @param p_email_address The person's email address.
50  * @param p_expense_check_send_to_addres The person's address to be used as
51  * mailing address.
52  * @param p_first_name The person's first name.
53  * @param p_known_as The person's preferred name.
54  * @param p_marital_status The person's marital status. The valid values are
55  * defined by the 'MAR_STATUS' lookup type.
56  * @param p_nationality The person's nationality. The valid values are defined
57  * by the 'NATIONALITY' lookup type.
58  * @param p_national_identifier The person's national identifier.
59  * @param p_previous_last_name The person's previous last name.
60  * @param p_registered_disabled_flag Registered disabled flag. The valid values
61  * are defined by 'REGISTERED_DISABLED' lookup type.
62  * @param p_title The person's title. The valid values are defined by the
63  * 'TITLE' lookup type.
64  * @param p_vendor_id Obsolete parameter, do not use.
65  * @param p_work_telephone The person's work telephone number.
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_place_of_residence The person's place of residence.
99  * @param p_secondary_email The person's secondary e-mail.
100  * @param p_epost_address The person's e-post address.
101  * @param p_speed_dial_number The person's speed dial number.
102  * @param p_qualification The person's qualification.
103  * @param p_level The person's education level. The valid values are defined by
104  * 'FI_QUAL_LEVEL' lookup type.
105  * @param p_field The person's education field. The valid values are defined by
106  * 'FI_QUAL_FIELD' lookup type.
107  * @param p_retirement_date The person's retirement date.
108  * @param p_correspondence_language The person's correspondence language.
109  * @param p_honors Honors or degrees the person holds.
110  * @param p_benefit_group_id The Id 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. The valid values are
113  * defined by 'STUDENT_STATUS' lookup type.
114  * @param p_uses_tobacco_flag The person's tobacco usage details. The valid
115  * values are defined by 'TOBACCO_USER' lookup type.
116  * @param p_coord_ben_no_cvg_flag No secondary medical plan coverage. Column
117  * used for external processing.
118  * @param p_town_of_birth The town or city of birth.
119  * @param p_region_of_birth The geographical region of birth.
120  * @param p_country_of_birth The country of birth.
121  * @param p_global_person_id The global ID for the person.
122  * @param p_person_id If p_validate is false, then this uniquely identifies the
123  * person created. If p_validate is true, then set to null.
124  * @param p_object_version_number If p_validate is false, then set to the
125  * version number of the created contact. If p_validate is true, then the value
126  * will be null.
127  * @param p_effective_start_date If p_validate is false, then set to the
128  * earliest effective start date for the created contact. If p_validate is
129  * true, then set to null.
130  * @param p_effective_end_date If p_validate is false, then set to the
131  * effective end date for the created contact. If p_validate is true, then set
132  * to null.
133  * @param p_full_name If p_validate is false, this will be set to the complete
134  * full name of the person. If p_validate is true this will be null.
135  * @param p_comment_id If p_validate is false and comment text was provided,
136  * then will be set to the identifier of the created contact comment record. If
137  * p_validate is true or no comment text was provided, then will be null.
138  * @param p_name_combination_warning If set to true, then the combination of
139  * last name, first name and date of birth existed prior to calling this API.
140  * @param p_orig_hire_warning If set to true, an orginal date of hire exists
141  * for a person who has never been an employee.
142  * @param p_union_name Name of the Trade Union to which the contact person belongs.
143  * @param p_membership_number Contact person's Trade Union membership number.
144  * @param p_payment_mode Mode of Payment. The lookup type
145  * 'FI_TRADE_UNION_FEE_TYPE' defines the valid values.
146  * @param p_fixed_amount Amount  to deducted as Union membership
147  * fees.
148  * @param p_percentage Percentage of gross salary to deducted as Union
149  * membership fees.
150  * @param p_membership_start_date Union membership start date.
151  * @param p_membership_end_date Union membership end date.
152  * @param p_mother_tongue Mother Tongue
153  * @param p_foreign_personal_id Foreign Personal ID
154  * @rep:displayname Create Contact for Finland
155  * @rep:category BUSINESS_ENTITY PER_PERSONAL_CONTACT
156  * @rep:lifecycle active
157  * @rep:scope public
158  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
159 */
160 --
161 -- {End Of Comments}
162 --
163 procedure create_fi_person
164   (p_validate                      in     boolean  default false
165   ,p_start_date                    in     date
166   ,p_business_group_id             in     number
167   ,p_last_name                   in     varchar2
168   ,p_sex                           in     varchar2
169   ,p_person_type_id                in     number   default null
170   ,p_comments                      in     varchar2 default null
171   ,p_date_employee_data_verified   in     date     default null
172   ,p_date_of_birth                 in     date     default null
173   ,p_email_address                 in     varchar2 default null
174   ,p_expense_check_send_to_addres  in     varchar2 default null
175   ,p_first_name                    in     varchar2
176   ,p_known_as                      in     varchar2 default null
177   ,p_marital_status                in     varchar2 default null
178   ,p_nationality                   in     varchar2
179   ,p_national_identifier           in     varchar2 default null
180   ,p_previous_last_name            in     varchar2 default null
181   ,p_registered_disabled_flag      in     varchar2 default null
182   ,p_title                         in     varchar2
183   ,p_vendor_id                     in     number   default null
184   ,p_work_telephone                in     varchar2 default null
185   ,p_attribute_category            in     varchar2 default null
186   ,p_attribute1                    in     varchar2 default null
187   ,p_attribute2                    in     varchar2 default null
188   ,p_attribute3                    in     varchar2 default null
189   ,p_attribute4                    in     varchar2 default null
190   ,p_attribute5                    in     varchar2 default null
191   ,p_attribute6                    in     varchar2 default null
192   ,p_attribute7                    in     varchar2 default null
193   ,p_attribute8                    in     varchar2 default null
194   ,p_attribute9                    in     varchar2 default null
195   ,p_attribute10                   in     varchar2 default null
196   ,p_attribute11                   in     varchar2 default null
197   ,p_attribute12                   in     varchar2 default null
198   ,p_attribute13                   in     varchar2 default null
199   ,p_attribute14                   in     varchar2 default null
200   ,p_attribute15                   in     varchar2 default null
201   ,p_attribute16                   in     varchar2 default null
202   ,p_attribute17                   in     varchar2 default null
203   ,p_attribute18                   in     varchar2 default null
204   ,p_attribute19                   in     varchar2 default null
205   ,p_attribute20                   in     varchar2 default null
206   ,p_attribute21                   in     varchar2 default null
207   ,p_attribute22                   in     varchar2 default null
208   ,p_attribute23                   in     varchar2 default null
209   ,p_attribute24                   in     varchar2 default null
210   ,p_attribute25                   in     varchar2 default null
211   ,p_attribute26                   in     varchar2 default null
212   ,p_attribute27                   in     varchar2 default null
213   ,p_attribute28                   in     varchar2 default null
214   ,p_attribute29                   in     varchar2 default null
215   ,p_attribute30                   in     varchar2 default null
216   ,p_place_of_residence        	   in     varchar2 default null
217   ,p_secondary_email        	   in     varchar2 default null
218   ,p_epost_address 		   in     varchar2 default null
222   ,p_field	        	   in     varchar2 default null
219   ,p_speed_dial_number        	   in     varchar2 default null
220   ,p_qualification                 in     varchar2 default null
221   ,p_level	        	   in     varchar2 default null
223   ,p_retirement_date        	   in     varchar2 default null
224  ,p_union_name                   in      varchar2 default null
225   ,p_membership_number            in      varchar2 default null
226   ,p_payment_mode                 in      varchar2 default null
227   ,p_fixed_amount                 in      varchar2 default null
228   ,p_percentage                   in      varchar2 default null
229   ,p_membership_start_date         in      varchar2     default null
230   ,p_membership_end_date	   in	  varchar2     default null
231   ,p_mother_tongue         in      varchar2     default null
232   ,p_foreign_personal_id	   in	  varchar2     default null
233   ,p_correspondence_language       in     varchar2 default null
234   ,p_honors                        in     varchar2 default null
235   ,p_benefit_group_id              in     number   default null
236   ,p_on_military_service           in     varchar2 default null
237   ,p_student_status                in     varchar2 default null
238   ,p_uses_tobacco_flag             in     varchar2 default null
239   ,p_coord_ben_no_cvg_flag         in     varchar2 default null
240   ,p_town_of_birth                 in     varchar2 default null
241   ,p_region_of_birth               in     varchar2 default null
242   ,p_country_of_birth              in     varchar2 default null
243   ,p_global_person_id              in     varchar2 default null
244   ,p_person_id                        out nocopy number
245   ,p_object_version_number            out nocopy number
246   ,p_effective_start_date             out nocopy date
247   ,p_effective_end_date               out nocopy date
248   ,p_full_name                        out nocopy varchar2
249   ,p_comment_id                       out nocopy number
250   ,p_name_combination_warning         out nocopy boolean
251   ,p_orig_hire_warning                out nocopy boolean
252   );
253 
254 
255 --
256 
257 END HR_FI_CONTACT_API;