1 Package HR_RETAINED_RIGHTS_API AUTHID CURRENT_USER as
2 /* $Header: peretapi.pkh 120.1 2005/10/02 02:23:54 aroussel $ */
3 /*#
4 * This package contains APIs which create and maintain retained rights.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Retained Rights
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |--------------------------< create_retained_right >-----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a retained right for a collective agreement entitlement
17 * result record.
18 *
19 * A retained right is a retained entitlement (benefit) which is granted to a
20 * person, by virtue of the collective agreement they were previously or are
21 * currently covered by. Although no longer qualifying for the benefit that
22 * they were eligible for previously, the collective agreement may specify that
23 * the entitlement may not be taken away from the person for a period of time.
24 * An example could be the regional salary allowance that a person once
25 * qualified for by working within that region, but following a change in
26 * location, they should not be able to receive. If the regional allowance was
27 * designated as a retained right within the collective agreement, then that
28 * benefit will still be paid to the person for the duration of the retained
29 * right.
30 *
31 * <p><b>Licensing</b><br>
32 * This API is licensed for use with Human Resources.
33 *
34 * <p><b>Prerequisites</b><br>
35 * Entitlement result record exists
36 *
37 * <p><b>Post Success</b><br>
38 * The retained right record is created and the API sets the following out
39 *
40 * <p><b>Post Failure</b><br>
41 * The API does not create the retained right and raises an error.
42 * @param p_validate If true, then validation alone will be performed and the
43 * database will remain unchanged. If false and all validation checks pass,
44 * then the database will be modified.
45 * @param p_effective_date Reference date for validating lookup values are
46 * applicable during the start to end active date range. This date does not
47 * determine when the changes take effect.
48 * @param p_cagr_entitlement_result_id Uniquely identifies the collective
49 * agreement entitlement result that the retained right is to be created for.
50 * @param p_start_date Start date of the retained right record.
51 * @param p_end_date End date of the retained right record.
52 * @param p_freeze_flag Flag indicating whether the retained right should be
53 * created with the entitlement result values, or whether the values for the
54 * retained right should be re-evaluated.
55 * @param p_cagr_retained_right_id If p_validate is false, uniquely identifies
56 * the retained right created. If p_validate is true, set to null.
57 * @param p_object_version_number If p_validate is false, then set to the
58 * version number of the created retained right. If p_validate is true, then
59 * the value will be null.
60 * @rep:displayname Create Retained Right
61 * @rep:category BUSINESS_ENTITY PER_COLLECTIVE_AGREEMENT
62 * @rep:scope public
63 * @rep:lifecycle active
64 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
65 */
66 --
67 -- {End Of Comments}
68 --
69 procedure create_retained_right
70 (p_validate in boolean default false
71 ,p_effective_date in date
72 ,p_cagr_entitlement_result_id in number
73 ,p_start_date in date
74 ,p_end_date in date default hr_api.g_date
75 ,p_freeze_flag in varchar2 default hr_api.g_varchar2
76 ,p_cagr_retained_right_id out nocopy number
77 ,p_object_version_number out nocopy number
78 );
79 --
80 -- ----------------------------------------------------------------------------
81 -- |--------------------------< update_retained_right >-----------------------|
82 -- ----------------------------------------------------------------------------
83 --
84 -- {Start Of Comments}
85 /*#
86 * This API updates a retained right record as identified by the value for
87 * p_cagr_retained_right_id and p_object_version_number.
88 *
89 * A retained right is a retained entitlement (benefit) which is granted to a
90 * person, by virtue of the collective agreement they were previously or are
91 * currently covered by. Although no longer qualifying for the benefit that
92 * they were eligible for previously, the collective agreement may specify that
93 * the entitlement may not be taken away from the person for a period of time.
94 * An example could be the regional salary allowance that a person once
95 * qualified for by working within that region, but following a change in
96 * location, they should not be able to receive. If the regional allowance was
97 * designated as a retained right within the collective agreement, then that
98 * benefit will still be paid to the person for the duration of the retained
99 * right.
100 *
101 * <p><b>Licensing</b><br>
102 * This API is licensed for use with Human Resources.
103 *
104 * <p><b>Prerequisites</b><br>
105 * The retained right record identified by p_cagr_retained_right_id and
106 * object_version_number must exist.
107 *
108 * <p><b>Post Success</b><br>
109 * The retained right record is updated and the API sets the following out
110 *
111 * <p><b>Post Failure</b><br>
112 * The API does not update the retained right and raises an error.
113 * @param p_validate If true, then validation alone will be performed and the
114 * database will remain unchanged. If false and all validation checks pass,
115 * then the database will be modified.
116 * @param p_effective_date Reference date for validating lookup values are
117 * applicable during the start to end active date range. This date does not
118 * determine when the changes take effect.
119 * @param p_cagr_retained_right_id Uniquely identifies the retained right to be
120 * updated.
121 * @param p_end_date End date for the retained right record.
122 * @param p_object_version_number Pass in the current version number of the
123 * retained right to be updated. When the API completes if p_validate is false,
124 * will be set to the new version number of the updated retained right. If
125 * p_validate is true will be set to the same value which was passed in.
126 * @rep:displayname Update Retained Right
127 * @rep:category BUSINESS_ENTITY PER_COLLECTIVE_AGREEMENT
128 * @rep:scope public
129 * @rep:lifecycle active
130 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
131 */
132 --
133 -- {End Of Comments}
134 --
135 procedure update_retained_right
136 (p_validate in boolean default false
137 ,p_effective_date in date
138 ,p_cagr_retained_right_id in number
139 ,p_end_date in date default hr_api.g_date
140 ,p_object_version_number in out nocopy number
141 );
142 --
143 -- ----------------------------------------------------------------------------
144 -- |--------------------------< delete_retained_right >-----------------------|
145 -- ----------------------------------------------------------------------------
146 --
147 -- {Start Of Comments}
148 /*#
149 * This API deletes a retained right for a person as identified by the
150 * parameter p_cagr_retained_right_id and p_object_version_number.
151 *
152 * A retained right is a retained entitlement (benefit) which is granted to a
153 * person, by virtue of the collective agreement they were previously or are
154 * currently covered by. Although no longer qualifying for the benefit that
155 * they were eligible for previously, the collective agreement may specify that
156 * the entitlement may not be taken away from the person for a period of time.
157 * An example could be the regional salary allowance that a person once
158 * qualified for by working within that region, but following a change in
159 * location, they should not be able to receive. If the regional allowance was
160 * designated as a retained right within the collective agreement, then that
161 * benefit will still be paid to the person for the duration of the retained
162 * right.
163 *
164 * <p><b>Licensing</b><br>
165 * This API is licensed for use with Human Resources.
166 *
167 * <p><b>Prerequisites</b><br>
168 * The retained right as identified by the in parameter
169 * p_cagr_retained_right_id and the in out parameter p_object_version_number
170 * must already exist.
171 *
172 * <p><b>Post Success</b><br>
173 * The retained right is deleted.
174 *
175 * <p><b>Post Failure</b><br>
176 * The API does not delete the retained right and raises an error.
177 * @param p_validate If true, then validation alone will be performed and the
178 * database will remain unchanged. If false and all validation checks pass,
179 * then the database will be modified.
180 * @param p_cagr_retained_right_id Uniquely identifies the retained right to be
181 * deleted.
182 * @param p_object_version_number Current version number of the retained right
183 * to be deleted.
184 * @rep:displayname Delete Retained Right
185 * @rep:category BUSINESS_ENTITY PER_COLLECTIVE_AGREEMENT
186 * @rep:scope public
187 * @rep:lifecycle active
188 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
189 */
190 --
191 -- {End Of Comments}
192 --
193 procedure delete_retained_right
194 (p_validate in boolean default false
195 ,p_cagr_retained_right_id in number
196 ,p_object_version_number in number
197 );
198 --
199 --
200 end HR_RETAINED_RIGHTS_API;
[Home] [Help]