DBA Data[Home] [Help]

PACKAGE: APPS.AME_API4

Source


1 package ame_api4 AUTHID CURRENT_USER as
2 /* $Header: ameeapi4.pkh 120.1 2005/10/02 02:35 aroussel $ */
3 /*#
4  * This package contains ancillary APIs.
5  * @rep:scope public
6  * @rep:product AME
7  * @rep:displayname Approval Process Groups
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-----------------------------< getgroupmembers >--------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16  * This API returns the approval group members' details for the input approval
17  * group id and transaction.
18  *
19  * This API returns the approval group members order number, person id and user
20  * id for the input approval group id and transaction.
21  *
22  * <p><b>Licensing</b><br>
23  * This API is available for use with any licensed component of the e-business
24  * suite.
25  *
26  * <p><b>Prerequisites</b><br>
27  * No known prerequisites.
28  *
29  * <p><b>Post Success</b><br>
30  * The API will return the approval group members' person id or user id and
31  * their corresponding order numbers.
32  *
33  * <p><b>Post Failure</b><br>
34  * The API will not return the group members' details and will raise an error.
35  *
36  * @param applicationidin The fnd_application.application_id value of the
37  * originating application calling the AME API routine.
38  * @param transactiontypein This is a string parameter up to 50 bytes long. It
39  * distinguishes one transaction type from another, within a given originating
40  * application. It can be null, but you must always pass its value explicitly.
41  * @param transactionidin This is a string up to 50 bytes long. It identifies a
42  * transaction within a transaction type. Its value must not contain
43  * white-space characters, and must not be the character representation of a
44  * negative integer.
45  * @param groupidin Approval group id.
46  * @param memberordernumbersout Group members' order number.
47  * @param memberpersonidsout Group members' person id.
48  * @param memberuseridsout Group members' user id.
49  * @rep:displayname Get Group Members
50  * @rep:category BUSINESS_ENTITY AME_APPROVAL
51  * @rep:lifecycle active
52  * @rep:scope public
53 */
54 --
55 -- {End Of Comments}
56 --
57   procedure getGroupMembers(applicationIdIn       in number,
58                             transactionTypeIn     in varchar2,
59                             transactionIdIn       in varchar2,
60                             groupIdIn             in number,
61                             memberOrderNumbersOut out nocopy ame_util.idList,
62                             memberPersonIdsOut    out nocopy ame_util.idList,
63                             memberUserIdsOut      out nocopy ame_util.idList);
64 end ame_api4;