[Home] [Help]
67: *
68: *
Post Failure
69: * This API returns false.
70: *
71: * @param approverin This is an ame_util.approverRecord that represents an
72: * approver.
73: * @return This API will return true if the approver represented by approverIn has a current wf_roles entry, otherwise will return false.
74: * @rep:displayname Validate Approver
75: * @rep:category BUSINESS_ENTITY AME_APPROVAL
78: */
79: --
80: -- {End Of Comments}
81: --
82: function validateApprover(approverIn in ame_util.approverRecord) return boolean;
83: --
84: -- ----------------------------------------------------------------------------
85: -- |-----------------------------< clearallapprovals >-------------------------|
86: -- ----------------------------------------------------------------------------
152: *
Post Failure
153: * The API will raise an error.
154: *
155: * @param approverIn This is the approver record defined by
156: * ame_util.approverRecord which identifies the Approver.
157: * @param applicationidin The fnd_application.application_id value of the
158: * originating application calling the AME API routine.
159: * @param transactionidin This is a string up to 50 bytes long. It identifies a
160: * transaction within a transaction type. Its value must not contain
170: */
171: --
172: -- {End Of Comments}
173: --
174: procedure clearDeletion(approverIn in ame_util.approverRecord,
175: applicationIdIn in integer,
176: transactionIdIn in varchar2,
177: transactionTypeIn in varchar2 default null);
178: --
242: *
243: *
Post Failure
244: * The API will raise an error.
245: *
246: * @param approverIn This is the approverRecord defined by ame_util.approverRecord
247: * which gives information regarding the Approver.
248: * @param applicationidin The fnd_application.application_id value of the
249: * originating application calling the AME API routine.
250: * @param transactionidin This is a string up to 50 bytes long. It identifies a
261: */
262: --
263: -- {End Of Comments}
264: --
265: procedure clearInsertion(approverIn in ame_util.approverRecord,
266: applicationIdIn in integer,
267: transactionIdIn in varchar2,
268: transactionTypeIn in varchar2 default null);
269: --
340: * @param transactionidin This is a string up to 50 bytes long. It identifies a
341: * transaction within a transaction type. Its value must not contain
342: * white-space characters, and must not be the character representation of a
343: * negative integer.
344: * @param approverIn This is the approverRecord defined by ame_util.approverRecord
345: * which gives information regarding the Approver.
346: * @param transactiontypein This is a string parameter up to 50 bytes long. It
347: * distinguishes one transaction type from another, within a given originating
348: * application. It can be null, but you must always pass its value explicitly.
355: -- {End Of Comments}
356: --
357: procedure deleteApprover(applicationIdIn in integer,
358: transactionIdIn in varchar2,
359: approverIn in ame_util.approverRecord,
360: transactionTypeIn in varchar2 default null);
361: --
362: -- ----------------------------------------------------------------------------
363: -- |-----------------------------< deleteapprovers >-------------------------|
388: * @param transactionidin This is a string up to 50 bytes long. It identifies a
389: * transaction within a transaction type. Its value must not contain
390: * white-space characters, and must not be the character representation of a
391: * negative integer.
392: * @param approversIn This is the approversTable defined by ame_util.approversTable
393: * which gives information regarding the Approvers.
394: * @param transactiontypein This is a string parameter up to 50 bytes long. It
395: * distinguishes one transaction type from another, within a given originating
396: * application. It can be null, but you must always pass its value explicitly.
403: -- {End Of Comments}
404: --
405: procedure deleteApprovers(applicationIdIn in integer,
406: transactionIdIn in varchar2,
407: approversIn in ame_util.approversTable,
408: transactionTypeIn in varchar2 default null);
409: --
410: -- ----------------------------------------------------------------------------
411: -- |-----------------------------< getadminapprover >-------------------------|
437: * originating application calling the AME API routine.
438: * @param transactiontypein This is a string parameter up to 50 bytes long. It
439: * distinguishes one transaction type from another, within a given originating
440: * application. It can be null, but you must always pass its value explicitly.
441: * @param adminapproverout Admin approver in ame_util.approverrecord format.
442: * @rep:displayname Get Admin Approver
443: * @rep:category BUSINESS_ENTITY AME_APPROVAL
444: * @rep:lifecycle active
445: * @rep:scope public
448: -- {End Of Comments}
449: --
450: procedure getAdminApprover(applicationIdIn in integer default null,
451: transactionTypeIn in varchar2 default null,
452: adminApproverOut out nocopy ame_util.approverRecord);
453: --
454: -- ----------------------------------------------------------------------------
455: -- |-----------------------------< getallapprovers >--------------------------|
456: -- ----------------------------------------------------------------------------
470: * ame_api.deleteApprover(s), or suppressed to account for the value of the
471: * repeatedApprovers configuration variable. In AME 11.5.10, this behavior has
472: * changed. The approver list in approversOut now includes deleted and repeated
473: * approvers, but assigns them one of the approval_status values
474: * ame_util.suppressedStatus and ame_util.repeatedStatus. Your code should
475: * treat these statuses as logically equivalent to ame_util.approvedStatus. The
476: * ame_api.getNextApprover will skip approvers with either status when it
477: * iterates through the approver list to find the first approver that has not
478: * yet approved. Note : This is an alternative API for
471: * repeatedApprovers configuration variable. In AME 11.5.10, this behavior has
472: * changed. The approver list in approversOut now includes deleted and repeated
473: * approvers, but assigns them one of the approval_status values
474: * ame_util.suppressedStatus and ame_util.repeatedStatus. Your code should
475: * treat these statuses as logically equivalent to ame_util.approvedStatus. The
476: * ame_api.getNextApprover will skip approvers with either status when it
477: * iterates through the approver list to find the first approver that has not
478: * yet approved. Note : This is an alternative API for
479: * ame_api2.getAllApprovers7 See also the ame_api2.getAllApprovers[n]
501: * negative integer.
502: * @param transactiontypein This is a string parameter up to 50 bytes long. It
503: * distinguishes one transaction type from another, within a given originating
504: * application. It can be null, but you must always pass its value explicitly.
505: * @param approversout This is the ame_util.approversTable which represents the
506: * list of approvers.
507: * @rep:displayname Get All Approvers
508: * @rep:category BUSINESS_ENTITY AME_APPROVAL
509: * @rep:lifecycle active
514: --
515: procedure getAllApprovers(applicationIdIn in integer,
516: transactionIdIn in varchar2,
517: transactionTypeIn in varchar2 default null,
518: approversOut out nocopy ame_util.approversTable);
519: --
520: -- ----------------------------------------------------------------------------
521: -- |-----------------------------< getandrecordallapprovers >------------------|
522: -- ----------------------------------------------------------------------------
550: * negative integer.
551: * @param transactiontypein This is a string parameter up to 50 bytes long. It
552: * distinguishes one transaction type from another, within a given originating
553: * application. It can be null, but you must always pass its value explicitly.
554: * @param approversout This is the ame_util.approversTable which represents the
555: * list of approvers.
556: * @rep:displayname Get And Record All Approvers
557: * @rep:category BUSINESS_ENTITY AME_APPROVAL
558: * @rep:lifecycle active
563: --
564: procedure getAndRecordAllApprovers(applicationIdIn in integer,
565: transactionIdIn in varchar2,
566: transactionTypeIn in varchar2 default null,
567: approversOut out nocopy ame_util.approversTable);
568: --
569: -- ----------------------------------------------------------------------------
570: -- |---------------------------< getapplicablerules1 >------------------------|
571: -- ----------------------------------------------------------------------------
613: --
614: procedure getApplicableRules1(applicationIdIn in integer,
615: transactionIdIn in varchar2,
616: transactionTypeIn in varchar2 default null,
617: ruleIdsOut out nocopy ame_util.idList);
618: --
619: -- ----------------------------------------------------------------------------
620: -- |---------------------------< getapplicablerules2 >------------------------|
621: -- ----------------------------------------------------------------------------
664: --
665: procedure getApplicableRules2(applicationIdIn in integer,
666: transactionIdIn in varchar2,
667: transactionTypeIn in varchar2 default null,
668: ruleDescriptionsOut out nocopy ame_util.stringList);
669: --
670: -- ----------------------------------------------------------------------------
671: -- |---------------------------< getapplicablerules3 >------------------------|
672: -- ----------------------------------------------------------------------------
721: --
722: procedure getApplicableRules3(applicationIdIn in integer,
723: transactionIdIn in varchar2,
724: transactionTypeIn in varchar2 default null,
725: ruleIdsOut out nocopy ame_util.idList,
726: ruleDescriptionsOut out nocopy ame_util.stringList);
727: --
728: -- ----------------------------------------------------------------------------
729: -- |--------------------------< getapproversandrules1 >-----------------------|
722: procedure getApplicableRules3(applicationIdIn in integer,
723: transactionIdIn in varchar2,
724: transactionTypeIn in varchar2 default null,
725: ruleIdsOut out nocopy ame_util.idList,
726: ruleDescriptionsOut out nocopy ame_util.stringList);
727: --
728: -- ----------------------------------------------------------------------------
729: -- |--------------------------< getapproversandrules1 >-----------------------|
730: -- ----------------------------------------------------------------------------
761: * negative integer.
762: * @param transactiontypein This is a string parameter up to 50 bytes long. It
763: * distinguishes one transaction type from another, within a given originating
764: * application. It can be null, but you must always pass its value explicitly.
765: * @param approversout This is the ame_util.approversTable which represents the
766: * list of approvers.
767: * @param ruleidsout Rule ids for the rules corresponding to each of the
768: * approvers.
769: * @rep:displayname Get Approvers And Rules1
776: --
777: procedure getApproversAndRules1(applicationIdIn in integer,
778: transactionIdIn in varchar2,
779: transactionTypeIn in varchar2 default null,
780: approversOut out nocopy ame_util.approversTable,
781: ruleIdsOut out nocopy ame_util.idList);
782: --
783: -- ----------------------------------------------------------------------------
784: -- |--------------------------< getapproversandrules2 >-----------------------|
777: procedure getApproversAndRules1(applicationIdIn in integer,
778: transactionIdIn in varchar2,
779: transactionTypeIn in varchar2 default null,
780: approversOut out nocopy ame_util.approversTable,
781: ruleIdsOut out nocopy ame_util.idList);
782: --
783: -- ----------------------------------------------------------------------------
784: -- |--------------------------< getapproversandrules2 >-----------------------|
785: -- ----------------------------------------------------------------------------
818: * negative integer.
819: * @param transactiontypein This is a string parameter up to 50 bytes long. It
820: * distinguishes one transaction type from another, within a given originating
821: * application. It can be null, but you must always pass its value explicitly.
822: * @param approversout This is the ame_util.approversTable which represents the
823: * list of approvers.
824: * @param ruledescriptionsout Rule descriptions for the rules corresponding to
825: * each of the approvers.
826: * @rep:displayname Get Approvers And Rules2
833: --
834: procedure getApproversAndRules2(applicationIdIn in integer,
835: transactionIdIn in varchar2,
836: transactionTypeIn in varchar2 default null,
837: approversOut out nocopy ame_util.approversTable,
838: ruleDescriptionsOut out nocopy ame_util.stringList);
839: --
840: -- ----------------------------------------------------------------------------
841: -- |--------------------------< getapproversandrules3 >-----------------------|
834: procedure getApproversAndRules2(applicationIdIn in integer,
835: transactionIdIn in varchar2,
836: transactionTypeIn in varchar2 default null,
837: approversOut out nocopy ame_util.approversTable,
838: ruleDescriptionsOut out nocopy ame_util.stringList);
839: --
840: -- ----------------------------------------------------------------------------
841: -- |--------------------------< getapproversandrules3 >-----------------------|
842: -- ----------------------------------------------------------------------------
875: * negative integer.
876: * @param transactiontypein This is a string parameter up to 50 bytes long. It
877: * distinguishes one transaction type from another, within a given originating
878: * application. It can be null, but you must always pass its value explicitly.
879: * @param approversout This is the ame_util.approversTable which represents the
880: * list of approvers.
881: * @param ruleidsout Rule ids for the rules corresponding to each of the
882: * approvers.
883: * @param ruledescriptionsout Rule descriptions for the rules corresponding to
892: --
893: procedure getApproversAndRules3(applicationIdIn in integer,
894: transactionIdIn in varchar2,
895: transactionTypeIn in varchar2 default null,
896: approversOut out nocopy ame_util.approversTable,
897: ruleIdsOut out nocopy ame_util.idList,
898: ruleDescriptionsOut out nocopy ame_util.stringList);
899: --
900: -- ----------------------------------------------------------------------------
893: procedure getApproversAndRules3(applicationIdIn in integer,
894: transactionIdIn in varchar2,
895: transactionTypeIn in varchar2 default null,
896: approversOut out nocopy ame_util.approversTable,
897: ruleIdsOut out nocopy ame_util.idList,
898: ruleDescriptionsOut out nocopy ame_util.stringList);
899: --
900: -- ----------------------------------------------------------------------------
901: -- |--------------------------< getAvailableInsertions >-----------------------|
894: transactionIdIn in varchar2,
895: transactionTypeIn in varchar2 default null,
896: approversOut out nocopy ame_util.approversTable,
897: ruleIdsOut out nocopy ame_util.idList,
898: ruleDescriptionsOut out nocopy ame_util.stringList);
899: --
900: -- ----------------------------------------------------------------------------
901: -- |--------------------------< getAvailableInsertions >-----------------------|
902: -- ----------------------------------------------------------------------------
902: -- ----------------------------------------------------------------------------
903: --
904: -- {Start Of Comments}
905: /*#
906: * This API returns a list of ame_util.insertionRecord records representing
907: * the dynamic approver insertions that are possible at the absolute
908: * position positionIn in the transaction's current approver list.
909: *
910: *
Licensing
931: * available insertions are to be fetched.
932: * @param transactiontypein This is a string parameter up to 50 bytes long. It
933: * distinguishes one transaction type from another, within a given originating
934: * application. It can be null, but you must always pass its value explicitly.
935: * @param availableInsertionsOut This is the table defined by ame_util.insertionsTable
936: * which represents the list of available insertions.
937: * @rep:displayname Get Available Insertions
938: * @rep:category BUSINESS_ENTITY AME_APPROVAL
939: * @rep:lifecycle active
945: procedure getAvailableInsertions(applicationIdIn in integer,
946: transactionIdIn in varchar2,
947: positionIn in integer,
948: transactionTypeIn in varchar2 default null,
949: availableInsertionsOut out nocopy ame_util.insertionsTable);
950: --
951: -- ----------------------------------------------------------------------------
952: -- |--------------------------< getAvailableOrders >-----------------------|
953: -- ----------------------------------------------------------------------------
953: -- ----------------------------------------------------------------------------
954: --
955: -- {Start Of Comments}
956: /*#
957: * Returns a list of ame_util.orderRecord records representing
958: * the dynamic approver insertions that are possible at the absolute
959: * position positionIn in the transaction's current approver list.
960: *
961: *
Licensing
981: * @param positionIn absolute position in the current approver list.
982: * @param transactiontypein This is a string parameter up to 50 bytes long. It
983: * distinguishes one transaction type from another, within a given originating
984: * application. It can be null, but you must always pass its value explicitly.
985: * @param availableOrdersOut This is the table defined by ame_util.ordersTable
986: * which represents the list of available orders.
987: * @rep:displayname Get Available Orders
988: * @rep:category BUSINESS_ENTITY AME_APPROVAL
989: * @rep:lifecycle active
995: procedure getAvailableOrders(applicationIdIn in integer,
996: transactionIdIn in varchar2,
997: positionIn in integer,
998: transactionTypeIn in varchar2 default null,
999: availableOrdersOut out nocopy ame_util.ordersTable);
1000: --
1001: -- ----------------------------------------------------------------------------
1002: -- |---------------------------< getconditiondetails >------------------------|
1003: -- ----------------------------------------------------------------------------
1060: includeLowerLimitOut out nocopy varchar2,
1061: includeUpperLimitOut out nocopy varchar2,
1062: /*
1063: includeLowerLimitOut and includeUpperLimitOut will be
1064: ame_util.booleanTrue, ame_util.booleanFalse, or null.
1065: */
1066: currencyCodeOut out nocopy varchar2,
1067: allowedValuesOut out nocopy ame_util.longestStringList);
1068: --
1063: includeLowerLimitOut and includeUpperLimitOut will be
1064: ame_util.booleanTrue, ame_util.booleanFalse, or null.
1065: */
1066: currencyCodeOut out nocopy varchar2,
1067: allowedValuesOut out nocopy ame_util.longestStringList);
1068: --
1069: -- ----------------------------------------------------------------------------
1070: -- |-----------------------------< getGroupMembers >--------------------------|
1071: -- ----------------------------------------------------------------------------
1112: procedure getGroupMembers(applicationIdIn in number,
1113: transactionTypeIn in varchar2,
1114: transactionIdIn in varchar2,
1115: groupIdIn in number,
1116: memberOrderNumbersOut out nocopy ame_util.idList,
1117: memberPersonIdsOut out nocopy ame_util.idList,
1118: memberUserIdsOut out nocopy ame_util.idList);
1119: --
1120: -- ----------------------------------------------------------------------------
1113: transactionTypeIn in varchar2,
1114: transactionIdIn in varchar2,
1115: groupIdIn in number,
1116: memberOrderNumbersOut out nocopy ame_util.idList,
1117: memberPersonIdsOut out nocopy ame_util.idList,
1118: memberUserIdsOut out nocopy ame_util.idList);
1119: --
1120: -- ----------------------------------------------------------------------------
1121: -- |-----------------------------< getnextapprover >--------------------------|
1114: transactionIdIn in varchar2,
1115: groupIdIn in number,
1116: memberOrderNumbersOut out nocopy ame_util.idList,
1117: memberPersonIdsOut out nocopy ame_util.idList,
1118: memberUserIdsOut out nocopy ame_util.idList);
1119: --
1120: -- ----------------------------------------------------------------------------
1121: -- |-----------------------------< getnextapprover >--------------------------|
1122: -- ----------------------------------------------------------------------------
1154: * negative integer.
1155: * @param transactiontypein This is a string parameter up to 50 bytes long. It
1156: * distinguishes one transaction type from another, within a given originating
1157: * application. It can be null, but you must always pass its value explicitly.
1158: * @param nextapproverout This is an ame_util.approverRecord which identifies
1159: * the approver, requiring notification for
1160: * the current stage of the input transaction's approval process.
1161: * @rep:displayname Get Next Approver
1162: * @rep:category BUSINESS_ENTITY AME_APPROVAL
1168: --
1169: procedure getNextApprover(applicationIdIn in integer,
1170: transactionIdIn in varchar2,
1171: transactionTypeIn in varchar2 default null,
1172: nextApproverOut out nocopy ame_util.approverRecord);
1173: --
1174: -- ----------------------------------------------------------------------------
1175: -- |-----------------------------< getoldapprovers >--------------------------|
1176: -- ----------------------------------------------------------------------------
1206: * negative integer.
1207: * @param transactiontypein This is a string parameter up to 50 bytes long. It
1208: * distinguishes one transaction type from another, within a given originating
1209: * application. It can be null, but you must always pass its value explicitly.
1210: * @param oldapproversout This is an ame_util.approverTable that will keep the
1211: * generated old approvers list.
1212: * @rep:displayname Get Old Approvers
1213: * @rep:category BUSINESS_ENTITY AME_APPROVAL
1214: * @rep:lifecycle active
1219: --
1220: procedure getOldApprovers(applicationIdIn in integer,
1221: transactionIdIn in varchar2,
1222: transactionTypeIn in varchar2 default null,
1223: oldApproversOut out nocopy ame_util.approversTable);
1224: --
1225: -- ----------------------------------------------------------------------------
1226: -- |-----------------------------< getruledetails1 >--------------------------|
1227: -- ----------------------------------------------------------------------------
1274: --
1275: procedure getRuleDetails1(ruleIdIn in integer,
1276: ruleTypeOut out nocopy varchar2,
1277: ruleDescriptionOut out nocopy varchar2,
1278: conditionIdsOut out nocopy ame_util.idList,
1279: approvalTypeNameOut out nocopy varchar2,
1280: approvalTypeDescriptionOut out nocopy varchar2,
1281: approvalDescriptionOut out nocopy varchar2);
1282: --
1328: --
1329: procedure getRuleDetails2(ruleIdIn in integer,
1330: ruleTypeOut out nocopy varchar2,
1331: ruleDescriptionOut out nocopy varchar2,
1332: conditionDescriptionsOut out nocopy ame_util.longestStringList,
1333: approvalTypeNameOut out nocopy varchar2,
1334: approvalTypeDescriptionOut out nocopy varchar2,
1335: approvalDescriptionOut out nocopy varchar2);
1336: --
1388: --
1389: procedure getRuleDetails3(ruleIdIn in integer,
1390: ruleTypeOut out nocopy varchar2,
1391: ruleDescriptionOut out nocopy varchar2,
1392: conditionIdsOut out nocopy ame_util.idList,
1393: conditionDescriptionsOut out nocopy ame_util.longestStringList,
1394: conditionHasLOVsOut out nocopy ame_util.charList,
1395: /* Each value is ame_util.booleanTrue or ame_util.booleanFalse. */
1396: approvalTypeNameOut out nocopy varchar2,
1389: procedure getRuleDetails3(ruleIdIn in integer,
1390: ruleTypeOut out nocopy varchar2,
1391: ruleDescriptionOut out nocopy varchar2,
1392: conditionIdsOut out nocopy ame_util.idList,
1393: conditionDescriptionsOut out nocopy ame_util.longestStringList,
1394: conditionHasLOVsOut out nocopy ame_util.charList,
1395: /* Each value is ame_util.booleanTrue or ame_util.booleanFalse. */
1396: approvalTypeNameOut out nocopy varchar2,
1397: approvalTypeDescriptionOut out nocopy varchar2,
1390: ruleTypeOut out nocopy varchar2,
1391: ruleDescriptionOut out nocopy varchar2,
1392: conditionIdsOut out nocopy ame_util.idList,
1393: conditionDescriptionsOut out nocopy ame_util.longestStringList,
1394: conditionHasLOVsOut out nocopy ame_util.charList,
1395: /* Each value is ame_util.booleanTrue or ame_util.booleanFalse. */
1396: approvalTypeNameOut out nocopy varchar2,
1397: approvalTypeDescriptionOut out nocopy varchar2,
1398: approvalDescriptionOut out nocopy varchar2);
1391: ruleDescriptionOut out nocopy varchar2,
1392: conditionIdsOut out nocopy ame_util.idList,
1393: conditionDescriptionsOut out nocopy ame_util.longestStringList,
1394: conditionHasLOVsOut out nocopy ame_util.charList,
1395: /* Each value is ame_util.booleanTrue or ame_util.booleanFalse. */
1396: approvalTypeNameOut out nocopy varchar2,
1397: approvalTypeDescriptionOut out nocopy varchar2,
1398: approvalDescriptionOut out nocopy varchar2);
1399: --
1479: * negative integer.
1480: * @param transactiontypein This is a string parameter up to 50 bytes long. It
1481: * distinguishes one transaction type from another, within a given originating
1482: * application. It can be null, but you must always pass its value explicitly.
1483: * @param approverIn This is the approverRecord defined by ame_util.approverRecord
1484: * which gives information regarding the Approver.
1485: * @param positionIn This specifies the index in the approver list where the insertion
1486: * is to be performed.
1487: * @param orderIn This is the record defined by ame_util.orderRecord which indicates the
1483: * @param approverIn This is the approverRecord defined by ame_util.approverRecord
1484: * which gives information regarding the Approver.
1485: * @param positionIn This specifies the index in the approver list where the insertion
1486: * is to be performed.
1487: * @param orderIn This is the record defined by ame_util.orderRecord which indicates the
1488: * order of insertion.
1489: * @rep:displayname Insert Approver
1490: * @rep:category BUSINESS_ENTITY AME_APPROVAL
1491: * @rep:lifecycle active
1495: -- {End Of Comments}
1496: --
1497: procedure insertApprover(applicationIdIn in integer,
1498: transactionIdIn in varchar2,
1499: approverIn in ame_util.approverRecord,
1500: positionIn in integer,
1501: orderIn in ame_util.orderRecord,
1502: transactionTypeIn in varchar2 default null);
1503: --
1497: procedure insertApprover(applicationIdIn in integer,
1498: transactionIdIn in varchar2,
1499: approverIn in ame_util.approverRecord,
1500: positionIn in integer,
1501: orderIn in ame_util.orderRecord,
1502: transactionTypeIn in varchar2 default null);
1503: --
1504: -- ----------------------------------------------------------------------------
1505: -- |-----------------------------< setFirstAuthorityApprover >-----------------|
1533: * @param transactionidin This is a string up to 50 bytes long. It identifies a
1534: * transaction within a transaction type. Its value must not contain
1535: * white-space characters, and must not be the character representation of a
1536: * negative integer.
1537: * @param approverIn This is the approverRecord defined by ame_util.approverRecord
1538: * which gives information regarding the Approver.
1539: * @param transactiontypein This is a string parameter up to 50 bytes long. It
1540: * distinguishes one transaction type from another, within a given originating
1541: * application. It can be null, but you must always pass its value explicitly.
1550: --
1551:
1552: procedure setFirstAuthorityApprover(applicationIdIn in integer,
1553: transactionIdIn in varchar2,
1554: approverIn in ame_util.approverRecord,
1555: transactionTypeIn in varchar2 default null);
1556: --
1557: -- ----------------------------------------------------------------------------
1558: -- |---------------------------< updateapprovalstatus >-----------------------|
1563: * This API updates an approver's approval status.
1564: * Updates an approver's status (to the approval_status value in
1565: * approverIn); and, if the approval_status value indicates that a
1566: * forwarding has occurred, identifies the forwardee. However, if
1567: * the approval_status value is ame_util.clearExceptionsStatus, the
1568: * procedure clears the transaction's exception log in AME, without
1569: * changing any approver's status, regardless of the approver
1570: * identified by approverIn.
1571: * When a chain-of-authority approver forwards, AME makes the
1569: * changing any approver's status, regardless of the approver
1570: * identified by approverIn.
1571: * When a chain-of-authority approver forwards, AME makes the
1572: * forwardee also a chain-of-authority approver. Otherwise, the
1573: * forwardee has the api_insertion value ame_util.apiInsertion, and
1574: * the same authority value as the forwarder.
1575: *
1576: *
Licensing
1577: * This API is available for use with any licensed component of the e-business
1595: * negative integer.
1596: * @param transactiontypein This is a string parameter up to 50 bytes long. It
1597: * distinguishes one transaction type from another, within a given originating
1598: * application. It can be null, but you must always pass its value explicitly.
1599: * @param approverIn This is the approverRecord defined by ame_util.approverRecord
1600: * which gives information regarding the Approver.
1601: * @param forwardeeIn Approver record of the forwardee if forwarding has been done.
1602: * @rep:displayname Update Approval Status
1603: * @rep:category BUSINESS_ENTITY AME_APPROVAL
1608: -- {End Of Comments}
1609: --
1610: procedure updateApprovalStatus(applicationIdIn in integer,
1611: transactionIdIn in varchar2,
1612: approverIn in ame_util.approverRecord,
1613: transactionTypeIn in varchar2 default null,
1614: forwardeeIn in ame_util.approverRecord default ame_util.emptyApproverRecord);
1615: --
1616: -- ----------------------------------------------------------------------------
1610: procedure updateApprovalStatus(applicationIdIn in integer,
1611: transactionIdIn in varchar2,
1612: approverIn in ame_util.approverRecord,
1613: transactionTypeIn in varchar2 default null,
1614: forwardeeIn in ame_util.approverRecord default ame_util.emptyApproverRecord);
1615: --
1616: -- ----------------------------------------------------------------------------
1617: -- |--------------------------< updateapprovalstatus2 >-----------------------|
1618: -- ----------------------------------------------------------------------------
1620: -- {Start Of Comments}
1621: /*#
1622: * This is a wrapper for updateApprovalStatus that lets you
1623: * identify an approver by person ID or user ID, rather than passing
1624: * an entire ame_util.approverRecord to the API.
1625: *
1626: *
Licensing
1627: * This API is available for use with any licensed component of the e-business
1628: * suite.
1648: * application. It can be null, but you must always pass its value explicitly.
1649: * @param approvalStatusIn This specifies the status to be updated.
1650: * @param approverPersonIdIn This specifies the person id of the approver.
1651: * @param approverUserIdIn This specifies the user id of the approver.
1652: * @param forwardeeIn This is the record specified by ame_util.approverRecord
1653: * that represents the approver to whom forwarding has been done.
1654: * @param approvalTypeIdIn This specifies the type of the approver.
1655: * @param groupOrChainIdIn This specifies the id of the Group or the chain
1656: * to which the approver belongs to.
1669: approvalStatusIn in varchar2,
1670: approverPersonIdIn in integer default null,
1671: approverUserIdIn in integer default null,
1672: transactionTypeIn in varchar2 default null,
1673: forwardeeIn in ame_util.approverRecord default ame_util.emptyApproverRecord,
1674: approvalTypeIdIn in integer default null,
1675: groupOrChainIdIn in integer default null,
1676: occurrenceIn in integer default null);
1677: end ame_api;