1 PACKAGE GMF_ALLOCATIONDEFINITION_PUB AUTHID CURRENT_USER AS
2 /* $Header: GMFPALCS.pls 120.2 2006/02/03 00:58:32 pmarada noship $ */
3 /*#
4 * This is the public interface for OPM Allocation Definitions API
5 * This API can be used to create, update and delete
6 * allocation definitions
7 * @rep:scope public
8 * @rep:product GMF
9 * @rep:displayname GMF Allocation Definitions API
10 * @rep:lifecycle active
11 * @rep:category BUSINESS_ENTITY GMF_ALLOCATION_DEFINITION
12 */
13
14 -- Definition of all the entities
15 TYPE Allocation_Definition_Rec_Type IS RECORD
16 (
17 alloc_id NUMBER ,
18 alloc_code gl_aloc_mst.alloc_code%TYPE ,
19 legal_entity_id gmf_legal_entities.legal_entity_id%TYPE ,
20 alloc_method NUMBER ,
21 line_no NUMBER ,
22 item_id NUMBER ,
23 item_number mtl_item_flexfields.item_number%TYPE ,
24 basis_account_id gl_aloc_bas.basis_account_id%TYPE,
25 basis_account_key gl_aloc_bas.basis_account_key%TYPE ,
26 balance_type NUMBER ,
27 bas_ytd_ptd NUMBER ,
28 basis_type NUMBER,
29 fixed_percent NUMBER ,
30 cmpntcls_id NUMBER ,
31 cost_cmpntcls_code cm_cmpt_mst.cost_cmpntcls_code%TYPE ,
32 analysis_code cm_alys_mst.cost_analysis_code%TYPE ,
33 organization_id gl_aloc_bas.organization_id%TYPE ,
34 organization_code mtl_parameters.organization_code%TYPE,
35 delete_mark gl_aloc_bas.delete_mark%TYPE := 0 ,
36 user_name fnd_user.user_name%TYPE
37 );
38
39 /*#
40 * Allocation Definitions Creation API
41 * This API Creates a new Allocation Definitions in Allocation Basis Table
42 * @param p_api_version Version Number of the API
43 * @param p_init_msg_list Flag for initializing message list
44 * @param p_commit Flag for commiting the data or not
45 * @param x_return_status Return status 'S'-Success, 'E'-Error, 'U'-Unexpected Error
46 * @param x_msg_count Number of messages on message stack
47 * @param x_msg_data Actual message data from message stack
48 * @param p_allocation_definition_rec Allocation definitions record type
49 * @rep:scope public
50 * @rep:lifecycle active
51 * @rep:displayname Create Allocation Definitions API
52 */
53 PROCEDURE Create_Allocation_Definition
54 (
55 p_api_version IN NUMBER ,
56 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE ,
57 p_commit IN VARCHAR2 := FND_API.G_FALSE ,
58
59 x_return_status OUT NOCOPY VARCHAR2 ,
60 x_msg_count OUT NOCOPY NUMBER ,
61 x_msg_data OUT NOCOPY VARCHAR2 ,
62
63 p_allocation_definition_rec IN Allocation_Definition_Rec_Type
64 );
65
66 /*#
67 * Allocation Definitions Updation API
68 * This API Updates a Allocation Definitions in Allocation Basis Table
69 * @param p_api_version Version Number of the API
70 * @param p_init_msg_list Flag for initializing message list
71 * @param p_commit Flag for commiting the data or not
72 * @param x_return_status Return status 'S'-Success, 'E'-Error, 'U'-Unexpected Error
73 * @param x_msg_count Number of messages on message stack
74 * @param x_msg_data Actual message data from message stack
75 * @param p_allocation_definition_rec Allocation definitions record type
76 * @rep:scope public
77 * @rep:lifecycle active
78 * @rep:displayname Update Allocation Definitions API
79 */
80 PROCEDURE Update_Allocation_Definition
81 (
82 p_api_version IN NUMBER ,
83 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE ,
84 p_commit IN VARCHAR2 := FND_API.G_FALSE ,
85
86 x_return_status OUT NOCOPY VARCHAR2 ,
87 x_msg_count OUT NOCOPY NUMBER ,
88 x_msg_data OUT NOCOPY VARCHAR2 ,
89
90 p_allocation_definition_rec IN Allocation_Definition_Rec_Type
91 );
92
93 /*#
94 * Allocation Definitions Deletion API
95 * This API Deletes a new Allocation Definitions from Allocation Basis Table
96 * @param p_api_version Version Number of the API
97 * @param p_init_msg_list Flag for initializing message list
98 * @param p_commit Flag for commiting the data or not
99 * @param x_return_status Return status 'S'-Success, 'E'-Error, 'U'-Unexpected Error
100 * @param x_msg_count Number of messages on message stack
101 * @param x_msg_data Actual message data from message stack
102 * @param p_allocation_definition_rec Allocation definitions record type
103 * @rep:scope public
104 * @rep:lifecycle active
105 * @rep:displayname Delete Allocation Definitions API
106 */
107 PROCEDURE Delete_Allocation_Definition
108 (
109 p_api_version IN NUMBER ,
110 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE ,
111 p_commit IN VARCHAR2 := FND_API.G_FALSE ,
112
113 x_return_status OUT NOCOPY VARCHAR2 ,
114 x_msg_count OUT NOCOPY NUMBER ,
115 x_msg_data OUT NOCOPY VARCHAR2 ,
116
117 p_allocation_definition_rec IN Allocation_Definition_Rec_Type
118 );
119
120 END GMF_ALLOCATIONDEFINITION_PUB;
121