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