1 PACKAGE hr_au_applicant_api AUTHID CURRENT_USER AS
2 /* $Header: hrauwraa.pkh 120.2 2011/12/20 09:48:22 jmarupil ship $ */
3 /*#
4 * This package contains applicant API for Australia.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Applicant for Australia
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |---------------------------< create_au_applicant >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a new applicant for Australia.
17 *
18 * A default primary assignment and an application for the applicant are
19 * created with this API. The API calls the generic API create_applicant, with
20 * the parameters set as appropriate for an applicant in Australia. Secure user
21 * functionality is not included in this version of the API. As this API is
22 * effectively an alternative to the API create_applicant, see that API for
23 * further explanation.
24 *
25 * <p><b>Licensing</b><br>
26 * This API is licensed for use with Human Resources.
27 *
28 * <p><b>Prerequisites</b><br>
29 * A business group for Australian legislation must be specified. See core API
30 * create_applicant.
31 *
32 * <p><b>Post Success</b><br>
33 * The person, primary assignment and application will be successfully
34 * inserted.
35 *
36 * <p><b>Post Failure</b><br>
37 * The API does not create the applicant, DEFAULT assignment or application and
38 * raises an error.
39 * @param p_validate If true, then validation alone will be performed and the
40 * database will remain unchanged. If false and all validation checks pass,
41 * then the database will be modified.
42 * @param p_date_received The applicant hire date and effective start date of
43 * the person, primary assignment and application.
44 * @param p_business_group_id {@rep:casecolumn
45 * PER_ALL_PEOPLE_F.BUSINESS_GROUP_ID}
46 * @param p_last_name {@rep:casecolumn PER_ALL_PEOPLE_F.LAST_NAME}
47 * @param p_sex The applicant's legal gender as defined by the lookup type
48 * "SEX".
49 * @param p_person_type_id {@rep:casecolumn PER_ALL_PEOPLE_F.PERSON_TYPE_ID}
50 * @param p_applicant_number If the number generation method is Manual then
51 * this parameter is mandatory. If the number generation method is Automatic
52 * then the value of this parameter must be NULL. When the API completes, if
53 * p_validate is false and the applicant number generation method is Automatic
54 * this will be set to the generated applicant number of the person created. If
55 * p_validate is false and the applicant number generation method is manual or
56 * if p_validate is true this will be set to the same value passed in.
57 * @param p_comments Comment text.
58 * @param p_date_employee_data_verified {@rep:casecolumn
59 * PER_ALL_PEOPLE_F.DATE_EMPLOYEE_DATA_VERIFIED}
60 * @param p_date_of_birth {@rep:casecolumn PER_ALL_PEOPLE_F.DATE_OF_BIRTH}
61 * @param p_email_address {@rep:casecolumn PER_ALL_PEOPLE_F.EMAIL_ADDRESS}
62 * @param p_expense_check_send_to_addres The applicant's address to which the
63 * expense should be sent. Valid values are determined by the lookup type
64 * 'HOME_OFFICE'.
65 * @param p_first_name {@rep:casecolumn PER_ALL_PEOPLE_F.FIRST_NAME}
66 * @param p_known_as {@rep:casecolumn PER_ALL_PEOPLE_F.KNOWN_AS}
67 * @param p_marital_status The applicant's marital status. Valid values are
68 * defined by the lookup type 'MAR_STATUS' .
69 * @param p_middle_names {@rep:casecolumn PER_ALL_PEOPLE_F.MIDDLE_NAMES}
70 * @param p_nationality The applicant' s nationality. Valid values are defined
71 * by the lookup type 'NATIONALITY' .
72 * @param p_national_identifier {@rep:casecolumn
73 * PER_ALL_PEOPLE_F.NATIONAL_IDENTIFIER}
74 * @param p_previous_last_name {@rep:casecolumn
75 * PER_ALL_PEOPLE_F.PREVIOUS_LAST_NAME}
76 * @param p_registered_disabled_flag This flag indicates whether the applicant
77 * is classified as disabled. Valid values are defined by the lookup type
78 * 'REGISTERED_DISABLED'.
79 * @param p_title Applicant's Title e.g. Mr, Mrs, Dr. Valid values are defined
80 * by 'TITLE' lookup type.
81 * @param p_work_telephone {@rep:casecolumn PER_ALL_PEOPLE_F.WORK_TELEPHONE}
82 * @param p_attribute_category This context value determines which flexfield
83 * structure to use with the descriptive flexfield segments.
84 * @param p_attribute1 Descriptive flexfield segment.
85 * @param p_attribute2 Descriptive flexfield segment.
86 * @param p_attribute3 Descriptive flexfield segment.
87 * @param p_attribute4 Descriptive flexfield segment.
88 * @param p_attribute5 Descriptive flexfield segment.
89 * @param p_attribute6 Descriptive flexfield segment.
90 * @param p_attribute7 Descriptive flexfield segment.
91 * @param p_attribute8 Descriptive flexfield segment.
92 * @param p_attribute9 Descriptive flexfield segment.
93 * @param p_attribute10 Descriptive flexfield segment.
94 * @param p_attribute11 Descriptive flexfield segment.
95 * @param p_attribute12 Descriptive flexfield segment.
96 * @param p_attribute13 Descriptive flexfield segment.
97 * @param p_attribute14 Descriptive flexfield segment.
98 * @param p_attribute15 Descriptive flexfield segment.
99 * @param p_attribute16 Descriptive flexfield segment.
100 * @param p_attribute17 Descriptive flexfield segment.
101 * @param p_attribute18 Descriptive flexfield segment.
102 * @param p_attribute19 Descriptive flexfield segment.
103 * @param p_attribute20 Descriptive flexfield segment.
104 * @param p_attribute21 Descriptive flexfield segment.
105 * @param p_attribute22 Descriptive flexfield segment.
106 * @param p_attribute23 Descriptive flexfield segment.
107 * @param p_attribute24 Descriptive flexfield segment.
108 * @param p_attribute25 Descriptive flexfield segment.
109 * @param p_attribute26 Descriptive flexfield segment.
110 * @param p_attribute27 Descriptive flexfield segment.
111 * @param p_attribute28 Descriptive flexfield segment.
112 * @param p_attribute29 Descriptive flexfield segment.
113 * @param p_attribute30 Descriptive flexfield segment.
114 * @param p_country_of_birth {@rep:casecolumn
115 * PER_ALL_PEOPLE_F.COUNTRY_OF_BIRTH}
116 * @param p_background_check_status The applicant's background check status.
117 * Valid values are defined by the lookup type 'YES_NO'.
118 * @param p_background_date_check {@rep:casecolumn
119 * PER_ALL_PEOPLE_F.BACKGROUND_DATE_CHECK}
120 * @param p_correspondence_language {@rep:casecolumn
121 * PER_ALL_PEOPLE_F.CORRESPONDENCE_LANGUAGE}
122 * @param p_fte_capacity {@rep:casecolumn PER_ALL_PEOPLE_F.FTE_CAPACITY}
123 * @param p_hold_applicant_date_until {@rep:casecolumn
124 * PER_ALL_PEOPLE_F.HOLD_APPLICANT_DATE_UNTIL}
125 * @param p_honors {@rep:casecolumn PER_ALL_PEOPLE_F.HONORS}
126 * @param p_mailstop {@rep:casecolumn PER_ALL_PEOPLE_F.MAILSTOP}
127 * @param p_office_number {@rep:casecolumn PER_ALL_PEOPLE_F.OFFICE_NUMBER}
128 * @param p_on_military_service Indicates if the applicant is on military
129 * service. Valid values are defined by the lookup type 'YES_NO'.
130 * @param p_pre_name_adjunct {@rep:casecolumn
131 * PER_ALL_PEOPLE_F.PRE_NAME_ADJUNCT}
132 * @param p_projected_start_date {@rep:casecolumn
133 * PER_ALL_PEOPLE_F.PROJECTED_START_DATE}
134 * @param p_resume_exists Indicates if the applicant's resume exists. Valid
135 * values are defined by the lookup type 'YES_NO'.
136 * @param p_resume_last_updated {@rep:casecolumn
137 * PER_ALL_PEOPLE_F.RESUME_LAST_UPDATED}
138 * @param p_student_status {@rep:casecolumn PER_ALL_PEOPLE_F.STUDENT_STATUS}
139 * @param p_work_schedule The applicant's work schedule, defined by the lookup
140 * type 'WORK_SCHEDULE' .
141 * @param p_suffix {@rep:casecolumn PER_ALL_PEOPLE_F.SUFFIX}
142 * @param p_date_of_death {@rep:casecolumn PER_ALL_PEOPLE_F.DATE_OF_DEATH}
143 * @param p_benefit_group_id {@rep:casecolumn
144 * PER_ALL_PEOPLE_F.BENEFIT_GROUP_ID}
145 * @param p_receipt_of_death_cert_date {@rep:casecolumn
146 * PER_ALL_PEOPLE_F.RECEIPT_OF_DEATH_CERT_DATE}
147 * @param p_coord_ben_med_pln_no {@rep:casecolumn
148 * PER_ALL_PEOPLE_F.COORD_BEN_MED_PLN_NO}
149 * @param p_coord_ben_no_cvg_flag The applicant's coordination of benefits no
150 * other coverage, valid values as applicable are defined by 'YES_NO' lookup
151 * type.
152 * @param p_uses_tobacco_flag Indicates whether the applicant uses tabacco.
153 * Valid values are defined by the lookup type 'YES_NO'.
154 * @param p_dpdnt_adoption_date {@rep:casecolumn
155 * PER_ALL_PEOPLE_F.DPDNT_ADOPTION_DATE}
156 * @param p_dpdnt_vlntry_svce_flag Indicates whether the applicant's dependent
157 * have undertaken voluntary service. Valid values are defined by the lookup
158 * type 'YES_NO'.
159 * @param p_original_date_of_hire {@rep:casecolumn
160 * PER_ALL_PEOPLE_F.ORIGINAL_DATE_OF_HIRE}
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_assignment_id If p_validate is false, then this uniquely identifies
164 * the created assignment. If p_validate is true, then set to null.
165 * @param p_application_id If p_validate is FALSE, this uniquely identifies the
166 * application created. If p_validate is true this parameter will be NULL.
167 * @param p_per_object_version_number If p_validate is false, then set to the
168 * version number of the created person. If p_validate is true, then the value
169 * will be null.
170 * @param p_asg_object_version_number If p_validate is false, then set to the
171 * version number of the created assignment. If p_validate is true, then the
172 * value will be null.
173 * @param p_apl_object_version_number If p_validate is FALSE, this will be set
174 * to the version number of the application created. If p_validate is true this
175 * parameter will be set to NULL.
176 * @param p_per_effective_start_date If p_validate is FALSE, this will be set
177 * to the effective start date of the person. If p_validate is true this will
178 * be NULL.
179 * @param p_per_effective_end_date If p_validate is FALSE, this will be set to
180 * the effective end date of the person. If p_validate is true this will be
181 * NULL.
182 * @param p_full_name If p_validate is FALSE, this will be set to the complete
183 * full name of the person. If p_validate is true this will be NULL.
184 * @param p_per_comment_id If p_validate is FALSE this will be set to the id of
185 * the corresponding person comment row,if any comment text exists. If
186 * p_validate is true this will be NULL.
187 * @param p_assignment_sequence If p_validate is FALSE this will be set to the
188 * sequence number of the primary assignment. If p_validate is true this will
189 * be NULL.
190 * @param p_name_combination_warning If set to true, then the combination of
191 * last name, first name and date of birth existed prior to calling this API.
192 * @param p_orig_hire_warning If p_validate is false,this is set to true if the
193 * original date of hire is provided and the person type is not
194 * Employee,Employee-Applicant,Ex-Employee or Ex-Employee Applicant.
195 * @rep:displayname Create Applicant for Australia
196 * @rep:category BUSINESS_ENTITY PER_APPLICANT
197 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
198 * @rep:scope public
199 * @rep:lifecycle active
200 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
201 */
202 --
203 -- {End Of Comments}
204 --
205 PROCEDURE create_au_applicant
206 (p_validate IN BOOLEAN DEFAULT FALSE
207 ,p_date_received IN DATE
208 ,p_business_group_id IN NUMBER
209 ,p_last_name IN VARCHAR2
210 ,p_sex IN VARCHAR2 DEFAULT NULL
211 ,p_person_type_id IN NUMBER DEFAULT NULL
212 ,p_applicant_number IN OUT NOCOPY VARCHAR2
213 ,p_comments IN hr_comments.comment_text%TYPE DEFAULT NULL
214 ,p_date_employee_data_verified IN DATE DEFAULT NULL
215 ,p_date_of_birth IN DATE DEFAULT NULL
216 ,p_email_address IN VARCHAR2 DEFAULT NULL
217 ,p_expense_check_send_to_addres IN VARCHAR2 DEFAULT NULL
218 ,p_first_name IN VARCHAR2 DEFAULT NULL
219 ,p_known_as IN VARCHAR2 DEFAULT NULL
220 ,p_marital_status IN VARCHAR2 DEFAULT NULL
221 ,p_middle_names IN VARCHAR2 DEFAULT NULL
222 ,p_nationality IN VARCHAR2 DEFAULT NULL
223 ,p_national_identifier IN VARCHAR2 DEFAULT NULL
224 ,p_previous_last_name IN VARCHAR2 DEFAULT NULL
225 ,p_registered_disabled_flag IN VARCHAR2 DEFAULT NULL
226 ,p_title IN VARCHAR2 DEFAULT NULL
227 ,p_work_telephone IN VARCHAR2 DEFAULT NULL
228 ,p_attribute_category IN VARCHAR2 DEFAULT NULL
229 ,p_attribute1 IN VARCHAR2 DEFAULT NULL
230 ,p_attribute2 IN VARCHAR2 DEFAULT NULL
231 ,p_attribute3 IN VARCHAR2 DEFAULT NULL
232 ,p_attribute4 IN VARCHAR2 DEFAULT NULL
233 ,p_attribute5 IN VARCHAR2 DEFAULT NULL
234 ,p_attribute6 IN VARCHAR2 DEFAULT NULL
235 ,p_attribute7 IN VARCHAR2 DEFAULT NULL
236 ,p_attribute8 IN VARCHAR2 DEFAULT NULL
237 ,p_attribute9 IN VARCHAR2 DEFAULT NULL
238 ,p_attribute10 IN VARCHAR2 DEFAULT NULL
239 ,p_attribute11 IN VARCHAR2 DEFAULT NULL
240 ,p_attribute12 IN VARCHAR2 DEFAULT NULL
241 ,p_attribute13 IN VARCHAR2 DEFAULT NULL
242 ,p_attribute14 IN VARCHAR2 DEFAULT NULL
243 ,p_attribute15 IN VARCHAR2 DEFAULT NULL
244 ,p_attribute16 IN VARCHAR2 DEFAULT NULL
245 ,p_attribute17 IN VARCHAR2 DEFAULT NULL
246 ,p_attribute18 IN VARCHAR2 DEFAULT NULL
247 ,p_attribute19 IN VARCHAR2 DEFAULT NULL
248 ,p_attribute20 IN VARCHAR2 DEFAULT NULL
249 ,p_attribute21 IN VARCHAR2 DEFAULT NULL
250 ,p_attribute22 IN VARCHAR2 DEFAULT NULL
251 ,p_attribute23 IN VARCHAR2 DEFAULT NULL
252 ,p_attribute24 IN VARCHAR2 DEFAULT NULL
253 ,p_attribute25 IN VARCHAR2 DEFAULT NULL
254 ,p_attribute26 IN VARCHAR2 DEFAULT NULL
255 ,p_attribute27 IN VARCHAR2 DEFAULT NULL
256 ,p_attribute28 IN VARCHAR2 DEFAULT NULL
257 ,p_attribute29 IN VARCHAR2 DEFAULT NULL
258 ,p_attribute30 IN VARCHAR2 DEFAULT NULL
259 ,p_country_of_birth IN VARCHAR2 DEFAULT NULL
260 ,p_background_check_status IN VARCHAR2 DEFAULT NULL
261 ,p_background_date_check IN DATE DEFAULT NULL
262 ,p_correspondence_language IN VARCHAR2 DEFAULT NULL
263 ,p_fte_capacity IN NUMBER DEFAULT NULL
264 ,p_hold_applicant_date_until IN DATE DEFAULT NULL
265 ,p_honors IN VARCHAR2 DEFAULT NULL
266 ,p_mailstop IN VARCHAR2 DEFAULT NULL
267 ,p_office_number IN VARCHAR2 DEFAULT NULL
268 ,p_on_military_service IN VARCHAR2 DEFAULT NULL
269 ,p_pre_name_adjunct IN VARCHAR2 DEFAULT NULL
270 ,p_projected_start_date IN DATE DEFAULT NULL
271 ,p_resume_exists IN VARCHAR2 DEFAULT NULL
272 ,p_resume_last_updated IN DATE DEFAULT NULL
273 ,p_student_status IN VARCHAR2 DEFAULT NULL
274 ,p_work_schedule IN VARCHAR2 DEFAULT NULL
275 ,p_suffix IN VARCHAR2 DEFAULT NULL
276 ,p_date_of_death IN DATE DEFAULT NULL
277 ,p_benefit_group_id IN NUMBER DEFAULT NULL
278 ,p_receipt_of_death_cert_date IN DATE DEFAULT NULL
279 ,p_coord_ben_med_pln_no IN VARCHAR2 DEFAULT NULL
280 ,p_coord_ben_no_cvg_flag IN VARCHAR2 DEFAULT 'N'
281 ,p_uses_tobacco_flag IN VARCHAR2 DEFAULT NULL
282 ,p_dpdnt_adoption_date IN DATE DEFAULT NULL
283 ,p_dpdnt_vlntry_svce_flag IN VARCHAR2 DEFAULT 'N'
284 ,p_original_date_of_hire IN DATE DEFAULT NULL
285 ,p_person_id OUT NOCOPY NUMBER
286 ,p_assignment_id OUT NOCOPY NUMBER
287 ,p_application_id OUT NOCOPY NUMBER
288 ,p_per_object_version_number OUT NOCOPY NUMBER
289 ,p_asg_object_version_number OUT NOCOPY NUMBER
290 ,p_apl_object_version_number OUT NOCOPY NUMBER
291 ,p_per_effective_start_date OUT NOCOPY DATE
292 ,p_per_effective_end_date OUT NOCOPY DATE
293 ,p_full_name OUT NOCOPY VARCHAR2
294 ,p_per_comment_id OUT NOCOPY NUMBER
295 ,p_assignment_sequence OUT NOCOPY NUMBER
296 ,p_name_combination_warning OUT NOCOPY BOOLEAN
297 ,p_orig_hire_warning OUT NOCOPY BOOLEAN
298 );
299
300 END hr_au_applicant_api;
[Home] [Help]