DBA Data[Home] [Help]

PACKAGE: APPS.IRC_APL_PRFL_SNAPSHOTS_API

Source


1 Package irc_apl_prfl_snapshots_api AUTHID CURRENT_USER as
2 /* $Header: irapsapi.pkh 120.1 2008/02/21 13:57:08 viviswan noship $ */
3 /*#
4  * This package contains APIs for maintaining Applicant Profile Snapshots
5  * @rep:scope public
6  * @rep:product irc
7  * @rep:displayname Applicant Profile Snapshots
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |------------------------< create_applicant_snapshot >---------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16  * This API creates a new Applicant Profile Snapshot.
17  *
18  *
19  * <p><b>Licensing</b><br>
20  * This API is licensed for use with iRecruitment.
21  *
22  * <p><b>Prerequisites</b><br>
23  * Snapshot of Applicant Profile  is created only for BGs that have Applicant
24  * Tracking enabled.
25  *
26  * <p><b>Post Success</b><br>
27  * Snapshot of Applicant Profile is successfully inserted into the database.
28  *
29  * <p><b>Post Failure</b><br>
30  * The API does not create the Applicant Snapshot and raises an error.
31  *
32  * @param p_validate If true, then validation alone will be performed and the
33  * database will remain unchanged. If false and all validation checks pass,
34  * then the database will be modified.
35  * @param p_effective_date Effective date for the creation of Applicant
36  * Snapshot.
37  * @param p_person_id Person id of the Applicant.
38  * @param p_profile_snapshot_id If p_validate is false, then this uniquely
39  * identifies the Snapshot created. If p_validate is true, then set to null.
40  * @param p_object_version_number If p_validate is false, then set to the
41  * version number of the created applicant snapshot. If p_validate is true,
42  * then the value will be null.
43  * @rep:displayname Create Applicant Snapshot
44  * @rep:category BUSINESS_ENTITY IRC_RECRUITMENT_CANDIDATE
45  * @rep:lifecycle active
46  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
47  * @rep:scope public
48  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
49 */
50 --
51 -- {End Of Comments}
52 --
53 procedure create_applicant_snapshot
54   (p_validate                      in     boolean  default false
55   ,p_effective_date                in     date
56   ,p_person_id                     in     number
57   ,p_profile_snapshot_id           out    nocopy   number
58   ,p_object_version_number         out    nocopy   number
59   );
60 --
61 -- ----------------------------------------------------------------------------
62 -- |------------------------< update_applicant_snapshot >---------------------|
63 -- ----------------------------------------------------------------------------
64 --
65 -- {Start Of Comments}
66 /*#
67  * This API updates an existing Applicant Snapshot.
68  *
69  *
70  * <p><b>Licensing</b><br>
71  * This API is licensed for use with iRecruitment.
72  *
73  * <p><b>Prerequisites</b><br>
74  * Snapshot of Applicant Profile should exist.
75  *
76  * <p><b>Post Success</b><br>
77  * Successfully updates the Applicant Profile Snapshot.
78  *
79  * <p><b>Post Failure</b><br>
80  * The API does not update the Applicant Profile Snapshot and raises an error.
81  *
82  * @param p_validate If true, then validation alone will be performed and the
83  * database will remain unchanged. If false and all validation checks pass,
84  * then the database will be modified.
85  * @param p_effective_date Effective date for the creation of Applicant
86  * Snapshot.
87  * @param p_person_id Person id of the Applicant.
88  * @param p_profile_snapshot_id If p_validate is false, then this uniquely
89  * identifies the Snapshot created. If p_validate is true, then set to null.
90  * @param p_object_version_number If p_validate is false, then set to the
91  * version number of the created applicant snapshot. If p_validate is true,
92  * then the value will be null.
93  * @rep:displayname Update Applicant Snapshot
94  * @rep:category BUSINESS_ENTITY IRC_RECRUITMENT_CANDIDATE
95  * @rep:lifecycle active
96  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
97  * @rep:scope public
98  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
99 */
100 --
101 -- {End Of Comments}
102 --
103 procedure update_applicant_snapshot
104   (p_validate                      in     boolean  default false
105   ,p_effective_date                in     date
106   ,p_person_id                     in     number
107   ,p_profile_snapshot_id           in out nocopy   number
108   ,p_object_version_number         in out nocopy   number
109   );
110 --
111 --
112 -- ----------------------------------------------------------------------------
113 -- |------------------------< delete_applicant_snapshot >---------------------|
114 -- ----------------------------------------------------------------------------
115 --
116 -- {Start Of Comments}
117 /*#
118  * This API deletes a new Applicant Profile Snapshot.
119  *
120  *
121  * <p><b>Licensing</b><br>
122  * This API is licensed for use with iRecruitment.
123  *
124  * <p><b>Prerequisites</b><br>
125  * Snapshot of Applicant Profile  is created only for BGs that have Applicant
126  * Tracking enabled.
127  *
128  * <p><b>Post Success</b><br>
129  * Snapshot of Applicant Profile is successfully inserted into the database.
130  *
131  * <p><b>Post Failure</b><br>
132  * The API does not create the Applicant Snapshot and raises an error.
133  *
134  * @param p_validate If true, then validation alone will be performed and the
135  * database will remain unchanged. If false and all validation checks pass,
136  * then the database will be modified.
137  * @param p_effective_date Effective date for the creation of Applicant
138  * Snapshot.
139  * @param p_person_id Person id of the Applicant.
140  * @param p_profile_snapshot_id If p_validate is false, then this uniquely
141  * identifies the Snapshot created. If p_validate is true, then set to null.
142  * @param p_object_version_number If p_validate is false, then set to the
143  * version number of the created applicant snapshot. If p_validate is true,
144  * then the value will be null.
145  * @rep:displayname Create Applicant Snapshot
146  * @rep:category BUSINESS_ENTITY IRC_RECRUITMENT_CANDIDATE
147  * @rep:lifecycle active
148  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
149  * @rep:scope public
150  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
151 */
152 --
153 -- {End Of Comments}
154 --
155 procedure delete_applicant_snapshot
156   (p_validate                      in     boolean  default false
157   ,p_effective_date                in     date
158   ,p_person_id                     in     number
159   ,p_profile_snapshot_id           in     number
160   ,p_object_version_number         in     number
161   );
162 --
163 end irc_apl_prfl_snapshots_api;