1 PACKAGE hr_cancel_placement_api AS
2 /* $Header: pecplapi.pkh 120.1.12010000.1 2008/07/28 04:25:57 appldev ship $ */
3 /*#
4 * This package contains APIs relating to canceling contingent worker
5 * placements.
6 * @rep:scope public
7 * @rep:product per
8 * @rep:displayname Cancel Placement
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |-----------------------------< cancel_placement >-------------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API cancels the placement of a contingent worker.
18 *
19 * The API deletes all record of a placement that exists on the effective date
20 * specified, and restores the personal data from the period of time
21 * immediately before the placement.
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 * The person must exist, must not have future person type changes, and must
28 * have a previous person record before the period of placement to which the
29 * system can revert the data.
30 *
31 * <p><b>Post Success</b><br>
32 * The current period of placement is deleted along with the contingent worker
33 * assignments. The person data from the period of time prior to becoming an
34 * contingent worker are reinstated.
35 *
36 * <p><b>Post Failure</b><br>
37 * An error is raised and the period of placement and related contingent worker
38 * assignment records are not deleted.
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_person_id Identifies the person record for which the cancellation
43 * is to be processed.
44 * @param p_effective_date Identifies the date on which the period of placement
45 * that is to be cancelled should exist.
46 * @param p_supervisor_warning Set to true if contingent worker was a
47 * supervisor, otherwise set to false.
48 * @param p_recruiter_warning Set to true if contingent worker was a recruiter
49 * for any assignments, otherwise set to false.
50 * @param p_event_warning Set to true if the contingent worker was registered
51 * for any outstanding events, otherwise set to false.
52 * @param p_interview_warning Set to true if the contingent worker had any
53 * interviews scheduled, otherwise set to false.
54 * @param p_review_warning Set to true if the contingent worker has a review
55 * scheduled, otherwise set to false.
56 * @param p_vacancy_warning Set to true if contingent worker was a recruiter
57 * for a vacancy, otherwise set to false.
58 * @param p_requisition_warning Set to true if the contingent worker raised a
59 * requisition, otherwise set to false.
60 * @param p_budget_warning Set to true if the contingent worker had assignment
61 * budget values defined for any assignment. Otherwise set to false.
62 * @param p_payment_warning Set to true if the contingent worker has a personal
63 * payment method registered. Otherwise set to false.
64 * @rep:displayname Cancel Placement
65 * @rep:category BUSINESS_ENTITY PER_CWK
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_placement
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_placement_api;