1 PACKAGE HR_MX_CONTINGENT_WORKER_API AS
2 /* $Header: hrmxwrcw.pkh 120.1 2005/10/02 02:36:27 aroussel $ */
3 /*#
4 * This API creates contingent worker for Mexico.
5 * @rep:scope public
6 * @rep:product PER
7 * @rep:displayname Contingent Worker for Mexico
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |------------------------------< create_mx_cwk >---------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a new contingent worker for Mexico.
17 *
18 * This API creates a person record, a default contingent worker assignment,
19 * and a period of placement for a new contingent worker. The process adds the
20 * contingent worker to the security lists so that secure users can see the
21 * contingent worker.
22 *
23 * <p><b>Licensing</b><br>
24 * This API is licensed for use with Human Resources.
25 *
26 * <p><b>Prerequisites</b><br>
27 * The business group must exist on the effective date. A valid
28 * business_group_id, a valid person_type_id (if specified), and a
29 * corresponding system type of CWK are required. The CWK type must be active
30 * in the same business group as the contingent worker you are creating. If you
31 * do not specify a person_type_id, the API uses the default CWK type for the
32 * business group.
33 *
34 * <p><b>Post Success</b><br>
35 * The API creates person details, a period of placement, and a default
36 * contingent worker assignment.
37 *
38 * <p><b>Post Failure</b><br>
39 * The API does not create the contingent worker, primary assignment, or period
40 * of placement and raises an error.
41 *
42 * @param p_validate If true, then validation alone will be performed and the
43 * database will remain unchanged. If false and all validation checks pass,
44 * then the database will be modified.
45 * @param p_start_date Start Date.
46 * @param p_business_group_id Business group of the person.
47 * @param p_paternal_last_name Last name.
48 * @param p_person_type_id Type of contingent worker being created.
49 * @param p_npw_number The business group's contingent worker number generation
50 * method determines when the API derives and passes out a contingent worker
51 * number or when the calling program should pass in a value. When the API call
52 * completes, if p_validate is false, then set to the contingent worker number.
53 * If p_validate is true then set to the passed value.
54 * @param p_background_check_status Flag indicating whether the person's
55 * background has been checked.
56 * @param p_background_date_check Date on which the background check was
57 * performed.
58 * @param p_blood_type Blood type.
59 * @param p_comments Contingent worker comment text.
60 * @param p_correspondence_language Preferred language for correspondence.
61 * @param p_country_of_birth Country of birth.
62 * @param p_date_of_birth Date of birth.
63 * @param p_date_of_death Date of death.
64 * @param p_dpdnt_adoption_date Date on which the dependent was adopted.
65 * @param p_dpdnt_vlntry_svce_flag Flag indicating whether the dependent is on
66 * voluntary service.
67 * @param p_email_address Email address.
68 * @param p_first_name First name.
69 * @param p_fte_capacity Obsolete parameter, do not use.
70 * @param p_honors Honors awarded.
71 * @param p_internal_location Internal location of office.
72 * @param p_known_as Preferred name.
73 * @param p_last_medical_test_by Name of physician who performed last medical
74 * test.
75 * @param p_last_medical_test_date Date of last medical test.
76 * @param p_mailstop Internal mail location.
77 * @param p_marital_status Marital status. Valid values are defined by the
78 * MAR_STATUS lookup type.
79 * @param p_second_name Second name of the person.
80 * @param p_curp_id Mexican National Identifier.
81 * @param p_nationality Nationality. Valid values are defined by the
82 * NATIONALITY lookup type.
83 * @param p_office_number Office number.
84 * @param p_on_military_service Flag indicating whether the person is on
85 * military service.
86 * @param p_party_id TCA party for whom you create the person record.
87 * @param p_pre_name_adjunct Prefix before the person's name.
88 * @param p_previous_last_name Obsolete parameter, do not use.
89 * @param p_projected_placement_end Obsolete parameter, do not use.
90 * @param p_receipt_of_death_cert_date Date death certificate was received.
91 * @param p_region_of_birth Geographical region of birth.
92 * @param p_registered_disabled_flag Flag indicating whether the person is
93 * classified as disabled.
94 * @param p_resume_exists Flag indicating whether the person's resume is on
95 * file.
96 * @param p_resume_last_updated Date on which the resume was last updated.
97 * @param p_second_passport_exists Flag indicating whether a person has
98 * multiple passports.
99 * @param p_sex Legal gender. Valid values are defined by the SEX lookup type.
100 * @param p_student_status If this contingent worker is a student, this field
101 * is used to capture their status. Valid values are defined by the
102 * STUDENT_STATUS lookup type.
103 * @param p_suffix Suffix after the person's last name e.g. Sr., Jr., III.
104 * @param p_title Title. Valid values are defined by the TITLE lookup type.
105 * @param p_town_of_birth Town or city of birth.
106 * @param p_uses_tobacco_flag Flag indicating whether the person uses tobacco.
107 * @param p_vendor_id Obsolete parameter, do not use.
108 * @param p_work_schedule Days on which this person will work.
109 * @param p_work_telephone Obsolete parameter, do not use.
110 * @param p_exp_check_send_to_address Mailing address.
111 * @param p_hold_applicant_date_until Date until when the applicant's
112 * information is to be maintained.
113 * @param p_date_employee_data_verified Date on which the contingent worker
114 * data was last verified.
115 * @param p_benefit_group_id Benefit group to which this person will belong.
116 * @param p_coord_ben_med_pln_no Secondary medical plan name. Column used for
117 * external processing.
118 * @param p_coord_ben_no_cvg_flag No secondary medical plan coverage. Column
119 * used for external processing.
120 * @param p_original_date_of_hire Original date of hire.
121 * @param p_attribute_category This context value determines which flexfield
122 * structure to use with the descriptive flexfield segments.
123 * @param p_attribute1 Descriptive flexfield segment.
124 * @param p_attribute2 Descriptive flexfield segment.
125 * @param p_attribute3 Descriptive flexfield segment.
126 * @param p_attribute4 Descriptive flexfield segment.
127 * @param p_attribute5 Descriptive flexfield segment.
128 * @param p_attribute6 Descriptive flexfield segment.
129 * @param p_attribute7 Descriptive flexfield segment.
130 * @param p_attribute8 Descriptive flexfield segment.
131 * @param p_attribute9 Descriptive flexfield segment.
132 * @param p_attribute10 Descriptive flexfield segment.
133 * @param p_attribute11 Descriptive flexfield segment.
134 * @param p_attribute12 Descriptive flexfield segment.
135 * @param p_attribute13 Descriptive flexfield segment.
136 * @param p_attribute14 Descriptive flexfield segment.
137 * @param p_attribute15 Descriptive flexfield segment.
138 * @param p_attribute16 Descriptive flexfield segment.
139 * @param p_attribute17 Descriptive flexfield segment.
140 * @param p_attribute18 Descriptive flexfield segment.
141 * @param p_attribute19 Descriptive flexfield segment.
142 * @param p_attribute20 Descriptive flexfield segment.
143 * @param p_attribute21 Descriptive flexfield segment.
144 * @param p_attribute22 Descriptive flexfield segment.
145 * @param p_attribute23 Descriptive flexfield segment.
146 * @param p_attribute24 Descriptive flexfield segment.
147 * @param p_attribute25 Descriptive flexfield segment.
148 * @param p_attribute26 Descriptive flexfield segment.
149 * @param p_attribute27 Descriptive flexfield segment.
150 * @param p_attribute28 Descriptive flexfield segment.
151 * @param p_attribute29 Descriptive flexfield segment.
152 * @param p_attribute30 Descriptive flexfield segment.
153 * @param p_maternal_last_name Maternal last name of the person.
154 * @param p_rfc_id Federal Contributor Identifier (Registro Federal de
155 * Contribuyentes).
156 * @param p_ss_id Social Security Identifier.
157 * @param p_imss_med_center Social Security Medical Center.
158 * @param p_fed_gov_affil_id Federal Government Affiliation Identifier (Clave
159 * de Afiliacion).
160 * @param p_mil_serv_id Military Service Identifier (Cartilla Militar).
161 * @param p_person_id If p_validate is false, then this uniquely identifies the
162 * person created. If p_validate is true, then set to null.
163 * @param p_per_object_version_number If p_validate is false, then set to the
164 * version number of the created person. If p_validate is true, then the value
165 * will be null.
166 * @param p_per_effective_start_date If p_validate is false, then set to the
167 * earliest effective start date for the created person. If p_validate is true,
168 * then set to null.
169 * @param p_per_effective_end_date If p_validate is false, then set to the
170 * effective end date for the created person. If p_validate is true, then set
171 * to null.
172 * @param p_pdp_object_version_number If p_validate is false, then set to the
173 * version number of the person created. If p_validate is true, then set to
174 * null.
175 * @param p_full_name If p_validate is false, then set to the complete full
176 * name of the person. If p_validate is true, then set to null.
177 * @param p_comment_id If p_validate is false and comment text was provided,
178 * then will be set to the identifier of the created contingent worker comment
179 * record. If p_validate is true or no comment text was provided, then will be
180 * null.
181 * @param p_assignment_id If p_validate is false, then this uniquely identifies
182 * the created assignment. If p_validate is true, then set to null.
183 * @param p_asg_object_version_number If p_validate is false, then this
184 * parameter is set to the version number of the assignment created. If
185 * p_validate is true, then this parameter is null.
186 * @param p_assignment_sequence If p_validate is false, then set to the
187 * sequence number of the default assignment. If p_validate is true, then set
188 * to null.
189 * @param p_assignment_number If p_validate is false, then set to the
190 * assignment number of the default assignment. If p_validate is true, then set
191 * to null.
192 * @param p_name_combination_warning If set to true, then the combination of
193 * last name, first name and date of birth existed prior to calling this API.
194 * @rep:displayname Create Contingent Worker for Mexico
195 * @rep:category BUSINESS_ENTITY PER_CWK
196 * @rep:lifecycle active
197 * @rep:scope public
198 */
199 --
200 -- {End Of Comments}
201 --
202 PROCEDURE CREATE_MX_CWK
203 (p_validate in boolean default false
204 ,p_start_date in date
205 ,p_business_group_id in number
206 ,p_paternal_last_name in varchar2
207 ,p_person_type_id in number default null
208 ,p_npw_number in out nocopy varchar2
209 ,p_background_check_status in varchar2 default null
210 ,p_background_date_check in date default null
211 ,p_blood_type in varchar2 default null
212 ,p_comments in varchar2 default null
213 ,p_correspondence_language in varchar2 default null
214 ,p_country_of_birth in varchar2 default null
215 ,p_date_of_birth in date default null
216 ,p_date_of_death in date default null
217 ,p_dpdnt_adoption_date in date default null
218 ,p_dpdnt_vlntry_svce_flag in varchar2 default null
219 ,p_email_address in varchar2 default null
220 ,p_first_name in varchar2 default null
221 ,p_fte_capacity in number default null
222 ,p_honors in varchar2 default null
223 ,p_internal_location in varchar2 default null
224 ,p_known_as in varchar2 default null
225 ,p_last_medical_test_by in varchar2 default null
226 ,p_last_medical_test_date in date default null
227 ,p_mailstop in varchar2 default null
228 ,p_marital_status in varchar2 default null
229 ,p_second_name in varchar2 default null
230 ,p_curp_id in varchar2 default null
231 ,p_nationality in varchar2 default null
232 ,p_office_number in varchar2 default null
233 ,p_on_military_service in varchar2 default null
234 ,p_party_id in number default null
235 ,p_pre_name_adjunct in varchar2 default null
236 ,p_previous_last_name in varchar2 default null
237 ,p_projected_placement_end in date default null
238 ,p_receipt_of_death_cert_date in date default null
239 ,p_region_of_birth in varchar2 default null
240 ,p_registered_disabled_flag in varchar2 default null
241 ,p_resume_exists in varchar2 default null
242 ,p_resume_last_updated in date default null
243 ,p_second_passport_exists in varchar2 default null
244 ,p_sex in varchar2 default null
245 ,p_student_status in varchar2 default null
246 ,p_suffix in varchar2 default null
247 ,p_title in varchar2 default null
248 ,p_town_of_birth in varchar2 default null
249 ,p_uses_tobacco_flag in varchar2 default null
250 ,p_vendor_id in number default null
251 ,p_work_schedule in varchar2 default null
252 ,p_work_telephone in varchar2 default null
253 ,p_exp_check_send_to_address in varchar2 default null
254 ,p_hold_applicant_date_until in date default null
255 ,p_date_employee_data_verified in date default null
256 ,p_benefit_group_id in number default null
257 ,p_coord_ben_med_pln_no in varchar2 default null
258 ,p_coord_ben_no_cvg_flag in varchar2 default null
259 ,p_original_date_of_hire in date default null
260 ,p_attribute_category in varchar2 default null
261 ,p_attribute1 in varchar2 default null
262 ,p_attribute2 in varchar2 default null
263 ,p_attribute3 in varchar2 default null
264 ,p_attribute4 in varchar2 default null
265 ,p_attribute5 in varchar2 default null
266 ,p_attribute6 in varchar2 default null
267 ,p_attribute7 in varchar2 default null
268 ,p_attribute8 in varchar2 default null
269 ,p_attribute9 in varchar2 default null
270 ,p_attribute10 in varchar2 default null
271 ,p_attribute11 in varchar2 default null
272 ,p_attribute12 in varchar2 default null
273 ,p_attribute13 in varchar2 default null
274 ,p_attribute14 in varchar2 default null
275 ,p_attribute15 in varchar2 default null
276 ,p_attribute16 in varchar2 default null
277 ,p_attribute17 in varchar2 default null
278 ,p_attribute18 in varchar2 default null
279 ,p_attribute19 in varchar2 default null
280 ,p_attribute20 in varchar2 default null
281 ,p_attribute21 in varchar2 default null
282 ,p_attribute22 in varchar2 default null
283 ,p_attribute23 in varchar2 default null
284 ,p_attribute24 in varchar2 default null
285 ,p_attribute25 in varchar2 default null
286 ,p_attribute26 in varchar2 default null
287 ,p_attribute27 in varchar2 default null
288 ,p_attribute28 in varchar2 default null
289 ,p_attribute29 in varchar2 default null
290 ,p_attribute30 in varchar2 default null
291 ,p_maternal_last_name in varchar2 default null
292 ,p_rfc_id in varchar2 default null
293 ,p_ss_id in varchar2 default null
294 ,p_imss_med_center in varchar2 default null
295 ,p_fed_gov_affil_id in varchar2 default null
296 ,p_mil_serv_id in varchar2 default null
297 ,p_person_id out nocopy number
298 ,p_per_object_version_number out nocopy number
299 ,p_per_effective_start_date out nocopy date
300 ,p_per_effective_end_date out nocopy date
301 ,p_pdp_object_version_number out nocopy number
302 ,p_full_name out nocopy varchar2
303 ,p_comment_id out nocopy number
304 ,p_assignment_id out nocopy number
305 ,p_asg_object_version_number out nocopy number
306 ,p_assignment_sequence out nocopy number
307 ,p_assignment_number out nocopy varchar2
308 ,p_name_combination_warning out nocopy boolean
309 );
310 END HR_MX_CONTINGENT_WORKER_API;