1 Package per_cancel_application_api as
2 /* $Header: pecapapi.pkh 120.1 2005/10/02 02:12:39 aroussel $ */
3 /*#
4 * This package contains APIs relating to canceling application.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Cancel Application
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------------< cancel_application >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API cancels an application.
17 *
18 * The API will delete the record of the application and applicant assignments
19 * and restore the personal data from before the application.
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 person must be a current applicant with no future person type changes,
26 * and there must be a previous non-applicant person type to which the system
27 * can revert.
28 *
29 * <p><b>Post Success</b><br>
30 * The application record is deleted and all records related to the applicant
31 * assignment. The person data from the period of time prior to becoming an
32 * applicant are reinstated.
33 *
34 * <p><b>Post Failure</b><br>
35 * An error is raised and the application and related applicant assignment
36 * records are not deleted.
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 Business group of the applicant
41 * @param p_person_id Identifies the person record for which the cancellation
42 * is to be processed.
43 * @param p_application_id Identifies the application that is to be cancelled.
44 * @rep:displayname Cancel Application
45 * @rep:category BUSINESS_ENTITY PER_APPLICANT
46 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
47 * @rep:scope public
48 * @rep:lifecycle active
49 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
50 */
51 --
52 -- {End Of Comments}
53 --
54 procedure cancel_application
55 (p_validate in boolean default false
56 ,p_business_group_id in number
57 ,p_person_id in number
58 ,p_application_id in number
59 );
60 --
61 end per_cancel_application_api;