1 package ame_api3 as
2 /* $Header: ameeapi3.pkh 120.5 2006/10/12 11:58:50 avarri noship $ */
3 /*#
4 * This API package contains ancillary routines.
5 * @rep:scope public
6 * @rep:product AME
7 * @rep:displayname Ancillary Parallel Approvers Process
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------------< getruledescription >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API returns the description of the rule for a rule primary key.
17 *
18 * Rule descriptions are atmost 100 bytes long.
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 API will return the rule description.
29 *
30 * <p><b>Post Failure</b><br>
31 * The API will return null.
32 *
33 * @param ruleidin Rule id.
34 * @return The API will return the rule description for the input rule id.
35 * @rep:displayname Get Rule Description
36 * @rep:category BUSINESS_ENTITY AME_APPROVAL
37 * @rep:lifecycle active
38 * @rep:scope public
39 */
40 --
41 -- {End Of Comments}
42 --
43 function getRuleDescription(ruleIdIn in varchar2) return varchar2;
44 --
45 -- ----------------------------------------------------------------------------
46 -- |-----------------------------< clearInsertion >---------------------------|
47 -- ----------------------------------------------------------------------------
48 --
49 -- {Start Of Comments}
50 /*#
51 * This API will clear the approver previously inserted by calls to
52 * ame_api.insertApprover, ame_api.setFirstAuthorityApprover.
53 * It will also clear the approvers inserted as a result of forwarding.
54 * This will NOT clear the approval statuses and the approver deletions.
55 *
56 * <p><b>Licensing</b><br>
57 * This API is available for use with any licensed component of the e-business
58 * suite.
59 *
60 * <p><b>Prerequisites</b><br>
61 * The approver should exist in the transaction's approver list.
62 *
63 * <p><b>Post Success</b><br>
64 * The API will clear the insertion of the approver in the transaction's
65 * approver list.
66 *
67 * <p><b>Post Failure</b><br>
68 * The API will raise an error.
69 *
70 * @param applicationidin The fnd_application.application_id value of the
71 * originating application calling the AME API routine.
72 * @param transactiontypein This is a string parameter up to 50 bytes long. It
73 * distinguishes one transaction type from another, within a given originating
74 * application. It can be null, but you must always pass its value explicitly.
75 * @param transactionidin This is a string up to 50 bytes long. It identifies a
76 * transaction within a transaction type. Its value must not contain
77 * white-space characters, and must not be the character representation of a
78 * negative integer.
79 * @param approverIn This is the approverRecord defined by ame_util.approverRecord2
80 * that identifies the approver.
81 * @rep:displayname Clear Insertion
82 * @rep:category BUSINESS_ENTITY AME_APPROVAL
83 * @rep:lifecycle active
84 * @rep:scope public
85 */
86 --
87 -- {End Of Comments}
88 --
89 procedure clearInsertion(applicationIdIn in number,
90 transactionTypeIn in varchar2,
91 transactionIdIn in varchar2,
92 approverIn in ame_util.approverRecord2);
93 --
94 -- ----------------------------------------------------------------------------
95 -- |-----------------------------< clearInsertions >-------------------------|
96 -- ----------------------------------------------------------------------------
97 --
98 -- {Start Of Comments}
99 /*#
100 * This API clears all the approvers previously inserted for a
101 * given transaction. This is same as the clearInsertion API but in this case it
102 * clears all the insertions in the given transacton.
103 *
104 * <p><b>Licensing</b><br>
105 * This API is available for use with any licensed component of the e-business
106 * suite.
107 *
108 * <p><b>Prerequisites</b><br>
109 * No known prerequisites.
110 *
111 * <p><b>Post Success</b><br>
112 * The API will clear all the previously inserted approvers in the given
113 * transaction's approver list.
114 *
115 * <p><b>Post Failure</b><br>
116 * The API will raise an error.
117 *
118 * @param applicationidin The fnd_application.application_id value of the
119 * originating application calling the AME API routine.
120 * @param transactiontypein This is a string parameter up to 50 bytes long. It
121 * distinguishes one transaction type from another, within a given originating
122 * application. It can be null, but you must always pass its value explicitly.
123 * @param transactionidin This is a string up to 50 bytes long. It identifies a
124 * transaction within a transaction type. Its value must not contain
125 * white-space characters, and must not be the character representation of a
126 * negative integer.
127 * @rep:displayname Clear Insertions
128 * @rep:category BUSINESS_ENTITY AME_APPROVAL
129 * @rep:lifecycle active
130 * @rep:scope public
131 */
132 --
133 -- {End Of Comments}
134 --
135 procedure clearInsertions(applicationIdIn in integer,
136 transactionTypeIn in varchar2,
137 transactionIdIn in varchar2);
138 --
139 -- ----------------------------------------------------------------------------
140 -- |-----------------------------< clearSuppression >-------------------------|
141 -- ----------------------------------------------------------------------------
142 --
143 -- {Start Of Comments}
144 /*#
145 * This API clears a suppression of an approver previously requested via the
146 * suppressApprover or suppressApprovers API.
147 * Typical use: Reverse a delete approver instruction
148 *
149 * <p><b>Licensing</b><br>
150 * This API is available for use with any licensed component of the e-business
151 * suite.
152 *
153 * <p><b>Prerequisites</b><br>
154 * The approver must have been previously suppressed using the
155 * suppressApprover or suppressApprovers API.
156 *
157 * <p><b>Post Success</b><br>
158 * The API will clear the suppression of the given approver.
159 *
160 * <p><b>Post Failure</b><br>
161 * The API will raise an error.
162 *
163 * @param applicationidin The fnd_application.application_id value of the
164 * originating application calling the AME API routine.
165 * @param transactiontypein This is a string parameter up to 50 bytes long. It
166 * distinguishes one transaction type from another, within a given originating
167 * application. It can be null, but you must always pass its value explicitly.
168 * @param transactionidin This is a string up to 50 bytes long. It identifies a
169 * transaction within a transaction type. Its value must not contain
170 * white-space characters, and must not be the character representation of a
171 * negative integer.
172 * @param approverIn This is the approverRecord defined by
173 * ame_util.approverRecord2 that identifies the suppressed approver
174 * @rep:displayname Clear Suppression
175 * @rep:category BUSINESS_ENTITY AME_APPROVAL
176 * @rep:lifecycle active
177 * @rep:scope public
178 */
179 --
180 -- {End Of Comments}
181 --
182 procedure clearSuppression(applicationIdIn in number,
183 transactionTypeIn in varchar2,
184 transactionIdIn in varchar2,
185 approverIn in ame_util.approverRecord2);
186 --
187 -- ----------------------------------------------------------------------------
188 -- |-----------------------------< clearSuppressions >------------------------|
189 -- ----------------------------------------------------------------------------
190 --
191 -- {Start Of Comments}
192 /*#
193 * This API clears all suppressions previously requested using
194 * suppressApprover API or suppressApprovers API for a given transaction. This
195 * is same as the clearSuppression API but in this case it clears all the
196 * suppressions of a given transaction.
197 *
198 * <p><b>Licensing</b><br>
199 * This API is available for use with any licensed component of the e-business
200 * suite.
201 *
202 * <p><b>Prerequisites</b><br>
203 * No known prerequisites.
204 *
205 * <p><b>Post Success</b><br>
206 * The API will clear all the suppressions for the given transaction.
207 *
208 * <p><b>Post Failure</b><br>
209 * The API will raise an error.
210 *
211 * @param applicationidin The fnd_application.application_id value of the
212 * originating application calling the AME API routine.
213 * @param transactiontypein This is a string parameter up to 50 bytes long. It
214 * distinguishes one transaction type from another, within a given originating
215 * application. It can be null, but you must always pass its value explicitly.
216 * @param transactionidin This is a string up to 50 bytes long. It identifies a
217 * transaction within a transaction type. Its value must not contain
218 * white-space characters, and must not be the character representation of a
219 * negative integer.
220 * @rep:displayname Clear Suppressions
221 * @rep:category BUSINESS_ENTITY AME_APPROVAL
222 * @rep:lifecycle active
223 * @rep:scope public
224 */
225 --
226 -- {End Of Comments}
227 --
228 procedure clearSuppressions(applicationIdIn in integer,
229 transactionTypeIn in varchar2,
230 transactionIdIn in varchar2);
231 --
232 -- ----------------------------------------------------------------------------
233 -- |---------------------------< getallapprovalgroups >-----------------------|
234 -- ----------------------------------------------------------------------------
235 --
236 -- {Start Of Comments}
237 /*#
238 * This API returns all the current AME approval groups.
239 *
240 * The approval group id and the names of all the active approval groups is
241 * returned by in ascending order of their names.
242 *
243 * <p><b>Licensing</b><br>
244 * This API is available for use with any licensed component of the e-business
245 * suite.
246 *
247 * <p><b>Prerequisites</b><br>
248 * No known prerequisites.
249 *
250 * <p><b>Post Success</b><br>
251 * The group Id and the group names will be returned.
252 *
253 * <p><b>Post Failure</b><br>
254 * The API will raise an error.
255 *
256 * @param groupidsout Approval group ids
257 * @param groupnamesout Approval group names corresponding to the approval
258 * group ids
259 * @rep:displayname Get All Approvalgroups
260 * @rep:category BUSINESS_ENTITY AME_APPROVAL
261 * @rep:lifecycle active
262 * @rep:scope public
263 */
264 --
265 -- {End Of Comments}
266 --
267 procedure getAllApprovalGroups(groupIdsOut out nocopy ame_util.idList,
268 groupNamesOut out nocopy ame_util.stringList);
269 --
270 -- ----------------------------------------------------------------------------
274 -- {Start Of Comments}
271 -- |---------------------------< getapplicablerules1 >------------------------|
272 -- ----------------------------------------------------------------------------
273 --
275 /*#
276 * This API returns the primary key information of the rules that are
277 * applicable for a transaction.
278 *
279 * See also ame_api3.getApplicableRules2 and getApplicableRules3.
280 *
281 * <p><b>Licensing</b><br>
282 * This API is available for use with any licensed component of the e-business
283 * suite.
284 *
285 * <p><b>Prerequisites</b><br>
286 * No known prerequisites.
287 *
288 * <p><b>Post Success</b><br>
289 * The Rule Ids will be returned.
290 *
291 * <p><b>Post Failure</b><br>
292 * The API will raise an error.
293 *
294 * @param applicationidin The fnd_application.application_id value of the
295 * originating application calling the AME API routine.
296 * @param transactionidin This is a string up to 50 bytes long. It identifies a
297 * transaction within a transaction type. Its value must not contain
298 * white-space characters, and must not be the character representation of a
299 * negative integer.
300 * @param transactiontypein This is a string parameter up to 50 bytes long. It
301 * distinguishes one transaction type from another, within a given originating
302 * application. It can be null, but you must always pass its value explicitly.
303 * @param ruleidsout Rule ids.
304 * @rep:displayname Get Applicable Rules 1
305 * @rep:category BUSINESS_ENTITY AME_APPROVAL
306 * @rep:lifecycle active
307 * @rep:scope public
308 */
309 --
310 -- {End Of Comments}
311 --
312 procedure getApplicableRules1(applicationIdIn in integer,
313 transactionIdIn in varchar2,
314 transactionTypeIn in varchar2,
315 ruleIdsOut out nocopy ame_util.idList);
316 --
317 -- ----------------------------------------------------------------------------
318 -- |---------------------------< getapplicablerules2 >------------------------|
319 -- ----------------------------------------------------------------------------
320 --
321 -- {Start Of Comments}
322 /*#
323 * This API returns the descriptions of the rules that are applicable for a
324 * transaction.
325 *
326 * Use this API when you only need the rule descriptions. See also
327 * ame_api3.getApplicableRules1 and ame_api3.getApplicableRules3.
328 *
329 * <p><b>Licensing</b><br>
330 * This API is available for use with any licensed component of the e-business
331 * suite.
332 *
333 * <p><b>Prerequisites</b><br>
334 * No known prerequisites.
335 *
336 * <p><b>Post Success</b><br>
337 * The API will return the rule description.
338 *
339 * <p><b>Post Failure</b><br>
340 * The API will raise an error.
341 *
342 * @param applicationidin The fnd_application.application_id value of the
343 * originating application calling the AME API routine.
344 * @param transactionidin This is a string up to 50 bytes long. It identifies a
345 * transaction within a transaction type. Its value must not contain
346 * white-space characters, and must not be the character representation of a
347 * negative integer.
348 * @param transactiontypein This is a string parameter up to 50 bytes long. It
349 * distinguishes one transaction type from another, within a given originating
350 * application. It can be null, but you must always pass its value explicitly.
351 * @param ruledescriptionsout Rule descriptions.
352 * @rep:displayname Get Applicable Rules 2
353 * @rep:category BUSINESS_ENTITY AME_APPROVAL
354 * @rep:lifecycle active
355 * @rep:scope public
356 */
357 --
358 -- {End Of Comments}
359 --
360 procedure getApplicableRules2(applicationIdIn in integer,
361 transactionIdIn in varchar2,
362 transactionTypeIn in varchar2,
363 ruleDescriptionsOut out nocopy ame_util.stringList);
364 --
365 -- ----------------------------------------------------------------------------
366 -- |---------------------------< getapplicablerules3 >------------------------|
367 -- ----------------------------------------------------------------------------
368 --
369 -- {Start Of Comments}
370 /*#
371 * This API returns the primary key information and description of all the
372 * rules that are applicable for a transaction.
373 *
374 * This procedure is useful to construct a displayable list of descriptiosn of
375 * applicable rules, where each rule description hyperlinks to a more detailed
376 * description of the rule (generated by one of the ame_api3.getRuleDetails[n]
377 * procedures). See also ame_api3.getApplicableRules1,
378 * ame_api3.getApplicableRules1, and the three ame_api3.getRuleDetails[n]
379 * procedures.
380 *
381 * <p><b>Licensing</b><br>
382 * This API is available for use with any licensed component of the e-business
383 * suite.
384 *
385 * <p><b>Prerequisites</b><br>
386 * No known prerequisites.
387 *
388 * <p><b>Post Success</b><br>
389 * The rule ids and rule description will be returned.
390 *
391 * <p><b>Post Failure</b><br>
392 * The API will raise an error.
393 *
394 * @param applicationidin The fnd_application.application_id value of the
395 * originating application calling the AME API routine.
396 * @param transactionidin This is a string up to 50 bytes long. It identifies a
397 * transaction within a transaction type. Its value must not contain
398 * white-space characters, and must not be the character representation of a
399 * negative integer.
400 * @param transactiontypein This is a string parameter up to 50 bytes long. It
401 * distinguishes one transaction type from another, within a given originating
405 * @rep:displayname Get Applicable Rules 3
402 * application. It can be null, but you must always pass its value explicitly.
403 * @param ruleidsout Rule ids.
404 * @param ruledescriptionsout Rule descriptions corresponding to rule ids.
406 * @rep:category BUSINESS_ENTITY AME_APPROVAL
407 * @rep:lifecycle active
408 * @rep:scope public
409 */
410 --
411 -- {End Of Comments}
412 --
413 procedure getApplicableRules3(applicationIdIn in integer,
414 transactionIdIn in varchar2,
415 transactionTypeIn in varchar2,
416 ruleIdsOut out nocopy ame_util.idList,
417 ruleDescriptionsOut out nocopy ame_util.stringList);
418 --
419 -- ----------------------------------------------------------------------------
420 -- |----------------------------< getapprovalgroupid >------------------------|
421 -- ----------------------------------------------------------------------------
422 --
423 -- {Start Of Comments}
424 /*#
425 * This API returns the approval group primary key information for a given
426 * approval group name.
427 *
428 * The approval group ID is returned for a given approval group name.
429 *
430 * <p><b>Licensing</b><br>
431 * This API is available for use with any licensed component of the e-business
432 * suite.
433 *
434 * <p><b>Prerequisites</b><br>
435 * No known prerequisites.
436 *
437 * <p><b>Post Success</b><br>
438 * The Approval Group Id will be returned.
439 *
440 * <p><b>Post Failure</b><br>
441 * The API will raise an error.
442 *
443 * @param groupnamein This specifies the Approval group name.
444 * @param groupidout This specifies the unique identifier of Approval group.
445 * @rep:displayname Get Approval Group
446 * @rep:category BUSINESS_ENTITY AME_APPROVAL
447 * @rep:lifecycle active
448 * @rep:scope public
449 */
450 --
451 -- {End Of Comments}
452 --
453 procedure getApprovalGroupId(groupNameIn ame_util.stringType,
454 groupIdOut out nocopy number);
455 --
456 -- ----------------------------------------------------------------------------
457 -- |----------------------------< getattributevalue >-------------------------|
458 -- ----------------------------------------------------------------------------
459 --
460 -- {Start Of Comments}
461 /*#
462 * This API returns the value of an attribute for a given transaction.
463 *
464 * This API outputs in attributeValue1Out, attributeValue2Out, and
465 * attributeValue3Out the values of the attribute with the name attributeNameIn
466 * for the item with ID itemIdIn, for the input transaction. An attribute is
467 * always associated with an item class, and attribute names are unique across
468 * item classes, so it is not necessary to input the item class. If the
469 * attribute pertains to the header item class, itemIdIn should have the same
470 * value as transactionIdIn. For all attribute types other than currency
471 * attributes, attributeValue1Out contains the attribute's value, and
472 * attributeValue2Out and attributeValue3Out are null. For currency attributes,
473 * attributeValue1Out is the amount, attributeValue2Out is the General Ledger
474 * currency code, and attributeValue3Out is the General Ledger conversion type.
475 *
476 * <p><b>Licensing</b><br>
477 * This API is available for use with any licensed component of the e-business
478 * suite.
479 *
480 * <p><b>Prerequisites</b><br>
481 * No known prerequisites.
482 *
483 * <p><b>Post Success</b><br>
484 * The API will return the value of the attribute.
485 *
486 * <p><b>Post Failure</b><br>
487 * The API will raise an error.
488 *
489 * @param applicationidin The fnd_application.application_id value of the
490 * originating application calling the AME API routine.
491 * @param transactiontypein This is a string parameter up to 50 bytes long. It
492 * distinguishes one transaction type from another, within a given originating
493 * application. It can be null, but you must always pass its value explicitly.
494 * @param transactionidin This is a string up to 50 bytes long. It identifies a
495 * transaction within a transaction type. Its value must not contain
496 * white-space characters, and must not be the character representation of a
497 * negative integer.
498 * @param attributenamein Attribute name.
499 * @param itemidin Item id corresponding to the item class, to that the
500 * attribute belongs.
501 * @param attributevalue1out Attribute value.
502 * @param attributevalue2out For non-currency attribute type, it will contain
503 * null and for currency type it will contain General Ledger currency code.
504 * @param attributevalue3out For non-currency attribute type, it will contain
505 * null and for currency type it will contain General Ledger conversion type.
506 * @rep:displayname Get Attribute Value
507 * @rep:category BUSINESS_ENTITY AME_APPROVAL
508 * @rep:lifecycle active
509 * @rep:scope public
510 */
511 --
512 -- {End Of Comments}
513 --
514 procedure getAttributeValue( applicationIdIn in number,
515 transactionTypeIn in varchar2,
516 transactionIdIn in varchar2,
517 attributeNameIn in varchar2,
518 itemIdIn in varchar2,
519 attributeValue1Out out nocopy varchar2,
520 attributeValue2Out out nocopy varchar2,
521 attributeValue3Out out nocopy varchar2);
522 --
523 -- ----------------------------------------------------------------------------
524 -- |--------------------------< getAvailableInsertions >-----------------------|
525 -- ----------------------------------------------------------------------------
529 * Returns a list of ame_util.insertionRecord2 records representing
526 --
527 -- {Start Of Comments}
528 /*#
530 * the dynamic approver insertions. Returns the available insertions that
531 * are of type specified at the given position in the transaction's
532 * current approver list.
533 *
534 * <p><b>Licensing</b><br>
535 * This API is available for use with any licensed component of the e-business
536 * suite.
537 *
538 * <p><b>Prerequisites</b><br>
539 * No known prerequisites.
540 *
541 * <p><b>Post Success</b><br>
542 * The API will return the list of available insertions with the out parameter
543 * availableInsertionsOut.
544 *
545 * <p><b>Post Failure</b><br>
546 * The API will raise an error.
547 *
548 * @param applicationidin The fnd_application.application_id value of the
549 * originating application calling the AME API routine.
550 * @param transactiontypein This is a string parameter up to 50 bytes long. It
551 * distinguishes one transaction type from another, within a given originating
552 * application. It can be null, but you must always pass its value explicitly.
553 * @param transactionidin This is a string up to 50 bytes long. It identifies a
554 * transaction within a transaction type. Its value must not contain
555 * white-space characters, and must not be the character representation of a
556 * negative integer.
557 * @param positionIn Absolute position in the current approver list.
558 * @param orderTypeIn Order type record defined by ame_util.orderRecord
559 * identifies the order type.
560 * @param availableInsertionsOut List of available insertions.
561 * @rep:displayname Get Available Insertions
562 * @rep:category BUSINESS_ENTITY AME_APPROVAL
563 * @rep:lifecycle active
564 * @rep:scope public
565 */
566 --
567 -- {End Of Comments}
568 --
569 procedure getAvailableInsertions(applicationIdIn in number,
570 transactionTypeIn in varchar2,
571 transactionIdIn in varchar2,
572 positionIn in number,
573 orderTypeIn in varchar2 default null,
574 availableInsertionsOut out nocopy ame_util.insertionsTable2);
575 --
576 -- ----------------------------------------------------------------------------
577 -- |---------------------------< getconditiondetails >------------------------|
578 -- ----------------------------------------------------------------------------
579 --
580 -- {Start Of Comments}
581 /*#
582 * This API returns the details of an AME condition.
583 *
584 * The condition details include the attribute details (ie. attribute name,
585 * type and description) on which the condition is based.
586 *
587 * <p><b>Licensing</b><br>
588 * This API is available for use with any licensed component of the e-business
589 * suite.
590 *
591 * <p><b>Prerequisites</b><br>
592 * No known prerequisites.
593 *
594 * <p><b>Post Success</b><br>
595 * The API will return the condition details along with the attribute on which
596 * the condition is based i.e. attributeNameOut, attributeTypeOut,
597 * attributeDescriptionOut, lowerLimitOut upperLimitOut, includeLowerLimitOut,
598 * includeUpperLimitOut, currencyCodeOut and allowedValuesOut.
599 *
600 * <p><b>Post Failure</b><br>
601 * The API will raise an error.
602 *
603 * @param conditionidin Condition id.
604 * @param attributenameout Attribute name, on which the condition is based.
605 * @param attributetypeout Attribute type, for example, number, currency,
606 * string and so on.
607 * @param attributedescriptionout Attribute description.
608 * @param lowerlimitout Lower limit. For number and currency type it contains
609 * the lower value. For boolean type it contains true or false, and for string
610 * type, it contains null.
611 * @param upperlimitout Upper Limit. For number and currency type it contains
612 * the upper value. For boolean and string type it contains contains null.
613 * @param includelowerlimitout For number and currency type it determines
614 * whether the Lower Limit is included, otherwise it contains null.
615 * @param includeupperlimitout For number and currency type it determines
616 * whether the Upper Limit is included, otherwise it contains null.
617 * @param currencycodeout For currency type, it contains the General Ledger
618 * currency code, otherwise null.
619 * @param allowedvaluesout For string type conditions it contains the list of
620 * values, otherwise null.
621 * @rep:displayname Get Condition Details
622 * @rep:category BUSINESS_ENTITY AME_APPROVAL
623 * @rep:lifecycle active
624 * @rep:scope public
625 */
626 --
627 -- {End Of Comments}
628 --
629 procedure getConditionDetails(conditionIdIn in integer,
630 attributeNameOut out nocopy varchar2,
631 attributeTypeOut out nocopy varchar2,
632 attributeDescriptionOut out nocopy varchar2,
633 lowerLimitOut out nocopy varchar2,
634 upperLimitOut out nocopy varchar2,
635 includeLowerLimitOut out nocopy varchar2,
636 includeUpperLimitOut out nocopy varchar2,
637 currencyCodeOut out nocopy varchar2,
638 allowedValuesOut out nocopy ame_util.longestStringList);
639 --
640 -- ----------------------------------------------------------------------------
641 -- |-----------------------------< getgroupmembers1 >-------------------------|
642 -- ----------------------------------------------------------------------------
643 --
644 -- {Start Of Comments}
645 /*#
646 * This API returns the approval group members display name for a given
647 * transaction.
651 * three inputs must identify the transaction for which AME should calculate
648 *
649 * If applicationIdIn, transactionIdIn, and transactionTypeIn are null, the
650 * GROUP ID must be for a static approval group. If the group is dynamic, these
652 * the group's members.
653 *
654 * <p><b>Licensing</b><br>
655 * This API is available for use with any licensed component of the e-business
656 * suite.
657 *
658 * <p><b>Prerequisites</b><br>
659 * No known prerequisites.
660 *
661 * <p><b>Post Success</b><br>
662 * The API will return the approval group members' display name.
663 *
664 * <p><b>Post Failure</b><br>
665 * The API will raise an error.
666 *
667 * @param applicationidin The fnd_application.application_id value of the
668 * originating application calling the AME API routine.
669 * @param transactiontypein This is a string parameter up to 50 bytes long. It
670 * distinguishes one transaction type from another, within a given originating
671 * application. It can be null, but you must always pass its value explicitly.
672 * @param transactionidin This is a string up to 50 bytes long. It identifies a
673 * transaction within a transaction type. Its value must not contain
674 * white-space characters, and must not be the character representation of a
675 * negative integer.
676 * @param groupidin This specifies the unique identifier of Approval group.
677 * @param memberdisplaynamesout Group members' display name.
678 * @rep:displayname Get Group Members 1
679 * @rep:category BUSINESS_ENTITY AME_APPROVAL
680 * @rep:lifecycle active
681 * @rep:scope public
682 */
683 --
684 -- {End Of Comments}
685 --
686 procedure getGroupMembers1(applicationIdIn in number default null,
687 transactionTypeIn in varchar2 default null,
688 transactionIdIn in varchar2 default null,
689 groupIdIn in number,
690 memberDisplayNamesOut out nocopy ame_util.longStringList);
691 --
692 -- ----------------------------------------------------------------------------
693 -- |-----------------------------< getgroupmembers2 >-------------------------|
694 -- ----------------------------------------------------------------------------
695 --
696 -- {Start Of Comments}
697 /*#
698 * This API returns the approval group members name and display name for a
699 * given transaction.
700 *
701 * This API has the same functionality as getGroupMembers1, but it also outputs
702 * the group members' wf_roles.name values. See also ame_api3.getGroupMembers1.
703 *
704 * <p><b>Licensing</b><br>
705 * This API is available for use with any licensed component of the e-business
706 * suite.
707 *
708 * <p><b>Prerequisites</b><br>
709 * No known prerequisites.
710 *
711 * <p><b>Post Success</b><br>
712 * The API will return the approval group members' role name and display name.
713 *
714 * <p><b>Post Failure</b><br>
715 * The API will raise an error.
716 *
717 * @param applicationidin The fnd_application.application_id value of the
718 * originating application calling the AME API routine.
719 * @param transactiontypein This is a string parameter up to 50 bytes long. It
720 * distinguishes one transaction type from another, within a given originating
721 * application. It can be null, but you must always pass its value explicitly.
722 * @param transactionidin This is a string up to 50 bytes long. It identifies a
723 * transaction within a transaction type. Its value must not contain
724 * white-space characters, and must not be the character representation of a
725 * negative integer.
726 * @param groupidin This specifies the unique identifier of Approval group.
727 * @param membernamesout Group members' name.
728 * @param memberdisplaynamesout Group members' display name.
729 * @rep:displayname Get Group Members 2
730 * @rep:category BUSINESS_ENTITY AME_APPROVAL
731 * @rep:lifecycle active
732 * @rep:scope public
733 */
734 --
735 -- {End Of Comments}
736 --
737 procedure getGroupMembers2(applicationIdIn in number default null,
738 transactionTypeIn in varchar2 default null,
739 transactionIdIn in varchar2 default null,
740 groupIdIn in number,
741 memberNamesOut out nocopy ame_util.longStringList,
742 memberDisplayNamesOut out nocopy ame_util.longStringList);
743 --
744 -- ----------------------------------------------------------------------------
745 -- |-----------------------------< getgroupmembers3 >-------------------------|
746 -- ----------------------------------------------------------------------------
747 --
748 -- {Start Of Comments}
749 /*#
750 * This API returns the approval group members name, display name and order
751 * number for a given transaction.
752 *
753 * This API has the same functionality as getGroupMembers2, but it also outputs
754 * the members' order numbers. See also ame_api3.getGroupMembers2.
755 *
756 * <p><b>Licensing</b><br>
757 * This API is available for use with any licensed component of the e-business
758 * suite.
759 *
760 * <p><b>Prerequisites</b><br>
761 * No known prerequisites.
762 *
763 * <p><b>Post Success</b><br>
764 * The API will return the approval group members' role name, display name and
765 * the order number.
766 *
767 * <p><b>Post Failure</b><br>
768 * The API will raise an error.
769 *
770 * @param applicationidin The fnd_application.application_id value of the
771 * originating application calling the AME API routine.
772 * @param transactiontypein This is a string parameter up to 50 bytes long. It
773 * distinguishes one transaction type from another, within a given originating
777 * white-space characters, and must not be the character representation of a
774 * application. It can be null, but you must always pass its value explicitly.
775 * @param transactionidin This is a string up to 50 bytes long. It identifies a
776 * transaction within a transaction type. Its value must not contain
778 * negative integer.
779 * @param groupidin This specifies the unique identifier of Approval group.
780 * @param membernamesout Group members' name.
781 * @param memberordernumbersout Group members' order number.
782 * @param memberdisplaynamesout Group members' display name.
783 * @rep:displayname Get Group Members 3
784 * @rep:category BUSINESS_ENTITY AME_APPROVAL
785 * @rep:lifecycle active
786 * @rep:scope public
787 */
788 --
789 -- {End Of Comments}
790 --
791 procedure getGroupMembers3(applicationIdIn in number default null,
792 transactionTypeIn in varchar2 default null,
793 transactionIdIn in varchar2 default null,
794 groupIdIn in number,
795 memberNamesOut out nocopy ame_util.longStringList,
796 memberOrderNumbersOut out nocopy ame_util.idList,
797 memberDisplayNamesOut out nocopy ame_util.longStringList);
798 --
799 -- ----------------------------------------------------------------------------
800 -- |-----------------------------< getgroupmembers4 >-------------------------|
801 -- ----------------------------------------------------------------------------
802 --
803 -- {Start Of Comments}
804 /*#
805 * This API returns the approval group members name, display name, order
806 * number, orig system details for a given transaction.
807 *
808 * This API has the same functionality as getGroupMembers3, but it also outputs
809 * the members' wf_roles.orig_system and wf_roles.orig_system_id values. See
810 * also ame_api3.getGroupMembers3.
811 *
812 * <p><b>Licensing</b><br>
813 * This API is available for use with any licensed component of the e-business
814 * suite.
815 *
816 * <p><b>Prerequisites</b><br>
817 * No known prerequisites.
818 *
819 * <p><b>Post Success</b><br>
820 * The API will return approval group members' role name, display name, order
821 * number, orig system and orig system id.
822 *
823 * <p><b>Post Failure</b><br>
824 * The API will raise an error.
825 *
826 * @param applicationidin The fnd_application.application_id value of the
827 * originating application calling the AME API routine.
828 * @param transactiontypein This is a string parameter up to 50 bytes long. It
829 * distinguishes one transaction type from another, within a given originating
830 * application. It can be null, but you must always pass its value explicitly.
831 * @param transactionidin This is a string up to 50 bytes long. It identifies a
832 * transaction within a transaction type. Its value must not contain
833 * white-space characters, and must not be the character representation of a
834 * negative integer.
835 * @param groupidin This specifies the unique identifier of Approval group.
836 * @param membernamesout Group members' name.
837 * @param memberordernumbersout Group members' order number.
838 * @param memberdisplaynamesout Group members' display name.
839 * @param memberorigsystemidsout Group members' orig system id.
840 * @param memberorigsystemsout Group members' orig system, for example,
841 * FND_USR, PER, POS and so on.
842 * @rep:displayname Get Group Members 4
843 * @rep:category BUSINESS_ENTITY AME_APPROVAL
844 * @rep:lifecycle active
845 * @rep:scope public
846 */
847 --
848 -- {End Of Comments}
849 --
850 procedure getGroupMembers4(applicationIdIn in number default null,
851 transactionTypeIn in varchar2 default null,
852 transactionIdIn in varchar2 default null,
853 groupIdIn in number,
854 memberNamesOut out nocopy ame_util.longStringList,
855 memberOrderNumbersOut out nocopy ame_util.idList,
856 memberDisplayNamesOut out nocopy ame_util.longStringList,
857 memberOrigSystemIdsOut out nocopy ame_util.idList,
858 memberOrigSystemsOut out nocopy ame_util.stringList);
859 --
860 -- ----------------------------------------------------------------------------
861 -- |------------------------------< getitemclasses >--------------------------|
862 -- ----------------------------------------------------------------------------
863 --
864 -- {Start Of Comments}
865 /*#
866 * This API gets item class information for a given transaction type.
867 *
868 * This outputs the IDs and names of the item classes defined for a transaction
869 * type.
870 *
871 * <p><b>Licensing</b><br>
872 * This API is available for use with any licensed component of the e-business
873 * suite.
874 *
875 * <p><b>Prerequisites</b><br>
876 * No known prerequisites.
877 *
878 * <p><b>Post Success</b><br>
879 * The API will return all the item class ids and the corresponding item class
880 * names for a transaction type.
881 *
882 * <p><b>Post Failure</b><br>
883 * The API will raise an error.
884 *
885 * @param applicationidin The fnd_application.application_id value of the
886 * originating application calling the AME API routine.
887 * @param transactiontypein This is a string parameter up to 50 bytes long. It
888 * distinguishes one transaction type from another, within a given originating
889 * application. It can be null, but you must always pass its value explicitly.
890 * @param itemclassidsout Item class ids.
891 * @param itemclassnamesout Item class names corresponding to ids.
892 * @rep:displayname Get Item Classes
893 * @rep:category BUSINESS_ENTITY AME_APPROVAL
897 --
894 * @rep:lifecycle active
895 * @rep:scope public
896 */
898 -- {End Of Comments}
899 --
900 procedure getItemClasses( applicationIdIn in number,
901 transactionTypeIn in varchar2,
902 itemClassIdsOut out nocopy ame_util.idList,
903 itemClassNamesOut out nocopy ame_util.stringList);
904 --
905 -- ----------------------------------------------------------------------------
906 -- |------------------------------< getitemclassid >--------------------------|
907 -- ----------------------------------------------------------------------------
908 --
909 -- {Start Of Comments}
910 /*#
911 * This API gets item class primary key information for a given Item class
912 * name.
913 *
914 * The item class id for the given item class name is returned.
915 *
916 * <p><b>Licensing</b><br>
917 * This API is available for use with any licensed component of the e-business
918 * suite.
919 *
920 * <p><b>Prerequisites</b><br>
921 * No known prerequisites.
922 *
923 * <p><b>Post Success</b><br>
924 * The API will return the item class id for a given item class name.
925 *
926 * <p><b>Post Failure</b><br>
927 * The API will raise an error.
928 *
929 * @param itemclassnamein Item class name.
930 * @param itemclassidout Item class id.
931 * @rep:displayname Get Item Class Id
932 * @rep:category BUSINESS_ENTITY AME_APPROVAL
933 * @rep:lifecycle active
934 * @rep:scope public
935 */
936 --
937 -- {End Of Comments}
938 --
939 procedure getItemClassId( itemClassNameIn in varchar2,
940 itemClassIdOut out nocopy number);
941 --
942 -- ----------------------------------------------------------------------------
943 -- |-----------------------------< getitemclassname >-------------------------|
944 -- ----------------------------------------------------------------------------
945 --
946 -- {Start Of Comments}
947 /*#
948 * This API gets an Item class name information for a given item class primary
949 * key.
950 *
951 * This API outputs in itemClassNameOut, the name of the item class with the ID
952 * itemClassIdIn.
953 *
954 * <p><b>Licensing</b><br>
955 * This API is available for use with any licensed component of the e-business
956 * suite.
957 *
958 * <p><b>Prerequisites</b><br>
959 * No known prerequisites.
960 *
961 * <p><b>Post Success</b><br>
962 * The API will return the name of the item class for a given item class id.
963 *
964 * <p><b>Post Failure</b><br>
965 * The API will raise an error.
966 *
967 * @param itemclassidin Item class id.
968 * @param itemclassnameout Item class name.
969 * @rep:displayname Get Item Class Name
970 * @rep:category BUSINESS_ENTITY AME_APPROVAL
971 * @rep:lifecycle active
972 * @rep:scope public
973 */
974 --
975 -- {End Of Comments}
976 --
977 procedure getItemClassName( itemClassIdIn in number,
978 itemClassNameOut out nocopy varchar2);
979 --
980 -- ----------------------------------------------------------------------------
981 -- |-----------------------------< getoldapprovers >--------------------------|
982 -- ----------------------------------------------------------------------------
983 --
984 -- {Start Of Comments}
985 /*#
986 * This API returns the approver list that AME calculated when it last
987 * generated an approver list for the input transaction.
988 *
989 * This approver list may not be the transaction's current list. That is,
990 * simultaneous calls to getAllApprovers1 and getOldApprovers could return
991 * different approver lists (and the list returned by getOldApprovers would
992 * then be outdated). This API is a deprecated routine available only for the
993 * sake of backward compatibility.
994 *
995 * <p><b>Licensing</b><br>
996 * This API is available for use with any licensed component of the e-business
997 * suite.
998 *
999 * <p><b>Prerequisites</b><br>
1000 * No known prerequisites.
1001 *
1002 * <p><b>Post Success</b><br>
1003 * The API will return the list of old approvers.
1004 *
1005 * <p><b>Post Failure</b><br>
1006 * The API will raise an error.
1007 *
1008 * @param applicationidin The fnd_application.application_id value of the
1009 * originating application calling the AME API routine.
1010 * @param transactiontypein This is a string parameter up to 50 bytes long. It
1011 * distinguishes one transaction type from another, within a given originating
1012 * application. It can be null, but you must always pass its value explicitly.
1013 * @param transactionidin This is a string up to 50 bytes long. It identifies a
1014 * transaction within a transaction type. Its value must not contain
1015 * white-space characters and must not be the character representation of a
1016 * negative integer.
1017 * @param oldapproversout This is an ame_util.approverTable2 that will keep the
1018 * generated old approvers list.
1019 * @rep:displayname Get Old Approvers
1020 * @rep:category BUSINESS_ENTITY AME_APPROVAL
1021 * @rep:lifecycle active
1022 * @rep:scope public
1023 */
1024 --
1025 -- {End Of Comments}
1026 --
1027 procedure getOldApprovers( applicationIdIn in number,
1028 transactionTypeIn in varchar2,
1029 transactionIdIn in varchar2,
1030 oldApproversOut out nocopy ame_util.approversTable2);
1031 --
1032 -- ----------------------------------------------------------------------------
1033 -- |-----------------------------< getruledetails1 >--------------------------|
1037 /*#
1034 -- ----------------------------------------------------------------------------
1035 --
1036 -- {Start Of Comments}
1038 * This API returns various rule details.
1039 *
1040 * This API returns the following details about the rule with ID ruleIdIn: rule
1041 * type, rule description, condition Ids for the conditions used in this rule,
1042 * action type names and descriptions, action descriptions corresponding to
1043 * actions that are used in this rule. Use getRuleDetails1 in connection with
1044 * one of the getApplicableRules procedures. See also the getApplicableRules[n]
1045 * procedures.
1046 *
1047 * <p><b>Licensing</b><br>
1048 * This API is available for use with any licensed component of the e-business
1049 * suite.
1050 *
1051 * <p><b>Prerequisites</b><br>
1052 * No known prerequisites.
1053 *
1054 * <p><b>Post Success</b><br>
1055 * The API will return the following rule details for a given rule id: rule
1056 * type, rule description, conditions (used in the rule), action type name,
1057 * action type descriptions and action descriptions.
1058 *
1059 * <p><b>Post Failure</b><br>
1060 * The API will raise an error.
1061 *
1062 * @param ruleidin Rule id.
1063 * @param ruletypeout Rule type, for example, list creation, list creation and
1064 * exception, list modification and so on.
1065 * @param ruledescriptionout Rule description.
1066 * @param conditionidsout Condition ids for the conditions that are used in the
1067 * input rule.
1068 * @param actiontypenamesout Action type names corresponding to the actions
1069 * that are used in the input rule.
1070 * @param actiontypedescriptionsout Action type descriptions corresponding to
1071 * the actions that are used in the input rule.
1072 * @param actiondescriptionsout Action descriptions corresponding to the
1073 * actions that are used in the input rule.
1074 * @rep:displayname Get Rule Details 1
1075 * @rep:category BUSINESS_ENTITY AME_APPROVAL
1076 * @rep:lifecycle active
1077 * @rep:scope public
1078 */
1079 --
1080 -- {End Of Comments}
1081 --
1082 procedure getRuleDetails1( ruleIdIn in number,
1083 ruleTypeOut out nocopy varchar2,
1084 ruleDescriptionOut out nocopy varchar2,
1085 conditionIdsOut out nocopy ame_util.idList,
1086 actionTypeNamesOut out nocopy ame_util.stringList,
1087 actionTypeDescriptionsOut out nocopy ame_util.stringList,
1088 actionDescriptionsOut out nocopy ame_util.stringList);
1089 --
1090 -- ----------------------------------------------------------------------------
1091 -- |-----------------------------< getruledetails2 >--------------------------|
1092 -- ----------------------------------------------------------------------------
1093 --
1094 -- {Start Of Comments}
1095 /*#
1096 * This API gets the various rule details such as conditions applying to the
1097 * rule.
1098 *
1099 * This API has the same functionality as getRuleDetails1, but it outputs
1100 * condition descriptions rather than condition IDs. See also
1101 * ame_api3.getRuleDetails1.
1102 *
1103 * <p><b>Licensing</b><br>
1104 * This API is available for use with any licensed component of the e-business
1105 * suite.
1106 *
1107 * <p><b>Prerequisites</b><br>
1108 * No known prerequisites.
1109 *
1110 * <p><b>Post Success</b><br>
1111 * The API will return the following details for a given rule: rule type, rule
1112 * description, condition descriptions, action type names, action type
1113 * descriptions and action descriptions.
1114 *
1115 * <p><b>Post Failure</b><br>
1116 * The API will raise an error.
1117 *
1118 * @param ruleidin Rule id.
1119 * @param ruletypeout Rule type, for example, list creation, list creation and
1120 * exception, list modification and so on.
1121 * @param ruledescriptionout Rule description.
1122 * @param conditiondescriptionsout Condition descriptions for the conditions
1123 * that are used in the input rule.
1124 * @param actiontypenamesout Action type names corresponding to the actions
1125 * that are used in the input rule.
1126 * @param actiontypedescriptionsout Action type descriptions corresponding to
1127 * the actions that are used in the input rule.
1128 * @param actiondescriptionsout Action descriptions corresponding to the
1129 * actions that are used in the input rule.
1130 * @rep:displayname Get Rule Details 2
1131 * @rep:category BUSINESS_ENTITY AME_APPROVAL
1132 * @rep:lifecycle active
1133 * @rep:scope public
1134 */
1135 --
1136 -- {End Of Comments}
1137 --
1138 procedure getRuleDetails2( ruleIdIn in number,
1139 ruleTypeOut out nocopy varchar2,
1140 ruleDescriptionOut out nocopy varchar2,
1141 conditionDescriptionsOut out nocopy ame_util.longestStringList,
1142 actionTypeNamesOut out nocopy ame_util.stringList,
1143 actionTypeDescriptionsOut out nocopy ame_util.stringList,
1144 actionDescriptionsOut out nocopy ame_util.stringList);
1145 --
1146 -- ----------------------------------------------------------------------------
1147 -- |-----------------------------< getruledetails3 >--------------------------|
1148 -- ----------------------------------------------------------------------------
1149 --
1150 -- {Start Of Comments}
1151 /*#
1152 * This API gets the various rule details and provides further description of
1153 * the conditions applying to the rule.
1154 *
1155 * This API has the same functionality as getRuleDetails1, but it outputs
1156 * condition ID and descriptions, and indicates whether each condition has a
1157 * list of allowed values. See also ame_api3.getRuleDetails2.
1158 *
1159 * <p><b>Licensing</b><br>
1163 * <p><b>Prerequisites</b><br>
1160 * This API is available for use with any licensed component of the e-business
1161 * suite.
1162 *
1164 * No known prerequisites.
1165 *
1166 * <p><b>Post Success</b><br>
1167 * The API will return the rule details, conditions are being used by that rule
1168 * and action details for a given rule id into the various OUT parameters.
1169 *
1170 * <p><b>Post Failure</b><br>
1171 * The API will raise an error.
1172 *
1173 * @param ruleidin Rule id.
1174 * @param ruletypeout Rule type, for example, list creation, list creation and
1175 * exception, list modification and so on.
1176 * @param ruledescriptionout Rule description.
1177 * @param conditionidsout Condition ids for the conditions that are used in the
1178 * input rule.
1179 * @param conditiondescriptionsout Condition descriptions corresponding to the
1180 * condition ids that are used in the input rule.
1181 * @param conditionhaslovsout This indicates whether the corresponding
1182 * condition has a list of allowed values.
1183 * @param actiontypenamesout Action type names corresponding to the actions
1184 * that are used in the input rule.
1185 * @param actiontypedescriptionsout Action type descriptions corresponding to
1186 * the actions that are used in the input rule.
1187 * @param actiondescriptionsout Action descriptions corresponding to the
1188 * actions that are used in the input rule.
1189 * @rep:displayname Get Rule Details 3
1190 * @rep:category BUSINESS_ENTITY AME_APPROVAL
1191 * @rep:lifecycle active
1192 * @rep:scope public
1193 */
1194 --
1195 -- {End Of Comments}
1196 --
1197 procedure getRuleDetails3( ruleIdIn in number,
1198 ruleTypeOut out nocopy varchar2,
1199 ruleDescriptionOut out nocopy varchar2,
1200 conditionIdsOut out nocopy ame_util.idList,
1201 conditionDescriptionsOut out nocopy ame_util.longestStringList,
1202 conditionHasLOVsOut out nocopy ame_util.charList,
1203 actionTypeNamesOut out nocopy ame_util.stringList,
1204 actionTypeDescriptionsOut out nocopy ame_util.stringList,
1205 actionDescriptionsOut out nocopy ame_util.stringList);
1206 --
1207 -- ----------------------------------------------------------------------------
1208 -- |------------------------------< insertapprover >--------------------------|
1209 -- ----------------------------------------------------------------------------
1210 --
1211 -- {Start Of Comments}
1212 /*#
1213 * Dynamically inserts an approver with a given insertion-order
1214 * relation at a given position in the transaction's current approver
1215 * list.
1216 *
1217 * <p><b>Licensing</b><br>
1218 * This API is available for use with any licensed component of the e-business
1219 * suite.
1220 *
1221 * <p><b>Prerequisites</b><br>
1222 * 1. The approval_status field of approverIn is null.
1223 * 2. The combination of values in orderIn, the api_insertion field
1224 * of approverIn, and the authority field of approverIn match a
1225 * record returned by getAvailableInsertions.
1226 *
1227 *
1228 * <p><b>Post Success</b><br>
1229 * The approver will be inserted in the given transaction's approver list.
1230 *
1231 * <p><b>Post Failure</b><br>
1232 * The API will raise an error.
1233 *
1234 * @param applicationidin The fnd_application.application_id value of the
1235 * originating application calling the AME API routine.
1236 * @param transactiontypein This is a string parameter up to 50 bytes long. It
1237 * distinguishes one transaction type from another, within a given originating
1238 * application. It can be null, but you must always pass its value explicitly.
1239 * @param transactionidin This is a string up to 50 bytes long. It identifies a
1240 * transaction within a transaction type. Its value must not contain
1241 * white-space characters, and must not be the character representation of a
1242 * negative integer.
1243 * @param approverIn This is the approverRecord defined by ame_util.approverRecord2
1244 * that identifies the approver.
1245 * @param positionIn The position in approver list where the approver insertion will be done.
1246 * @param insertionIn Insertion record.
1247 * @rep:displayname Insert Approver
1248 * @rep:category BUSINESS_ENTITY AME_APPROVAL
1249 * @rep:lifecycle active
1250 * @rep:scope public
1251 */
1252 --
1253 -- {End Of Comments}
1254 --
1255 procedure insertApprover( applicationIdIn in number,
1256 transactionTypeIn in varchar2,
1257 transactionIdIn in varchar2,
1258 approverIn in ame_util.approverRecord2,
1259 positionIn in number,
1260 insertionIn in ame_util.insertionRecord2);
1261 --
1262 -- ----------------------------------------------------------------------------
1263 -- |---------------------------< parseapproversource >------------------------|
1264 -- ----------------------------------------------------------------------------
1265 --
1266 -- {Start Of Comments}
1267 /*#
1268 * This api parses the source field of a ame_util.approverRecord of
1269 * an approver and returns the description of the source
1270 * and the list of rule ids that generated this approver.
1271 *
1272 * <p><b>Licensing</b><br>
1273 * This API is available for use with any licensed component of the e-business
1274 * suite.
1275 *
1276 * <p><b>Prerequisites</b><br>
1277 * None
1278 *
1279 * <p><b>Post Success</b><br>
1280 * This api returns description of the source and the list of rule ids
1281 * which have generated this approver, if any.
1282 *
1286 * @param approversourcein This is the value of the source field of
1283 * <p><b>Post Failure</b><br>
1284 * The API will raise an error.
1285 *
1287 * ame_util.approverRecord of an approver.
1288 * @param sourcedescriptionout Description of the source.
1289 * @param ruleidlistout This is the list of rule IDs that generated this approver.
1290 * @rep:displayname Parse Approver Source
1291 * @rep:category BUSINESS_ENTITY AME_APPROVAL
1292 * @rep:lifecycle active
1293 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
1294 * @rep:scope public
1295 */
1296 --
1297 -- {End Of Comments}
1298 --
1299 procedure parseApproverSource(approverSourceIn in varchar2,
1300 sourceDescriptionOut out nocopy varchar2,
1301 ruleIdListOut out nocopy ame_util.idList);
1302 --
1303 -- ----------------------------------------------------------------------------
1304 -- |------------------------------< suppressApprover >------------------------|
1305 -- ----------------------------------------------------------------------------
1306 --
1307 -- {Start Of Comments}
1308 /*#
1309 * Dynamically suppresses an approver in the transaction's current approver
1310 * list.
1311 *
1312 * <p><b>Licensing</b><br>
1313 * This API is available for use with any licensed component of the e-business
1314 * suite.
1315 *
1316 * <p><b>Prerequisites</b><br>
1317 * The approver identified by approverIn should already be in the
1318 * transaction's approver list.
1319 *
1320 *
1321 * <p><b>Post Success</b><br>
1322 * The approver will be suppressed in the given transaction's approver list.
1323 *
1324 * <p><b>Post Failure</b><br>
1325 * The API will raise an error.
1326 *
1327 * @param applicationidin The fnd_application.application_id value of the
1328 * originating application calling the AME API routine.
1329 * @param transactiontypein This is a string parameter up to 50 bytes long. It
1330 * distinguishes one transaction type from another, within a given originating
1331 * application. It can be null, but you must always pass its value explicitly.
1332 * @param transactionidin This is a string up to 50 bytes long. It identifies a
1333 * transaction within a transaction type. Its value must not contain
1334 * white-space characters, and must not be the character representation of a
1335 * negative integer.
1336 * @param approverIn This is the approverRecord defined by ame_util.approverRecord2
1337 * that identifies the approver.
1338 * @rep:displayname Suppress Approver
1339 * @rep:category BUSINESS_ENTITY AME_APPROVAL
1340 * @rep:lifecycle active
1341 * @rep:scope public
1342 */
1343 --
1344 -- {End Of Comments}
1345 --
1346 procedure suppressApprover(applicationIdIn in number,
1347 transactionTypeIn in varchar2,
1348 transactionIdIn in varchar2,
1349 approverIn in ame_util.approverRecord2);
1350 --
1351 -- ----------------------------------------------------------------------------
1352 -- |------------------------------< suppressApprovers >-----------------------|
1353 -- ----------------------------------------------------------------------------
1354 --
1355 -- {Start Of Comments}
1356 /*#
1357 * Dynamically suppresses multiple approvers in the transaction's current approver
1358 * list.
1359 *
1360 * <p><b>Licensing</b><br>
1361 * This API is available for use with any licensed component of the e-business
1362 * suite.
1363 *
1364 * <p><b>Prerequisites</b><br>
1365 * The approvers identified by approverIn should already be in the
1366 * transaction's approver list.
1367 *
1368 *
1369 * <p><b>Post Success</b><br>
1370 * The specified approvers will be suppressed in the transaction's approver list.
1371 *
1372 * <p><b>Post Failure</b><br>
1373 * The API will raise an error.
1374 *
1375 * @param applicationidin The fnd_application.application_id value of the
1376 * originating application calling the AME API routine.
1377 * @param transactiontypein This is a string parameter up to 50 bytes long. It
1378 * distinguishes one transaction type from another, within a given originating
1379 * application. It can be null, but you must always pass its value explicitly.
1380 * @param transactionidin This is a string up to 50 bytes long. It identifies a
1381 * transaction within a transaction type. Its value must not contain
1382 * white-space characters, and must not be the character representation of a
1383 * negative integer.
1384 * @param approversIn Approvers list defined by ame_util.approversTable2
1385 * identifies the list of approvers.
1386 * @rep:displayname Suppress Approvers
1387 * @rep:category BUSINESS_ENTITY AME_APPROVAL
1388 * @rep:lifecycle active
1389 * @rep:scope public
1390 */
1391 --
1392 -- {End Of Comments}
1393 --
1394 procedure suppressApprovers(applicationIdIn in integer,
1395 transactionTypeIn in varchar2,
1396 transactionIdIn in varchar2,
1397 approversIn in ame_util.approversTable2);
1398 end ame_api3;
[Home] [Help]