1 Package hr_cancel_hire_api as
2 /* $Header: pecahapi.pkh 120.1.12010000.1 2008/07/28 04:17:28 appldev ship $ */
3 /*#
4 * This package contains APIs relating to canceling employee hires.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Cancel Hire
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-------------------------------< cancel_hire >----------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API cancels the hire of an employee.
17 *
18 * The API deletes all record of a hire that exists on the effective date and
19 * restores the personal data from the period of time immediately before the
20 * hire.
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 must exist, must not have future person type changes, and must
27 * have a previous person record before the hire to which the system can revert
28 * the data.
29 *
30 * <p><b>Post Success</b><br>
31 * The current period of service is deleted along with the employee
32 * assignments. The person data from the period of time prior to becoming an
33 * employee are reinstated.
34 *
35 * <p><b>Post Failure</b><br>
36 * An error is raised and the period of service and related employee assignment
37 * records are not deleted.
38 * @param p_validate If true, then validation alone will be performed and the
39 * database will remain unchanged. If false and all validation checks pass,
40 * then the database will be modified.
41 * @param p_person_id Identifies the person record for which the cancellation
42 * is to be processed.
43 * @param p_effective_date Identifies the date on which the period of service
44 * that is to be cancelled should exist.
45 * @param p_supervisor_warning Set to true if employee was a supervisor,
46 * otherwise set to false.
47 * @param p_recruiter_warning Set to true if employee was a recruiter for any
48 * assignments, otherwise set to false.
49 * @param p_event_warning Set to true if the employee was registered for any
50 * outstanding events, otherwise set to false.
51 * @param p_interview_warning Set to true if the employee had any interviews
52 * scheduled, otherwise set to false.
53 * @param p_review_warning Set to true if the employee has a review scheduled,
54 * otherwise set to false.
55 * @param p_vacancy_warning Set to true if employee was a recruiter for a
56 * vacancy, otherwise set to false.
57 * @param p_requisition_warning Set to true if the employee raised a
58 * requisition, otherwise set to false.
59 * @param p_budget_warning Set to true if the employee had assignment budget
60 * values defined for any assignment. Otherwise set to false.
61 * @param p_payment_warning Set to true if the employee has a personal payment
62 * method registered. Otherwise set to false.
63 * @rep:displayname Cancel Hire
64 * @rep:category BUSINESS_ENTITY PER_EMPLOYEE
65 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
66 * @rep:scope public
67 * @rep:lifecycle active
68 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
69 */
70 --
71 -- {End Of Comments}
72 --
73 procedure cancel_hire
74 (p_validate IN BOOLEAN DEFAULT FALSE
75 ,p_person_id IN NUMBER
76 ,p_effective_date IN DATE
77 ,p_supervisor_warning OUT NOCOPY BOOLEAN
78 ,p_recruiter_warning OUT NOCOPY BOOLEAN
79 ,p_event_warning OUT NOCOPY BOOLEAN
80 ,p_interview_warning OUT NOCOPY BOOLEAN
81 ,p_review_warning OUT NOCOPY BOOLEAN
82 ,p_vacancy_warning OUT NOCOPY BOOLEAN
83 ,p_requisition_warning OUT NOCOPY BOOLEAN
84 ,p_budget_warning OUT NOCOPY BOOLEAN
85 ,p_payment_warning OUT NOCOPY BOOLEAN);
86 --
87 end hr_cancel_hire_api;
[Home] [Help]