1 Package hr_deployment_factor_api as
2 /* $Header: pedpfapi.pkh 120.1 2005/10/02 02:15:01 aroussel $ */
3 /*#
4 * This package contains person deployment factor APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Deployment Factor
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |------------------------< create_person_dpmt_factor >---------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API is used to create a deployment factor for a person.
17 *
18 * Use this API to record work choices and work preferences for a person. You
19 * can record details such as relocation preferences and International
20 * Deployment.
21 *
22 * <p><b>Licensing</b><br>
23 * This API is licensed for use with Human Resources.
24 *
25 * <p><b>Prerequisites</b><br>
26 * The person for whom deployment factors are being created must already exist
27 * within the business group.
28 *
29 * <p><b>Post Success</b><br>
30 * The deployment factor for the person will have been created.
31 *
32 * <p><b>Post Failure</b><br>
33 * The deployment factor will not be created and an error will be raised.
34 * @param p_validate If true, then validation alone will be performed and the
35 * database will remain unchanged. If false and all validation checks pass,
36 * then the database will be modified.
37 * @param p_effective_date Reference date for validating lookup values are
38 * applicable during the start to end active date range. This date does not
39 * determine when the changes take effect.
40 * @param p_person_id Uniquely identifies the person for whom you create the
41 * deployment factor record.
42 * @param p_work_any_country Specifies if the person is available to work in
43 * any country. Valid values are defined by the 'YES_NO' lookup type.
44 * @param p_work_any_location Specifies if the person is available to work in
45 * any location. Valid values are defined by the 'YES_NO' lookup type.
46 * @param p_relocate_domestically Specifies if the person is available to
47 * relocate domestically. Valid values are defined by the 'YES_NO' lookup type.
48 * @param p_relocate_internationally Specifies if the person is available to
49 * relocate internationally. Valid values are defined by the 'YES_NO' lookup
50 * type.
51 * @param p_travel_required Specifies if the person is available to travel.
52 * Valid values are defined by the YES_NO' lookup type.
53 * @param p_country1 Country one where the person is available to work.
54 * @param p_country2 Country two where the person is available to work.
55 * @param p_country3 Country three where the person is available to work.
56 * @param p_work_duration Preferred work duration. Valid values are defined by
57 * the 'PER_TIME_SCALES' lookup type.
58 * @param p_work_schedule Preferred work schedule. Valid values are defined by
59 * the 'PER_WORK_SCHEDULE' lookup type.
60 * @param p_work_hours Preferred work hours. Valid values are defined by the
61 * 'PER_WORK_HOURS' lookup type.
62 * @param p_fte_capacity The Full Time Equivalent (FTE) capacity. Valid values
63 * are defined by the 'PER_FTE_CAPACITY' lookup type.
64 * @param p_visit_internationally Specifies willingness to travel
65 * internationally. Valid values are defined by the 'YES_NO' lookup type.
66 * @param p_only_current_location Specifies if only the current location is
67 * acceptable. Valid values are defined by the 'YES_NO' lookup type.
68 * @param p_no_country1 Country one that is not acceptable.
69 * @param p_no_country2 Country two that is not acceptable.
70 * @param p_no_country3 Country three that is not acceptable.
71 * @param p_comments Comment text.
72 * @param p_earliest_available_date The earliest available date for transfer.
73 * @param p_available_for_transfer Specifies if the person is available for
74 * transfer. Valid values are defined by the 'YES_NO' lookup type.
75 * @param p_relocation_preference The person's relocation preference. Valid
76 * values are defined by the 'PER_RELOCATION_PREFERENCES' lookup type.
77 * @param p_attribute_category This context value determines which flexfield
78 * structure to use with the descriptive flexfield segments.
79 * @param p_attribute1 Descriptive flexfield segment.
80 * @param p_attribute2 Descriptive flexfield segment.
81 * @param p_attribute3 Descriptive flexfield segment.
82 * @param p_attribute4 Descriptive flexfield segment.
83 * @param p_attribute5 Descriptive flexfield segment.
84 * @param p_attribute6 Descriptive flexfield segment.
85 * @param p_attribute7 Descriptive flexfield segment.
86 * @param p_attribute8 Descriptive flexfield segment.
87 * @param p_attribute9 Descriptive flexfield segment.
88 * @param p_attribute10 Descriptive flexfield segment.
89 * @param p_attribute11 Descriptive flexfield segment.
90 * @param p_attribute12 Descriptive flexfield segment.
91 * @param p_attribute13 Descriptive flexfield segment.
92 * @param p_attribute14 Descriptive flexfield segment.
93 * @param p_attribute15 Descriptive flexfield segment.
94 * @param p_attribute16 Descriptive flexfield segment.
95 * @param p_attribute17 Descriptive flexfield segment.
96 * @param p_attribute18 Descriptive flexfield segment.
97 * @param p_attribute19 Descriptive flexfield segment.
98 * @param p_attribute20 Descriptive flexfield segment.
99 * @param p_deployment_factor_id If p_validate is false, then this uniquely
100 * identifies the person deployment factor created. If p_validate is true, then
101 * this is set to null.
102 * @param p_object_version_number If p_validate is false, then set to the
103 * version number of the created deployment factor. If p_validate is true, then
104 * the value will be null.
105 * @rep:displayname Create Person Deployment Factor
106 * @rep:category BUSINESS_ENTITY PER_EMPLOYEE
107 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
108 * @rep:scope public
109 * @rep:lifecycle active
110 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
111 */
112 --
113 -- {End Of Comments}
114 --
115 procedure create_person_dpmt_factor
116 (p_validate in boolean default false
117 ,p_effective_date in date
118 ,p_person_id in number
119 ,p_work_any_country in varchar2
120 ,p_work_any_location in varchar2
121 ,p_relocate_domestically in varchar2
122 ,p_relocate_internationally in varchar2
123 ,p_travel_required in varchar2
124 ,p_country1 in varchar2 default null
125 ,p_country2 in varchar2 default null
126 ,p_country3 in varchar2 default null
127 ,p_work_duration in varchar2 default null
128 ,p_work_schedule in varchar2 default null
129 ,p_work_hours in varchar2 default null
130 ,p_fte_capacity in varchar2 default null
131 ,p_visit_internationally in varchar2 default null
132 ,p_only_current_location in varchar2 default null
133 ,p_no_country1 in varchar2 default null
134 ,p_no_country2 in varchar2 default null
135 ,p_no_country3 in varchar2 default null
136 ,p_comments in varchar2 default null
137 ,p_earliest_available_date in date default null
138 ,p_available_for_transfer in varchar2 default null
139 ,p_relocation_preference in varchar2 default null
140 ,p_attribute_category in varchar2 default null
141 ,p_attribute1 in varchar2 default null
142 ,p_attribute2 in varchar2 default null
143 ,p_attribute3 in varchar2 default null
144 ,p_attribute4 in varchar2 default null
145 ,p_attribute5 in varchar2 default null
146 ,p_attribute6 in varchar2 default null
147 ,p_attribute7 in varchar2 default null
148 ,p_attribute8 in varchar2 default null
149 ,p_attribute9 in varchar2 default null
150 ,p_attribute10 in varchar2 default null
151 ,p_attribute11 in varchar2 default null
152 ,p_attribute12 in varchar2 default null
153 ,p_attribute13 in varchar2 default null
154 ,p_attribute14 in varchar2 default null
155 ,p_attribute15 in varchar2 default null
156 ,p_attribute16 in varchar2 default null
157 ,p_attribute17 in varchar2 default null
158 ,p_attribute18 in varchar2 default null
159 ,p_attribute19 in varchar2 default null
160 ,p_attribute20 in varchar2 default null
161 ,p_deployment_factor_id out nocopy number
162 ,p_object_version_number out nocopy number
163 );
164 --
165 -- ----------------------------------------------------------------------------
166 -- |------------------------< update_person_dpmt_factor >---------------------|
167 -- ----------------------------------------------------------------------------
168 --
169 -- {Start Of Comments}
170 /*#
171 * This API is used to update a deployment factor for a person.
172 *
173 * Use this API to update the work choices and work preferences for a person.
174 * You can also record details such as relocation preferences and International
175 * Deployment.
176 *
177 * <p><b>Licensing</b><br>
178 * This API is licensed for use with Human Resources.
179 *
180 * <p><b>Prerequisites</b><br>
181 * The deployment factor must exist in the database.
182 *
183 * <p><b>Post Success</b><br>
184 * The deployment factor for the person will have been updated.
185 *
186 * <p><b>Post Failure</b><br>
187 * The deployment factor will not be updated and an error will be raised.
188 * @param p_validate If true, then validation alone will be performed and the
189 * database will remain unchanged. If false and all validation checks pass,
190 * then the database will be modified.
191 * @param p_effective_date Reference date for validating lookup values are
192 * applicable during the start to end active date range. This date does not
193 * determine when the changes take effect.
194 * @param p_deployment_factor_id Uniquely identifies the person deployment
195 * factor the process updates.
196 * @param p_object_version_number Pass in the current version number of the
197 * deployment factor to be updated. When the API completes if p_validate is
198 * false, will be set to the new version number of the updated deployment
199 * factor. If p_validate is true will be set to the same value which was passed
200 * in.
201 * @param p_work_any_country Specifies if the person is available to work in
202 * any country. Valid values are defined by the 'YES_NO' lookup type.
203 * @param p_work_any_location Specifies if the person is available to work in
204 * any location. Valid values are defined by the 'YES_NO' lookup type.
205 * @param p_relocate_domestically Specifies if the person is available to
206 * relocate domestically. Valid values are defined by the 'YES_NO' lookup type.
207 * @param p_relocate_internationally Specifies if the person is available to
208 * relocate internationally. Valid values are defined by the 'YES_NO' lookup
209 * type.
210 * @param p_travel_required Specifies if the person is available to travel.
211 * Valid values are defined by the YES_NO' lookup type.
212 * @param p_country1 Country one where the person is available to work.
213 * @param p_country2 Country two where the person is available to work.
214 * @param p_country3 Country three where the person is available to work.
215 * @param p_work_duration Preferred work duration. Valid values are defined by
216 * the 'PER_TIME_SCALES' lookup type.
217 * @param p_work_schedule Preferred work schedule. Valid values are defined by
218 * the 'PER_WORK_SCHEDULE' lookup type.
219 * @param p_work_hours Preferred work hours. Valid values are defined by the
220 * 'PER_WORK_HOURS' lookup type.
221 * @param p_fte_capacity The Full Time Equivalent (FTE) capacity. Valid values
222 * are defined by the 'PER_FTE_CAPACITY' lookup type.
223 * @param p_visit_internationally Yes/No field to describe willingness to
224 * travel internationally. Valid values are defined by the 'YES_NO' lookup
225 * type.
226 * @param p_only_current_location Specifies if only the current location is
227 * acceptable. Valid values are defined by the 'YES_NO' lookup type.
228 * @param p_no_country1 Country one that is not acceptable.
229 * @param p_no_country2 Country two that is not acceptable.
230 * @param p_no_country3 Country three that is not acceptable.
231 * @param p_comments Comment text.
232 * @param p_earliest_available_date The earliest available date for transfer.
233 * @param p_available_for_transfer Specifies if the person is available for
234 * transfer. Valid values are defined by the 'YES_NO' lookup type.
235 * @param p_relocation_preference The person's relocation preference. Valid
236 * values are defined by the 'PER_RELOCATION_PREFERENCES' lookup type.
237 * @param p_attribute_category This context value determines which flexfield
238 * structure to use with the descriptive flexfield segments.
239 * @param p_attribute1 Descriptive flexfield segment.
240 * @param p_attribute2 Descriptive flexfield segment.
241 * @param p_attribute3 Descriptive flexfield segment.
242 * @param p_attribute4 Descriptive flexfield segment.
243 * @param p_attribute5 Descriptive flexfield segment.
244 * @param p_attribute6 Descriptive flexfield segment.
245 * @param p_attribute7 Descriptive flexfield segment.
246 * @param p_attribute8 Descriptive flexfield segment.
247 * @param p_attribute9 Descriptive flexfield segment.
248 * @param p_attribute10 Descriptive flexfield segment.
249 * @param p_attribute11 Descriptive flexfield segment.
250 * @param p_attribute12 Descriptive flexfield segment.
251 * @param p_attribute13 Descriptive flexfield segment.
252 * @param p_attribute14 Descriptive flexfield segment.
253 * @param p_attribute15 Descriptive flexfield segment.
254 * @param p_attribute16 Descriptive flexfield segment.
255 * @param p_attribute17 Descriptive flexfield segment.
256 * @param p_attribute18 Descriptive flexfield segment.
257 * @param p_attribute19 Descriptive flexfield segment.
258 * @param p_attribute20 Descriptive flexfield segment.
259 * @rep:displayname Update Person Deployment Factor
260 * @rep:category BUSINESS_ENTITY PER_EMPLOYEE
261 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
262 * @rep:scope public
263 * @rep:lifecycle active
264 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
265 */
266 --
267 -- {End Of Comments}
268 --
269 procedure update_person_dpmt_factor
270 (p_validate in boolean default false
271 ,p_effective_date in date
272 ,p_deployment_factor_id in number
273 ,p_object_version_number in out nocopy number
274 ,p_work_any_country in varchar2 default hr_api.g_varchar2
275 ,p_work_any_location in varchar2 default hr_api.g_varchar2
276 ,p_relocate_domestically in varchar2 default hr_api.g_varchar2
277 ,p_relocate_internationally in varchar2 default hr_api.g_varchar2
278 ,p_travel_required in varchar2 default hr_api.g_varchar2
279 ,p_country1 in varchar2 default hr_api.g_varchar2
280 ,p_country2 in varchar2 default hr_api.g_varchar2
281 ,p_country3 in varchar2 default hr_api.g_varchar2
282 ,p_work_duration in varchar2 default hr_api.g_varchar2
283 ,p_work_schedule in varchar2 default hr_api.g_varchar2
284 ,p_work_hours in varchar2 default hr_api.g_varchar2
285 ,p_fte_capacity in varchar2 default hr_api.g_varchar2
286 ,p_visit_internationally in varchar2 default hr_api.g_varchar2
287 ,p_only_current_location in varchar2 default hr_api.g_varchar2
288 ,p_no_country1 in varchar2 default hr_api.g_varchar2
289 ,p_no_country2 in varchar2 default hr_api.g_varchar2
290 ,p_no_country3 in varchar2 default hr_api.g_varchar2
291 ,p_comments in varchar2 default hr_api.g_varchar2
292 ,p_earliest_available_date in date default hr_api.g_date
293 ,p_available_for_transfer in varchar2 default hr_api.g_varchar2
294 ,p_relocation_preference in varchar2 default hr_api.g_varchar2
295 ,p_attribute_category in varchar2 default hr_api.g_varchar2
296 ,p_attribute1 in varchar2 default hr_api.g_varchar2
297 ,p_attribute2 in varchar2 default hr_api.g_varchar2
298 ,p_attribute3 in varchar2 default hr_api.g_varchar2
299 ,p_attribute4 in varchar2 default hr_api.g_varchar2
300 ,p_attribute5 in varchar2 default hr_api.g_varchar2
301 ,p_attribute6 in varchar2 default hr_api.g_varchar2
302 ,p_attribute7 in varchar2 default hr_api.g_varchar2
303 ,p_attribute8 in varchar2 default hr_api.g_varchar2
304 ,p_attribute9 in varchar2 default hr_api.g_varchar2
305 ,p_attribute10 in varchar2 default hr_api.g_varchar2
306 ,p_attribute11 in varchar2 default hr_api.g_varchar2
307 ,p_attribute12 in varchar2 default hr_api.g_varchar2
308 ,p_attribute13 in varchar2 default hr_api.g_varchar2
309 ,p_attribute14 in varchar2 default hr_api.g_varchar2
310 ,p_attribute15 in varchar2 default hr_api.g_varchar2
311 ,p_attribute16 in varchar2 default hr_api.g_varchar2
312 ,p_attribute17 in varchar2 default hr_api.g_varchar2
313 ,p_attribute18 in varchar2 default hr_api.g_varchar2
314 ,p_attribute19 in varchar2 default hr_api.g_varchar2
315 ,p_attribute20 in varchar2 default hr_api.g_varchar2
316 );
317 --
318 -- ----------------------------------------------------------------------------
319 -- |-----------------------< create_position_dpmt_factor >--------------------|
320 -- ----------------------------------------------------------------------------
321 --
322 -- {Start Of Comments}
323 /*#
324 * This API is used to create a deployment factor for a position.
325 *
326 * Use this API to record the work choices and work preferences for a position.
327 * You can also record details such as relocation preferences and International
328 * Deployment.
329 *
330 * <p><b>Licensing</b><br>
331 * This API is licensed for use with Human Resources.
332 *
333 * <p><b>Prerequisites</b><br>
334 * The position for which deployment factors are being created must already
335 * exist within the business group.
336 *
337 * <p><b>Post Success</b><br>
338 * The deployment factor for the position will have been created.
339 *
340 * <p><b>Post Failure</b><br>
341 * The deployment factor will not be created and an error will be raised.
342 * @param p_validate If true, then validation alone will be performed and the
343 * database will remain unchanged. If false and all validation checks pass,
344 * then the database will be modified.
345 * @param p_effective_date Reference date for validating lookup values are
346 * applicable during the start to end active date range. This date does not
347 * determine when the changes take effect.
348 * @param p_position_id Identifies the position for which you create the
349 * deployment factor record.
350 * @param p_work_any_country Specifies if the position requires availability to
351 * work in any country. Valid values are defined by the 'YES_NO' lookup type.
352 * @param p_work_any_location Specifies if the position requires availability
353 * to work in any location. Valid values are defined by the 'YES_NO' lookup
354 * type.
355 * @param p_relocate_domestically Specifies if the position requires
356 * willingness to relocate domestically. Valid values are defined by the
357 * 'YES_NO' lookup type.
358 * @param p_relocate_internationally Specifies if the position requires
359 * willingness to relocate internationally. Valid values are defined by the
360 * 'YES_NO' lookup type.
361 * @param p_travel_required Specifies if the position requires travel. Valid
362 * values are defined by the 'YES_NO' lookup type.
363 * @param p_country1 Country one where the position requires work.
364 * @param p_country2 Country two where the position requires work.
365 * @param p_country3 Country three where the position requires work.
366 * @param p_work_duration The work duration the position requires. Valid values
367 * are defined by the 'PER_TIME_SCALES' lookup type.
368 * @param p_work_schedule The work schedule the position requires. Valid values
369 * are defined by the 'PER_WORK_SCHEDULE' lookup type.
370 * @param p_work_hours The work hours the position requires. Valid values are
371 * defined by the 'PER_WORK_HOURS' lookup type.
372 * @param p_fte_capacity The Full Time Equivalent (FTE) capacity. Valid values
373 * are defined by the 'PER_FTE_CAPACITY' lookup type.
374 * @param p_relocation_required Specifies if the position requires relocation.
375 * Valid values are defined by the 'YES_NO' lookup type.
376 * @param p_passport_required Specifies if the position requires a passport.
377 * Valid values are defined by the 'YES_NO' lookup type.
378 * @param p_location1 Location one where the position requires work.
379 * @param p_location2 Location two where the position requires work.
380 * @param p_location3 Location three where the position requires work.
381 * @param p_other_requirements Other miscellaneous requirements.
382 * @param p_service_minimum Minimum length of service. Valid values are defined
383 * by the 'PER_LENGTHS_OF_SERVICE' lookup type.
384 * @param p_attribute_category This context value determines which flexfield
385 * structure to use with the descriptive flexfield segments.
386 * @param p_attribute1 Descriptive flexfield segment.
387 * @param p_attribute2 Descriptive flexfield segment.
388 * @param p_attribute3 Descriptive flexfield segment.
389 * @param p_attribute4 Descriptive flexfield segment.
390 * @param p_attribute5 Descriptive flexfield segment.
391 * @param p_attribute6 Descriptive flexfield segment.
392 * @param p_attribute7 Descriptive flexfield segment.
393 * @param p_attribute8 Descriptive flexfield segment.
394 * @param p_attribute9 Descriptive flexfield segment.
395 * @param p_attribute10 Descriptive flexfield segment.
396 * @param p_attribute11 Descriptive flexfield segment.
397 * @param p_attribute12 Descriptive flexfield segment.
398 * @param p_attribute13 Descriptive flexfield segment.
399 * @param p_attribute14 Descriptive flexfield segment.
400 * @param p_attribute15 Descriptive flexfield segment.
401 * @param p_attribute16 Descriptive flexfield segment.
402 * @param p_attribute17 Descriptive flexfield segment.
403 * @param p_attribute18 Descriptive flexfield segment.
404 * @param p_attribute19 Descriptive flexfield segment.
405 * @param p_attribute20 Descriptive flexfield segment.
406 * @param p_deployment_factor_id If p_validate is false, then this uniquely
407 * identifies the position deployment factor created. If p_validate is true,
408 * then this is set to null.
409 * @param p_object_version_number If p_validate is false, then set to the
410 * version number of the created deployment factor. If p_validate is true, then
411 * the value will be null.
412 * @rep:displayname Create Position Deployment Factor
413 * @rep:category BUSINESS_ENTITY PER_POSITION
414 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
415 * @rep:scope public
416 * @rep:lifecycle active
417 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
418 */
419 --
420 -- {End Of Comments}
421 --
422 procedure create_position_dpmt_factor
423 (p_validate in boolean default false
424 ,p_effective_date in date
425 ,p_position_id in number
426 ,p_work_any_country in varchar2
427 ,p_work_any_location in varchar2
428 ,p_relocate_domestically in varchar2
429 ,p_relocate_internationally in varchar2
430 ,p_travel_required in varchar2
431 ,p_country1 in varchar2 default null
432 ,p_country2 in varchar2 default null
433 ,p_country3 in varchar2 default null
434 ,p_work_duration in varchar2 default null
435 ,p_work_schedule in varchar2 default null
436 ,p_work_hours in varchar2 default null
437 ,p_fte_capacity in varchar2 default null
438 ,p_relocation_required in varchar2 default null
439 ,p_passport_required in varchar2 default null
440 ,p_location1 in varchar2 default null
441 ,p_location2 in varchar2 default null
442 ,p_location3 in varchar2 default null
443 ,p_other_requirements in varchar2 default null
444 ,p_service_minimum in varchar2 default null
445 ,p_attribute_category in varchar2 default null
446 ,p_attribute1 in varchar2 default null
447 ,p_attribute2 in varchar2 default null
448 ,p_attribute3 in varchar2 default null
449 ,p_attribute4 in varchar2 default null
450 ,p_attribute5 in varchar2 default null
451 ,p_attribute6 in varchar2 default null
452 ,p_attribute7 in varchar2 default null
453 ,p_attribute8 in varchar2 default null
454 ,p_attribute9 in varchar2 default null
455 ,p_attribute10 in varchar2 default null
456 ,p_attribute11 in varchar2 default null
457 ,p_attribute12 in varchar2 default null
458 ,p_attribute13 in varchar2 default null
459 ,p_attribute14 in varchar2 default null
460 ,p_attribute15 in varchar2 default null
461 ,p_attribute16 in varchar2 default null
462 ,p_attribute17 in varchar2 default null
463 ,p_attribute18 in varchar2 default null
464 ,p_attribute19 in varchar2 default null
465 ,p_attribute20 in varchar2 default null
466 ,p_deployment_factor_id out nocopy number
467 ,p_object_version_number out nocopy number
468 );
469 --
470 -- ----------------------------------------------------------------------------
471 -- |-----------------------< update_position_dpmt_factor >--------------------|
472 -- ----------------------------------------------------------------------------
473 --
474 -- {Start Of Comments}
475 /*#
476 * This API is used to update a deployment factor for a position.
477 *
478 * Use this API to update the work choices and work preferences for a position.
479 * You can also record details such as relocation preferences and International
480 * Deployment.
481 *
482 * <p><b>Licensing</b><br>
483 * This API is licensed for use with Human Resources.
484 *
485 * <p><b>Prerequisites</b><br>
486 * The deployment factor must exist in the database.
487 *
488 * <p><b>Post Success</b><br>
489 * The deployment factor for the position will have been updated.
490 *
491 * <p><b>Post Failure</b><br>
492 * The deployment factor will not be updated and an error will be raised.
493 * @param p_validate If true, then validation alone will be performed and the
494 * database will remain unchanged. If false and all validation checks pass,
495 * then the database will be modified.
496 * @param p_effective_date Reference date for validating lookup values are
497 * applicable during the start to end active date range. This date does not
498 * determine when the changes take effect.
499 * @param p_deployment_factor_id Uniquely identifies the position deployment
500 * factor that will be updated.
501 * @param p_object_version_number Pass in the current version number of the
502 * deployment factor to be updated. When the API completes if p_validate is
503 * false, will be set to the new version number of the updated deployment
504 * factor. If p_validate is true will be set to the same value which was passed
505 * in.
506 * @param p_work_any_country Specifies if the position requires availability to
507 * work in any country. Valid values are defined by the 'YES_NO' lookup type.
508 * @param p_work_any_location Specifies if the position requires availability
509 * to work in any location. Valid values are defined by the 'YES_NO' lookup
510 * type.
511 * @param p_relocate_domestically Specifies if the position requires
512 * willingness to relocate domestically. Valid values are defined by the
513 * 'YES_NO' lookup type.
514 * @param p_relocate_internationally Specifies if the position requires
515 * willingness to relocate internationally. Valid values are defined by the
516 * 'YES_NO' lookup type.
517 * @param p_travel_required Specifies if the position requires travel. Valid
518 * values are defined by the 'YES_NO' lookup type.
519 * @param p_country1 Country one where the position requires work.
520 * @param p_country2 Country two where the position requires work.
521 * @param p_country3 Country three where the position requires work.
522 * @param p_work_duration The work duration the position requires. Valid values
523 * are defined by the 'PER_TIME_SCALES' lookup type.
524 * @param p_work_schedule The work schedule the position requires. Valid values
525 * are defined by the 'PER_WORK_SCHEDULE' lookup type.
526 * @param p_work_hours The work hours the position requires. Valid values are
527 * defined by the 'PER_WORK_HOURS' lookup type.
528 * @param p_fte_capacity The Full Time Equivalent (FTE) capacity. Valid values
529 * are defined by the 'PER_FTE_CAPACITY' lookup type.
530 * @param p_relocation_required Specifies if the position requires relocation.
531 * Valid values are defined by the 'YES_NO' lookup type.
532 * @param p_passport_required Specifies if the position requires a passport.
533 * Valid values are defined by the 'YES_NO' lookup type.
534 * @param p_location1 Location one where the position requires work.
535 * @param p_location2 Location two where the position requires work.
536 * @param p_location3 Location three where the position requires work.
537 * @param p_other_requirements Other miscellaneous requirements.
538 * @param p_service_minimum Minimum length of service. Valid values are defined
539 * by the 'PER_LENGTHS_OF_SERVICE' lookup type.
540 * @param p_attribute_category This context value determines which flexfield
541 * structure to use with the descriptive flexfield segments.
542 * @param p_attribute1 Descriptive flexfield segment.
543 * @param p_attribute2 Descriptive flexfield segment.
544 * @param p_attribute3 Descriptive flexfield segment.
545 * @param p_attribute4 Descriptive flexfield segment.
546 * @param p_attribute5 Descriptive flexfield segment.
547 * @param p_attribute6 Descriptive flexfield segment.
548 * @param p_attribute7 Descriptive flexfield segment.
549 * @param p_attribute8 Descriptive flexfield segment.
550 * @param p_attribute9 Descriptive flexfield segment.
551 * @param p_attribute10 Descriptive flexfield segment.
552 * @param p_attribute11 Descriptive flexfield segment.
553 * @param p_attribute12 Descriptive flexfield segment.
554 * @param p_attribute13 Descriptive flexfield segment.
555 * @param p_attribute14 Descriptive flexfield segment.
556 * @param p_attribute15 Descriptive flexfield segment.
557 * @param p_attribute16 Descriptive flexfield segment.
558 * @param p_attribute17 Descriptive flexfield segment.
559 * @param p_attribute18 Descriptive flexfield segment.
560 * @param p_attribute19 Descriptive flexfield segment.
561 * @param p_attribute20 Descriptive flexfield segment.
562 * @rep:displayname Update Position Deployment Factor
563 * @rep:category BUSINESS_ENTITY PER_POSITION
564 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
565 * @rep:scope public
566 * @rep:lifecycle active
567 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
568 */
569 --
570 -- {End Of Comments}
571 --
572 procedure update_position_dpmt_factor
573 (p_validate in boolean default false
574 ,p_effective_date in date
575 ,p_deployment_factor_id in number
576 ,p_object_version_number in out nocopy number
577 ,p_work_any_country in varchar2 default hr_api.g_varchar2
578 ,p_work_any_location in varchar2 default hr_api.g_varchar2
579 ,p_relocate_domestically in varchar2 default hr_api.g_varchar2
580 ,p_relocate_internationally in varchar2 default hr_api.g_varchar2
581 ,p_travel_required in varchar2 default hr_api.g_varchar2
582 ,p_country1 in varchar2 default hr_api.g_varchar2
583 ,p_country2 in varchar2 default hr_api.g_varchar2
584 ,p_country3 in varchar2 default hr_api.g_varchar2
585 ,p_work_duration in varchar2 default hr_api.g_varchar2
586 ,p_work_schedule in varchar2 default hr_api.g_varchar2
587 ,p_work_hours in varchar2 default hr_api.g_varchar2
588 ,p_fte_capacity in varchar2 default hr_api.g_varchar2
589 ,p_relocation_required in varchar2 default hr_api.g_varchar2
590 ,p_passport_required in varchar2 default hr_api.g_varchar2
591 ,p_location1 in varchar2 default hr_api.g_varchar2
592 ,p_location2 in varchar2 default hr_api.g_varchar2
593 ,p_location3 in varchar2 default hr_api.g_varchar2
594 ,p_other_requirements in varchar2 default hr_api.g_varchar2
595 ,p_service_minimum in varchar2 default hr_api.g_varchar2
596 ,p_attribute_category in varchar2 default hr_api.g_varchar2
597 ,p_attribute1 in varchar2 default hr_api.g_varchar2
598 ,p_attribute2 in varchar2 default hr_api.g_varchar2
599 ,p_attribute3 in varchar2 default hr_api.g_varchar2
600 ,p_attribute4 in varchar2 default hr_api.g_varchar2
601 ,p_attribute5 in varchar2 default hr_api.g_varchar2
602 ,p_attribute6 in varchar2 default hr_api.g_varchar2
603 ,p_attribute7 in varchar2 default hr_api.g_varchar2
604 ,p_attribute8 in varchar2 default hr_api.g_varchar2
605 ,p_attribute9 in varchar2 default hr_api.g_varchar2
606 ,p_attribute10 in varchar2 default hr_api.g_varchar2
607 ,p_attribute11 in varchar2 default hr_api.g_varchar2
608 ,p_attribute12 in varchar2 default hr_api.g_varchar2
609 ,p_attribute13 in varchar2 default hr_api.g_varchar2
610 ,p_attribute14 in varchar2 default hr_api.g_varchar2
611 ,p_attribute15 in varchar2 default hr_api.g_varchar2
612 ,p_attribute16 in varchar2 default hr_api.g_varchar2
613 ,p_attribute17 in varchar2 default hr_api.g_varchar2
614 ,p_attribute18 in varchar2 default hr_api.g_varchar2
615 ,p_attribute19 in varchar2 default hr_api.g_varchar2
616 ,p_attribute20 in varchar2 default hr_api.g_varchar2
617 );
618 --
619 -- ----------------------------------------------------------------------------
620 -- |--------------------------< create_job_dpmt_factor >----------------------|
621 -- ----------------------------------------------------------------------------
622 --
623 -- {Start Of Comments}
624 /*#
625 * This API is used to create a deployment factor for a job.
626 *
627 * Use this API to record the work choices and work preferences for a job. You
628 * can also record details such as relocation preferences and International
629 * Deployment.
630 *
631 * <p><b>Licensing</b><br>
632 * This API is licensed for use with Human Resources.
633 *
634 * <p><b>Prerequisites</b><br>
635 * The job for which deployment factors are being created must already exist
636 * within the business group.
637 *
638 * <p><b>Post Success</b><br>
639 * The deployment factor for the job will have been created.
640 *
641 * <p><b>Post Failure</b><br>
642 * The deployment factor will not be created and an error will be raised.
643 * @param p_validate If true, then validation alone will be performed and the
644 * database will remain unchanged. If false and all validation checks pass,
645 * then the database will be modified.
646 * @param p_effective_date Reference date for validating lookup values are
647 * applicable during the start to end active date range. This date does not
648 * determine when the changes take effect.
649 * @param p_job_id Uniquely identifies the job for which you create the
650 * deployment factor record.
651 * @param p_work_any_country Specifies if the job requires availability to work
652 * in any country. Valid values are defined by the 'YES_NO' lookup type.
653 * @param p_work_any_location Specifies if the job requires availability to
654 * work in any location. Valid values are defined by the 'YES_NO' lookup type.
655 * @param p_relocate_domestically Specifies if the job requires willingness to
656 * relocate domestically. Valid values are defined by the 'YES_NO' lookup type.
657 * @param p_relocate_internationally Specifies if the job requires willingness
658 * to relocate internationally. Valid values are defined by the 'YES_NO' lookup
659 * type.
660 * @param p_travel_required Specifies if the job requires travel. Valid values
661 * are defined by the 'YES_NO' lookup type.
662 * @param p_country1 Country one where the job requires work.
663 * @param p_country2 Country two where the job requires work.
664 * @param p_country3 Country three where the job requires work.
665 * @param p_work_duration The work duration the job requires. Valid values are
666 * defined by the 'PER_TIME_SCALES' lookup type.
667 * @param p_work_schedule The work schedule the job requires. Valid values are
668 * defined by the 'PER_WORK_SCHEDULE' lookup type.
669 * @param p_work_hours The work hours the job requires. Valid values are
670 * defined by the 'PER_WORK_HOURS' lookup type.
671 * @param p_fte_capacity The Full Time Equivalent (FTE) capacity. Valid values
672 * are defined by the 'PER_FTE_CAPACITY' lookup type.
673 * @param p_relocation_required Specifies if the job requires relocation. Valid
674 * values are defined by the 'YES_NO' lookup type.
675 * @param p_passport_required Specifies if the job requires a passport. Valid
676 * values are defined by the 'YES_NO' lookup type.
677 * @param p_location1 Location one where the job requires work.
678 * @param p_location2 Location two where the job requires work.
679 * @param p_location3 Location three where the job requires work.
680 * @param p_other_requirements Other miscellaneous requirements.
681 * @param p_service_minimum Minimum length of service. Valid values are defined
682 * by the 'PER_LENGTHS_OF_SERVICE' lookup type.
683 * @param p_attribute_category This context value determines which flexfield
684 * structure to use with the descriptive flexfield segments.
685 * @param p_attribute1 Descriptive flexfield segment.
686 * @param p_attribute2 Descriptive flexfield segment.
687 * @param p_attribute3 Descriptive flexfield segment.
688 * @param p_attribute4 Descriptive flexfield segment.
689 * @param p_attribute5 Descriptive flexfield segment.
690 * @param p_attribute6 Descriptive flexfield segment.
691 * @param p_attribute7 Descriptive flexfield segment.
692 * @param p_attribute8 Descriptive flexfield segment.
693 * @param p_attribute9 Descriptive flexfield segment.
694 * @param p_attribute10 Descriptive flexfield segment.
695 * @param p_attribute11 Descriptive flexfield segment.
696 * @param p_attribute12 Descriptive flexfield segment.
697 * @param p_attribute13 Descriptive flexfield segment.
698 * @param p_attribute14 Descriptive flexfield segment.
699 * @param p_attribute15 Descriptive flexfield segment.
700 * @param p_attribute16 Descriptive flexfield segment.
701 * @param p_attribute17 Descriptive flexfield segment.
702 * @param p_attribute18 Descriptive flexfield segment.
703 * @param p_attribute19 Descriptive flexfield segment.
704 * @param p_attribute20 Descriptive flexfield segment.
705 * @param p_deployment_factor_id If p_validate is false, then this uniquely
706 * identifies the job deployment factor created. If p_validate is true, then
707 * this is set to null.
708 * @param p_object_version_number If p_validate is false, then set to the
709 * version number of the created deployment factor. If p_validate is true, then
710 * the value will be null.
711 * @rep:displayname Create Job Deployment Factor
712 * @rep:category BUSINESS_ENTITY PER_JOB
713 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
714 * @rep:scope public
715 * @rep:lifecycle active
716 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
717 */
718 --
719 -- {End Of Comments}
720 --
721 procedure create_job_dpmt_factor
722 (p_validate in boolean default false
723 ,p_effective_date in date
724 ,p_job_id in number
725 ,p_work_any_country in varchar2
726 ,p_work_any_location in varchar2
727 ,p_relocate_domestically in varchar2
728 ,p_relocate_internationally in varchar2
729 ,p_travel_required in varchar2
730 ,p_country1 in varchar2 default null
731 ,p_country2 in varchar2 default null
732 ,p_country3 in varchar2 default null
733 ,p_work_duration in varchar2 default null
734 ,p_work_schedule in varchar2 default null
735 ,p_work_hours in varchar2 default null
736 ,p_fte_capacity in varchar2 default null
737 ,p_relocation_required in varchar2 default null
738 ,p_passport_required in varchar2 default null
739 ,p_location1 in varchar2 default null
740 ,p_location2 in varchar2 default null
741 ,p_location3 in varchar2 default null
742 ,p_other_requirements in varchar2 default null
743 ,p_service_minimum in varchar2 default null
744 ,p_attribute_category in varchar2 default null
745 ,p_attribute1 in varchar2 default null
746 ,p_attribute2 in varchar2 default null
747 ,p_attribute3 in varchar2 default null
748 ,p_attribute4 in varchar2 default null
749 ,p_attribute5 in varchar2 default null
750 ,p_attribute6 in varchar2 default null
751 ,p_attribute7 in varchar2 default null
752 ,p_attribute8 in varchar2 default null
753 ,p_attribute9 in varchar2 default null
754 ,p_attribute10 in varchar2 default null
755 ,p_attribute11 in varchar2 default null
756 ,p_attribute12 in varchar2 default null
757 ,p_attribute13 in varchar2 default null
758 ,p_attribute14 in varchar2 default null
759 ,p_attribute15 in varchar2 default null
760 ,p_attribute16 in varchar2 default null
761 ,p_attribute17 in varchar2 default null
762 ,p_attribute18 in varchar2 default null
763 ,p_attribute19 in varchar2 default null
764 ,p_attribute20 in varchar2 default null
765 ,p_deployment_factor_id out nocopy number
766 ,p_object_version_number out nocopy number
767 );
768 --
769 -- ----------------------------------------------------------------------------
770 -- |--------------------------< update_job_dpmt_factor >----------------------|
771 -- ----------------------------------------------------------------------------
772 --
773 -- {Start Of Comments}
774 /*#
775 * This API is used to update a deployment factor for a job.
776 *
777 * Use this API to update the work choices and work preferences for a job. You
778 * can also record details such as relocation preferences and International
779 * Deployment.
780 *
781 * <p><b>Licensing</b><br>
782 * This API is licensed for use with Human Resources.
783 *
784 * <p><b>Prerequisites</b><br>
785 * The deployment factor must exist in the database.
786 *
787 * <p><b>Post Success</b><br>
788 * The deployment factor for the job will have been updated.
789 *
790 * <p><b>Post Failure</b><br>
791 * The deployment factor will not be updated and an error will be raised.
792 * @param p_validate If true, then validation alone will be performed and the
793 * database will remain unchanged. If false and all validation checks pass,
794 * then the database will be modified.
795 * @param p_effective_date Reference date for validating lookup values are
796 * applicable during the start to end active date range. This date does not
797 * determine when the changes take effect.
798 * @param p_deployment_factor_id Uniquely identifies the job deployment factor
799 * that will be updated.
800 * @param p_object_version_number Pass in the current version number of the
801 * deployment factor to be updated. When the API completes if p_validate is
802 * false, will be set to the new version number of the updated deployment
803 * factor. If p_validate is true will be set to the same value which was passed
804 * in.
805 * @param p_work_any_country Specifies if the job requires availability to work
806 * in any country. Valid values are defined by the 'YES_NO' lookup type.
807 * @param p_work_any_location Specifies if the job requires availability to
808 * work in any location. Valid values are defined by the 'YES_NO' lookup type.
809 * @param p_relocate_domestically Specifies if the job requires willingness to
810 * relocate domestically. Valid values are defined by the 'YES_NO' lookup type.
811 * @param p_relocate_internationally Specifies if the job requires willingness
812 * to relocate internationally. Valid values are defined by the 'YES_NO' lookup
813 * type.
814 * @param p_travel_required Specifies if the job requires travel. Valid values
815 * are defined by the 'YES_NO' lookup type.
816 * @param p_country1 Country one where the job requires work.
817 * @param p_country2 Country two where the job requires work.
818 * @param p_country3 Country three where the job requires work.
819 * @param p_work_duration The work duration the job requires. Valid values are
820 * defined by the 'PER_TIME_SCALES' lookup type.
821 * @param p_work_schedule The work schedule the job requires. Valid values are
822 * defined by the 'PER_WORK_SCHEDULE' lookup type.
823 * @param p_work_hours The work hours the job requires. Valid values are
824 * defined by the 'PER_WORK_HOURS' lookup type.
825 * @param p_fte_capacity The Full Time Equivalent (FTE) capacity. Valid values
826 * are defined by the 'PER_FTE_CAPACITY' lookup type.
827 * @param p_relocation_required Specifies if the job requires relocation. Valid
828 * values are defined by the 'YES_NO' lookup type.
829 * @param p_passport_required Specifies if the job requires a passport. Valid
830 * values are defined by the 'YES_NO' lookup type.
831 * @param p_location1 Location one where the job requires work.
832 * @param p_location2 Location two where the job requires work.
833 * @param p_location3 Location three where the job requires work.
834 * @param p_other_requirements Other miscellaneous requirements.
835 * @param p_service_minimum Minimum length of service. Valid values are defined
836 * by the 'PER_LENGTHS_OF_SERVICE' lookup type.
837 * @param p_attribute_category This context value determines which flexfield
838 * structure to use with the descriptive flexfield segments.
839 * @param p_attribute1 Descriptive flexfield segment.
840 * @param p_attribute2 Descriptive flexfield segment.
841 * @param p_attribute3 Descriptive flexfield segment.
842 * @param p_attribute4 Descriptive flexfield segment.
843 * @param p_attribute5 Descriptive flexfield segment.
844 * @param p_attribute6 Descriptive flexfield segment.
845 * @param p_attribute7 Descriptive flexfield segment.
846 * @param p_attribute8 Descriptive flexfield segment.
847 * @param p_attribute9 Descriptive flexfield segment.
848 * @param p_attribute10 Descriptive flexfield segment.
849 * @param p_attribute11 Descriptive flexfield segment.
850 * @param p_attribute12 Descriptive flexfield segment.
851 * @param p_attribute13 Descriptive flexfield segment.
852 * @param p_attribute14 Descriptive flexfield segment.
853 * @param p_attribute15 Descriptive flexfield segment.
854 * @param p_attribute16 Descriptive flexfield segment.
855 * @param p_attribute17 Descriptive flexfield segment.
856 * @param p_attribute18 Descriptive flexfield segment.
857 * @param p_attribute19 Descriptive flexfield segment.
858 * @param p_attribute20 Descriptive flexfield segment.
859 * @rep:displayname Update Job Deployment Factor
860 * @rep:category BUSINESS_ENTITY PER_JOB
861 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
862 * @rep:scope public
863 * @rep:lifecycle active
864 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
865 */
866 --
867 -- {End Of Comments}
868 --
869 procedure update_job_dpmt_factor
870 (p_validate in boolean default false
871 ,p_effective_date in date
872 ,p_deployment_factor_id in number
873 ,p_object_version_number in out nocopy number
874 ,p_work_any_country in varchar2 default hr_api.g_varchar2
875 ,p_work_any_location in varchar2 default hr_api.g_varchar2
876 ,p_relocate_domestically in varchar2 default hr_api.g_varchar2
877 ,p_relocate_internationally in varchar2 default hr_api.g_varchar2
878 ,p_travel_required in varchar2 default hr_api.g_varchar2
879 ,p_country1 in varchar2 default hr_api.g_varchar2
880 ,p_country2 in varchar2 default hr_api.g_varchar2
881 ,p_country3 in varchar2 default hr_api.g_varchar2
882 ,p_work_duration in varchar2 default hr_api.g_varchar2
883 ,p_work_schedule in varchar2 default hr_api.g_varchar2
884 ,p_work_hours in varchar2 default hr_api.g_varchar2
885 ,p_fte_capacity in varchar2 default hr_api.g_varchar2
886 ,p_relocation_required in varchar2 default hr_api.g_varchar2
887 ,p_passport_required in varchar2 default hr_api.g_varchar2
888 ,p_location1 in varchar2 default hr_api.g_varchar2
889 ,p_location2 in varchar2 default hr_api.g_varchar2
890 ,p_location3 in varchar2 default hr_api.g_varchar2
891 ,p_other_requirements in varchar2 default hr_api.g_varchar2
892 ,p_service_minimum in varchar2 default hr_api.g_varchar2
893 ,p_attribute_category in varchar2 default hr_api.g_varchar2
894 ,p_attribute1 in varchar2 default hr_api.g_varchar2
895 ,p_attribute2 in varchar2 default hr_api.g_varchar2
896 ,p_attribute3 in varchar2 default hr_api.g_varchar2
897 ,p_attribute4 in varchar2 default hr_api.g_varchar2
898 ,p_attribute5 in varchar2 default hr_api.g_varchar2
899 ,p_attribute6 in varchar2 default hr_api.g_varchar2
900 ,p_attribute7 in varchar2 default hr_api.g_varchar2
901 ,p_attribute8 in varchar2 default hr_api.g_varchar2
902 ,p_attribute9 in varchar2 default hr_api.g_varchar2
903 ,p_attribute10 in varchar2 default hr_api.g_varchar2
904 ,p_attribute11 in varchar2 default hr_api.g_varchar2
905 ,p_attribute12 in varchar2 default hr_api.g_varchar2
906 ,p_attribute13 in varchar2 default hr_api.g_varchar2
907 ,p_attribute14 in varchar2 default hr_api.g_varchar2
908 ,p_attribute15 in varchar2 default hr_api.g_varchar2
909 ,p_attribute16 in varchar2 default hr_api.g_varchar2
910 ,p_attribute17 in varchar2 default hr_api.g_varchar2
911 ,p_attribute18 in varchar2 default hr_api.g_varchar2
912 ,p_attribute19 in varchar2 default hr_api.g_varchar2
913 ,p_attribute20 in varchar2 default hr_api.g_varchar2
914 );
915 --
916 end hr_deployment_factor_api;