1 Package hr_contact_api as
2 /* $Header: peconapi.pkh 120.1 2005/10/02 02:13:15 aroussel $ */
3 /*#
4 * This API creates a new contact.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Personal Contact
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |------------------------------< create_person >---------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a new contact.
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 * @param p_validate If true, then validation alone will be performed and the
38 * database will remain unchanged. If false and all validation checks pass,
39 * then the database will be modified.
40 * @param p_start_date Start Date.
41 * @param p_business_group_id Business group of the person.
42 * @param p_last_name Last name.
43 * @param p_sex Legal gender. Valid values are defined by the SEX lookup type.
44 * @param p_person_type_id Type of person being created.
45 * @param p_comments Comment text.
46 * @param p_date_employee_data_verified Date on which the person data was last
47 * verified.
48 * @param p_date_of_birth Date of birth.
49 * @param p_email_address Email address.
50 * @param p_expense_check_send_to_addres Mailing address.
51 * @param p_first_name First name.
52 * @param p_known_as Preferred name.
53 * @param p_marital_status Marital status. Valid values are defined by the
54 * MAR_STATUS lookup type.
55 * @param p_middle_names Middle names.
56 * @param p_nationality Nationality. Valid values are defined by the
57 * NATIONALITY lookup type.
58 * @param p_national_identifier Number by which a person is identified in a
59 * given legislation.
60 * @param p_previous_last_name Previous last name.
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_per_information_category Obsolete parameter, do not use.
99 * @param p_per_information1 Developer descriptive flexfield segment.
100 * @param p_per_information2 Developer descriptive flexfield segment.
101 * @param p_per_information3 Developer descriptive flexfield segment.
102 * @param p_per_information4 Developer descriptive flexfield segment.
103 * @param p_per_information5 Developer descriptive flexfield segment.
104 * @param p_per_information6 Developer descriptive flexfield segment.
105 * @param p_per_information7 Developer descriptive flexfield segment.
106 * @param p_per_information8 Developer descriptive flexfield segment.
107 * @param p_per_information9 Developer descriptive flexfield segment.
108 * @param p_per_information10 Developer descriptive flexfield segment.
109 * @param p_per_information11 Developer descriptive flexfield segment.
110 * @param p_per_information12 Developer descriptive flexfield segment.
111 * @param p_per_information13 Developer descriptive flexfield segment.
112 * @param p_per_information14 Developer descriptive flexfield segment.
113 * @param p_per_information15 Developer descriptive flexfield segment.
114 * @param p_per_information16 Developer descriptive flexfield segment.
115 * @param p_per_information17 Developer descriptive flexfield segment.
116 * @param p_per_information18 Developer descriptive flexfield segment.
117 * @param p_per_information19 Developer descriptive flexfield segment.
118 * @param p_per_information20 Developer descriptive flexfield segment.
119 * @param p_per_information21 Developer descriptive flexfield segment.
120 * @param p_per_information22 Developer descriptive flexfield segment.
121 * @param p_per_information23 Developer descriptive flexfield segment.
122 * @param p_per_information24 Developer descriptive flexfield segment.
123 * @param p_per_information25 Developer descriptive flexfield segment.
124 * @param p_per_information26 Developer descriptive flexfield segment.
125 * @param p_per_information27 Developer descriptive flexfield segment.
126 * @param p_per_information28 Developer descriptive flexfield segment.
127 * @param p_per_information29 Developer descriptive flexfield segment.
128 * @param p_per_information30 Developer descriptive flexfield segment.
129 * @param p_correspondence_language Preferred language for correspondence.
130 * @param p_honors Honors awarded.
131 * @param p_benefit_group_id Benefit group to which this person will belong.
132 * @param p_on_military_service Flag indicating whether the person is on
133 * military service.
134 * @param p_student_status If this person is a student, this field is used to
135 * capture their status. Valid values are defined by the STUDENT_STATUS lookup
136 * type.
137 * @param p_uses_tobacco_flag Flag indicating whether the person uses tobacco.
138 * @param p_coord_ben_no_cvg_flag No secondary medical plan coverage. Column
139 * used for external processing.
140 * @param p_pre_name_adjunct First part of the last name.
141 * @param p_suffix Suffix after the person's last name e.g. Sr., Jr., III.
142 * @param p_town_of_birth Town or city of birth.
143 * @param p_region_of_birth Geographical region of birth.
144 * @param p_country_of_birth Country of birth.
145 * @param p_global_person_id Obsolete parameter, do not use.
146 * @param p_person_id If p_validate is false, then this uniquely identifies the
147 * person created. If p_validate is true, then set to null.
148 * @param p_object_version_number If p_validate is false, then set to the
149 * version number of the created person. If p_validate is true, then the value
150 * will be null.
151 * @param p_effective_start_date If p_validate is false, then set to the
152 * earliest effective start date for the created person, If p_validate is true,
153 * then set to null.
154 * @param p_effective_end_date If p_validate is false, then set to the
155 * effective end date for the created person. If p_validate is true, then set
156 * to null.
157 * @param p_full_name If p_validate is false, then set to the complete full
158 * name of the person. If p_validate is true, then set to null.
159 * @param p_comment_id If p_validate is false and comment text was provided,
160 * then will be set to the identifier of the created person comment record. If
161 * p_validate is true or no comment text was provided, then will be null.
162 * @param p_name_combination_warning If set to true, then the combination of
163 * last name, first name and date of birth existed prior to calling this API.
164 * @param p_orig_hire_warning If set to true, an orginal date of hire exists
165 * for a person who has never been an employee.
166 * @rep:displayname Create Contact Person
167 * @rep:category BUSINESS_ENTITY PER_PERSONAL_CONTACT
168 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
169 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
170 * @rep:scope public
171 * @rep:lifecycle active
172 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
173 */
174 --
175 -- {End Of Comments}
176 --
177 procedure create_person
178 (p_validate in boolean default false
179 ,p_start_date in date
180 ,p_business_group_id in number
181 ,p_last_name in varchar2
182 ,p_sex in varchar2
183 ,p_person_type_id in number default null -- Bug 918219
184 ,p_comments in varchar2 default null
185 ,p_date_employee_data_verified in date default null
186 ,p_date_of_birth in date default null
187 ,p_email_address in varchar2 default null
188 ,p_expense_check_send_to_addres in varchar2 default null
189 ,p_first_name in varchar2 default null
190 ,p_known_as in varchar2 default null
191 ,p_marital_status in varchar2 default null
192 ,p_middle_names in varchar2 default null
193 ,p_nationality in varchar2 default null
194 ,p_national_identifier in varchar2 default null
195 ,p_previous_last_name in varchar2 default null
196 ,p_registered_disabled_flag in varchar2 default null
197 ,p_title in varchar2 default null
198 ,p_vendor_id in number default null
199 ,p_work_telephone in varchar2 default null
200 ,p_attribute_category in varchar2 default null
201 ,p_attribute1 in varchar2 default null
202 ,p_attribute2 in varchar2 default null
203 ,p_attribute3 in varchar2 default null
204 ,p_attribute4 in varchar2 default null
205 ,p_attribute5 in varchar2 default null
206 ,p_attribute6 in varchar2 default null
207 ,p_attribute7 in varchar2 default null
208 ,p_attribute8 in varchar2 default null
209 ,p_attribute9 in varchar2 default null
210 ,p_attribute10 in varchar2 default null
211 ,p_attribute11 in varchar2 default null
212 ,p_attribute12 in varchar2 default null
213 ,p_attribute13 in varchar2 default null
214 ,p_attribute14 in varchar2 default null
215 ,p_attribute15 in varchar2 default null
216 ,p_attribute16 in varchar2 default null
217 ,p_attribute17 in varchar2 default null
218 ,p_attribute18 in varchar2 default null
219 ,p_attribute19 in varchar2 default null
220 ,p_attribute20 in varchar2 default null
221 ,p_attribute21 in varchar2 default null
222 ,p_attribute22 in varchar2 default null
223 ,p_attribute23 in varchar2 default null
224 ,p_attribute24 in varchar2 default null
225 ,p_attribute25 in varchar2 default null
226 ,p_attribute26 in varchar2 default null
227 ,p_attribute27 in varchar2 default null
228 ,p_attribute28 in varchar2 default null
229 ,p_attribute29 in varchar2 default null
230 ,p_attribute30 in varchar2 default null
231 ,p_per_information_category in varchar2 default null
232 ,p_per_information1 in varchar2 default null
233 ,p_per_information2 in varchar2 default null
234 ,p_per_information3 in varchar2 default null
235 ,p_per_information4 in varchar2 default null
236 ,p_per_information5 in varchar2 default null
237 ,p_per_information6 in varchar2 default null
238 ,p_per_information7 in varchar2 default null
239 ,p_per_information8 in varchar2 default null
240 ,p_per_information9 in varchar2 default null
241 ,p_per_information10 in varchar2 default null
242 ,p_per_information11 in varchar2 default null
243 ,p_per_information12 in varchar2 default null
244 ,p_per_information13 in varchar2 default null
245 ,p_per_information14 in varchar2 default null
246 ,p_per_information15 in varchar2 default null
247 ,p_per_information16 in varchar2 default null
248 ,p_per_information17 in varchar2 default null
249 ,p_per_information18 in varchar2 default null
250 ,p_per_information19 in varchar2 default null
251 ,p_per_information20 in varchar2 default null
252 ,p_per_information21 in varchar2 default null
253 ,p_per_information22 in varchar2 default null
254 ,p_per_information23 in varchar2 default null
255 ,p_per_information24 in varchar2 default null
256 ,p_per_information25 in varchar2 default null
257 ,p_per_information26 in varchar2 default null
258 ,p_per_information27 in varchar2 default null
259 ,p_per_information28 in varchar2 default null
260 ,p_per_information29 in varchar2 default null
261 ,p_per_information30 in varchar2 default null
262 ,p_correspondence_language in varchar2 default null
263 ,p_honors in varchar2 default null
264 ,p_benefit_group_id in number default null
265 ,p_on_military_service in varchar2 default null
266 ,p_student_status in varchar2 default null
267 ,p_uses_tobacco_flag in varchar2 default null
268 ,p_coord_ben_no_cvg_flag in varchar2 default null
269 ,p_pre_name_adjunct in varchar2 default null
270 ,p_suffix in varchar2 default null
271 ,p_town_of_birth in varchar2 default null
272 ,p_region_of_birth in varchar2 default null
273 ,p_country_of_birth in varchar2 default null
274 ,p_global_person_id in varchar2 default null
275 ,p_person_id out nocopy number
276 ,p_object_version_number out nocopy number
277 ,p_effective_start_date out nocopy date
278 ,p_effective_end_date out nocopy date
279 ,p_full_name out nocopy varchar2
280 ,p_comment_id out nocopy number
281 ,p_name_combination_warning out nocopy boolean
282 ,p_orig_hire_warning out nocopy boolean
283 );
284 --
285 end hr_contact_api;
[Home] [Help]