1 Package hr_cagr_grade_structures_api as
2 /* $Header: pegrsapi.pkh 120.1 2005/10/02 02:17:25 aroussel $ */
3 /*#
4 * This package contains APIs which maintain collective agreement grade
5 * structures.
6 * @rep:scope public
7 * @rep:product per
8 * @rep:displayname Collective Agreement Grade Structure
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |-----------------------< create_cagr_grade_structures >-------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates a collective agreement grade structure.
18 *
19 * A collective agreement may have one or more valid grade structures which are
20 * defined via the CAGR Grades key flexfield.
21 *
22 * <p><b>Licensing</b><br>
23 * This API is licensed for use with Human Resources.
24 *
25 * <p><b>Prerequisites</b><br>
26 * The collective agreement for which the grade structure is to be created must
27 * exist.
28 *
29 * <p><b>Post Success</b><br>
30 * The collective agreement grade structure is created.
31 *
32 * <p><b>Post Failure</b><br>
33 * The collective agreement grade structure is not created and an error is
34 * raised.
35 * @param p_validate If true, then validation alone will be performed and the
36 * database will remain unchanged. If false and all validation checks pass,
37 * then the database will be modified.
38 * @param p_cagr_grade_structure_id If p_validate is false, then this uniquely
39 * identifies the collective agreement grade structure created. If p_validate
40 * is true, then set to null.
41 * @param p_collective_agreement_id Uniquely identifies the parent collective
42 * agreement.
43 * @param p_object_version_number If p_validate is false, then set to the
44 * version number of the created grade structure. If p_validate is true, then
45 * the value will be null.
46 * @param p_id_flex_num Uniquely identifies the collective agreement grade
47 * structure within the internal key flexfield table.
48 * @param p_dynamic_insert_allowed Indicates whether the assignment collective
49 * agreement grades can vary from the collectively agreed set.
50 * @param p_attribute_category This context value determines which flexfield
51 * structure to use with the descriptive flexfield segments.
52 * @param p_attribute1 Descriptive flexfield segment.
53 * @param p_attribute2 Descriptive flexfield segment.
54 * @param p_attribute3 Descriptive flexfield segment.
55 * @param p_attribute4 Descriptive flexfield segment.
56 * @param p_attribute5 Descriptive flexfield segment.
57 * @param p_attribute6 Descriptive flexfield segment.
58 * @param p_attribute7 Descriptive flexfield segment.
59 * @param p_attribute8 Descriptive flexfield segment.
60 * @param p_attribute9 Descriptive flexfield segment.
61 * @param p_attribute10 Descriptive flexfield segment.
62 * @param p_attribute11 Descriptive flexfield segment.
63 * @param p_attribute12 Descriptive flexfield segment.
64 * @param p_attribute13 Descriptive flexfield segment.
65 * @param p_attribute14 Descriptive flexfield segment.
66 * @param p_attribute15 Descriptive flexfield segment.
67 * @param p_attribute16 Descriptive flexfield segment.
68 * @param p_attribute17 Descriptive flexfield segment.
69 * @param p_attribute18 Descriptive flexfield segment.
70 * @param p_attribute19 Descriptive flexfield segment.
71 * @param p_attribute20 Descriptive flexfield segment.
72 * @param p_effective_date Reference date for validating lookup values are
73 * applicable during the start to end active date range. This date does not
74 * determine when the changes take effect.
75 * @rep:displayname Create Collective Agreement Grade Structure
76 * @rep:category BUSINESS_ENTITY PER_COLLECTIVE_AGREEMENT
77 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
78 * @rep:scope public
79 * @rep:lifecycle active
80 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
81 */
82 --
83 -- {End Of Comments}
84 --
85 procedure create_cagr_grade_structures
86 (p_validate in boolean default false
87 ,p_cagr_grade_structure_id out nocopy number
88 ,p_collective_agreement_id in number default null
89 ,p_object_version_number out nocopy number
90 ,p_id_flex_num in number default null
91 ,p_dynamic_insert_allowed in varchar2 default null
92 ,p_attribute_category in varchar2 default null
93 ,p_attribute1 in varchar2 default null
94 ,p_attribute2 in varchar2 default null
95 ,p_attribute3 in varchar2 default null
96 ,p_attribute4 in varchar2 default null
97 ,p_attribute5 in varchar2 default null
98 ,p_attribute6 in varchar2 default null
99 ,p_attribute7 in varchar2 default null
100 ,p_attribute8 in varchar2 default null
101 ,p_attribute9 in varchar2 default null
102 ,p_attribute10 in varchar2 default null
103 ,p_attribute11 in varchar2 default null
104 ,p_attribute12 in varchar2 default null
105 ,p_attribute13 in varchar2 default null
106 ,p_attribute14 in varchar2 default null
107 ,p_attribute15 in varchar2 default null
108 ,p_attribute16 in varchar2 default null
109 ,p_attribute17 in varchar2 default null
110 ,p_attribute18 in varchar2 default null
111 ,p_attribute19 in varchar2 default null
112 ,p_attribute20 in varchar2 default null
113 ,p_effective_date in date
114 );
115 --
116 -- ----------------------------------------------------------------------------
117 -- |-----------------------< update_cagr_grade_structures >-------------------|
118 -- ----------------------------------------------------------------------------
119 --
120 -- {Start Of Comments}
121 /*#
122 * This API updates a collective agreement grade structure.
123 *
124 * This API updates a collective agreement grade structure. A collective
125 * agreement may have one or more valid grade structures which are defined
126 * within the CAGR Grades key flexfield.
127 *
128 * <p><b>Licensing</b><br>
129 * This API is licensed for use with Human Resources.
130 *
131 * <p><b>Prerequisites</b><br>
132 * The collective agreement grade structure as identified by the parameter
133 * p_cagr_grade_structure_id and the p_object_version_number must exist.
134 *
135 * <p><b>Post Success</b><br>
136 * The collective agreement grade structure is updated.
137 *
138 * <p><b>Post Failure</b><br>
139 * The API does not update the collective agreement grade structure and raises
140 * an error.
141 * @param p_validate If true, then validation alone will be performed and the
142 * database will remain unchanged. If false and all validation checks pass,
143 * then the database will be modified.
144 * @param p_cagr_grade_structure_id Uniquely identifies the collective
145 * agreement grade structure to be updated.
146 * @param p_object_version_number Pass in the current version number of the
147 * collective agreement grade structure to be updated. When the API completes
148 * if p_validate is false, will be set to the new version number of the updated
149 * collective agreement grade structure . If p_validate is true will be set to
150 * the same value which was passed in.
151 * @param p_dynamic_insert_allowed Indicates whether the assignment collective
152 * agreement grades can vary from the collectively agreed set.
153 * @param p_attribute_category This context value determines which flexfield
154 * structure to use with the descriptive flexfield segments.
155 * @param p_attribute1 Descriptive flexfield segment.
156 * @param p_attribute2 Descriptive flexfield segment.
157 * @param p_attribute3 Descriptive flexfield segment.
158 * @param p_attribute4 Descriptive flexfield segment.
159 * @param p_attribute5 Descriptive flexfield segment.
160 * @param p_attribute6 Descriptive flexfield segment.
161 * @param p_attribute7 Descriptive flexfield segment.
162 * @param p_attribute8 Descriptive flexfield segment.
163 * @param p_attribute9 Descriptive flexfield segment.
164 * @param p_attribute10 Descriptive flexfield segment.
165 * @param p_attribute11 Descriptive flexfield segment.
166 * @param p_attribute12 Descriptive flexfield segment.
167 * @param p_attribute13 Descriptive flexfield segment.
168 * @param p_attribute14 Descriptive flexfield segment.
169 * @param p_attribute15 Descriptive flexfield segment.
170 * @param p_attribute16 Descriptive flexfield segment.
171 * @param p_attribute17 Descriptive flexfield segment.
172 * @param p_attribute18 Descriptive flexfield segment.
173 * @param p_attribute19 Descriptive flexfield segment.
174 * @param p_attribute20 Descriptive flexfield segment.
175 * @param p_effective_date Reference date for validating lookup values are
176 * applicable during the start to end active date range. This date does not
177 * determine when the changes take effect.
178 * @rep:displayname Update Collective Agreement Grade Structure
179 * @rep:category BUSINESS_ENTITY PER_COLLECTIVE_AGREEMENT
180 * @rep:scope public
181 * @rep:lifecycle active
182 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
183 */
184 --
185 -- {End Of Comments}
186 --
187 procedure update_cagr_grade_structures
188 (p_validate in boolean default false
189 ,p_cagr_grade_structure_id in number
190 ,p_object_version_number in out nocopy number
191 ,p_dynamic_insert_allowed in varchar2 default hr_api.g_varchar2
192 ,p_attribute_category in varchar2 default hr_api.g_varchar2
193 ,p_attribute1 in varchar2 default hr_api.g_varchar2
194 ,p_attribute2 in varchar2 default hr_api.g_varchar2
195 ,p_attribute3 in varchar2 default hr_api.g_varchar2
196 ,p_attribute4 in varchar2 default hr_api.g_varchar2
197 ,p_attribute5 in varchar2 default hr_api.g_varchar2
198 ,p_attribute6 in varchar2 default hr_api.g_varchar2
199 ,p_attribute7 in varchar2 default hr_api.g_varchar2
200 ,p_attribute8 in varchar2 default hr_api.g_varchar2
201 ,p_attribute9 in varchar2 default hr_api.g_varchar2
202 ,p_attribute10 in varchar2 default hr_api.g_varchar2
203 ,p_attribute11 in varchar2 default hr_api.g_varchar2
204 ,p_attribute12 in varchar2 default hr_api.g_varchar2
205 ,p_attribute13 in varchar2 default hr_api.g_varchar2
206 ,p_attribute14 in varchar2 default hr_api.g_varchar2
207 ,p_attribute15 in varchar2 default hr_api.g_varchar2
208 ,p_attribute16 in varchar2 default hr_api.g_varchar2
209 ,p_attribute17 in varchar2 default hr_api.g_varchar2
210 ,p_attribute18 in varchar2 default hr_api.g_varchar2
211 ,p_attribute19 in varchar2 default hr_api.g_varchar2
212 ,p_attribute20 in varchar2 default hr_api.g_varchar2
213 ,p_effective_date in date
214 );
215 --
216 -- ----------------------------------------------------------------------------
217 -- |-----------------------< delete_cagr_grade_structures >-------------------|
221 /*#
218 -- ----------------------------------------------------------------------------
219 --
220 -- {Start Of Comments}
222 * This API deletes a collective agreement grade structure.
223 *
224 * A collective agreement may have one or more valid grade structures which are
225 * defined within the CAGR Grades key flexfield.
226 *
227 * <p><b>Licensing</b><br>
228 * This API is licensed for use with Human Resources.
229 *
230 * <p><b>Prerequisites</b><br>
231 * The collective agreement grade structure as identified by the parameter
232 * p_cagr_grade_structure_id and the p_object_version_number must exist.
233 *
234 * <p><b>Post Success</b><br>
235 * The collective agreement grade structure is deleted.
236 *
237 * <p><b>Post Failure</b><br>
238 * The API does not delete the collective agreement grade structure and raises
239 * an error.
240 * @param p_validate If true, then validation alone will be performed and the
241 * database will remain unchanged. If false and all validation checks pass,
242 * then the database will be modified.
243 * @param p_cagr_grade_structure_id Uniquely identifies the collective
244 * agreement grade structure to be deleted.
245 * @param p_object_version_number Current version number of the collective
246 * agreement grade structure to be deleted.
247 * @param p_effective_date Reference date for validating lookup values are
248 * applicable during the start to end active date range. This date does not
249 * determine when the changes take effect.
250 * @rep:displayname Delete Collective Agreement Grade Structure
251 * @rep:category BUSINESS_ENTITY PER_COLLECTIVE_AGREEMENT
252 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
253 * @rep:scope public
254 * @rep:lifecycle active
255 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
256 */
257 --
258 -- {End Of Comments}
259 --
260 procedure delete_cagr_grade_structures
261 (p_validate in boolean default false
262 ,p_cagr_grade_structure_id in number
263 ,p_object_version_number in out nocopy number
264 ,p_effective_date in date
265 );
266 --
267 -- ----------------------------------------------------------------------------
268 -- |----------------------------------< lck >---------------------------------|
269 -- ----------------------------------------------------------------------------
270 -- {Start Of Comments}
271 --
272 -- Description:
273 --
274 -- Prerequisites:
275 --
276 --
277 -- In Parameters:
278 -- Name Reqd Type Description
279 -- p_cagr_grade_structure_id Yes number PK of record
280 -- p_effective_date No date Session date
281 -- p_object_version_number Yes number OVN of record
282 --
283 -- Post Success:
284 --
285 -- Name Type Description
286 --
287 -- Post Failure:
288 --
289 -- Access Status:
290 -- Public.
291 --
292 -- {End Of Comments}
293 --
294 procedure lck
295 (
296 p_cagr_grade_structure_id in number
297 ,p_object_version_number in number
298 ,p_effective_date in date
299 );
300 --
301 end hr_cagr_grade_structures_api;
[Home] [Help]