1 PACKAGE per_position_structure_api AS
2 /* $Header: pepstapi.pkh 120.2 2005/10/22 01:24:54 aroussel noship $ */
3 /*#
4 * This package contains APIs that create and maintain position hierarchies.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Position Hierarchy
8 */
9 g_package VARCHAR2(33) := ' per_position_structure_api.';
10 --
11 --------------------------------------------------------------------------------
12 g_dummy number(1); -- Dummy for cursor returns which are not needed
13 g_business_group_id number(15); -- For validating translation;
14 g_legislation_code varchar2(150); -- For validating translation;
15 --------------------------------------------------------------------------------
16 --
17 -- ----------------------------------------------------------------------------
18 -- |----------------------< create_pos_struct_and_def_ver >-------------------|
19 -- ----------------------------------------------------------------------------
20 --
21 -- {Start Of Comments}
22 /*#
23 * This API creates a position hierarchy and version.
24 *
25 * An position structure show reporting lines or other relationships. You can
26 * use hierarchies for reporting and for controlling access to Oracle HRMS
27 * information.
28 *
29 * <p><b>Licensing</b><br>
30 * This API is licensed for use with Human Resources.
31 *
32 * <p><b>Prerequisites</b><br>
33 * None
34 *
35 * <p><b>Post Success</b><br>
36 * Position hierarchy and version gets created.
37 *
38 * <p><b>Post Failure</b><br>
39 * Position hierarchy and version is not created and error is returned..
40 * @param p_validate If true, then validation alone will be performed and the
41 * database will remain unchanged. If false and all validation checks pass,
42 * then the database will be modified.
43 * @param p_effective_date Reference date for validating lookup values are
44 * applicable during the start to end active date range. This date does not
45 * determine when the changes take effect.
46 * @param p_name The name of the position hierarchy.
47 * @param p_business_group_id Uniquely identifies the business group associated
48 * with the position hierarchy.
49 * @param p_comments Comment text.
50 * @param p_primary_position_flag Flag specifying if the created position
51 * hierarchy is the primary position hierarchy.
52 * @param p_request_id When the API is executed from a concurrent program set
53 * to the concurrent request identifier.
54 * @param p_program_application_id When the API is executed from a concurrent
55 * program set to the program's Application.
56 * @param p_program_id When the API is executed from a concurrent program set
57 * to the program's identifier.
58 * @param p_program_update_date When the API is executed from a concurrent
59 * program set to when the program was ran.
60 * @param p_attribute_category This context value determines which flexfield
61 * structure to use with the descriptive flexfield segments.
62 * @param p_attribute1 Descriptive flexfield segment.
63 * @param p_attribute2 Descriptive flexfield segment.
64 * @param p_attribute3 Descriptive flexfield segment.
65 * @param p_attribute4 Descriptive flexfield segment.
66 * @param p_attribute5 Descriptive flexfield segment.
67 * @param p_attribute6 Descriptive flexfield segment.
68 * @param p_attribute7 Descriptive flexfield segment.
69 * @param p_attribute8 Descriptive flexfield segment.
70 * @param p_attribute9 Descriptive flexfield segment.
71 * @param p_attribute10 Descriptive flexfield segment.
72 * @param p_attribute11 Descriptive flexfield segment.
73 * @param p_attribute12 Descriptive flexfield segment.
74 * @param p_attribute13 Descriptive flexfield segment.
75 * @param p_attribute14 Descriptive flexfield segment.
76 * @param p_attribute15 Descriptive flexfield segment.
77 * @param p_attribute16 Descriptive flexfield segment.
78 * @param p_attribute17 Descriptive flexfield segment.
79 * @param p_attribute18 Descriptive flexfield segment.
80 * @param p_attribute19 Descriptive flexfield segment.
81 * @param p_attribute20 Descriptive flexfield segment.
82 * @param p_position_structure_id If p_validate is false, then this uniquely
83 * identifies the position hierarchy created. If p_validate is true, then set
84 * to null.
85 * @param p_object_version_number If p_validate is false, then set to the
86 * version number of the created Position Hierarchy. If p_validate is true,
87 * then the value will be null.
88 * @rep:displayname Create Position Hierarchy and Version
89 * @rep:category BUSINESS_ENTITY PER_POSITION_HIERARCHY
90 * @rep:scope public
91 * @rep:lifecycle active
92 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
93 */
94 --
95 -- {End Of Comments}
96 --
97 PROCEDURE create_pos_struct_and_def_ver
98 (p_validate IN BOOLEAN DEFAULT false
99 ,p_effective_date in date
100 ,p_name in varchar2
101 ,p_business_group_id in number
102 ,p_comments in varchar2 default null
103 ,p_primary_position_flag in varchar2 default 'N'
104 ,p_request_id in number default null
105 ,p_program_application_id in number default null
106 ,p_program_id in number default null
107 ,p_program_update_date in date default null
108 ,p_attribute_category in varchar2 default null
109 ,p_attribute1 in varchar2 default null
110 ,p_attribute2 in varchar2 default null
111 ,p_attribute3 in varchar2 default null
112 ,p_attribute4 in varchar2 default null
113 ,p_attribute5 in varchar2 default null
114 ,p_attribute6 in varchar2 default null
115 ,p_attribute7 in varchar2 default null
116 ,p_attribute8 in varchar2 default null
117 ,p_attribute9 in varchar2 default null
118 ,p_attribute10 in varchar2 default null
119 ,p_attribute11 in varchar2 default null
120 ,p_attribute12 in varchar2 default null
121 ,p_attribute13 in varchar2 default null
122 ,p_attribute14 in varchar2 default null
123 ,p_attribute15 in varchar2 default null
124 ,p_attribute16 in varchar2 default null
125 ,p_attribute17 in varchar2 default null
126 ,p_attribute18 in varchar2 default null
127 ,p_attribute19 in varchar2 default null
128 ,p_attribute20 in varchar2 default null
129 ,p_position_structure_id out nocopy number
130 ,p_object_version_number out nocopy number
131 );
132 --
133 -- ----------------------------------------------------------------------------
134 -- |------------------------< create_position_structure >---------------------|
135 -- ----------------------------------------------------------------------------
136 --
137 -- {Start Of Comments}
138 /*#
139 * This API creates a position hierarchy.
140 *
141 * An position structure show reporting lines or other relationships. You can
142 * use hierarchies for reporting and for controlling access to Oracle HRMS
143 * information.
144 *
145 * <p><b>Licensing</b><br>
146 * This API is licensed for use with Human Resources.
147 *
148 * <p><b>Prerequisites</b><br>
149 * None
150 *
151 * <p><b>Post Success</b><br>
152 * Position Hierarchy gets created.
153 *
154 * <p><b>Post Failure</b><br>
155 * Position Hierarchy does not get created and error is returned.
156 * @param p_validate If true, then validation alone will be performed and the
157 * database will remain unchanged. If false and all validation checks pass,
158 * then the database will be modified.
159 * @param p_effective_date Reference date for validating lookup values are
160 * applicable during the start to end active date range. This date does not
161 * determine when the changes take effect.
162 * @param p_name The name of the position hierarchy.
163 * @param p_business_group_id Uniquely identifies the business group associated
164 * with the position hierarchy.
165 * @param p_comments Comment text.
166 * @param p_primary_position_flag Flag specifying if the created position
167 * hierarchy is the primary position hierarchy.
168 * @param p_request_id When the API is executed from a concurrent program set
169 * to the concurrent request identifier.
170 * @param p_program_application_id When the API is executed from a concurrent
171 * program set to the program's Application.
172 * @param p_program_id When the API is executed from a concurrent program set
173 * to the program's identifier.
174 * @param p_program_update_date When the API is executed from a concurrent
175 * program set to when the program was ran.
176 * @param p_attribute_category This context value determines which flexfield
177 * structure to use with the descriptive flexfield segments.
178 * @param p_attribute1 Descriptive flexfield segment.
179 * @param p_attribute2 Descriptive flexfield segment.
180 * @param p_attribute3 Descriptive flexfield segment.
181 * @param p_attribute4 Descriptive flexfield segment.
182 * @param p_attribute5 Descriptive flexfield segment.
183 * @param p_attribute6 Descriptive flexfield segment.
184 * @param p_attribute7 Descriptive flexfield segment.
185 * @param p_attribute8 Descriptive flexfield segment.
186 * @param p_attribute9 Descriptive flexfield segment.
187 * @param p_attribute10 Descriptive flexfield segment.
188 * @param p_attribute11 Descriptive flexfield segment.
189 * @param p_attribute12 Descriptive flexfield segment.
190 * @param p_attribute13 Descriptive flexfield segment.
191 * @param p_attribute14 Descriptive flexfield segment.
192 * @param p_attribute15 Descriptive flexfield segment.
193 * @param p_attribute16 Descriptive flexfield segment.
194 * @param p_attribute17 Descriptive flexfield segment.
195 * @param p_attribute18 Descriptive flexfield segment.
196 * @param p_attribute19 Descriptive flexfield segment.
197 * @param p_attribute20 Descriptive flexfield segment.
198 * @param p_position_structure_id If p_validate is false, then this uniquely
199 * identifies the position hierarchy created. If p_validate is true, then set
200 * to null.
201 * @param p_object_version_number If p_validate is false, then set to the
202 * version number of the created position hierarchy. If p_validate is true,
203 * then the value will be null.
204 * @rep:displayname Create Position Hierarchy
205 * @rep:category BUSINESS_ENTITY PER_POSITION_HIERARCHY
206 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
207 * @rep:scope public
208 * @rep:lifecycle active
209 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
210 */
211 --
212 -- {End Of Comments}
213 --
214 PROCEDURE create_position_structure
215 (p_validate IN BOOLEAN DEFAULT false
216 ,p_effective_date in date
217 ,p_name in varchar2
218 ,p_business_group_id in number
219 ,p_comments in varchar2 default null
220 ,p_primary_position_flag in varchar2 default 'N'
221 ,p_request_id in number default null
222 ,p_program_application_id in number default null
223 ,p_program_id in number default null
224 ,p_program_update_date in date default null
225 ,p_attribute_category in varchar2 default null
226 ,p_attribute1 in varchar2 default null
227 ,p_attribute2 in varchar2 default null
228 ,p_attribute3 in varchar2 default null
229 ,p_attribute4 in varchar2 default null
230 ,p_attribute5 in varchar2 default null
231 ,p_attribute6 in varchar2 default null
232 ,p_attribute7 in varchar2 default null
233 ,p_attribute8 in varchar2 default null
234 ,p_attribute9 in varchar2 default null
235 ,p_attribute10 in varchar2 default null
236 ,p_attribute11 in varchar2 default null
237 ,p_attribute12 in varchar2 default null
238 ,p_attribute13 in varchar2 default null
239 ,p_attribute14 in varchar2 default null
240 ,p_attribute15 in varchar2 default null
241 ,p_attribute16 in varchar2 default null
242 ,p_attribute17 in varchar2 default null
243 ,p_attribute18 in varchar2 default null
244 ,p_attribute19 in varchar2 default null
245 ,p_attribute20 in varchar2 default null
246 ,p_position_structure_id out nocopy number
247 ,p_object_version_number out nocopy number
248 );
249 --
250 -- ----------------------------------------------------------------------------
254 -- {Start Of Comments}
251 -- |------------------------< update_position_structure >---------------------|
252 -- ----------------------------------------------------------------------------
253 --
255 /*#
256 * This API updates a position hierarchy.
257 *
258 * An position structure show reporting lines or other relationships. You can
259 * use hierarchies for reporting and for controlling access to Oracle HRMS
260 * information.
261 *
262 * <p><b>Licensing</b><br>
263 * This API is licensed for use with Human Resources.
264 *
265 * <p><b>Prerequisites</b><br>
266 * Position hierarchy should exist.
267 *
268 * <p><b>Post Success</b><br>
269 * Position hierarchy will be updated.
270 *
271 * <p><b>Post Failure</b><br>
272 * Position hierarchy will not be updated and an error will be returned.
273 * @param p_validate If true, then validation alone will be performed and the
274 * database will remain unchanged. If false and all validation checks pass,
275 * then the database will be modified.
276 * @param p_effective_date Reference date for validating lookup values are
277 * applicable during the start to end active date range. This date does not
278 * determine when the changes take effect.
279 * @param p_position_structure_id Uniquely identifies the position hierarchy
280 * record to modify.
281 * @param p_name The name of the position hierarchy.
282 * @param p_comments Comment text.
283 * @param p_primary_position_flag Flag specifying if the created position
284 * hierarchy is the primary position hierarchy.
285 * @param p_request_id When the API is executed from a concurrent program set
286 * to the concurrent request identifier.
287 * @param p_program_application_id When the API is executed from a concurrent
288 * program set to the program's Application.
289 * @param p_program_id When the API is executed from a concurrent program set
290 * to the program's identifier.
291 * @param p_program_update_date When the API is executed from a concurrent
292 * program set to when the program was ran.
293 * @param p_attribute_category This context value determines which flexfield
294 * structure to use with the descriptive flexfield segments.
295 * @param p_attribute1 Descriptive flexfield segment.
296 * @param p_attribute2 Descriptive flexfield segment.
297 * @param p_attribute3 Descriptive flexfield segment.
298 * @param p_attribute4 Descriptive flexfield segment.
299 * @param p_attribute5 Descriptive flexfield segment.
300 * @param p_attribute6 Descriptive flexfield segment.
301 * @param p_attribute7 Descriptive flexfield segment.
302 * @param p_attribute8 Descriptive flexfield segment.
303 * @param p_attribute9 Descriptive flexfield segment.
304 * @param p_attribute10 Descriptive flexfield segment.
305 * @param p_attribute11 Descriptive flexfield segment.
306 * @param p_attribute12 Descriptive flexfield segment.
307 * @param p_attribute13 Descriptive flexfield segment.
308 * @param p_attribute14 Descriptive flexfield segment.
309 * @param p_attribute15 Descriptive flexfield segment.
310 * @param p_attribute16 Descriptive flexfield segment.
311 * @param p_attribute17 Descriptive flexfield segment.
312 * @param p_attribute18 Descriptive flexfield segment.
313 * @param p_attribute19 Descriptive flexfield segment.
314 * @param p_attribute20 Descriptive flexfield segment.
315 * @param p_object_version_number Pass in the current version number of the
316 * position hierarchy to be updated. When the API completes if p_validate is
317 * false, will be set to the new version number of the updated position
318 * hierarchy. If p_validate is true will be set to the same value which was
319 * passed in.
320 * @rep:displayname Update Position Hierarchy
321 * @rep:category BUSINESS_ENTITY PER_POSITION_HIERARCHY
322 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
323 * @rep:scope public
324 * @rep:lifecycle active
325 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
326 */
327 --
328 -- {End Of Comments}
329 --
330 PROCEDURE update_position_structure
331 ( p_validate in boolean default false
332 ,p_effective_date in date
333 ,p_position_structure_id in number
334 ,p_name in varchar2 default hr_api.g_varchar2
335 ,p_comments in varchar2 default hr_api.g_varchar2
336 ,p_primary_position_flag in varchar2 default hr_api.g_varchar2
337 ,p_request_id in number default hr_api.g_number
338 ,p_program_application_id in number default hr_api.g_number
339 ,p_program_id in number default hr_api.g_number
340 ,p_program_update_date in date default hr_api.g_date
341 ,p_attribute_category in varchar2 default hr_api.g_varchar2
342 ,p_attribute1 in varchar2 default hr_api.g_varchar2
343 ,p_attribute2 in varchar2 default hr_api.g_varchar2
344 ,p_attribute3 in varchar2 default hr_api.g_varchar2
345 ,p_attribute4 in varchar2 default hr_api.g_varchar2
346 ,p_attribute5 in varchar2 default hr_api.g_varchar2
347 ,p_attribute6 in varchar2 default hr_api.g_varchar2
348 ,p_attribute7 in varchar2 default hr_api.g_varchar2
349 ,p_attribute8 in varchar2 default hr_api.g_varchar2
350 ,p_attribute9 in varchar2 default hr_api.g_varchar2
351 ,p_attribute10 in varchar2 default hr_api.g_varchar2
352 ,p_attribute11 in varchar2 default hr_api.g_varchar2
353 ,p_attribute12 in varchar2 default hr_api.g_varchar2
354 ,p_attribute13 in varchar2 default hr_api.g_varchar2
355 ,p_attribute14 in varchar2 default hr_api.g_varchar2
356 ,p_attribute15 in varchar2 default hr_api.g_varchar2
360 ,p_attribute19 in varchar2 default hr_api.g_varchar2
357 ,p_attribute16 in varchar2 default hr_api.g_varchar2
358 ,p_attribute17 in varchar2 default hr_api.g_varchar2
359 ,p_attribute18 in varchar2 default hr_api.g_varchar2
361 ,p_attribute20 in varchar2 default hr_api.g_varchar2
362 ,p_object_version_number in out nocopy number
363
364 );
365 --
366 -- ----------------------------------------------------------------------------
367 -- |------------------------< delete_position_structure >---------------------|
368 -- ----------------------------------------------------------------------------
369 --
370 -- {Start Of Comments}
371 /*#
372 * This API deletes a position hierarchy.
373 *
374 * An position structure show reporting lines or other relationships. You can
375 * use hierarchies for reporting and for controlling access to Oracle HRMS
376 * information.
377 *
378 * <p><b>Licensing</b><br>
379 * This API is licensed for use with Human Resources.
380 *
381 * <p><b>Prerequisites</b><br>
382 * Position hierarchy should exist.
383 *
384 * <p><b>Post Success</b><br>
385 * Position hierarchy will be deleted.
386 *
387 * <p><b>Post Failure</b><br>
388 * Position hierarchy will not be deleted and error will be returned.
389 * @param p_validate If true, then validation alone will be performed and the
390 * database will remain unchanged. If false and all validation checks pass,
391 * then the database will be modified.
392 * @param p_position_structure_id Identifies the position hierarchy record to
393 * delete.
394 * @param p_object_version_number Current version number of the position
395 * hierarchy to be deleted.
396 * @rep:displayname Delete Position Hierarchy
397 * @rep:category BUSINESS_ENTITY PER_POSITION_HIERARCHY
398 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
399 * @rep:scope public
400 * @rep:lifecycle active
401 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
402 */
403 --
404 -- {End Of Comments}
405 --
406 PROCEDURE delete_position_structure
407 ( p_validate IN BOOLEAN default false
408 ,p_position_structure_id IN number
409 ,p_object_version_number IN number );
410 --
411 --
412 END per_position_structure_api;
[Home] [Help]