1 PACKAGE GMD_FORMULA_PUB AS
2 /* $Header: GMDPFMHS.pls 120.1 2006/10/03 18:10:31 rajreddy noship $ */
3 /*#
4 * This interface is used to create, update and delete Formula headers.
5 * This package defines and implements the procedures and datatypes
6 * required to create, update and delete Formula header information.
7 * Provides customers with thet ability to load/update externally formulated
8 * products and byproducts into OPM database schema.
9 * @rep:scope public
10 * @rep:product GMD
11 * @rep:lifecycle active
12 * @rep:displayname Formula Header package
13 * @rep:compatibility S
14 * @rep:category BUSINESS_ENTITY GMD_FORMULA
15 */
16
17 TYPE formula_update_hdr_tbl_type IS TABLE OF GMD_FORMULA_COMMON_PUB.formula_update_rec_type
18 INDEX BY BINARY_INTEGER;
19
20 TYPE formula_insert_hdr_tbl_type IS TABLE OF GMD_FORMULA_COMMON_PUB.formula_insert_rec_type
21 INDEX BY BINARY_INTEGER;
22
23 /* Start of commments */
24 /* API name : Insert_Formula */
25 /* Type : Public */
26 /* Function : */
27 /* Paramaters : */
28 /* IN : p_api_version IN NUMBER Required */
29 /* p_init_msg_list IN Varchar2 Optional */
30 /* p_commit IN Varchar2 Optional */
31 /* p_called_from_forms IN Varchar2 Optional */
32 /* p_formula_header_tbl_type IN Required */
33 /* p_allow_zero_ing_qty IN VARCHAR2 DEFAULT 'FALSE' --BUG#2868184 */
34 /* OUT x_return_status OUT varchar2(1) */
35 /* x_msg_count OUT Number */
36 /* x_msg_data OUT varchar2(2000) */
37 /* */
38 /* Version : Current Version 1.0 */
39 /* */
40 /* Notes : */
41 /* */
42 /* End of comments */
43
44 /*#
45 * Inserts Formula Header
46 * This is a PL/SQL procedure to create a Formula header.
47 * Every formula header at least needs an ingredient and a product, so formula line
48 * details and formula effectivity are also inserted for the formula header.
49 * Call is made to Insert_FormulaHeader API of GMD_FORMULA_HEADER_PVT package.
50 * @param p_api_version API version field
51 * @param p_init_msg_list Flag to check if message list intialized
52 * @param p_commit Flag to check for commit
53 * @param p_called_from_forms Flag to check if API is called from a form
54 * @param x_return_status 'S'-Success, 'E'-Error, 'U'-Unexpected Error
55 * @param x_msg_count Number of msg's on message stack
56 * @param x_msg_data Actual message data on message stack
57 * @param p_formula_header_tbl Table structure of Formula header
58 * @param p_allow_zero_ing_qty Flag to check if ingredient qty. can be zero
59 * @rep:scope public
60 * @rep:lifecycle active
61 * @rep:displayname Insert Formula Header procedure
62 * @rep:compatibility S
63 */
64 PROCEDURE Insert_Formula
65 ( p_api_version IN NUMBER ,
66 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE ,
67 p_commit IN VARCHAR2 := FND_API.G_FALSE ,
68 p_called_from_forms IN VARCHAR2 := 'NO' ,
69 x_return_status OUT NOCOPY VARCHAR2 ,
70 x_msg_count OUT NOCOPY NUMBER ,
71 x_msg_data OUT NOCOPY VARCHAR2 ,
72 p_formula_header_tbl IN formula_insert_hdr_tbl_type ,
73 p_allow_zero_ing_qty IN VARCHAR2 := 'FALSE'
74 );
75
76
77
78 /* Start of commments */
79 /* API name : Update_formulaHeader */
80 /* Type : Public */
81 /* Function : */
82 /* Paramaters : */
83 /* IN : p_api_version IN NUMBER Required */
84 /* p_init_msg_list IN Varchar2 Optional */
85 /* p_commit IN Varchar2 Optional */
86 /* p_called_from_forms IN Varchar2 Optional */
87 /* p_formula_header_tbl_type IN formula_header_tbl_type Required */
88 /* p_delete_mark IN NUMBER Required */
89 /* */
90 /* OUT x_return_status OUT varchar2(1) */
91 /* x_msg_count OUT Number */
92 /* x_msg_data OUT varchar2(2000) */
93 /* */
94 /* Version : Current Version 1.0 */
95 /* */
96 /* Notes : */
97 /* */
98 /* End of comments */
99
100 /*#
101 * Updates Formula Header
102 * This PL/SQL procedure is responsible for updating a formula header.
103 * Call is made to Update_FormulaHeader API of GMD_FORMULA_HEADER_PVT package.
104 * @param p_api_version API version field
105 * @param p_init_msg_list Flag to check if message list intialized
106 * @param p_commit Flag to check for commit
107 * @param p_called_from_forms Flag to check if API is called from a form
108 * @param x_return_status 'S'-Success, 'E'-Error, 'U'-Unexpected Error
109 * @param x_msg_count Number of msg's on message stack
110 * @param x_msg_data Actual message data on message stack
111 * @param p_formula_header_tbl Table structure of Formula header
112 * @rep:scope public
113 * @rep:lifecycle active
114 * @rep:displayname Update Formula Header procedure
115 * @rep:compatibility S
116 */
117 PROCEDURE Update_FormulaHeader
118 ( p_api_version IN NUMBER ,
119 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE ,
120 p_commit IN VARCHAR2 := FND_API.G_FALSE ,
121 p_called_from_forms IN VARCHAR2 := 'NO' ,
122 x_return_status OUT NOCOPY VARCHAR2 ,
123 x_msg_count OUT NOCOPY NUMBER ,
124 x_msg_data OUT NOCOPY VARCHAR2 ,
125 p_formula_header_tbl IN formula_update_hdr_tbl_type
126 );
127
128
129
130 /* Start of commments */
131 /* API name : Delete_FormulaHeader */
132 /* Type : Public */
133 /* Function : */
134 /* Paramaters : */
135 /* IN : p_api_version IN NUMBER Required */
136 /* p_init_msg_list IN Varchar2 Optional */
137 /* p_commit IN Varchar2 Optional */
138 /* p_called_from_forms IN Varchar2 Optional */
139 /* p_formula_header_tbl IN formula_header_tbl_type Required */
140 /* */
141 /* OUT x_return_status OUT varchar2(1) */
142 /* x_msg_count OUT Number */
143 /* x_msg_data OUT varchar2(2000) */
144 /* */
145 /* Version : Current Version 1.0 */
146 /* */
147 /* Notes : */
148 /* */
149 /* End of comments */
150
151 /*#
152 * Deletes Formula Header
153 * This PL/SQL procedure is responsible for deleting a formula header.
154 * Call is made to Delete_FormulaHeader API of GMD_FORMULA_HEADER_PVT package.
155 * @param p_api_version API version field
156 * @param p_init_msg_list Flag to check if message list intialized
157 * @param p_commit Flag to check for commit
158 * @param p_called_from_forms Flag to check if API is called from a form
159 * @param x_return_status 'S'-Success, 'E'-Error, 'U'-Unexpected Error
160 * @param x_msg_count Number of msg's on message stack
161 * @param x_msg_data Actual message data on message stack
162 * @param p_formula_header_tbl Table structure of Formula header
163 * @rep:scope public
164 * @rep:lifecycle active
165 * @rep:displayname Delete Formula Header procedure
166 * @rep:compatibility S
167 */
168 PROCEDURE Delete_FormulaHeader
169 ( p_api_version IN NUMBER ,
170 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE ,
171 p_commit IN VARCHAR2 := FND_API.G_FALSE ,
172 p_called_from_forms IN VARCHAR2 := 'YES' ,
173 x_return_status OUT NOCOPY VARCHAR2 ,
174 x_msg_count OUT NOCOPY NUMBER ,
175 x_msg_data OUT NOCOPY VARCHAR2 ,
176 p_formula_header_tbl IN formula_update_hdr_tbl_type
177 );
178
179
180
181 END GMD_FORMULA_PUB;
[Home] [Help]