1 Package per_supplementary_role_api as
2 /* $Header: perolapi.pkh 120.1.12010000.1 2008/07/28 05:45:40 appldev ship $ */
3 /*#
4 * This package contains APIs that create and maintain supplementary roles.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Supplementary Role
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |------------------------< create_supplementary_role >---------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a supplementary role for a person.
17 *
18 * Supplementary roles are activities a person does for the enterprise but
19 * typically receives no renumeration for doing it, such as fire wardens or
20 * health and safety officers. HRMS also uses supplementary roles to specify
21 * union representatives within the workforce, so you can associate a
22 * supplementary role with a representative body. Before you can give a person
23 * a supplementary role, you must define the role itself by creating a job in
24 * any job group other than the 'Default HR Job Group'. For more details on job
25 * groups, see the package 'HR Job Group APIs'.
26 *
27 * <p><b>Licensing</b><br>
28 * This API is licensed for use with Human Resources.
29 *
30 * <p><b>Prerequisites</b><br>
31 * A person must exist and at least one job must have been created in any other
32 * job group other than the 'Default HR Job Group'.
33 *
34 * <p><b>Post Success</b><br>
35 * A supplementary role is created.
36 *
37 * <p><b>Post Failure</b><br>
38 * A supplementary role is not created and an error will be 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_effective_date Reference date for validating lookup values are
43 * applicable during the start to end active date range. This date does not
44 * determine when the changes take effect.
45 * @param p_job_id Uniquely identifies the job associated with this
46 * supplementary role.
47 * @param p_job_group_id Uniquely identifies the job group the job is in.
48 * Cannot be the 'Default HR Job Group'.
49 * @param p_person_id Identifies the person for whom you create the
50 * supplementary role record.
51 * @param p_organization_id Uniquely identifies the representative body
52 * associated with the role. The organization must be of the class
53 * 'Representative Body'.
54 * @param p_start_date The start date of the role.
55 * @param p_end_date The end date of the role.
56 * @param p_confidential_date The date on which a confidentiality agreement was
57 * signed. (Some roles require a signed confidentiality agreement.)
58 * @param p_emp_rights_flag Use this flag to indicate whether extended
59 * employment rights are available for this role. Some roles grant additional
60 * employment rights to the employee. For example, termination rules may be
61 * different for union representatives. Valid values are 'Y' or 'N'.
62 * @param p_end_of_rights_date The date that extended employment rights end. If
63 * you terminate an employee before this date, the termination raises a
64 * warning. You can only set this date if the p_emp_rights_flag is set to 'Y'.
65 * @param p_primary_contact_flag Use this flag to indicate whether the person
66 * is a primary contact for this role. (Many people can hold the same role.)
67 * @param p_attribute_category This context value determines which flexfield
68 * structure to use with the descriptive flexfield segments.
69 * @param p_attribute1 Descriptive flexfield segment.
70 * @param p_attribute2 Descriptive flexfield segment.
71 * @param p_attribute3 Descriptive flexfield segment.
72 * @param p_attribute4 Descriptive flexfield segment.
73 * @param p_attribute5 Descriptive flexfield segment.
74 * @param p_attribute6 Descriptive flexfield segment.
75 * @param p_attribute7 Descriptive flexfield segment.
76 * @param p_attribute8 Descriptive flexfield segment.
77 * @param p_attribute9 Descriptive flexfield segment.
78 * @param p_attribute10 Descriptive flexfield segment.
79 * @param p_attribute11 Descriptive flexfield segment.
80 * @param p_attribute12 Descriptive flexfield segment.
81 * @param p_attribute13 Descriptive flexfield segment.
82 * @param p_attribute14 Descriptive flexfield segment.
83 * @param p_attribute15 Descriptive flexfield segment.
84 * @param p_attribute16 Descriptive flexfield segment.
85 * @param p_attribute17 Descriptive flexfield segment.
86 * @param p_attribute18 Descriptive flexfield segment.
87 * @param p_attribute19 Descriptive flexfield segment.
88 * @param p_attribute20 Descriptive flexfield segment.
89 * @param p_role_information_category This context value determines which
90 * Flexfield Structure to use with the Developer Descriptive flexfield
91 * segments.
92 * @param p_role_information1 Developer descriptive flexfield
93 * @param p_role_information2 Developer descriptive flexfield
94 * @param p_role_information3 Developer descriptive flexfield
95 * @param p_role_information4 Developer descriptive flexfield
96 * @param p_role_information5 Developer descriptive flexfield
97 * @param p_role_information6 Developer descriptive flexfield
98 * @param p_role_information7 Developer descriptive flexfield
99 * @param p_role_information8 Developer descriptive flexfield
100 * @param p_role_information9 Developer descriptive flexfield
101 * @param p_role_information10 Developer descriptive flexfield
102 * @param p_role_information11 Developer descriptive flexfield
103 * @param p_role_information12 Developer descriptive flexfield
104 * @param p_role_information13 Developer descriptive flexfield
105 * @param p_role_information14 Developer descriptive flexfield
106 * @param p_role_information15 Developer descriptive flexfield
107 * @param p_role_information16 Developer descriptive flexfield
108 * @param p_role_information17 Developer descriptive flexfield
109 * @param p_role_information18 Developer descriptive flexfield
110 * @param p_role_information19 Developer descriptive flexfield
111 * @param p_role_information20 Developer descriptive flexfield
112 * @param p_role_id If p_validate is false, uniquely identifies the
113 * supplementary role created. If p_validate is true, set to null.
114 * @param p_object_version_number If p_validate is false, then set to the
115 * version number of the created supplementary role. If p_validate is true,
116 * then the value will be null.
117 * @rep:displayname Create Supplementary Role
118 * @rep:category BUSINESS_ENTITY PER_SUPPLEMENTARY_ROLE
119 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
120 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
121 * @rep:scope public
122 * @rep:lifecycle active
123 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
124 */
125 --
126 -- {End Of Comments}
127 --
128 procedure create_supplementary_role
129 (p_validate in boolean default false
130 ,p_effective_date in date
131 ,p_job_id in number
132 ,p_job_group_id in number
133 ,p_person_id in number
134 ,p_organization_id in number default null
135 ,p_start_date in date
136 ,p_end_date in date default null
137 ,p_confidential_date in date default null
138 ,p_emp_rights_flag in varchar2 default 'N'
139 ,p_end_of_rights_date in date default null
140 ,p_primary_contact_flag in varchar2 default 'N'
141 ,p_attribute_category in varchar2 default null
142 ,p_attribute1 in varchar2 default null
143 ,p_attribute2 in varchar2 default null
144 ,p_attribute3 in varchar2 default null
145 ,p_attribute4 in varchar2 default null
146 ,p_attribute5 in varchar2 default null
147 ,p_attribute6 in varchar2 default null
148 ,p_attribute7 in varchar2 default null
149 ,p_attribute8 in varchar2 default null
150 ,p_attribute9 in varchar2 default null
151 ,p_attribute10 in varchar2 default null
152 ,p_attribute11 in varchar2 default null
153 ,p_attribute12 in varchar2 default null
154 ,p_attribute13 in varchar2 default null
155 ,p_attribute14 in varchar2 default null
156 ,p_attribute15 in varchar2 default null
157 ,p_attribute16 in varchar2 default null
158 ,p_attribute17 in varchar2 default null
159 ,p_attribute18 in varchar2 default null
160 ,p_attribute19 in varchar2 default null
161 ,p_attribute20 in varchar2 default null
162 ,p_role_information_category in varchar2 default null
163 ,p_role_information1 in varchar2 default null
164 ,p_role_information2 in varchar2 default null
165 ,p_role_information3 in varchar2 default null
166 ,p_role_information4 in varchar2 default null
167 ,p_role_information5 in varchar2 default null
168 ,p_role_information6 in varchar2 default null
169 ,p_role_information7 in varchar2 default null
170 ,p_role_information8 in varchar2 default null
171 ,p_role_information9 in varchar2 default null
172 ,p_role_information10 in varchar2 default null
173 ,p_role_information11 in varchar2 default null
174 ,p_role_information12 in varchar2 default null
175 ,p_role_information13 in varchar2 default null
176 ,p_role_information14 in varchar2 default null
177 ,p_role_information15 in varchar2 default null
178 ,p_role_information16 in varchar2 default null
179 ,p_role_information17 in varchar2 default null
180 ,p_role_information18 in varchar2 default null
181 ,p_role_information19 in varchar2 default null
182 ,p_role_information20 in varchar2 default null
183 ,p_role_id out nocopy number
184 ,p_object_version_number out nocopy number
185 );
186 --
187 -- ----------------------------------------------------------------------------
188 -- |------------------------< update_supplementary_role >---------------------|
189 -- ----------------------------------------------------------------------------
190 --
191 -- {Start Of Comments}
192 /*#
193 * This API updates a supplementary role for a person.
194 *
195 * Supplementary roles are activities a person does for the enterprise but
196 * typically receives no renumeration for doing it, such as fire wardens or
197 * health and safety officers. HRMS also uses supplementary roles to specify
198 * union representatives within the workforce, so you can associate a
199 * supplementary role with a representative body. Before you can give a person
200 * a supplementary role, you must define the role itself by creating a job in
201 * any job group other than the 'Default HR Job Group'. For more details on job
202 * groups, see the package 'HR Job Group APIs'.
203 *
204 * <p><b>Licensing</b><br>
205 * This API is licensed for use with Human Resources.
206 *
207 * <p><b>Prerequisites</b><br>
208 * The supplementary role must exist for the person.
209 *
210 * <p><b>Post Success</b><br>
211 * The supplementary role will be updated.
212 *
213 * <p><b>Post Failure</b><br>
214 * The supplementary role will not be updated and an error will be raised.
215 * @param p_validate If true, then validation alone will be performed and the
216 * database will remain unchanged. If false and all validation checks pass,
217 * then the database will be modified.
218 * @param p_effective_date Reference date for validating lookup values are
219 * applicable during the start to end active date range. This date does not
220 * determine when the changes take effect.
221 * @param p_role_id Uniquely identifies the supplementary role to be updated.
222 * @param p_object_version_number Pass in the current version number of the
223 * supplementary role to be updated. When the API completes if p_validate is
224 * false, will be set to the new version number of the updated supplementary
225 * role If p_validate is true will be set to the same value which was passed
226 * in.
227 * @param p_start_date The start date of the role.
228 * @param p_end_date The end date of the role.
229 * @param p_confidential_date The date on which a confidentiality agreement was
230 * signed. (Some roles require a signed confidentiality agreement.)
231 * @param p_emp_rights_flag Use this flag to indicate whether extended
232 * employment rights are available for this role. Some roles grant additional
233 * employment rights to the employee. For example, termination rules may be
234 * different for union representatives. Valid values are 'Y' or 'N'.
235 * @param p_end_of_rights_date The date that extended employment rights end. If
236 * you terminate an employee before this date, the termination raises a
237 * warning. You can only set this date if the p_emp_rights_flag is set to 'Y'.
238 * @param p_primary_contact_flag Use this flag to indicate whether the person
239 * is a primary contact for this role. (Many people can hold the same role.)
240 * @param p_attribute_category This context value determines which flexfield
241 * structure to use with the descriptive flexfield segments.
242 * @param p_attribute1 Descriptive flexfield segment.
243 * @param p_attribute2 Descriptive flexfield segment.
244 * @param p_attribute3 Descriptive flexfield segment.
245 * @param p_attribute4 Descriptive flexfield segment.
246 * @param p_attribute5 Descriptive flexfield segment.
247 * @param p_attribute6 Descriptive flexfield segment.
248 * @param p_attribute7 Descriptive flexfield segment.
249 * @param p_attribute8 Descriptive flexfield segment.
250 * @param p_attribute9 Descriptive flexfield segment.
251 * @param p_attribute10 Descriptive flexfield segment.
252 * @param p_attribute11 Descriptive flexfield segment.
253 * @param p_attribute12 Descriptive flexfield segment.
254 * @param p_attribute13 Descriptive flexfield segment.
255 * @param p_attribute14 Descriptive flexfield segment.
256 * @param p_attribute15 Descriptive flexfield segment.
257 * @param p_attribute16 Descriptive flexfield segment.
258 * @param p_attribute17 Descriptive flexfield segment.
259 * @param p_attribute18 Descriptive flexfield segment.
260 * @param p_attribute19 Descriptive flexfield segment.
261 * @param p_attribute20 Descriptive flexfield segment.
262 * @param p_role_information_category This context value determines which
263 * Flexfield Structure to use with the Developer Descriptive flexfield
264 * segments.
265 * @param p_role_information1 Developer descriptive flexfield
266 * @param p_role_information2 Developer descriptive flexfield
267 * @param p_role_information3 Developer descriptive flexfield
268 * @param p_role_information4 Developer descriptive flexfield
269 * @param p_role_information5 Developer descriptive flexfield
270 * @param p_role_information6 Developer descriptive flexfield
271 * @param p_role_information7 Developer descriptive flexfield
272 * @param p_role_information8 Developer descriptive flexfield
273 * @param p_role_information9 Developer descriptive flexfield
274 * @param p_role_information10 Developer descriptive flexfield
275 * @param p_role_information11 Developer descriptive flexfield
276 * @param p_role_information12 Developer descriptive flexfield
277 * @param p_role_information13 Developer descriptive flexfield
278 * @param p_role_information14 Developer descriptive flexfield
279 * @param p_role_information15 Developer descriptive flexfield
280 * @param p_role_information16 Developer descriptive flexfield
281 * @param p_role_information17 Developer descriptive flexfield
282 * @param p_role_information18 Developer descriptive flexfield
283 * @param p_role_information19 Developer descriptive flexfield
284 * @param p_role_information20 Developer descriptive flexfield
285 * @param p_old_end_date This is used in internal processing and should not be
286 * passed into the API.
287 * @rep:displayname Update Supplementary Role
288 * @rep:category BUSINESS_ENTITY PER_SUPPLEMENTARY_ROLE
289 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
290 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
291 * @rep:scope public
292 * @rep:lifecycle active
293 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
294 */
295 --
296 -- {End Of Comments}
297 --
301 ,p_role_id in number
298 procedure update_supplementary_role
299 (p_validate in boolean default false
300 ,p_effective_date in date
302 ,p_object_version_number in out nocopy number
303 ,p_start_date in date default hr_api.g_date
304 ,p_end_date in date default hr_api.g_date
305 ,p_confidential_date in date default hr_api.g_date
306 ,p_emp_rights_flag in varchar2 default hr_api.g_varchar2
307 ,p_end_of_rights_date in date default hr_api.g_date
308 ,p_primary_contact_flag in varchar2 default hr_api.g_varchar2
309 ,p_attribute_category in varchar2 default hr_api.g_varchar2
310 ,p_attribute1 in varchar2 default hr_api.g_varchar2
311 ,p_attribute2 in varchar2 default hr_api.g_varchar2
312 ,p_attribute3 in varchar2 default hr_api.g_varchar2
313 ,p_attribute4 in varchar2 default hr_api.g_varchar2
314 ,p_attribute5 in varchar2 default hr_api.g_varchar2
315 ,p_attribute6 in varchar2 default hr_api.g_varchar2
316 ,p_attribute7 in varchar2 default hr_api.g_varchar2
317 ,p_attribute8 in varchar2 default hr_api.g_varchar2
318 ,p_attribute9 in varchar2 default hr_api.g_varchar2
319 ,p_attribute10 in varchar2 default hr_api.g_varchar2
320 ,p_attribute11 in varchar2 default hr_api.g_varchar2
321 ,p_attribute12 in varchar2 default hr_api.g_varchar2
322 ,p_attribute13 in varchar2 default hr_api.g_varchar2
323 ,p_attribute14 in varchar2 default hr_api.g_varchar2
324 ,p_attribute15 in varchar2 default hr_api.g_varchar2
325 ,p_attribute16 in varchar2 default hr_api.g_varchar2
326 ,p_attribute17 in varchar2 default hr_api.g_varchar2
327 ,p_attribute18 in varchar2 default hr_api.g_varchar2
328 ,p_attribute19 in varchar2 default hr_api.g_varchar2
329 ,p_attribute20 in varchar2 default hr_api.g_varchar2
330 ,p_role_information_category in varchar2 default hr_api.g_varchar2
331 ,p_role_information1 in varchar2 default hr_api.g_varchar2
332 ,p_role_information2 in varchar2 default hr_api.g_varchar2
333 ,p_role_information3 in varchar2 default hr_api.g_varchar2
334 ,p_role_information4 in varchar2 default hr_api.g_varchar2
335 ,p_role_information5 in varchar2 default hr_api.g_varchar2
336 ,p_role_information6 in varchar2 default hr_api.g_varchar2
337 ,p_role_information7 in varchar2 default hr_api.g_varchar2
338 ,p_role_information8 in varchar2 default hr_api.g_varchar2
339 ,p_role_information9 in varchar2 default hr_api.g_varchar2
340 ,p_role_information10 in varchar2 default hr_api.g_varchar2
341 ,p_role_information11 in varchar2 default hr_api.g_varchar2
342 ,p_role_information12 in varchar2 default hr_api.g_varchar2
343 ,p_role_information13 in varchar2 default hr_api.g_varchar2
344 ,p_role_information14 in varchar2 default hr_api.g_varchar2
345 ,p_role_information15 in varchar2 default hr_api.g_varchar2
346 ,p_role_information16 in varchar2 default hr_api.g_varchar2
347 ,p_role_information17 in varchar2 default hr_api.g_varchar2
348 ,p_role_information18 in varchar2 default hr_api.g_varchar2
349 ,p_role_information19 in varchar2 default hr_api.g_varchar2
350 ,p_role_information20 in varchar2 default hr_api.g_varchar2
351 ,p_old_end_date in date default hr_api.g_date -- fix 1370960
352 );
353 --
354 -- ----------------------------------------------------------------------------
355 -- |------------------------< delete_supplementary_role >---------------------|
356 -- ----------------------------------------------------------------------------
357 --
358 -- {Start Of Comments}
359 /*#
360 * This API deletes a supplementary role for a person.
361 *
362 * Supplementary roles are activities a person does for the enterprise but
363 * typically receives no renumeration for doing it, such as fire wardens or
364 * health and safety officers. HRMS also uses supplementary roles to specify
365 * union representatives within the workforce, so you can associate a
366 * supplementary role with a representative body. Before you can give a person
367 * a supplementary role, you must define the role itself by creating a job in
368 * any job group other than the 'Default HR Job Group'. For more details on job
369 * groups, see the package 'HR Job Group APIs'.
370 *
371 * <p><b>Licensing</b><br>
372 * This API is licensed for use with Human Resources.
373 *
374 * <p><b>Prerequisites</b><br>
375 * The supplementary role must exist for the person.
376 *
377 * <p><b>Post Success</b><br>
378 * The supplementary role is deleted.
379 *
380 * <p><b>Post Failure</b><br>
381 * The supplementary role is not deleted and an error will be raised.
382 * @param p_validate If true, then validation alone will be performed and the
383 * database will remain unchanged. If false and all validation checks pass,
384 * then the database will be modified.
385 * @param p_role_id Uniquely identifies the supplementary role to be deleted.
386 * @param p_object_version_number Current version number of the supplementary
387 * role to be deleted.
388 * @rep:displayname Delete Supplementary Role
389 * @rep:category BUSINESS_ENTITY PER_SUPPLEMENTARY_ROLE
390 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
391 * @rep:scope public
392 * @rep:lifecycle active
393 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
394 */
395 --
396 -- {End Of Comments}
397 --
398 procedure delete_supplementary_role
399 (p_validate in boolean default false
400 ,p_role_id in number
401 ,p_object_version_number in number
402 );
403 --
404 end per_supplementary_role_api;
[Home] [Help]