1 PACKAGE CSM_GROUP_DOWNLOAD_PUB AS
2 /* $Header: csmpgpds.pls 120.2 2008/02/25 09:31:56 anaraman noship $ */
3
4 TYPE l_group_id_tbl_type IS TABLE OF csm_groups.group_id%TYPE INDEX BY BINARY_INTEGER;
5
6 /*#
7 * Downloading a related group to a group API.
8 *
9 * @param p_api_version_number the standard API version number
10 * @param p_init_msg_list the standard API flag allows API callers to request
11 * that the API does the initialization of the message list on their behalf.
12 * By default, the message list will not be initialized.
13 * @param p_group_id the group id to which the related group is to be downloaded
14 * @param p_related_group_id the related group to be downloaded
15 * @param p_operation the operation to be performed
16 * must have one of the following values:
17 * <LI><Code>INSERT</Code>
18 * <LI><Code>DELETE</Code>
19 * @param x_msg_count returns the number of messages in the API message list
20 * @param x_return_status returns the result of all the operations performed
21 * by the API and must have one of the following values:
22 * <LI><Code>FND_API.G_RET_STS_SUCCESS</Code>
23 * <LI><Code>FND_API.G_RET_STS_ERROR</Code>
24 * <LI><Code>FND_API.G_RET_STS_UNEXP_ERROR</Code>
25 * @param x_error_message return the error message
26 */
27
28 PROCEDURE assign_related_group
29 ( p_api_version_number IN NUMBER,
30 p_init_msg_list IN VARCHAR2 :=FND_API.G_FALSE,
31 p_group_id IN NUMBER,
32 p_related_group_id IN NUMBER,
33 p_operation IN VARCHAR2,
34 x_msg_count OUT NOCOPY NUMBER,
35 x_return_status OUT NOCOPY VARCHAR2,
36 x_error_message OUT NOCOPY VARCHAR2
37 );
38
39 /*#
40 * Downloading more than one related groups to a group API.
41 *
42 * @param p_api_version_number the standard API version number
43 * @param p_init_msg_list the standard API flag allows API callers to request
44 * that the API does the initialization of the message list on their behalf.
45 * By default, the message list will not be initialized.
46 * @param p_group_id the group id to which the related group is to be downloaded
47 * @param p_related_group_lst the list of related group to be downloaded
48 * @param p_operation the operation to be performed
49 * must have one of the following values:
50 * <LI><Code>INSERT</Code>
51 * <LI><Code>DELETE</Code>
52 * @param x_msg_count returns the number of messages in the API message list
53 * @param x_return_status returns the result of all the operations performed
54 * by the API and must have one of the following values:
55 * <LI><Code>FND_API.G_RET_STS_SUCCESS</Code>
56 * <LI><Code>FND_API.G_RET_STS_ERROR</Code>
57 * <LI><Code>FND_API.G_RET_STS_UNEXP_ERROR</Code>
58 * @param x_error_message return the error message
59 */
60
61 PROCEDURE assign_mutiple_related_groups
62 ( p_api_version_number IN NUMBER,
63 p_init_msg_list IN VARCHAR2 :=FND_API.G_FALSE,
64 p_group_id IN NUMBER,
65 p_related_group_lst IN l_group_id_tbl_type,
66 p_operation IN VARCHAR2,
67 x_msg_count OUT NOCOPY NUMBER,
68 x_return_status OUT NOCOPY VARCHAR2,
69 x_error_message OUT NOCOPY VARCHAR2
70 );
71
72 /*#
73 * To fetch the related groups for a given group API.
74 *
75 * @param p_api_version_number the standard API version number
76 * @param p_init_msg_list the standard API flag allows API callers to request
77 * that the API does the initialization of the message list on their behalf.
78 * By default, the message list will not be initialized.
79 * @param p_group_id the group id to which the related group are downloaded
80 * @param p_related_group_lst the list of related group to be fetched
81 * @param x_msg_count returns the number of messages in the API message list
82 * @param x_return_status returns the result of all the operations performed
83 * by the API and must have one of the following values:
84 * <LI><Code>FND_API.G_RET_STS_SUCCESS</Code>
85 * <LI><Code>FND_API.G_RET_STS_ERROR</Code>
86 * <LI><Code>FND_API.G_RET_STS_UNEXP_ERROR</Code>
87 * @param x_error_message return the error message
88 */
89
90 PROCEDURE get_related_groups
91 ( p_api_version_number IN NUMBER,
92 p_init_msg_list IN VARCHAR2 :=FND_API.G_FALSE,
93 p_group_id IN NUMBER,
94 p_related_group_lst OUT NOCOPY l_group_id_tbl_type,
95 x_msg_count OUT NOCOPY NUMBER,
96 x_return_status OUT NOCOPY VARCHAR2,
97 x_error_message OUT NOCOPY VARCHAR2
98 );
99
100 END CSM_GROUP_DOWNLOAD_PUB;
[Home] [Help]