DBA Data[Home] [Help]

PACKAGE: APPS.HR_SA_PREVIOUS_EMPLOYMENT_API

Source


1 package hr_sa_previous_employment_api as
2 /* $Header: pepemsai.pkh 120.1 2005/10/02 02:20:34 aroussel $ */
3 /*#
4  * This package contains previous employment APIs for Saudi Arabia.
5  * @rep:scope public
6  * @rep:product per
7  * @rep:displayname Previous Employment for Saudi Arabia
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-----------------------< create_sa_previous_employer >--------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16  * This API creates a previous employer record for a person in a Saudi Arabia
17  * business group.
18  *
19  * The API calls the generic API create_previous_employer, with parameters as
20  * appropriate for the Saudi person. As this API is effectively an alternative
21  * to the API create_previous_employer, see that API for further explanation.
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  * See API create_previous_employer
28  *
29  * <p><b>Post Success</b><br>
30  * The API successfully creates a previous employer record in the database.
31  *
32  * <p><b>Post Failure</b><br>
33  * The API does not create the previous employer record and raises an error.
34  * @param p_effective_date Reference date for validating lookup values are
35  * applicable during the start to end active date range. This date does not
36  * determine when the changes take effect.
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_business_group_id Uniquely identifies the business group in which
41  * the previous employer record is created. It must be the same as the person's
42  * own business group.
43  * @param p_person_id Uniquely identifies the person for whom the previous
44  * employer record is created. The person type cannot be 'OTHER'.
45  * @param p_party_id Uniquely identiies employer information for a party, so
46  * that users can see the information for all instances of the person in
47  * different business groups.
48  * @param p_start_date The start date of the employee's previous employment.
49  * @param p_end_date The end date of the employee's previous employment.
50  * @param p_period_years The number of years the employee worked with the
51  * previous employer. If left null, the process calculates this based on the
52  * start date and end date. For example, if the start date is '01-JAN-2000' and
53  * the end date is '05-MAR-2004', the process sets four years.
54  * @param p_period_months The number of months the employee worked over and
55  * above the years worked. If left null, the process calculates this from the
56  * start and end date. For example, if the start date is '01-JAN-2000' and the
57  * end date is '05-MAR-2004', the the process sets two months.
58  * @param p_period_days The number of days worked over and above the years and
59  * months worked. If left null, the process calculatese this from the start and
60  * end date. For example, if the start date is '01-JAN-2000' and the end date
61  * is '05-MAR-2004', the process sets five days.
62  * @param p_employer_name The name of the previous employer
63  * @param p_employer_country The country in which the previous employer is
64  * located. For global previous employers, set to the country in which the
65  * company headquarters is located or the country in which the employment took
66  * place.
67  * @param p_employer_address The address of the previous employer.
68  * @param p_employer_type Type of previous employer. Valid values for this
69  * field are defined by the lookup type 'PREV_EMP_TYPE'. Values your enterprise
70  * defines for this lookup type should be high level, vertical descriptions for
71  * the industry, for example, 'Public Sector', 'Manufacturing', etc.
72  * @param p_employer_subtype The subtype of the previous employer. Valid values
73  * for this field are defined by the lookup type 'PREV_EMP_SUBTYPE'. Values
74  * your enterprise defines for this lookup type should identify the employer
75  * type more specifically. For example, for the employer type of 'Public
76  * Sector', you can define subtypes such as 'Civil Service', 'Teaching', or
77  * 'Health Care'.
78  * @param p_description Description of the previous employer.
79  * @param p_all_assignments Set to 'Y' if the previous employment applies to
80  * all of the employee's assignments. Otherwise set to 'N'. In order to create
81  * previous job usage records (using the create_previous_job_usage API), set
82  * this flag to 'N'.
83  * @param p_pem_attribute_category Descriptive flexfield structure defining
84  * column.
85  * @param p_pem_attribute1 Descriptive flexfield column
86  * @param p_pem_attribute2 Descriptive flexfield column
87  * @param p_pem_attribute3 Descriptive flexfield column
88  * @param p_pem_attribute4 Descriptive flexfield column
89  * @param p_pem_attribute5 Descriptive flexfield column
90  * @param p_pem_attribute6 Descriptive flexfield column
91  * @param p_pem_attribute7 Descriptive flexfield column
92  * @param p_pem_attribute8 Descriptive flexfield column
93  * @param p_pem_attribute9 Descriptive flexfield column
94  * @param p_pem_attribute10 Descriptive flexfield column
95  * @param p_pem_attribute11 Descriptive flexfield column
96  * @param p_pem_attribute12 Descriptive flexfield column
97  * @param p_pem_attribute13 Descriptive flexfield column
98  * @param p_pem_attribute14 Descriptive flexfield column
99  * @param p_pem_attribute15 Descriptive flexfield column
100  * @param p_pem_attribute16 Descriptive flexfield column
101  * @param p_pem_attribute17 Descriptive flexfield column
102  * @param p_pem_attribute18 Descriptive flexfield column
103  * @param p_pem_attribute19 Descriptive flexfield column
104  * @param p_pem_attribute20 Descriptive flexfield column
105  * @param p_pem_attribute21 Descriptive flexfield column
106  * @param p_pem_attribute22 Descriptive flexfield column
107  * @param p_pem_attribute23 Descriptive flexfield column
108  * @param p_pem_attribute24 Descriptive flexfield column
109  * @param p_pem_attribute25 Descriptive flexfield column
110  * @param p_pem_attribute26 Descriptive flexfield column
111  * @param p_pem_attribute27 Descriptive flexfield column
112  * @param p_pem_attribute28 Descriptive flexfield column
113  * @param p_pem_attribute29 Descriptive flexfield column
114  * @param p_pem_attribute30 Descriptive flexfield column
115  * @param p_termination_reason Termination reason
116  * @param p_previous_employer_id If p_validate is false, then this uniquely
117  * identifies the previous employer created. If p_validate is true, then set to
118  * null.
119  * @param p_object_version_number If p_validate is false, then set to the
120  * version number of the created previous employer. If p_validate is true, then
121  * the value will be null.
122  * @rep:displayname Create Previous Employer for Saudi Arabia
123  * @rep:category BUSINESS_ENTITY PER_PREVIOUS_EMPLOYMENT
124  * @rep:scope public
125  * @rep:lifecycle active
126  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
127 */
128 --
129 -- {End Of Comments}
130 --
131 procedure create_sa_previous_employer
132 (  p_effective_date               IN      date
133   ,p_validate                     IN      boolean   default false
134   ,p_business_group_id            IN      number
135   ,p_person_id                    IN      number
136   ,p_party_id                     IN      number    default null
137   ,p_start_date                   IN      date      default null
138   ,p_end_date                     IN      date      default null
139   ,p_period_years                 IN      number    default null
140   ,p_period_months                IN      number    default null
141   ,p_period_days                  IN      number    default null
142   ,p_employer_name                IN      varchar2  default null
143   ,p_employer_country             IN      varchar2  default null
144   ,p_employer_address             IN      varchar2  default null
145   ,p_employer_type                IN      varchar2  default null
146   ,p_employer_subtype             IN      varchar2  default null
147   ,p_description                  IN      varchar2  default null
148   ,p_all_assignments              IN      varchar2  default 'N'
149   ,p_pem_attribute_category       IN      varchar2  default null
150   ,p_pem_attribute1               IN      varchar2  default null
151   ,p_pem_attribute2               IN      varchar2  default null
152   ,p_pem_attribute3               IN      varchar2  default null
153   ,p_pem_attribute4               IN      varchar2  default null
154   ,p_pem_attribute5               IN      varchar2  default null
155   ,p_pem_attribute6               IN      varchar2  default null
156   ,p_pem_attribute7               IN      varchar2  default null
157   ,p_pem_attribute8               IN      varchar2  default null
158   ,p_pem_attribute9               IN      varchar2  default null
159   ,p_pem_attribute10              IN      varchar2  default null
160   ,p_pem_attribute11              IN      varchar2  default null
161   ,p_pem_attribute12              IN      varchar2  default null
162   ,p_pem_attribute13              IN      varchar2  default null
163   ,p_pem_attribute14              IN      varchar2  default null
164   ,p_pem_attribute15              IN      varchar2  default null
165   ,p_pem_attribute16              IN      varchar2  default null
166   ,p_pem_attribute17              IN      varchar2  default null
167   ,p_pem_attribute18              IN      varchar2  default null
168   ,p_pem_attribute19              IN      varchar2  default null
169   ,p_pem_attribute20              IN      varchar2  default null
170   ,p_pem_attribute21              IN      varchar2  default null
171   ,p_pem_attribute22              IN      varchar2  default null
172   ,p_pem_attribute23              IN      varchar2  default null
173   ,p_pem_attribute24              IN      varchar2  default null
174   ,p_pem_attribute25              IN      varchar2  default null
175   ,p_pem_attribute26              IN      varchar2  default null
176   ,p_pem_attribute27              IN      varchar2  default null
177   ,p_pem_attribute28              IN      varchar2  default null
178   ,p_pem_attribute29              IN      varchar2  default null
179   ,p_pem_attribute30              IN      varchar2  default null
180   ,p_termination_reason           IN      varchar2  default null
181   ,p_previous_employer_id         OUT NOCOPY     number
182   ,p_object_version_number        OUT NOCOPY     number
183   );
184 --
185 -- ----------------------------------------------------------------------------
186 -- |-----------------------< update_sa_previous_employer >--------------------|
187 -- ----------------------------------------------------------------------------
188 --
189 -- {Start Of Comments}
190 /*#
191  * This API updates information for an existing previous employer record for a
192  * person in a Saudi Arabia business group.
193  *
194  * The API calls the generic API update_previous_employer, with parameters set
195  * as appropriate for the Saudi person. As this API is effectively an
196  * alternative to the API update_previous_employer, see that API for further
197  * explanation.
198  *
199  * <p><b>Licensing</b><br>
200  * This API is licensed for use with Human Resources.
201  *
202  * <p><b>Prerequisites</b><br>
203  * See API update_previous_employer
204  *
205  * <p><b>Post Success</b><br>
206  * The API successfully updates the previous employer record in the database.
207  *
208  * <p><b>Post Failure</b><br>
209  * The API does not update the previous employer record and raises an error.
210  * @param p_effective_date Reference date for validating lookup values are
211  * applicable during the start to end active date range. This date does not
212  * determine when the changes take effect.
213  * @param p_validate If true, then validation alone will be performed and the
214  * database will remain unchanged. If false and all validation checks pass,
215  * then the database will be modified.
216  * @param p_previous_employer_id Uniquely identifies the previous employer
217  * record to be updated.
218  * @param p_start_date The start date of the employee's previous employment.
219  * @param p_end_date The end date of the employee's previous employment.
220  * @param p_period_years The number of years the employee worked with the
221  * previous employer. If left null, the process calculates this based on the
222  * start date and end date. For example, if the start date is '01-JAN-2000' and
223  * the end date is '05-MAR-2004', the process sets four years.
224  * @param p_period_months The number of months the employee worked over and
225  * above the years worked. If left null, the process calculates this from the
226  * start and end date. For example, if the start date is '01-JAN-2000' and the
227  * end date is '05-MAR-2004', the the process sets two months.
228  * @param p_period_days The number of days worked over and above the years and
229  * months worked. If left null, the process calculatese this from the start and
230  * end date. For example, if the start date is '01-JAN-2000' and the end date
231  * is '05-MAR-2004', the process sets five days.
232  * @param p_employer_name The name of the previous employer
233  * @param p_employer_country The country in which the previous employer is
234  * located. For global previous employers, set to the country in which the
235  * company headquarters is located or the country in which the employment took
236  * place.
237  * @param p_employer_address The address of the previous employer.
238  * @param p_employer_type Type of previous employer. Valid values for this
239  * field are defined by the lookup type 'PREV_EMP_TYPE'. Values your enterprise
240  * defines for this lookup type should be high level, vertical descriptions for
241  * the industry, for example, 'Public Sector', 'Manufacturing', etc.
242  * @param p_employer_subtype The subtype of the previous employer. Valid values
243  * for this field are defined by the lookup type 'PREV_EMP_SUBTYPE'. Values
244  * your enterprise defines for this lookup type should identify the employer
245  * type more specifically. For example, for the employer type of 'Public
246  * Sector', you can define subtypes such as 'Civil Service', 'Teaching', or
247  * 'Health Care'.
248  * @param p_description Description of the previous employer.
249  * @param p_all_assignments Set to 'Y' if the previous employment applies to
250  * all of the employee's assignments. Otherwise set to 'N'. In order to create
251  * previous job usage records (using the create_previous_job_usage API), set
252  * this flag to 'N'.
253  * @param p_pem_attribute_category Descriptive flexfield structure defining
254  * column.
255  * @param p_pem_attribute1 Descriptive flexfield structure defining column.
256  * @param p_pem_attribute2 Descriptive flexfield structure defining column.
257  * @param p_pem_attribute3 Descriptive flexfield structure defining column.
258  * @param p_pem_attribute4 Descriptive flexfield structure defining column.
259  * @param p_pem_attribute5 Descriptive flexfield structure defining column.
260  * @param p_pem_attribute6 Descriptive flexfield structure defining column.
261  * @param p_pem_attribute7 Descriptive flexfield structure defining column.
262  * @param p_pem_attribute8 Descriptive flexfield structure defining column.
263  * @param p_pem_attribute9 Descriptive flexfield structure defining column.
264  * @param p_pem_attribute10 Descriptive flexfield structure defining column.
265  * @param p_pem_attribute11 Descriptive flexfield structure defining column.
266  * @param p_pem_attribute12 Descriptive flexfield structure defining column.
267  * @param p_pem_attribute13 Descriptive flexfield structure defining column.
268  * @param p_pem_attribute14 Descriptive flexfield structure defining column.
269  * @param p_pem_attribute15 Descriptive flexfield structure defining column.
270  * @param p_pem_attribute16 Descriptive flexfield structure defining column.
271  * @param p_pem_attribute17 Descriptive flexfield structure defining column.
272  * @param p_pem_attribute18 Descriptive flexfield structure defining column.
273  * @param p_pem_attribute19 Descriptive flexfield structure defining column.
274  * @param p_pem_attribute20 Descriptive flexfield structure defining column.
275  * @param p_pem_attribute21 Descriptive flexfield structure defining column.
276  * @param p_pem_attribute22 Descriptive flexfield structure defining column.
277  * @param p_pem_attribute23 Descriptive flexfield structure defining column.
278  * @param p_pem_attribute24 Descriptive flexfield structure defining column.
279  * @param p_pem_attribute25 Descriptive flexfield structure defining column.
280  * @param p_pem_attribute26 Descriptive flexfield structure defining column.
281  * @param p_pem_attribute27 Descriptive flexfield structure defining column.
282  * @param p_pem_attribute28 Descriptive flexfield structure defining column.
283  * @param p_pem_attribute29 Descriptive flexfield structure defining column.
284  * @param p_pem_attribute30 Descriptive flexfield structure defining column.
285  * @param p_termination_reason Termination Reason
286  * @param p_object_version_number Pass in the current version number of the
287  * previous employer to be updated. When the API completes if p_validate is
288  * false, will be set to the new version number of the updated previous
289  * employer. If p_validate is true will be set to the same value which was
290  * passed in.
291  * @rep:displayname Update Previous Employer for Saudi Arabia
292  * @rep:category BUSINESS_ENTITY PER_PREVIOUS_EMPLOYMENT
293  * @rep:scope public
294  * @rep:lifecycle active
295  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
296 */
297 --
298 -- {End Of Comments}
299 --
300 procedure update_sa_previous_employer
301 (  p_effective_date             IN      date
302   ,p_validate                   IN      boolean   default false
303   ,p_previous_employer_id       IN      number
304   ,p_start_date                 IN      date      default hr_api.g_date
305   ,p_end_date                   IN      date      default hr_api.g_date
306   ,p_period_years               IN      number    default hr_api.g_number
307   ,p_period_months              IN      number    default hr_api.g_number
308   ,p_period_days                IN      number    default hr_api.g_number
309   ,p_employer_name              IN      varchar2  default hr_api.g_varchar2
310   ,p_employer_country           IN      varchar2  default hr_api.g_varchar2
311   ,p_employer_address           IN      varchar2  default hr_api.g_varchar2
312   ,p_employer_type              IN      varchar2  default hr_api.g_varchar2
313   ,p_employer_subtype           IN      varchar2  default hr_api.g_varchar2
314   ,p_description                IN      varchar2  default hr_api.g_varchar2
315   ,p_all_assignments            IN      varchar2  default 'N'
316   ,p_pem_attribute_category     IN      varchar2  default hr_api.g_varchar2
317   ,p_pem_attribute1             IN      varchar2  default hr_api.g_varchar2
318   ,p_pem_attribute2             IN      varchar2  default hr_api.g_varchar2
319   ,p_pem_attribute3             IN      varchar2  default hr_api.g_varchar2
320   ,p_pem_attribute4             IN      varchar2  default hr_api.g_varchar2
321   ,p_pem_attribute5             IN      varchar2  default hr_api.g_varchar2
322   ,p_pem_attribute6             IN      varchar2  default hr_api.g_varchar2
323   ,p_pem_attribute7             IN      varchar2  default hr_api.g_varchar2
324   ,p_pem_attribute8             IN      varchar2  default hr_api.g_varchar2
325   ,p_pem_attribute9             IN      varchar2  default hr_api.g_varchar2
326   ,p_pem_attribute10            IN      varchar2  default hr_api.g_varchar2
327   ,p_pem_attribute11            IN      varchar2  default hr_api.g_varchar2
328   ,p_pem_attribute12            IN      varchar2  default hr_api.g_varchar2
329   ,p_pem_attribute13            IN      varchar2  default hr_api.g_varchar2
330   ,p_pem_attribute14            IN      varchar2  default hr_api.g_varchar2
331   ,p_pem_attribute15            IN      varchar2  default hr_api.g_varchar2
332   ,p_pem_attribute16            IN      varchar2  default hr_api.g_varchar2
333   ,p_pem_attribute17            IN      varchar2  default hr_api.g_varchar2
334   ,p_pem_attribute18            IN      varchar2  default hr_api.g_varchar2
335   ,p_pem_attribute19            IN      varchar2  default hr_api.g_varchar2
336   ,p_pem_attribute20            IN      varchar2  default hr_api.g_varchar2
337   ,p_pem_attribute21            IN      varchar2  default hr_api.g_varchar2
338   ,p_pem_attribute22            IN      varchar2  default hr_api.g_varchar2
339   ,p_pem_attribute23            IN      varchar2  default hr_api.g_varchar2
340   ,p_pem_attribute24            IN      varchar2  default hr_api.g_varchar2
341   ,p_pem_attribute25            IN      varchar2  default hr_api.g_varchar2
342   ,p_pem_attribute26            IN      varchar2  default hr_api.g_varchar2
343   ,p_pem_attribute27            IN      varchar2  default hr_api.g_varchar2
344   ,p_pem_attribute28            IN      varchar2  default hr_api.g_varchar2
345   ,p_pem_attribute29            IN      varchar2  default hr_api.g_varchar2
346   ,p_pem_attribute30            IN      varchar2  default hr_api.g_varchar2
347   ,p_termination_reason         IN      varchar2  default hr_api.g_varchar2
348   ,p_object_version_number      IN OUT NOCOPY  number
349   );
350 --
351 end hr_sa_previous_employment_api;