DBA Data[Home] [Help]

PACKAGE: APPS.HR_DK_APPLICANT_API

Source


1 package hr_dk_applicant_api AUTHID CURRENT_USER AS
2 /* $Header: peappdki.pkh 120.4 2006/10/11 07:18:57 saurai noship $ */
3 /*#
4  * This package contains applicant APIs.
5  * @rep:scope public
6  * @rep:product PER
7  * @rep:displayname Applicant for Denmark
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |---------------------------< create_dk_applicant >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16  * This API creates a Danish applicant.
17  *
18  * This API is effectively an alternative to the API create_applicant. If
19  * p_validate is set to false, an applicant is created.
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 Denmark legislation must already exist. Also a valid
26  * person_type_id, with a corresponding system type of APL, must be active and
27  * in the same business group as that of the applicant being created.
28  *
29  * <p><b>Post Success</b><br>
30  * The person, application, default applicant assignment, and, if required,
31  * associated assignment budget values, and a letter request are successfully
32  * inserted into the database.
33  *
34  * <p><b>Post Failure</b><br>
35  * The API does not create the person, application, default applicant
36  * assignment, associated assignment budget values, and a letter request, and
37  * raises an error.
38  *
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 date an application was received, and thus the
43  * effective start date of the person, application and assignment.
44  * @param p_business_group_id The applicant's business group.
45  * @param p_last_name The applicant's last name.
46  * @param p_person_type_id Person type id. If a person_type_id is not specified
47  * the API will use the default APL type for the business group.
48  * @param p_applicant_number Applicant number, if the number generation method
49  * is Manual then this parameter is mandatory. If the number generation method
50  * is Automatic then the value of this parameter must be NULL. If p_validate is
51  * false and the applicant number generation method is Automatic this will be
52  * set to to the generated applicant number of the person created. If
53  * p_validate is false and the applicant number generation method is manual
54  * this will be set to the same value passed in. If p_validate is true this
55  * will be set to the same value as passed in.
56  * @param p_comments Applicant comment text.
57  * @param p_date_employee_data_verified The date on which the applicant data
58  * was last verified.
59  * @param p_date_of_birth Date of birth.
60  * @param p_email_address Email address.
61  * @param p_expense_check_send_to_addres Address to use as mailing address.
62  * @param p_first_name Applicant's first name.
63  * @param p_middle_names Person's middle name.
64  * @param p_known_as Applicant's alternative name.
65  * @param p_marital_status Marital status. Valid values are defined by the
66  * MAR_STATUS lookup type.
67  * @param p_nationality Applicant's nationality. Valid values are defined by
68  * the NATIONALITY lookup type.
69  * @param p_national_identifier National identifier.
70  * @param p_previous_last_name Previous last name.
71  * @param p_registered_disabled_flag Registered disabled flag.Valid values are
72  * defined by the REGISTERED_DISABLED lookup type.
73  * @param p_sex Applicant's sex. Valid values are defined by the SEX lookup
74  * type.
75  * @param p_title Applicant's title. Valid values are defined by the TITLE
76  * lookup type.
77  * @param p_work_telephone Work telephone.
78  * @param p_attribute_category This context value determines which flexfield
79  * structure to use with the descriptive flexfield segments.
80  * @param p_attribute1 Descriptive flexfield segment.
81  * @param p_attribute2 Descriptive flexfield segment.
82  * @param p_attribute3 Descriptive flexfield segment.
83  * @param p_attribute4 Descriptive flexfield segment.
84  * @param p_attribute5 Descriptive flexfield segment.
85  * @param p_attribute6 Descriptive flexfield segment.
86  * @param p_attribute7 Descriptive flexfield segment.
87  * @param p_attribute8 Descriptive flexfield segment.
88  * @param p_attribute9 Descriptive flexfield segment.
89  * @param p_attribute10 Descriptive flexfield segment.
90  * @param p_attribute11 Descriptive flexfield segment.
91  * @param p_attribute12 Descriptive flexfield segment.
92  * @param p_attribute13 Descriptive flexfield segment.
93  * @param p_attribute14 Descriptive flexfield segment.
94  * @param p_attribute15 Descriptive flexfield segment.
95  * @param p_attribute16 Descriptive flexfield segment.
96  * @param p_attribute17 Descriptive flexfield segment.
97  * @param p_attribute18 Descriptive flexfield segment.
98  * @param p_attribute19 Descriptive flexfield segment.
99  * @param p_attribute20 Descriptive flexfield segment.
100  * @param p_attribute21 Descriptive flexfield segment.
101  * @param p_attribute22 Descriptive flexfield segment.
102  * @param p_attribute23 Descriptive flexfield segment.
103  * @param p_attribute24 Descriptive flexfield segment.
104  * @param p_attribute25 Descriptive flexfield segment.
105  * @param p_attribute26 Descriptive flexfield segment.
106  * @param p_attribute27 Descriptive flexfield segment.
107  * @param p_attribute28 Descriptive flexfield segment.
108  * @param p_attribute29 Descriptive flexfield segment.
109  * @param p_attribute30 Descriptive flexfield segment.
110  * @param p_initials Initials.
111  * @param p_jubilee_date Jubilee date.
112  * @param p_trainee Trainee.
113  * @param p_background_check_status Y/N flag indicates whether background check
114  * has been performed.
115  * @param p_background_date_check Date background check was performed.
116  * @param p_correspondence_language Preferred language for correspondence.
117  * @param p_fte_capacity Currently unsupported.
118  * @param p_hold_applicant_date_until Date up to which the applicant's file is
119  * to be maintained.
120  * @param p_honors Honors or degrees awarded.
121  * @param p_mailstop Office identifier for internal mail.
122  * @param p_office_number Number of office.
123  * @param p_on_military_service Type of military service.
124  * @param p_projected_start_date Currently unsupported.
125  * @param p_resume_exists Y/N flag indicating whether resume is on file.
126  * @param p_resume_last_updated Date resume last updated.
127  * @param p_student_status Type of student status.
128  * @param p_work_schedule Type of work schedule indicating which days the
129  * person works.
130  * @param p_date_of_death Date of death.
131  * @param p_benefit_group_id ID for benefit group.
132  * @param p_receipt_of_death_cert_date Date death certificate was received.
133  * @param p_coord_ben_med_pln_no Number of an externally provided medical plan.
134  * @param p_coord_ben_no_cvg_flag No other coverage flag.
135  * @param p_uses_tobacco_flag Uses tobacco list of values.
136  * @param p_dpdnt_adoption_date Date dependent was adopted.
137  * @param p_dpdnt_vlntry_svce_flag Dependent on voluntary service flag.
138  * @param p_original_date_of_hire Original date of hire.
139  * @param p_town_of_birth Town or city of birth.
140  * @param p_region_of_birth Geographical region of birth.
141  * @param p_country_of_birth Country of birth.
142  * @param p_global_person_id Global ID for the person.
143  * @param p_person_id If p_validate is false, then this uniquely identifies the
144  * person created. If p_validate is true, then set to null.
145  * @param p_assignment_id If p_validate is false, then this uniquely identifies
146  * the created assignment. If p_validate is true, then set to null.
147  * @param p_application_id If p_validate is false, this uniquely identifies the
148  * application created. If p_validate is true this parameter will be null.
149  * @param p_per_object_version_number If p_validate is false, then set to the
150  * version number of the created person. If p_validate is true, then the value
151  * will be null.
152  * @param p_asg_object_version_number If p_validate is false, then this
153  * parameter is set to the version number of the assignment created. If
154  * p_validate is true, then this parameter is null.
155  * @param p_apl_object_version_number If p_validate is false, this will be set
156  * to the version number of the application created. If p_validate is true this
157  * parameter will be set to null.
158  * @param p_per_effective_start_date If p_validate is false, this will be set
159  * to the effective start date of the person. If p_validate is true this will
160  * be null.
161  * @param p_per_effective_end_date If p_validate is false, this will be set to
162  * the effective end date of the person. If p_validate is true this will be
163  * null.
164  * @param p_full_name If p_validate is false, this will be set to the complete
165  * full name of the person. If p_validate is true this will be null.
166  * @param p_per_comment_id If p_validate is false this will be set to the id of
167  * the corresponding person comment row, if any comment text exists. If
168  * p_validate is true this will be null.
169  * @param p_assignment_sequence If p_validate is false this will be set to the
170  * sequence number of the default assignment. If p_validate is true this will
171  * be null.
172  * @param p_name_combination_warning If set to true, then the combination of
173  * last name, first name and date of birth existed prior to calling this API.
174  * @param p_orig_hire_warning Thi is set to true if the original date of hire
175  * is not null and the person type is not EMP,EMP_APL, EX_EMP or EX_EMP_APL.
176  * @rep:displayname Create Applicant for Denmark
177  * @rep:category BUSINESS_ENTITY PER_APPLICANT
178  * @rep:lifecycle active
179  * @rep:scope public
180  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
181 */
182 --
183 -- {End Of Comments}
184 --
185   PROCEDURE create_dk_applicant
186   (p_validate                      in     boolean  default false
187   ,p_date_received                 in     date
188   ,p_business_group_id             in     number
189   ,p_last_name                   in     varchar2
190   ,p_person_type_id                in     number   default null
191   ,p_applicant_number              in out nocopy varchar2
192   ,p_comments                      in     varchar2 default null
193   ,p_date_employee_data_verified   in     date     default null
194   ,p_date_of_birth                 in     date     default null
195   ,p_email_address                 in     varchar2 default null
196   ,p_expense_check_send_to_addres  in     varchar2 default null
197   ,p_first_name                    in     varchar2
198   -- Added for bug fix 4666216
199   ,p_middle_names                  in     varchar2 default null
200   ,p_known_as                      in     varchar2 default null
201   ,p_marital_status                in     varchar2 default null
202   ,p_nationality                   in     varchar2
203   ,p_national_identifier           in     varchar2 default null
204   ,p_previous_last_name            in     varchar2 default null
205   ,p_registered_disabled_flag      in     varchar2 default null
206   ,p_sex                           in     varchar2 default null
207   ,p_title                         in     varchar2
208   ,p_work_telephone                in     varchar2 default null
209   ,p_attribute_category            in     varchar2 default null
210   ,p_attribute1                    in     varchar2 default null
211   ,p_attribute2                    in     varchar2 default null
212   ,p_attribute3                    in     varchar2 default null
213   ,p_attribute4                    in     varchar2 default null
214   ,p_attribute5                    in     varchar2 default null
215   ,p_attribute6                    in     varchar2 default null
216   ,p_attribute7                    in     varchar2 default null
217   ,p_attribute8                    in     varchar2 default null
218   ,p_attribute9                    in     varchar2 default null
219   ,p_attribute10                   in     varchar2 default null
220   ,p_attribute11                   in     varchar2 default null
221   ,p_attribute12                   in     varchar2 default null
222   ,p_attribute13                   in     varchar2 default null
223   ,p_attribute14                   in     varchar2 default null
224   ,p_attribute15                   in     varchar2 default null
225   ,p_attribute16                   in     varchar2 default null
226   ,p_attribute17                   in     varchar2 default null
227   ,p_attribute18                   in     varchar2 default null
228   ,p_attribute19                   in     varchar2 default null
229   ,p_attribute20                   in     varchar2 default null
230   ,p_attribute21                   in     varchar2 default null
231   ,p_attribute22                   in     varchar2 default null
232   ,p_attribute23                   in     varchar2 default null
233   ,p_attribute24                   in     varchar2 default null
234   ,p_attribute25                   in     varchar2 default null
235   ,p_attribute26                   in     varchar2 default null
236   ,p_attribute27                   in     varchar2 default null
237   ,p_attribute28                   in     varchar2 default null
238   ,p_attribute29                   in     varchar2 default null
239   ,p_attribute30                   in     varchar2 default null
240   ,p_initials			   in     varchar2 default null
241   ,p_jubilee_date		   in		date default null
242   ,p_trainee			   IN     VARCHAR2 DEFAULT null
243   ,p_background_check_status       in     varchar2 default null
247   ,p_hold_applicant_date_until     in     date     default null
244   ,p_background_date_check         in     date     default null
245   ,p_correspondence_language       in     varchar2 default null
246   ,p_fte_capacity                  in     number   default null
248   ,p_honors                        in     varchar2 default null
249   ,p_mailstop                      in     varchar2 default null
250   ,p_office_number                 in     varchar2 default null
251   ,p_on_military_service           in     varchar2 default null
252   ,p_projected_start_date          in     date     default null
253   ,p_resume_exists                 in     varchar2 default null
254   ,p_resume_last_updated           in     date     default null
255   ,p_student_status                in     varchar2 default null
256   ,p_work_schedule                 in     varchar2 default null
257   ,p_date_of_death                 in     date     default null
258   ,p_benefit_group_id              in     number   default null
259   ,p_receipt_of_death_cert_date    in     date     default null
260   ,p_coord_ben_med_pln_no          in     varchar2 default null
261   ,p_coord_ben_no_cvg_flag         in     varchar2 default 'N'
262   ,p_uses_tobacco_flag             in     varchar2 default null
263   ,p_dpdnt_adoption_date           in     date     default null
264   ,p_dpdnt_vlntry_svce_flag        in     varchar2 default 'N'
265   ,p_original_date_of_hire         in     date     default null
266   ,p_town_of_birth                 in     varchar2 default null
267   ,p_region_of_birth               in     varchar2 default null
268   ,p_country_of_birth              in     varchar2 default null
269   ,p_global_person_id              in     varchar2 default null
270   ,p_person_id                        out nocopy number
271   ,p_assignment_id                    out nocopy number
272   ,p_application_id                   out nocopy number
273   ,p_per_object_version_number        out nocopy number
274   ,p_asg_object_version_number        out nocopy number
275   ,p_apl_object_version_number        out nocopy number
276   ,p_per_effective_start_date         out nocopy date
277   ,p_per_effective_end_date           out nocopy date
278   ,p_full_name                        out nocopy varchar2
279   ,p_per_comment_id                   out nocopy number
280   ,p_assignment_sequence              out nocopy number
281   ,p_name_combination_warning         out nocopy boolean
282   ,p_orig_hire_warning                out nocopy boolean);
283 
284 end hr_dk_applicant_api;