DBA Data[Home] [Help]

PACKAGE: APPS.GHR_ASSIGNMENT_API

Source


1 Package ghr_assignment_api as
2 /* $Header: ghasgapi.pkh 120.2 2006/01/27 12:36:25 vravikan noship $ */
3 /*#
4  * This package contains the Assignment API.
5  * @rep:scope public
6  * @rep:product per
7  * @rep:displayname Assignment
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |------------------------------< accept_apl_asg >--------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16  * This API changes an existing Applicant Assignment status to Accepted.
17  *
18  * This API changes an existing Applicant Assignment status to Accepted in
19  * PER_ASSIGNMENTS_F table.
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 assignment (p_assignment_id) must exist on the effective date that the
26  * status changes, and the status (p_assignment_status_type_id) must exist with
27  * an ACCEPTED system status.
28  *
29  * <p><b>Post Success</b><br>
30  * The API changes the Applicant Assignment to ACCEPTED
31  *
32  * <p><b>Post Failure</b><br>
33  * The API does not update the Applicant Assignment status and raises an error.
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 Determines when the DateTrack operation comes into
38  * force.
39  * @param p_datetrack_update_mode Indicates which DateTrack mode to use when
40  * updating the record. You must set to either UPDATE, CORRECTION,
41  * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
42  * particular record depend on the dates of previous record changes and the
43  * effective date of this change.
44  * @param p_assignment_id {@rep:casecolumn PER_ALL_ASSIGNMENTS_F.ASSIGNMENT_ID}
45  * @param p_object_version_number Pass in the current version number of the
46  * Applicant assignment to be updated. When the API completes if p_validate is
47  * false, will be set to the new version number of the updated Applicant
48  * assignment. If p_validate is true will be set to the same value which was
49  * passed in.
50  * @param p_assignment_status_type_id {@rep:casecolumn
51  * PER_ALL_ASSIGNMENTS_F.ASSIGNMENT_STATUS_TYPE_ID}
52  * @param p_change_reason Reason the Assignment last changed.
53  * @param p_effective_start_date If p_validate is false, then set to the
54  * effective start date on the updated Applicant Assignment row which now
55  * exists as of the effective date. If p_validate is true, then set to null.
56  * @param p_effective_end_date If p_validate is false, then set to the
57  * effective end date in the updated Applicant Assignment row as of the
58  * effective date. If p_validate is true, then set to null.
59  * @rep:displayname Accept Applicant Assignment
60  * @rep:category BUSINESS_ENTITY PER_APPLICANT_ASG
61  * @rep:scope public
62  * @rep:lifecycle active
63  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
64 */
65 --
66 -- {End Of Comments}
67 --
68  procedure accept_apl_asg
69   (p_validate                     in     boolean  default false
70   ,p_effective_date               in     date
71   ,p_datetrack_update_mode        in     varchar2
72   ,p_assignment_id                in     number
73   ,p_object_version_number        in out nocopy number
74   ,p_assignment_status_type_id    in     number   default hr_api.g_number
75   ,p_change_reason                in     varchar2 default hr_api.g_varchar2
76   ,p_effective_start_date            out nocopy date
77   ,p_effective_end_date              out nocopy date
78   );
79 --
80 end ghr_assignment_api;