[Home] [Help]
PACKAGE: APPS.PER_ALLOCATED_CHECKLIST_API
Source
1 Package PER_ALLOCATED_CHECKLIST_API as
2 /* $Header: pepacapi.pkh 120.2 2005/12/13 03:15:03 lsilveir noship $ */
3 /*#
4 * This package contains APIs for maintaining allocated checklists.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Allocated Checklist
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |--------------------------< create_alloc_checklist >----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a new allocated checklist. These are checklists that are
17 * attached to a person or an assignment.
18 *
19 * <p><b>Licensing</b><br>
20 * This API is licensed for use with HR Foundation.
21 *
22 * <p><b>Prerequisites</b><br>
23 * A valid person ID must be passed in to the API. Additionally an optional
24 * assignment ID can be passed in.
25 *
26 * <p><b>Post Success</b><br>
27 * The API creates the allocated checklist successfully in the database.
28 *
29 * <p><b>Post Failure</b><br>
30 * The allocated checklist is not created in the database and an error is
31 * raised.
32 *
33 * @param p_validate If true, then validation alone will be performed and the
34 * database will remain unchanged. If false and all validation checks pass,
35 * then the database will be modified.
36 * @param p_effective_date The date on which the checklist is allocated.
37 * @param p_checklist_id The setup checklist used to build this allocated
38 * checklist.
39 * @param p_person_id The person to whom this checklist is to be allocated.
40 * @param p_assignment_id The assignment to which this checklist is to be
41 * allocated.
42 * @param p_checklist_name The allocated checklist name.
43 * @param p_description The allocated checklist description.
44 * @param p_checklist_category The checklist category.
45 * @param p_attribute_category This context value determines which flexfield
46 * structure to use with the descriptive flexfield segments.
47 * @param p_attribute1 Descriptive flexfield segment.
48 * @param p_attribute2 Descriptive flexfield segment.
49 * @param p_attribute3 Descriptive flexfield segment.
50 * @param p_attribute4 Descriptive flexfield segment.
51 * @param p_attribute5 Descriptive flexfield segment.
52 * @param p_attribute6 Descriptive flexfield segment.
53 * @param p_attribute7 Descriptive flexfield segment.
54 * @param p_attribute8 Descriptive flexfield segment.
55 * @param p_attribute9 Descriptive flexfield segment.
56 * @param p_attribute10 Descriptive flexfield segment.
57 * @param p_attribute11 Descriptive flexfield segment.
58 * @param p_attribute12 Descriptive flexfield segment.
59 * @param p_attribute13 Descriptive flexfield segment.
60 * @param p_attribute14 Descriptive flexfield segment.
61 * @param p_attribute15 Descriptive flexfield segment.
62 * @param p_attribute16 Descriptive flexfield segment.
63 * @param p_attribute17 Descriptive flexfield segment.
64 * @param p_attribute18 Descriptive flexfield segment.
65 * @param p_attribute19 Descriptive flexfield segment.
66 * @param p_attribute20 Descriptive flexfield segment.
67 * @param p_information_category This context value determines which flexfield
68 * structure to use with the developer descriptive flexfield segments.
69 * @param p_information1 Developer descriptive flexfield segment.
70 * @param p_information2 Developer descriptive flexfield segment.
71 * @param p_information3 Developer descriptive flexfield segment.
72 * @param p_information4 Developer descriptive flexfield segment.
73 * @param p_information5 Developer descriptive flexfield segment.
74 * @param p_information6 Developer descriptive flexfield segment.
75 * @param p_information7 Developer descriptive flexfield segment.
76 * @param p_information8 Developer descriptive flexfield segment.
77 * @param p_information9 Developer descriptive flexfield segment.
78 * @param p_information10 Developer descriptive flexfield segment.
79 * @param p_information11 Developer descriptive flexfield segment.
80 * @param p_information12 Developer descriptive flexfield segment.
81 * @param p_information13 Developer descriptive flexfield segment.
82 * @param p_information14 Developer descriptive flexfield segment.
83 * @param p_information15 Developer descriptive flexfield segment.
84 * @param p_information16 Developer descriptive flexfield segment.
85 * @param p_information17 Developer descriptive flexfield segment.
86 * @param p_information18 Developer descriptive flexfield segment.
87 * @param p_information19 Developer descriptive flexfield segment.
88 * @param p_information20 Developer descriptive flexfield segment.
89 * @param p_allocated_checklist_id If p_validate is false, then this
90 * uniquely identifies the allocated checklist created. If p_validate
91 * is true, then set to null.
92 * @param p_object_version_number If p_validate is false, then set to the
93 * version number of the created allocated checklist. If p_validate is true,
94 * then the value will be null.
95 * @rep:displayname Create Allocated Checklist
96 * @rep:category BUSINESS_ENTITY PER_APPLICANT
97 * @rep:category BUSINESS_ENTITY PER_EMPLOYEE
98 * @rep:category BUSINESS_ENTITY PER_CWK
99 * @rep:lifecycle active
100 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
101 * @rep:scope public
102 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
103 */
104 --
105 -- {End Of Comments}
106 --
107 procedure CREATE_ALLOC_CHECKLIST
108 (p_validate in boolean default false
109 ,p_effective_date in date
110 ,p_checklist_id in number default null
111 ,p_person_id in number
112 ,p_assignment_id in number default null
113 ,p_checklist_name in varchar2 default null
114 ,p_description in varchar2 default null
115 ,p_checklist_category in varchar2 default null
116 ,p_attribute_category in varchar2 default null
117 ,p_attribute1 in varchar2 default null
118 ,p_attribute2 in varchar2 default null
119 ,p_attribute3 in varchar2 default null
120 ,p_attribute4 in varchar2 default null
121 ,p_attribute5 in varchar2 default null
122 ,p_attribute6 in varchar2 default null
123 ,p_attribute7 in varchar2 default null
124 ,p_attribute8 in varchar2 default null
125 ,p_attribute9 in varchar2 default null
126 ,p_attribute10 in varchar2 default null
127 ,p_attribute11 in varchar2 default null
128 ,p_attribute12 in varchar2 default null
129 ,p_attribute13 in varchar2 default null
130 ,p_attribute14 in varchar2 default null
131 ,p_attribute15 in varchar2 default null
132 ,p_attribute16 in varchar2 default null
133 ,p_attribute17 in varchar2 default null
134 ,p_attribute18 in varchar2 default null
135 ,p_attribute19 in varchar2 default null
136 ,p_attribute20 in varchar2 default null
137 ,p_information_category in varchar2 default null
138 ,p_information1 in varchar2 default null
139 ,p_information2 in varchar2 default null
140 ,p_information3 in varchar2 default null
141 ,p_information4 in varchar2 default null
142 ,p_information5 in varchar2 default null
143 ,p_information6 in varchar2 default null
144 ,p_information7 in varchar2 default null
145 ,p_information8 in varchar2 default null
146 ,p_information9 in varchar2 default null
147 ,p_information10 in varchar2 default null
148 ,p_information11 in varchar2 default null
149 ,p_information12 in varchar2 default null
150 ,p_information13 in varchar2 default null
151 ,p_information14 in varchar2 default null
152 ,p_information15 in varchar2 default null
153 ,p_information16 in varchar2 default null
154 ,p_information17 in varchar2 default null
155 ,p_information18 in varchar2 default null
156 ,p_information19 in varchar2 default null
157 ,p_information20 in varchar2 default null
158 ,p_allocated_checklist_id out nocopy number
159 ,p_object_version_number out nocopy number
160 );
161 --
162 -- ----------------------------------------------------------------------------
163 -- |--------------------------< update_alloc_checklist >----------------------|
164 -- ----------------------------------------------------------------------------
165 --
166 -- {Start Of Comments}
167 /*#
168 * This API updates an existing Allocated Checklist. These are checklists that
169 * are attached to a person or an assignment.
170 *
171 * <p><b>Licensing</b><br>
172 * This API is licensed for use with HR Foundation.
173 *
174 * <p><b>Prerequisites</b><br>
175 * The allocated checklist that is to be updated must already exist.
176 *
177 * <p><b>Post Success</b><br>
178 * The API updates the allocated checklist successfully in the database.
179 *
180 * <p><b>Post Failure</b><br>
181 * The allocated checklist is not updated in the database and an error is
182 * raised.
183 *
184 * @param p_validate If true, then validation alone will be performed and the
185 * database will remain unchanged. If false and all validation checks pass,
186 * then the database will be modified.
187 * @param p_effective_date The date on which the allocated checklist is
188 * updated.
189 * @param p_allocated_checklist_id Identifies the allocated checklist to
190 * be updated.
191 * @param p_checklist_id The setup checklist used to build this checklist.
192 * @param p_person_id The person to whom this checklist is allocated.
193 * @param p_assignment_id The assignment to which this checklist is allocated.
194 * @param p_checklist_name The allocated checklist name.
195 * @param p_description The allocated checklist description.
196 * @param p_checklist_category The checklist category.
197 * @param p_attribute_category This context value determines which flexfield
198 * structure to use with the descriptive flexfield segments.
199 * @param p_attribute1 Descriptive flexfield segment.
200 * @param p_attribute2 Descriptive flexfield segment.
201 * @param p_attribute3 Descriptive flexfield segment.
202 * @param p_attribute4 Descriptive flexfield segment.
203 * @param p_attribute5 Descriptive flexfield segment.
204 * @param p_attribute6 Descriptive flexfield segment.
205 * @param p_attribute7 Descriptive flexfield segment.
206 * @param p_attribute8 Descriptive flexfield segment.
207 * @param p_attribute9 Descriptive flexfield segment.
208 * @param p_attribute10 Descriptive flexfield segment.
209 * @param p_attribute11 Descriptive flexfield segment.
210 * @param p_attribute12 Descriptive flexfield segment.
211 * @param p_attribute13 Descriptive flexfield segment.
212 * @param p_attribute14 Descriptive flexfield segment.
213 * @param p_attribute15 Descriptive flexfield segment.
214 * @param p_attribute16 Descriptive flexfield segment.
215 * @param p_attribute17 Descriptive flexfield segment.
216 * @param p_attribute18 Descriptive flexfield segment.
217 * @param p_attribute19 Descriptive flexfield segment.
218 * @param p_attribute20 Descriptive flexfield segment.
219 * @param p_information_category This context value determines which flexfield
220 * structure to use with the developer descriptive flexfield segments.
221 * @param p_information1 Developer descriptive flexfield segment.
222 * @param p_information2 Developer descriptive flexfield segment.
223 * @param p_information3 Developer descriptive flexfield segment.
224 * @param p_information4 Developer descriptive flexfield segment.
225 * @param p_information5 Developer descriptive flexfield segment.
226 * @param p_information6 Developer descriptive flexfield segment.
227 * @param p_information7 Developer descriptive flexfield segment.
228 * @param p_information8 Developer descriptive flexfield segment.
229 * @param p_information9 Developer descriptive flexfield segment.
230 * @param p_information10 Developer descriptive flexfield segment.
231 * @param p_information11 Developer descriptive flexfield segment.
232 * @param p_information12 Developer descriptive flexfield segment.
233 * @param p_information13 Developer descriptive flexfield segment.
234 * @param p_information14 Developer descriptive flexfield segment.
235 * @param p_information15 Developer descriptive flexfield segment.
236 * @param p_information16 Developer descriptive flexfield segment.
237 * @param p_information17 Developer descriptive flexfield segment.
238 * @param p_information18 Developer descriptive flexfield segment.
239 * @param p_information19 Developer descriptive flexfield segment.
240 * @param p_information20 Developer descriptive flexfield segment.
241 * @param p_object_version_number Pass in the current version number of the
242 * allocated checklist to be updated. When the API completes if p_validate
243 * is false, it will be set to the new version number of the updated allocated
244 * checklist. If p_validate is true it will be set to the same value which was
245 * passed in.
246 * @rep:displayname Update Allocated Checklist
247 * @rep:category BUSINESS_ENTITY PER_APPLICANT
248 * @rep:category BUSINESS_ENTITY PER_EMPLOYEE
252 * @rep:scope public
249 * @rep:category BUSINESS_ENTITY PER_CWK
250 * @rep:lifecycle active
251 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
253 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
254 */
255 --
256 -- {End Of Comments}
257 --
258 procedure UPDATE_ALLOC_CHECKLIST
259 (p_validate in boolean default false
260 ,p_effective_date in date
261 ,p_allocated_checklist_id in number
262 ,p_checklist_id in number default null
263 ,p_person_id in number default null
264 ,p_assignment_id in number default null
265 ,p_checklist_name in varchar2 default null
266 ,p_description in varchar2 default null
267 ,p_checklist_category in varchar2 default null
268 --
269 ,p_attribute_category in varchar2 default null
270 ,p_attribute1 in varchar2 default null
271 ,p_attribute2 in varchar2 default null
272 ,p_attribute3 in varchar2 default null
273 ,p_attribute4 in varchar2 default null
274 ,p_attribute5 in varchar2 default null
275 ,p_attribute6 in varchar2 default null
276 ,p_attribute7 in varchar2 default null
277 ,p_attribute8 in varchar2 default null
278 ,p_attribute9 in varchar2 default null
279 ,p_attribute10 in varchar2 default null
280 ,p_attribute11 in varchar2 default null
281 ,p_attribute12 in varchar2 default null
282 ,p_attribute13 in varchar2 default null
283 ,p_attribute14 in varchar2 default null
284 ,p_attribute15 in varchar2 default null
285 ,p_attribute16 in varchar2 default null
286 ,p_attribute17 in varchar2 default null
287 ,p_attribute18 in varchar2 default null
288 ,p_attribute19 in varchar2 default null
289 ,p_attribute20 in varchar2 default null
290 ,p_information_category in varchar2 default null
291 ,p_information1 in varchar2 default null
292 ,p_information2 in varchar2 default null
293 ,p_information3 in varchar2 default null
294 ,p_information4 in varchar2 default null
295 ,p_information5 in varchar2 default null
296 ,p_information6 in varchar2 default null
297 ,p_information7 in varchar2 default null
298 ,p_information8 in varchar2 default null
299 ,p_information9 in varchar2 default null
300 ,p_information10 in varchar2 default null
301 ,p_information11 in varchar2 default null
302 ,p_information12 in varchar2 default null
303 ,p_information13 in varchar2 default null
304 ,p_information14 in varchar2 default null
305 ,p_information15 in varchar2 default null
306 ,p_information16 in varchar2 default null
307 ,p_information17 in varchar2 default null
308 ,p_information18 in varchar2 default null
309 ,p_information19 in varchar2 default null
310 ,p_information20 in varchar2 default null
311 ,p_object_version_number in out nocopy number
312 );
313 --
314 -- ----------------------------------------------------------------------------
315 -- |--------------------------< delete_alloc_checklist >----------------------|
316 -- ----------------------------------------------------------------------------
317 --
318 -- {Start Of Comments}
319 /*#
320 * This API deletes an existing Allocated Checklist. These are checklists that
321 * are attached to a person or an assignment.
322 *
323 * <p><b>Licensing</b><br>
324 * This API is licensed for use with HR Foundation.
325 *
326 * <p><b>Prerequisites</b><br>
327 * The allocated checklist that is to be deleted must already exist.
328 *
329 * <p><b>Post Success</b><br>
330 * The API deletes the allocated checklist successfully from the database.
331 *
332 * <p><b>Post Failure</b><br>
333 * The allocated checklist is not deleted from the database and an error is
334 * raised.
335 *
336 * @param p_validate If true, then validation alone will be performed and the
337 * database will remain unchanged. If false and all validation checks pass,
338 * then the database will be modified.
339 * @param p_allocated_checklist_id Identifies the allocated checklist to be
340 * deleted.
341 * @param p_object_version_number Current version number of the allocated
342 * checklist to be deleted.
343 * @rep:displayname Delete Allocated Checklist.
344 * @rep:category BUSINESS_ENTITY PER_APPLICANT
345 * @rep:category BUSINESS_ENTITY PER_EMPLOYEE
346 * @rep:category BUSINESS_ENTITY PER_CWK
347 * @rep:lifecycle active
348 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
349 * @rep:scope public
350 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
351 */
352 --
353 -- {End Of Comments}
354 --
355 procedure DELETE_ALLOC_CHECKLIST
356 (p_validate in boolean default false
357 ,p_allocated_checklist_id in number
358 ,p_object_version_number in number
359 );
360
361
362 end PER_ALLOCATED_CHECKLIST_API;