1 Package AME_APPROVER_GROUP_API as
2 /* $Header: amapgapi.pkh 120.4 2006/12/23 09:54:34 avarri noship $ */
3 /*#
4 * This package contains AME approver group APIs.
5 * @rep:scope public
6 * @rep:product AME
7 * @rep:displayname Approver Group
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-------------------------< CREATE_AME_APPROVER_GROUP >--------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates an approver group.
17 *
18 * Use this API when you need to create an approver group.
19 *
20 * <p><b>Licensing</b><br>
21 * This API is available for use with any licensed component of the e-business
22 * suite.
23 *
24 * <p><b>Prerequisites</b><br>
25 * No known prerequisites.
26 *
27 * <p><b>Post Success</b><br>
28 * The approver group is created.
29 *
30 * <p><b>Post Failure</b><br>
31 * The approver group is not created and an error is 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_LANGUAGE_CODE Specifies to which language the translation values
37 * apply, You can set to the base or any installed language. The default value
38 * of hr_api.userenv_lang is equivalent to the RDBMS userenv('LANG') function
39 * value.
40 * @param P_NAME Name of the approver group.
41 * @param P_DESCRIPTION Description of the approver group.
42 * @param P_IS_STATIC Indicates whether the approver group is static or
43 * dynamic, allowed values are 'Y' and 'N'.
44 * @param P_APPROVAL_GROUP_ID If p_validate is false, then this uniquely
45 * identifies the created approver group. If p_validate is true, then set
46 * to null.
47 * @param P_QUERY_STRING Dynamic sql query string that identifies the members
48 * of the dynamic approver group. The query may reference AME's:transactionId
49 * bind variable.
50 * @param P_OBJECT_VERSION_NUMBER If p_validate is false, then set to
51 * the version number of the approver group. If p_validate is true, then set
52 * to null.
53 * @param P_START_DATE If p_validate is false, then set to the effective
54 * start date of the approver group. If p_validate is true, then set to null.
55 * @param P_END_DATE It is the date up to, which the approver group is
56 * effective. If p_validate is false, then set to 31-Dec-4712. If p_validate
57 * is true, then set to null.
58 * @rep:displayname Create Ame Approver Group
59 * @rep:lifecycle active
60 * @rep:category BUSINESS_ENTITY AME_APPROVER_GROUP
61 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
62 * @rep:scope public
63 */
64 --
65 -- {End Of Comments}
66 --
67 procedure create_ame_approver_group
68 (p_validate in boolean default false
69 ,p_language_code in varchar2 default
70 hr_api.userenv_lang
71 ,p_name in varchar2
72 ,p_description in varchar2
73 ,p_is_static in varchar2
74 ,p_query_string in varchar2 default null
75 ,p_approval_group_id out nocopy number
76 ,p_start_date out nocopy date
77 ,p_end_date out nocopy date
78 ,p_object_version_number out nocopy number
79 );
80 --
81 -- ----------------------------------------------------------------------------
82 -- |----------------------< UPDATE_AME_APPROVER_GROUP >-----------------------|
83 -- ----------------------------------------------------------------------------
84 --
85 -- {Start Of Comments}
86 /*#
87 * This API updates the approver group.
88 *
89 * Use this API when you need to update an approver group.
90 *
91 * <p><b>Licensing</b><br>
92 * This API is available for use with any licensed component of the e-business
93 * suite.
94 *
95 * <p><b>Prerequisites</b><br>
96 * A valid group should exist.
97 *
98 * <p><b>Post Success</b><br>
99 * Approver group is updated.
100 *
101 * <p><b>Post Failure</b><br>
102 * The approver group is not updated and an error is raised.
103 *
104 * @param P_VALIDATE If true, then validation alone will be performed and the
105 * database will remain unchanged. If false and all validation checks pass,
106 * then the database will be modified.
107 * @param P_LANGUAGE_CODE Specifies to which language the translation values
108 * apply. You can set to the base or any installed language.
109 * The default value of hr_api.userenv_lang is equivalent to the RDBMS
110 * userenv('LANG') function value.
111 * @param P_DESCRIPTION Description of the approver group.
112 * @param P_IS_STATIC Indicates whather the approver group has static or
113 * dynamic, allowed values are 'Y' and 'N'.
114 * @param P_APPROVAL_GROUP_ID Approver group that has to be updated.
115 * @param P_QUERY_STRING Query to find the member when approver group
116 * is dynamic.
117 * @param P_OBJECT_VERSION_NUMBER Pass in the current version number of
118 * the approver group to be updated. When the API completes, if p_validate is
119 * false, it will be set to the new version number of the updated
120 * approver group. If p_validate is true will be set to the same value which
121 * was passed in.
122 * @param P_START_DATE If p_validate is false, It is set to present date.
123 * If p_validate is true, it is set null.
124 * @param P_END_DATE It is the date up to, which the updated approver group is
125 * effective. If p_validate is false, it is set to null.
126 * If p_validate is true, it is set to the same date which was passed in.
127 * @rep:displayname Update Ame Approver Group
128 * @rep:lifecycle active
129 * @rep:category BUSINESS_ENTITY AME_APPROVER_GROUP
130 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
131 * @rep:scope public
132 */
133 --
134 -- {End Of Comments}
135 --
136 procedure update_ame_approver_group
137 (p_validate in boolean default false
138 ,p_approval_group_id in number
139 ,p_language_code in varchar2 default
140 hr_api.userenv_lang
141 ,p_description in varchar2 default hr_api.g_varchar2
142 ,p_is_static in varchar2 default hr_api.g_varchar2
143 ,p_query_string in varchar2 default hr_api.g_varchar2
144 ,p_object_version_number in out nocopy number
145 ,p_start_date out nocopy date
146 ,p_end_date out nocopy date
147 );
148 --
149 -- ----------------------------------------------------------------------------
150 -- |-------------------< DELETE_AME_APPROVER_GROUP >--------------------------|
151 -- ----------------------------------------------------------------------------
152 --
153 -- {Start Of Comments}
154 /*#
155 * This API deletes an approver group.
156 *
157 * Use this API when you need to delete an approver group.
158 *
159 * <p><b>Licensing</b><br>
160 * This API is available for use with any licensed component of the e-business
161 * suite.
162 *
163 * <p><b>Prerequisites</b><br>
164 * No approver group config should exist for the group.
165 *
166 * <p><b>Post Success</b><br>
167 * The approver group is deleted.
168 *
169 * <p><b>Post Failure</b><br>
170 * The approver group is not deleted and an error is raised.
171 *
172 * @param P_VALIDATE If true, then validation alone will be performed and the
173 * database will remain unchanged. If false and all validation checks pass,
174 * then the database will be modified.
175 * @param P_APPROVAL_GROUP_ID ID of the approver group that has to be deleted.
176 * @param P_OBJECT_VERSION_NUMBER Pass in the current version number of the
177 * approver group to be deleted. When the API completes, if p_validate,
178 * is false, it will be set to the new version number of the deleted
179 * approver group. If p_validate is true will be set to the same value
180 * which was passed in.
181 * @param P_START_DATE If p_validate is false, it is set to the date from
182 * which the deleted approver group was effective. If p_validate is true,
183 * it is set null.
184 * @param P_END_DATE If p_validate is false, it is set to present date.
185 * If p_validate is true, it is set to null.
186 * @rep:displayname Delete Ame Approver Group
187 * @rep:lifecycle active
188 * @rep:category BUSINESS_ENTITY AME_APPROVER_GROUP
189 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
190 * @rep:scope public
191 */
192 --
193 -- {End Of Comments}
194 --
195 procedure delete_ame_approver_group
196 (p_validate in boolean default false
197 ,p_approval_group_id in number
198 ,p_object_version_number in out nocopy number
199 ,p_start_date out nocopy date
200 ,p_end_date out nocopy date
201 );
202 --
203 -- ----------------------------------------------------------------------------
204 -- |-----------------------< create_approver_group_config >-------------------|
205 -- ----------------------------------------------------------------------------
206 --
207 -- {Start Of Comments}
208 /*#
209 * This API creates an approver group config with default values.
210 *
211 * Use this API when you need to create an approver group config with default
212 * values.
213 *
214 * <p><b>Licensing</b><br>
215 * This API is available for use with any licensed component of the e-business
216 * suite.
217 *
218 * <p><b>Prerequisites</b><br>
219 * Valid approver group and valid transaction type should exist.
220 *
221 * <p><b>Post Success</b><br>
222 * The approver group config is created.
223 *
224 * <p><b>Post Failure</b><br>
225 * The approver group config is not created and an error is raised.
226 *
227 * @param P_VALIDATE If true, then validation alone will be performed and the
228 * database will remain unchanged. If false and all validation checks pass,
229 * then the database will be modified.
230 * @param P_APPLICATION_ID Transaction type for which approver group config
231 * is created.
232 * @param P_APPROVAL_GROUP_ID Uniquely identifies the approver group
233 * for which config has to be created.
234 * @param P_VOTING_REGIME The voting regime for the approver group config.
235 * The valid values are in the lookup type AME_APG_VOTING_REGIME.
236 * @param P_ORDER_NUMBER The order number of the group in the given
237 * transaction type (used for parallelization).
238 * @param P_OBJECT_VERSION_NUMBER If p_validate is false, then set to
239 * the version number of the created approver group config. If p_validate is
240 * true, then set to null.
241 * @param P_START_DATE If p_validate is false, then set to the effective
242 * start date for the created approver group config. If p_validate is true,
243 * then set to null.
244 * @param P_END_DATE It is the date up to, which the approver group config is
245 * effective. If p_validate is false, then set to 31-Dec-4712. If p_validate
246 * is true, then set to null.
247 * @rep:displayname Create Ame Approver Group Config
248 * @rep:lifecycle active
249 * @rep:category BUSINESS_ENTITY AME_APPROVER_GROUP
250 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
251 * @rep:scope public
252 */
253 --
254 -- {End Of Comments}
255 --
256 procedure create_approver_group_config
257 (
258 p_validate in boolean default false
259 ,p_approval_group_id in number
260 ,p_application_id in number
261 ,p_voting_regime in varchar2
262 ,p_order_number in number default null
263 ,p_object_version_number out nocopy number
264 ,p_start_date out nocopy date
265 ,p_end_date out nocopy date
266 );
267 --
268 -- ----------------------------------------------------------------------------
269 -- |-----------------------< delete_approver_group_config >-------------------|
270 -- ----------------------------------------------------------------------------
271 --
272 -- {Start Of Comments}
273 /*#
274 *This API deletes approver group config.
275 *
276 * Use this API when you need to delete an approver group config.
277 *
278 * <p><b>Licensing</b><br>
279 * This API is available for use with any licensed component of the e-business
280 * suite.
281 *
282 * <p><b>Prerequisites</b><br>
283 * A valid group and a valid transaction type should exist.
284 *
285 * The approver group should not be in use by any of the active rules in
286 * the transaction type specified by the parameter P_APPLICATION_ID.
287 *
288 * <p><b>Post Success</b><br>
289 * The approver group config is deleted.
290 *
291 * <p><b>Post Failure</b><br>
292 * The approver group config is not deleted and an error is raised.
293 *
294 * @param P_VALIDATE If true, then validation alone will be performed and the
295 * database will remain unchanged. If false and all validation checks pass,
296 * then the database will be modified.
297 * @param P_START_DATE If p_validate is false, it is set to the date from
298 * which the deleted approver group config was effective.
299 * If p_validate is true, it is set to null.
300 * @param P_END_DATE If p_validate is false, it is set to present date.
301 * If p_validate is true, it is set to null.
302 * @param P_APPLICATION_ID Transaction type for which the approver group config
303 * is to be deleted.
304 * @param P_APPROVAL_GROUP_ID Approver group for which config is deleted.
305 * @param P_OBJECT_VERSION_NUMBER Pass in the current version number of
306 * the approver group config to be deleted. When the API completes
307 * if p_validate is false, will be set to the new version number of the
308 * deleted approver group config. If p_validate is true will be set to the
309 * same value which was passed in.
310 * @rep:displayname Delete Ame Approver Group Config
311 * @rep:lifecycle active
312 * @rep:category BUSINESS_ENTITY AME_APPROVER_GROUP
313 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
314 * @rep:scope public
315 */
316 --
317 -- {End Of Comments}
318 --
319 procedure delete_approver_group_config
320 (
321 p_validate in boolean default false
322 ,p_approval_group_id in number
323 ,p_application_id in number
324 ,p_object_version_number in out nocopy number
325 ,p_start_date out nocopy date
326 ,p_end_date out nocopy date
327 );
328 --
329 -- ----------------------------------------------------------------------------
330 -- |-----------------------< update_approver_group_config >-------------------|
331 -- ----------------------------------------------------------------------------
332 --
333 -- {Start Of Comments}
334 /*#
335 *This API updates an approver group config.
336 *
337 * Use this API when you need to update an approver group config.
338 *
339 * <p><b>Licensing</b><br>
340 * This API is available for use with any licensed component of the e-business
341 * suite.
342 *
343 * <p><b>Prerequisites</b><br>
344 * A valid approver group and transaction type should exist.
345 *
346 * <p><b>Post Success</b><br>
347 * The approver group config is updated.
348 *
349 *
350 * <p><b>Post Failure</b><br>
351 * The approver group config is not updated and an error is raised.
352 *
353 *
354 * @param P_APPLICATION_ID Transaction type for which approver group config
355 * has to be modified.
356 * @param P_VALIDATE If true, then validation alone will be performed and the
357 * database will remain unchanged. If false and all validation checks pass,
358 * then the database will be modified.
359 * @param P_APPROVAL_GROUP_ID ID of the approver group for which the
360 * approver group config has to be modified.
361 * @param P_VOTING_REGIME Voting regime for the approver group config.
362 * @param P_ORDER_NUMBER Order number of the group config in the given
363 * transaction type (used for parallelization).
364 * @param P_OBJECT_VERSION_NUMBER Pass in the current version number
365 * of the approver group config to be updated. When the API completes
366 * if p_validate is false, will be set to the new version number of
367 * the updated approver group config.
368 * If p_validate is true will be set to the same value which was passed in.
369 * @param P_START_DATE If p_validate is false, It is set to present date.
370 * If p_validate is true, it is set to null.
371 * @param P_END_DATE It is the date up to, which the updated
372 * approver group config is effective. If p_validate is false, It is set
373 * to 31-Dec-4712. If p_validate is true, it is set to null.
374 * @rep:displayname Update Ame Approver Group config
375 * @rep:lifecycle active
376 * @rep:category BUSINESS_ENTITY AME_APPROVER_GROUP
377 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
378 * @rep:scope public
379 */
380 --
381 -- {End Of Comments}
382 --
383 procedure update_approver_group_config
384 (
385 p_validate in boolean default false
386 ,p_approval_group_id in number
387 ,p_application_id in number
388 ,p_voting_regime in varchar2 default hr_api.g_varchar2
389 ,p_order_number in varchar2 default hr_api.g_number
390 ,p_object_version_number in out nocopy number
391 ,p_start_date out nocopy date
392 ,p_end_date out nocopy date
393 );
394 --
395 -- ----------------------------------------------------------------------------
396 -- |-----------------------< create_approver_group_item >---------------------|
397 -- ----------------------------------------------------------------------------
398 --
399 -- {Start Of Comments}
400 /*#
401 * This API adds member to a static approver group.
402 *
403 * Use this API when you need to create approver group member. The member can
404 * be either a wf_roles or a nested group.
405 *
406 * <p><b>Licensing</b><br>
407 * This API is available for use with any licensed component of the e-business
408 * suite.
409 *
410 * <p><b>Prerequisites</b><br>
411 * A approver group should exist.
412 *
413 * <p><b>Post Success</b><br>
414 * Member is added to the approver group.
415 *
416 * <p><b>Post Failure</b><br>
417 * Member is not added to the approver group and an error is raised.
418 *
419 * @param P_VALIDATE If true, then validation alone will be performed and the
420 * database will remain unchanged. If false and all validation checks pass,
421 * then the database will be modified.
422 * @param P_APPROVAL_GROUP_ID Approver group to which member is added.
423 * @param P_PARAMETER_NAME IF equals 'wf_roles_name' then group member is
424 * normal wf_roles_name.
425 * If equals 'oam_group_id' then member is a nested group.
426 * @param P_PARAMETER If P_PARAMETER_NAME equals wf_roles_name then
427 * P_PARAMETER gives wf_roles_name. Otherwise specifies nested group.
428 * @param P_APPROVAL_GROUP_ITEM_ID If p_is_static is false then uniquely
429 * identifies the group member. If p_is_static true then returns null.
430 * @param P_ORDER_NUMBER Group member order number.
431 * @param P_OBJECT_VERSION_NUMBER If p_validate is false, then set to
432 * the version number of the created approver group item. If p_validate is
433 * true, then set to null.
434 * @param P_START_DATE If p_validate is false, then set to the effective
435 * start date for the created approver group member. If p_validate is true,
436 * then set to null.
437 * @param P_END_DATE It is the date up to, which the approver group member
438 * is effective. If p_validate is false, then set to 31-Dec-4712.
439 * If p_validate is true, then set to null.
440 * @rep:displayname Create Ame Approver Group Item
441 * @rep:lifecycle active
442 * @rep:category BUSINESS_ENTITY AME_APPROVER_GROUP
443 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
444 * @rep:scope public
445 */
446 --
447 -- {End Of Comments}
448 --
449 procedure create_approver_group_item
450 (
451 p_validate in boolean default false
452 ,p_approval_group_id in number
453 ,p_parameter_name in varchar2
454 ,p_parameter in varchar2
455 ,p_order_number in number
456 ,p_approval_group_item_id out nocopy number
457 ,p_object_version_number out nocopy number
458 ,p_start_date out nocopy date
459 ,p_end_date out nocopy date
460 );
461 --
462 -- ----------------------------------------------------------------------------
463 -- |-----------------------< delete_approver_group_item >---------------------|
464 -- ----------------------------------------------------------------------------
465 --
466 -- {Start Of Comments}
467 /*#
468 * This API deletes group member from a static approver group. Member can be
469 * wf_roles or nested group.
470 *
471 * Use this API when you need to delete a given approver group member.
472 *
473 * <p><b>Licensing</b><br>
474 * This API is available for use with any licensed component of the e-business
475 * suite.
476 *
477 * <p><b>Prerequisites</b><br>
478 * Valid approver group and valid approver group member should exist.
479 *
480 * <p><b>Post Success</b><br>
481 * The approver group member is deleted from the approver group.
482 *
483 *
484 * <p><b>Post Failure</b><br>
485 * The approver group member is not deleted and an error is raised.
486 *
487 * @param P_VALIDATE If true, then validation alone will be performed and the
488 * database will remain unchanged. If false and all validation checks pass,
489 * then the database will be modified.
490 * @param P_APPROVAL_GROUP_ITEM_ID Group member that has to be deleted from
491 * the approver group.
492 * @param P_OBJECT_VERSION_NUMBER Pass in the current version number of
493 * the approver group item to be deleted. When the API completes if p_validate
494 * is false, will be set to the new version number of the deleted
495 * approver group config. If p_validate is true will be set to the same value
496 * which was passed in.
497 * @param P_START_DATE If p_validate is false, it is set to the date
498 * from which the deleted approver group item was effective.
499 * If p_validate is true, it is set to null.
500 * @param P_END_DATE If p_validate is false, it is set to present date.
501 * If p_validate is true, it is set to null.
502 * @rep:displayname Delete Ame Approver Group Item
503 * @rep:lifecycle active
504 * @rep:category BUSINESS_ENTITY AME_APPROVER_GROUP
505 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
506 * @rep:scope public
507 */
508 --
509 -- {End Of Comments}
510 --
511 procedure delete_approver_group_item
512 (
513 p_validate in boolean default false
514 ,p_approval_group_item_id in number
515 ,p_object_version_number in out nocopy number
516 ,p_start_date out nocopy date
517 ,p_end_date out nocopy date
518 );
519 --
520 -- ----------------------------------------------------------------------------
521 -- |-----------------------< update_approver_group_item >---------------------|
522 -- ----------------------------------------------------------------------------
523 --
524 -- {Start Of Comments}
525 /*#
526 * This API updates a given approver group member.
527 *
528 * Use this API when you need to update a given approver group member.
529 *
530 * <p><b>Licensing</b><br>
531 * This API is available for use with any licensed component of the e-business
532 * suite.
533 *
534 * <p><b>Prerequisites</b><br>
535 * A valid approver group should exist.
536 *
537 * <p><b>Post Success</b><br>
538 * The approver group member is updated.
539 *
540 * <p><b>Post Failure</b><br>
541 * The approver group member is not updated and an error is raised.
542 *
543 * @param P_VALIDATE If true, then validation alone will be performed and the
544 * database will remain unchanged. If false and all validation checks pass,
545 * then the database will be modified.
546 * @param P_APPROVAL_GROUP_ITEM_ID ID of the approver group member that
547 * has to be modified.
548 * @param P_ORDER_NUMBER Group member order number.
549 * @param P_OBJECT_VERSION_NUMBER Pass in the current version number of the
550 * approver group item to be updated. When the API completes if p_validate
551 * is false, will be set to the new version number of the updated
552 * approver group item. If p_validate is true will be set to the same value
553 * which was passed in.
554 * @param P_START_DATE If p_validate is false, It is set to present date.
555 * If p_validate is true, it is set to null.
556 * @param P_END_DATE It is the date up to, which the updated approver group item
557 * is effective. If p_validate is false, It is set to 31-Dec-4712.
558 * If p_validate is true, it is set to null.
559 * @rep:displayname Update Ame Approver Group Item
560 * @rep:lifecycle active
561 * @rep:category BUSINESS_ENTITY AME_APPROVER_GROUP
562 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
563 * @rep:scope public
564 */
565 --
566 -- {End Of Comments}
567 --
571 ,p_approval_group_item_id in number
568 procedure update_approver_group_item
569 (
570 p_validate in boolean default false
572 ,p_order_number in varchar2 default hr_api.g_number
573 ,p_object_version_number in out nocopy number
574 ,p_start_date out nocopy date
575 ,p_end_date out nocopy date
576 );
577
578 end AME_APPROVER_GROUP_API;
[Home] [Help]