1 Package hr_cagr_grades_api as
2 /* $Header: pegraapi.pkh 120.1 2005/10/02 02:17:12 aroussel $ */
3 /*#
4 * This package contains APIs which maintain collective agreement grades.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Collective Agreement Grade
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------------< create_cagr_grades >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a collective agreement grade.
17 *
18 * There may be one or many collectively agreed grades for a specific
19 * collective agreement. The grades are defined according to the grade
20 * structure that has been defined for the collective agreement. The grades
21 * that are set up are considered to be the reference grades for the collective
22 * agreement, although it may be possible to define other grades if dynamic
23 * inserts are allowed on the grade structure.
24 *
25 * <p><b>Licensing</b><br>
26 * This API is licensed for use with Human Resources.
27 *
28 * <p><b>Prerequisites</b><br>
29 * The grade structure according to which this grade will be defined must exist
30 *
31 * <p><b>Post Success</b><br>
32 * The collective agreement grade is created.
33 *
34 * <p><b>Post Failure</b><br>
35 * The collective agreement grade is not created and an error is raised.
36 * @param p_validate If true, then validation alone will be performed and the
37 * database will remain unchanged. If false and all validation checks pass,
38 * then the database will be modified.
39 * @param p_cagr_grade_id If p_validate is false, then this uniquely identifies
40 * the collective agreement grade created. If p_validate is true, then set to
41 * null.
42 * @param p_cagr_grade_structure_id Uniquely identifies the grade structure
43 * according to which this grade is defined.
44 * @param p_segment1 Component of the collective agreement grade name.
45 * @param p_segment2 Component of the collective agreement grade name.
46 * @param p_segment3 Component of the collective agreement grade name.
47 * @param p_segment4 Component of the collective agreement grade name.
48 * @param p_segment5 Component of the collective agreement grade name.
49 * @param p_segment6 Component of the collective agreement grade name.
50 * @param p_segment7 Component of the collective agreement grade name.
51 * @param p_segment8 Component of the collective agreement grade name.
52 * @param p_segment9 Component of the collective agreement grade name.
53 * @param p_segment10 Component of the collective agreement grade name.
54 * @param p_segment11 Component of the collective agreement grade name.
55 * @param p_segment12 Component of the collective agreement grade name.
56 * @param p_segment13 Component of the collective agreement grade name.
57 * @param p_segment14 Component of the collective agreement grade name.
58 * @param p_segment15 Component of the collective agreement grade name.
59 * @param p_segment16 Component of the collective agreement grade name.
60 * @param p_segment17 Component of the collective agreement grade name.
61 * @param p_segment18 Component of the collective agreement grade name.
62 * @param p_segment19 Component of the collective agreement grade name.
63 * @param p_segment20 Component of the collective agreement grade name.
64 * @param p_concat_segments The concatenation of all segment values for this
65 * grade.
66 * @param p_sequence The sequence of this grade within the grade structure.
67 * @param p_cagr_grade_def_id Uniquely identifies the specific combination of
68 * segments used in this grade within the internal key flexfield combinations
69 * table. May be supplied directly or derived.
70 * @param p_object_version_number If p_validate is false, then set to the
71 * version number of the created collective agreement grade. If p_validate is
72 * true, then the value will be null.
73 * @param p_name If p_validate is false, concatenation of all segments. If
74 * p_validate is true, set to null.
75 * @param p_effective_date Reference date for validating lookup values are
76 * applicable during the start to end active date range. This date does not
77 * determine when the changes take effect.
78 * @rep:displayname Create Collective Agreement Grade
79 * @rep:category BUSINESS_ENTITY PER_COLLECTIVE_AGREEMENT
80 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
81 * @rep:scope public
82 * @rep:lifecycle active
83 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
84 */
85 --
86 -- {End Of Comments}
87 --
88 procedure create_cagr_grades
89 (p_validate in boolean default false
90 ,p_cagr_grade_id out nocopy number
91 ,p_cagr_grade_structure_id in number default null
92 ,p_segment1 in varchar2 default null
93 ,p_segment2 in varchar2 default null
94 ,p_segment3 in varchar2 default null
95 ,p_segment4 in varchar2 default null
96 ,p_segment5 in varchar2 default null
97 ,p_segment6 in varchar2 default null
98 ,p_segment7 in varchar2 default null
99 ,p_segment8 in varchar2 default null
100 ,p_segment9 in varchar2 default null
101 ,p_segment10 in varchar2 default null
102 ,p_segment11 in varchar2 default null
103 ,p_segment12 in varchar2 default null
104 ,p_segment13 in varchar2 default null
105 ,p_segment14 in varchar2 default null
106 ,p_segment15 in varchar2 default null
107 ,p_segment16 in varchar2 default null
108 ,p_segment17 in varchar2 default null
109 ,p_segment18 in varchar2 default null
110 ,p_segment19 in varchar2 default null
111 ,p_segment20 in varchar2 default null
112 ,p_concat_segments in varchar2 default null
113 ,p_sequence in number default null
114 ,p_cagr_grade_def_id in out nocopy number
115 ,p_object_version_number out nocopy number
116 ,p_name out nocopy varchar2
117 ,p_effective_date in date
118 );
119 --
120 -- ----------------------------------------------------------------------------
121 -- |----------------------------< update_cagr_grades >------------------------|
122 -- ----------------------------------------------------------------------------
123 --
124 -- {Start Of Comments}
125 /*#
126 * This API updates a collective agreement grade.
127 *
128 * This API updates a collective agreement grade. There may be one or many
129 * collectively agreed grades for a specific collective agreement. The grades
130 * are defined according to the grade structure that has been defined for the
131 * collective agreement.
132 *
133 * <p><b>Licensing</b><br>
134 * This API is licensed for use with Human Resources.
135 *
136 * <p><b>Prerequisites</b><br>
137 * The collective agreement grade to be updated must exist. The grade structure
138 * according to which this grade will be defined must exist.
139 *
140 * <p><b>Post Success</b><br>
141 * The collective agreement grade is updated.
142 *
143 * <p><b>Post Failure</b><br>
144 * The collective agreement grade 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_grade_id Uniquely identifies the collective agreement grade to
149 * be updated.
150 * @param p_sequence The sequence of this grade within the grade structure.
151 * @param p_segment1 Component of the collective agreement grade name.
152 * @param p_segment2 Component of the collective agreement grade name.
153 * @param p_segment3 Component of the collective agreement grade name.
154 * @param p_segment4 Component of the collective agreement grade name.
155 * @param p_segment5 Component of the collective agreement grade name.
156 * @param p_segment6 Component of the collective agreement grade name.
157 * @param p_segment7 Component of the collective agreement grade name.
158 * @param p_segment8 Component of the collective agreement grade name.
159 * @param p_segment9 Component of the collective agreement grade name.
160 * @param p_segment10 Component of the collective agreement grade name.
161 * @param p_segment11 Component of the collective agreement grade name.
162 * @param p_segment12 Component of the collective agreement grade name.
163 * @param p_segment13 Component of the collective agreement grade name.
164 * @param p_segment14 Component of the collective agreement grade name.
165 * @param p_segment15 Component of the collective agreement grade name.
166 * @param p_segment16 Component of the collective agreement grade name.
167 * @param p_segment17 Component of the collective agreement grade name.
168 * @param p_segment18 Component of the collective agreement grade name.
169 * @param p_segment19 Component of the collective agreement grade name.
170 * @param p_segment20 Component of the collective agreement grade name.
171 * @param p_concat_segments The concatenation of all segment values for this
172 * grade.
173 * @param p_object_version_number Pass in the current version number of the
174 * collective agreement grade to be updated. When the API completes if
175 * p_validate is false, will be set to the new version number of the updated
176 * collective agreement grade. If p_validate is true will be set to the same
177 * value which was passed in.
178 * @param p_effective_date Reference date for validating lookup values are
179 * applicable during the start to end active date range. This date does not
180 * determine when the changes take effect.
181 * @param p_name If p_validate is false, the concatenation of all segments. If
182 * p_validate is true, set to null.
183 * @param p_cagr_grade_def_id Uniquely identifies the specific combination of
184 * segments used in this grade within the internal key flexfield combinations
185 * table. May be supplied directly or derived.
186 * @rep:displayname Update Collective Agreement Grade
187 * @rep:category BUSINESS_ENTITY PER_COLLECTIVE_AGREEMENT
188 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
189 * @rep:scope public
190 * @rep:lifecycle active
191 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
192 */
193 --
194 -- {End Of Comments}
195 --
196 procedure update_cagr_grades
197 (p_validate in boolean default false
198 ,p_cagr_grade_id in number
199 ,p_sequence in number default hr_api.g_number
200 ,p_segment1 in varchar2 default hr_api.g_varchar2
201 ,p_segment2 in varchar2 default hr_api.g_varchar2
202 ,p_segment3 in varchar2 default hr_api.g_varchar2
203 ,p_segment4 in varchar2 default hr_api.g_varchar2
204 ,p_segment5 in varchar2 default hr_api.g_varchar2
205 ,p_segment6 in varchar2 default hr_api.g_varchar2
206 ,p_segment7 in varchar2 default hr_api.g_varchar2
207 ,p_segment8 in varchar2 default hr_api.g_varchar2
208 ,p_segment9 in varchar2 default hr_api.g_varchar2
209 ,p_segment10 in varchar2 default hr_api.g_varchar2
210 ,p_segment11 in varchar2 default hr_api.g_varchar2
211 ,p_segment12 in varchar2 default hr_api.g_varchar2
212 ,p_segment13 in varchar2 default hr_api.g_varchar2
213 ,p_segment14 in varchar2 default hr_api.g_varchar2
214 ,p_segment15 in varchar2 default hr_api.g_varchar2
215 ,p_segment16 in varchar2 default hr_api.g_varchar2
216 ,p_segment17 in varchar2 default hr_api.g_varchar2
217 ,p_segment18 in varchar2 default hr_api.g_varchar2
218 ,p_segment19 in varchar2 default hr_api.g_varchar2
219 ,p_segment20 in varchar2 default hr_api.g_varchar2
220 ,p_concat_segments in varchar2 default hr_api.g_varchar2
221 ,p_object_version_number in out nocopy number
222 ,p_effective_date in date
223 ,p_name out nocopy varchar2
224 ,p_cagr_grade_def_id in out nocopy number
225 );
226 --
227 -- ----------------------------------------------------------------------------
228 -- |----------------------------< delete_cagr_grades >------------------------|
229 -- ----------------------------------------------------------------------------
230 --
231 -- {Start Of Comments}
232 /*#
233 * This API deletes a collective agreement grade.
234 *
235 * This API deletes a collective agreement grade. There may be one or many
236 * collectively agreed grades for a specific collective agreement. The grades
237 * are defined according to the grade structure that has been defined for the
238 * collective agreement.
239 *
240 * <p><b>Licensing</b><br>
241 * This API is licensed for use with Human Resources.
242 *
243 * <p><b>Prerequisites</b><br>
244 * The collective agreement grade to be deleted must exist.
245 *
246 * <p><b>Post Success</b><br>
247 * The collective agreement grade is deleted.
248 *
249 * <p><b>Post Failure</b><br>
250 * The collective agreement grade is not deleted and an error is raised.
251 * @param p_validate If true, then validation alone will be performed and the
252 * database will remain unchanged. If false and all validation checks pass,
253 * then the database will be modified.
254 * @param p_cagr_grade_id Uniquely identifies the collective agreement grade to
255 * be deleted.
256 * @param p_object_version_number Current version number of the collective
257 * agreement grade to be deleted
258 * @param p_effective_date Reference date for validating lookup values are
259 * applicable during the start to end active date range. This date does not
260 * determine when the changes take effect.
261 * @rep:displayname Delete Collective Agreement Grades
262 * @rep:category BUSINESS_ENTITY PER_COLLECTIVE_AGREEMENT
263 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
264 * @rep:scope public
265 * @rep:lifecycle active
266 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
267 */
268 --
269 -- {End Of Comments}
270 --
271 procedure delete_cagr_grades
272 (p_validate in boolean default false
273 ,p_cagr_grade_id in number
274 ,p_object_version_number in out nocopy number
275 ,p_effective_date in date
276 );
277 --
278 -- ----------------------------------------------------------------------------
279 -- |----------------------------------< lck >---------------------------------|
280 -- ----------------------------------------------------------------------------
281 -- {Start Of Comments}
282 --
283 -- Description:
284 --
285 -- Prerequisites:
286 --
287 --
288 -- In Parameters:
289 -- Name Reqd Type Description
290 -- p_cagr_grade_id Yes number PK of record
291 -- p_object_version_number Yes number OVN of record
292 -- p_effective_date No date Session date
293 --
294 -- Post Success:
295 --
296 -- Name Type Description
297 --
298 -- Post Failure:
299 --
300 -- Access Status:
301 -- Public.
302 --
303 -- {End Of Comments}
304 --
305 procedure lck
306 (
307 p_cagr_grade_id in number
308 ,p_object_version_number in number
309 ,p_effective_date in date
310 );
311 --
312 end hr_cagr_grades_api;
[Home] [Help]