1 PACKAGE hr_cagr_ent_lines_api AS
2 /* $Header: pepclapi.pkh 120.2 2006/10/18 09:24:31 grreddy noship $ */
3 /*#
4 * This package contains APIs that maintain entitlement lines used by
5 * collective agreements.
6 * @rep:scope public
7 * @rep:product per
8 * @rep:displayname Collective Agreement Entitlement Line
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |-------------------------< create_entitlement_line >----------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates a collective agreement entitlement line.
18 *
19 * An entitlement line is an instance of an entitlement item for a specific
20 * collective agreement that holds a specific value. There may be one or more
21 * entitlement lines for each entitlement item used by a collective agreement.
22 * For example, the 'Health Workers Collective Agreement' may have one
23 * entitlement line for the item 'Normal Working Hours' holding the value 40,
24 * and another line holding the value 45. The collective agreement process
25 * determines whether a person receives the line based on eligibility profile
26 * associated with the line.
27 *
28 * <p><b>Licensing</b><br>
29 * This API is licensed for use with Human Resources.
30 *
31 * <p><b>Prerequisites</b><br>
32 * The collective agreement entitlement must exist.
33 *
34 * <p><b>Post Success</b><br>
35 * The entitlement line is created.
36 *
37 * <p><b>Post Failure</b><br>
38 * The entitlement line is not created and an error is raised.
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_cagr_entitlement_line_id If p_validate is false, then this uniquely
43 * identifies the entitlement line created. If p_validate is true, then set to
44 * null.
45 * @param p_mandatory Collective agreement processing always determines the
46 * entitlement line as eligible, irrespective of eligibility profile.
47 * @param p_value If collective agreement processing determines the entitlement
48 * line as eligible and the parent item category is 'Assignment', the
49 * entitlement line value is assigned to the person.
50 * @param p_range_from The lower bound of an allowed range of values (instead
51 * of a specific value).
52 * @param p_range_to The upper bound of an allowed range of values (instead of
53 * a specific value).
54 * @param p_effective_start_date If p_validate is false, then set to the
55 * earliest effective start date for the created entitlement line. If
56 * p_validate is true, then set to null.
57 * @param p_effective_end_date If p_validate is false, then set to the
58 * effective end date for the created entitlement line. If p_validate is true,
59 * then set to null.
60 * @param p_grade_spine_id If collective agreement processing determines the
61 * entitlement line as eligible and the parent item category is 'Grade', the
62 * entitlement line value is assigned to the person.
63 * @param p_parent_spine_id If collective agreement processing determines the
64 * entitlement line as eligible and the parent item category is 'Pay Scale',
65 * the entitlement line value is assigned to the person.
66 * @param p_cagr_entitlement_id The parent collective agreement entitlement to
67 * which this line belongs.
68 * @param p_status The status of the record. Valid values are defined by the
69 * 'CAGR_STATUS' lookup type.
70 * @param p_eligy_prfl_id The eligibility profile which is used to determine
71 * whether this line is valid for a person, or not.
72 * @param p_step_id The specific grade step to which the entitlement line
73 * relates.
74 * @param p_from_step_id The lower grade step to which the entitlement line
75 * relates.
76 * @param p_to_step_id The upper grade step to which the entitlement line
77 * relates.
78 * @param p_object_version_number If p_validate is false, then set to the
79 * version number of the created entitlement line. If p_validate is true, then
80 * the value will be null.
81 * @param p_oipl_id The option in plan record to which this line relates.
82 * @param p_effective_date Determines when the DateTrack operation comes into
83 * force.
84 * @rep:displayname Create Entitlement Line
85 * @rep:category BUSINESS_ENTITY PER_COLLECTIVE_AGREEMENT
86 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
87 * @rep:scope public
88 * @rep:lifecycle active
89 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
90 */
91 --
92 -- {End Of Comments}
93 --
94 procedure create_entitlement_line
95 (
96 p_validate in boolean default false
97 ,p_cagr_entitlement_line_id out nocopy number
98 ,p_mandatory in varchar2
99 ,p_value in varchar2 default null
100 ,p_range_from in varchar2 default null
101 ,p_range_to in varchar2 default null
102 ,p_effective_start_date out nocopy date
103 ,p_effective_end_date out nocopy date
104 ,p_grade_spine_id in number default null
105 ,p_parent_spine_id in number default null
106 ,p_cagr_entitlement_id in number
107 ,p_status in varchar2
108 ,p_eligy_prfl_id in number
109 ,p_step_id in number default null
110 ,p_from_step_id in number default null
111 ,p_to_step_id in number default null
112 ,p_object_version_number out nocopy number
113 ,p_oipl_id OUT NOCOPY NUMBER
114 ,p_effective_date in date
115 );
116 --
117 -- ----------------------------------------------------------------------------
118 -- |-------------------------< update_entitlement_line >----------------------|
119 -- ----------------------------------------------------------------------------
120 --
121 -- {Start Of Comments}
122 /*#
123 * This API updates a collective agreement entitlement line.
124 *
125 * An entitlement line is an instance of an entitlement item for a specific
126 * collective agreement that holds a specific value. There may be one or more
127 * entitlement lines for each entitlement item used by a collective agreement.
128 * For example the 'Health Workers Collective Agreement' may have one
129 * entitlement line for the item 'Normal Working Hours' holding the value 40,
130 * and another line holding the value 45. The collective agreement process
131 * determines whether a person receives the line based on eligibility profile
132 * associated with the line.
133 *
134 * <p><b>Licensing</b><br>
135 * This API is licensed for use with Human Resources.
136 *
137 * <p><b>Prerequisites</b><br>
138 * The entitlement line must exist.
139 *
140 * <p><b>Post Success</b><br>
141 * The entitlement line is updated.
142 *
143 * <p><b>Post Failure</b><br>
144 * The entitlement line is not updated and an error is raised.
145 * @param p_validate If true, then validation alone will be performed and the
146 * database will remain unchanged. If false and all validation checks pass,
147 * then the database will be modified.
148 * @param p_cagr_entitlement_line_id Uniquely identifies the entitlement line.
149 * @param p_mandatory Collective agreement processing always determines the
150 * entitlement line as eligible, irrespective of eligibility profile.
151 * @param p_value If collective agreement processing determines the entitlement
152 * line as eligible and the parent item category is 'Assignment', the
153 * entitlement line value is assigned to the person.
154 * @param p_range_from The lower bound of an allowed range of values (instead
155 * of a specific value).
156 * @param p_range_to The upper bound of an allowed range of values (instead of
157 * a specific value).
158 * @param p_effective_start_date If p_validate is false, then set to the
159 * effective start date on the updated entitlement line row which now exists as
160 * of the effective date. If p_validate is true, then set to null.
161 * @param p_effective_end_date If p_validate is false, then set to the
162 * effective end date on the updated entitlement line row which now exists as
163 * of the effective date. If p_validate is true, then set to null.
164 * @param p_grade_spine_id If collective agreement processing determines the
165 * entitlement line as eligible and the parent item category is 'Grade', the
166 * entitlement line value is assigned to the person.
167 * @param p_parent_spine_id If collective agreement processing determines the
168 * entitlement line as eligible and the parent item category is 'Pay Scale',
169 * the entitlement line value is assigned to the person.
170 * @param p_cagr_entitlement_id The parent collective agreement entitlement to
171 * which this line belongs.
172 * @param p_status The status of the record. Valid values are defined by the
173 * 'CAGR_STATUS' lookup type.
174 * @param p_oipl_id The option in plan record to which this line relates.
175 * @param p_eligy_prfl_id The eligibility profile which is used to determine
176 * whether this line is valid for a person, or not.
177 * @param p_step_id The specific grade step to which the entitlement line
178 * relates.
179 * @param p_from_step_id The lower grade step to which the entitlement line
180 * relates.
181 * @param p_to_step_id The upper grade step to which the entitlement line
182 * relates.
183 * @param p_object_version_number Pass in the current version number of the
184 * entitlement to be updated. When the API completes if p_validate is false,
185 * will be set to the new version number of the updated entitlement. If
186 * p_validate is true will be set to the same value which was passed in.
187 * @param p_effective_date Determines when the DateTrack operation comes into
188 * force.
189 * @param p_datetrack_mode Indicates which DateTrack mode to use when updating
190 * the record. You must set to either UPDATE, CORRECTION, UPDATE_OVERRIDE or
191 * UPDATE_CHANGE_INSERT. Modes available for use with a particular record
192 * depend on the dates of previous record changes and the effective date of
193 * this change.
194 * @rep:displayname Update Entitlement Line
195 * @rep:category BUSINESS_ENTITY PER_COLLECTIVE_AGREEMENT
196 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
197 * @rep:scope public
198 * @rep:lifecycle active
199 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
200 */
201 --
202 -- {End Of Comments}
203 --
204 procedure update_entitlement_line
205 (
206 p_validate in boolean default false
207 ,p_cagr_entitlement_line_id in number
208 ,p_mandatory in varchar2 default hr_api.g_varchar2
209 ,p_value in varchar2 default hr_api.g_varchar2
210 ,p_range_from in varchar2 default hr_api.g_varchar2
211 ,p_range_to in varchar2 default hr_api.g_varchar2
212 ,p_effective_start_date out nocopy date
213 ,p_effective_end_date out nocopy date
214 ,p_grade_spine_id in number default hr_api.g_number
215 ,p_parent_spine_id in number default hr_api.g_number
216 ,p_cagr_entitlement_id in number default hr_api.g_number
217 ,p_status in varchar2 default hr_api.g_varchar2
218 ,p_oipl_id in number default hr_api.g_number
219 ,p_eligy_prfl_id in number default hr_api.g_number
220 ,p_step_id in number default hr_api.g_number
221 ,p_from_step_id in number default hr_api.g_number
222 ,p_to_step_id in number default hr_api.g_number
223 ,p_object_version_number in out nocopy number
224 ,p_effective_date in date
225 ,p_datetrack_mode in varchar2
226 );
227 --
228 -- ----------------------------------------------------------------------------
229 -- |-------------------------< delete_entitlement_line >----------------------|
230 -- ----------------------------------------------------------------------------
231 --
232 -- {Start Of Comments}
233 /*#
234 * This API deletes a collective agreement entitlement line.
235 *
236 * An entitlement line is an instance of an entitlement item for a collective
237 * agreement that holds a specific value. There may be one or more entitlement
238 * lines for each entitlement item used by a collective agreement. For example
239 * the 'Health Workers Collective Agreement' may have one entitlement line for
240 * the item 'Normal Working Hours' holding the value 40, and another line
241 * holding the value 45. The collective agreement process determines whether a
242 * person receives the line based on eligibility profile associated with the
243 * line.
244 *
245 * <p><b>Licensing</b><br>
246 * This API is licensed for use with Human Resources.
247 *
248 * <p><b>Prerequisites</b><br>
249 * The entitlement line must exist.
250 *
251 * <p><b>Post Success</b><br>
252 * The entitlement line is deleted.
253 *
254 * <p><b>Post Failure</b><br>
255 * The entitlement line is not deleted and an error is raised.
256 * @param p_validate If true, then validation alone will be performed and the
257 * database will remain unchanged. If false and all validation checks pass,
258 * then the database will be modified.
259 * @param p_cagr_entitlement_line_id Uniquely identifies the entitlement line.
260 * @param p_effective_start_date If p_validate is false, then set to the
261 * effective start date for the deleted entitlement line row which now exists
262 * as of the effective date. If p_validate is true or all row instances have
263 * been deleted then set to null.
264 * @param p_effective_end_date If p_validate is false, then set to the
265 * effective end date for the deleted entitlement line row which now exists as
266 * of the effective date. If p_validate is true or all row instances have been
267 * deleted then set to null.
268 * @param p_object_version_number Current version number of the entitlement
269 * line to be deleted.
270 * @param p_effective_date Determines when the DateTrack operation comes into
271 * force.
272 * @param p_datetrack_mode Indicates which DateTrack mode to use when deleting
273 * the record. You must set to either ZAP, DELETE, FUTURE_CHANGE or
274 * DELETE_NEXT_CHANGE. Modes available for use with a particular record depend
275 * on the dates of previous record changes and the effective date of this
276 * change.
277 * @rep:displayname Delete Entitlement Line
278 * @rep:category BUSINESS_ENTITY PER_COLLECTIVE_AGREEMENT
279 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
280 * @rep:scope public
281 * @rep:lifecycle active
282 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
283 */
284 --
285 -- {End Of Comments}
286 --
287 procedure delete_entitlement_line
288 (
289 p_validate in boolean default false
290 ,p_cagr_entitlement_line_id in number
291 ,p_effective_start_date out nocopy date
292 ,p_effective_end_date out nocopy date
293 ,p_object_version_number in out nocopy number
294 ,p_effective_date in date
295 ,p_datetrack_mode in varchar2
296 );
297 --
298 -- ----------------------------------------------------------------------------
299 -- |----------------------------------< lck >---------------------------------|
300 -- ----------------------------------------------------------------------------
301 -- {Start Of Comments}
302 --
303 -- Description:
304 --
305 -- Prerequisites:
306 --
307 --
308 -- In Parameters:
309 -- Name Reqd Type Description
310 -- p_cagr_entitlement_line_id Yes number PK of record
311 -- p_object_version_number Yes number OVN of record
312 -- p_effective_date Yes date Session Date.
313 -- p_datetrack_mode Yes varchar2 Datetrack mode.
314 --
315 -- Post Success:
316 --
317 -- Name Type Description
318 -- p_validation_start_date Yes Derived Effective Start Date.
319 -- p_validation_end_date Yes Derived Effective End Date.
320 --
321 -- Post Failure:
322 --
323 -- Access Status:
324 -- Public.
325 --
326 -- {End Of Comments}
327 --
331 ,p_object_version_number in number
328 procedure lck
329 (
330 p_cagr_entitlement_line_id in number
332 ,p_effective_date in date
333 ,p_datetrack_mode in varchar2
334 ,p_validation_start_date out nocopy date
335 ,p_validation_end_date out nocopy date
336 );
337 --
338 end hr_cagr_ent_lines_api;
[Home] [Help]