1 PACKAGE Bom_Invoke_Bo AUTHID DEFINER AS
2 /* $Header: BOMBIVKS.pls 120.0 2005/05/25 06:03:07 appldev noship $ */
3 /*#
4 * API for invoking methods in BOM Public packages from a different schema.
5 * When integration applications or code with Oracle Bills of Material resides
6 * in a different schema, these integration application(s) or code can call the
7 * methods in this API to process the Bills of Material.
8 * @rep:scope public
9 * @rep:product BOM
10 * @rep:displayname Invoke Business Object
11 * @rep:compatibility S
12 * @rep:lifecycle active
13 * @rep:category BUSINESS_ENTITY BOM_BILL_OF_MATERIAL
14 */
15 /***************************************************************************
16 --
17 -- Copyright (c) 1996 Oracle Corporation, Redwood Shores, CA, USA
18 -- All rights reserved.
19 --
20 -- FILENAME
21 --
22 -- BOMBIVKS.pls
23 --
24 -- DESCRIPTION
25 --
26 -- Spec of package Bom_Invoke_BO
27 --
28 -- NOTES
29 --
30 -- HISTORY
31 --
32 -- 09-MAR-01 Refai Farook Initial Creation
33 -- 16-MAR-01 Masanori Kimizuka Added wrapper procedures for Error_Handlers
34 -- and FND_GLOBALS.Apps_Initialize
35 --
36 ***************************************************************************/
37
38 -- Invoker for Bom_Bo_Pub.Process_Bom
39 /*#
40 * This method invokes the Process_BOM procedure.This invokes the Process_Bom procedure
41 * in Bom_Bo_Pub public package for creating updating or deleting BOM/Structure Header and all its child entites.
42 * @see Bom_Bo_Pub.Process_Bom
43 * @param p_bo_identifier IN Business Object Identifier
44 * @param p_api_version_number IN API Version Number
45 * @param p_init_msg_list IN Message List Initializer flag
46 * @param p_bom_header_rec IN BOM Header Exposed Column Record
47 * @paraminfo {@rep:innertype Bom_Bo_Pub.Bom_Head_Rec_Type}
48 * @param p_bom_revision_tbl IN BOM Revision Record Table
49 * @paraminfo {@rep:innertype Bom_Bo_Pub.Bom_Revision_Tbl_Type}
50 * @param p_bom_component_tbl IN BOM Component Record Table
51 * @paraminfo {@rep:innertype Bom_Bo_Pub.Bom_Comps_Tbl_Type}
52 * @param p_bom_ref_designator_tbl IN BOM Reference Designator Table
53 * @paraminfo {@rep:innertype Bom_Bo_Pub.Bom_Ref_Designator_Tbl_type}
54 * @param p_bom_sub_component_tbl IN BOM Substitute Component Table
55 * @paraminfo {@rep:innertype Bom_Bo_Pub.Bom_Sub_Component_Tbl_Type}
56 * @param x_bom_header_rec OUT NOCOPY processed BOM Header Exposed Column Record
57 * @paraminfo {@rep:innertype Bom_Bo_Pub.Bom_Head_Rec_Type}
58 * @param x_bom_revision_tbl OUT NOCOPY processed BOM Revision Table
59 * @paraminfo {@rep:innertype Bom_Bo_Pub.Bom_Revision_Tbl_Type}
60 * @param x_bom_component_tbl OUT NOCOPY processed BOM Component Table
61 * @paraminfo {@rep:innertype Bom_Bo_Pub.Bom_Comps_Tbl_Type}
62 * @param x_bom_ref_designator_tbl OUT NOCOPY processed BOM Reference Designator Table
63 * @paraminfo {@rep:innertype Bom_Bo_Pub.Bom_Ref_Designator_Tbl_type}
64 * @param x_bom_sub_component_tbl OUT NOCOPY processed BOM Substitute Component Table
65 * @paraminfo {@rep:innertype Bom_Bo_Pub.Bom_Sub_Component_Tbl_Type}
66 * @param x_return_status OUT NOCOPY Return Status
67 * @param x_msg_count OUT NOCOPY Message Count
68 * @param p_debug IN Debug Flag
69 * @param p_output_dir IN Output Directory for Debug
70 * @param p_debug_filename IN Debug File Name
71 * @rep:scope public
72 * @rep:displayname Invoke Process BOM
73 * @rep:compatibility S
74 * @rep:category BUSINESS_ENTITY BOM_BILL_OF_MATERIAL
75 * @rep:lifecycle active
76 */
77 PROCEDURE Process_Bom
78 ( p_bo_identifier IN VARCHAR2 := 'BOM'
79 , p_api_version_number IN NUMBER := 1.0
80 , p_init_msg_list IN BOOLEAN := FALSE
81 , p_bom_header_rec IN Bom_Bo_Pub.Bom_Head_Rec_Type :=
82 Bom_Bo_Pub.G_MISS_BOM_HEADER_REC
83 , p_bom_revision_tbl IN Bom_Bo_Pub.Bom_Revision_Tbl_Type :=
84 Bom_Bo_Pub.G_MISS_BOM_REVISION_TBL
85 , p_bom_component_tbl IN Bom_Bo_Pub.Bom_Comps_Tbl_Type :=
86 Bom_Bo_Pub.G_MISS_BOM_COMPONENT_TBL
87 , p_bom_ref_designator_tbl IN Bom_Bo_Pub.Bom_Ref_Designator_Tbl_type :=
88 Bom_Bo_Pub.G_MISS_BOM_REF_DESIGNATOR_TBL
89 , p_bom_sub_component_tbl IN Bom_Bo_Pub.Bom_Sub_Component_Tbl_Type :=
90 Bom_Bo_Pub.G_MISS_BOM_SUB_COMPONENT_TBL
91 , x_bom_header_rec OUT NOCOPY Bom_Bo_Pub.bom_Head_Rec_Type
92 , x_bom_revision_tbl OUT NOCOPY Bom_Bo_Pub.Bom_Revision_Tbl_Type
93 , x_bom_component_tbl OUT NOCOPY Bom_Bo_pub.Bom_Comps_Tbl_Type
94 , x_bom_ref_designator_tbl OUT NOCOPY Bom_Bo_Pub.Bom_Ref_Designator_Tbl_Type
95 , x_bom_sub_component_tbl OUT NOCOPY Bom_Bo_Pub.Bom_Sub_Component_Tbl_Type
96 , x_return_status OUT NOCOPY VARCHAR2
97 , x_msg_count OUT NOCOPY NUMBER
98 , p_debug IN VARCHAR2 := 'N'
99 , p_output_dir IN VARCHAR2 := NULL
100 , p_debug_filename IN VARCHAR2 := 'BOM_BO_debug.log'
101 );
102
103 -- Invoker for Error_Handler procedures/functions
104 /*#
105 * This is the invoke call for Initialize method in Error Handler.The user should
106 * use this invoke call to initialize the message list.
107 * @see Error_Handler.Initialize
108 * @rep:displayname Invoke Initialize
109 * @rep:category BUSINESS_ENTITY BOM_BILL_OF_MATERIAL
110 * @rep:scope public
111 * @rep:lifecycle active
112 * @rep:compatibility S
113 */
114 PROCEDURE Initialize;
115 /*#
116 * This is the invoke call for Reset method in Error Handler.The user should
117 * use this invoke call to reset the message list to the begining.
118 * @see Error_Handler.Reset
119 * @rep:displayname Invoke Reset
120 * @rep:category BUSINESS_ENTITY BOM_BILL_OF_MATERIAL
121 * @rep:scope public
122 * @rep:lifecycle active
123 * @rep:compatibility S
124 */
125 PROCEDURE Reset;
126 /*#
127 * This is the invoke call for Get_Message_List in Error Handler.This invokes the
128 * error handling method which returns the entire message list for the business object.
129 * @see Error_Handler.Get_Message_List
130 * @param x_message_list OUT NOCOPY Message List
131 * @rep:scope public
132 * @rep:lifecycle active
133 * @rep:compatibility S
134 * @rep:displayname Invoke Get Message List
135 * @rep:category BUSINESS_ENTITY BOM_BILL_OF_MATERIAL
136 */
137 PROCEDURE Get_Message_List
138 ( x_message_list OUT NOCOPY Error_Handler.Error_Tbl_Type);
139 /*#
140 * This is the invoke call for Get_Entity_Message in Error_Handler.The user should use this
141 * invoke call to enable the error handler to retrieves all Messages for the given entity
142 * @see Eror_Handler.Get_Entity_Message
143 * @param p_entity_id IN Entity Id
144 * @param x_message_list OUT NOCOPY Message List
145 * @rep:scope public
146 * @rep:lifecycle active
147 * @rep:compatibility S
148 * @rep:displayname Invoke Get Entity Message
149 * @rep:category BUSINESS_ENTITY BOM_BILL_OF_MATERIAL
150 */
151 PROCEDURE Get_Entity_Message
152 ( p_entity_id IN VARCHAR2
153 , x_message_list OUT NOCOPY Error_Handler.Error_Tbl_Type
154 );
155 /*#
156 * This is the invoke call for Get_Entity_Message in Error_Handler and it invokes
157 * the method which will retrieve a particular Message at the entity index for an entity
158 * @see Eror_Handler.Get_Entity_Message
159 * @param p_entity_id IN Entity Id
160 * @param p_entity_index Entity Index
161 * @param x_message_text OUT NOCOPY Message List
162 * @rep:scope public
163 * @rep:lifecycle active
164 * @rep:compatibility S
165 * @rep:displayname Invoke Get Entity Message
166 * @rep:category BUSINESS_ENTITY BOM_BILL_OF_MATERIAL
167 */
168 PROCEDURE Get_Entity_Message
169 ( p_entity_id IN VARCHAR2
170 , p_entity_index IN NUMBER
171 , x_message_text OUT NOCOPY VARCHAR2
172 );
173 /*#
174 * This is the invoke call for Delete_Message in Error_Handler.The user invokes the
175 * error handler method which deletes a particular Messages for an entity at the entity index given
176 * with this call.
177 * @see Eror_Handler.Delete_Message
178 * @param p_entity_id IN Entity Id
179 * @param p_entity_index IN Entity Index
180 * @rep:scope public
181 * @rep:lifecycle active
182 * @rep:compatibility S
183 * @rep:displayname Invoke Delete Message
184 * @rep:category BUSINESS_ENTITY BOM_BILL_OF_MATERIAL
185 */
186 PROCEDURE Delete_Message
187 ( p_entity_id IN VARCHAR2
188 , p_entity_index IN NUMBER
189 );
190 /*#
191 * This is the invoke call for Delete_Message in Error_Handler.This will invoke the Error_Handler
192 * method which deletes all Messages for the specified entity.
193 * @see Eror_Handler.Delete_Message
194 * @param p_entity_id IN Entity Id
195 * @rep:scope public
196 * @rep:lifecycle active
197 * @rep:compatibility S
198 * @rep:displayname Invoke Delete Message
199 * @rep:category BUSINESS_ENTITY BOM_BILL_OF_MATERIAL
200 */
201 PROCEDURE Delete_Message
202 ( p_entity_id IN VARCHAR2 );
203 /*#
204 * This is the invoke call for the Get_Message in Error_Handler.This invokes the
205 * Error_Handler to retrieve message from the Message List
206 * @see Error_Handler.Get_Message
207 * @param x_message_text OUT NOCOPY Message Text
208 * @param x_entity_index OUT NOCOPY Entity Index
209 * @param x_entity_id OUT NOCOPY Entity Id
210 * @param x_message_type OUT NOCOPY Message Type
211 * @rep:scope public
212 * @rep:lifecycle active
213 * @rep:compatibility S
214 * @rep:displayname Invoke Get Message
215 * @rep:category BUSINESS_ENTITY BOM_BILL_OF_MATERIAL
216 */
217 PROCEDURE Get_Message
218 ( x_message_text OUT NOCOPY VARCHAR2
219 , x_entity_index OUT NOCOPY NUMBER
220 , x_entity_id OUT NOCOPY VARCHAR2
221 , x_message_type OUT NOCOPY VARCHAR2
222 );
223 /*#
224 * This is the invoke call for the Get_Message_Count function in Error_Handler.The user should use this
225 * invoke call to get the number of curretn messages in Message List.
226 * @return Message Count
227 * @see Error_Handler.Get_Message_Count
228 * @rep:displayname Invoke Get Message Count
229 * @rep:category BUSINESS_ENTITY BOM_BILL_OF_MATERIAL
230 */
231
232 FUNCTION Get_Message_Count RETURN NUMBER;
233 /*#
234 * This is the invoke call for the Dump_Message in Error Handler.This invoke call enables the
235 * Error_Handler to create a dump of message using dbms output.
236 * @see Error_Handler.Dump_Message_List
237 * @rep:displayname Invoke Get Message Count
238 * @rep:category BUSINESS_ENTITY BOM_BILL_OF_MATERIAL
239 */
240 PROCEDURE Dump_Message_List;
241
242
243 -- Invoker for FND_GLOBAL.APPS_INITIALIZE
244 PROCEDURE Apps_Initialize
245 ( user_id IN NUMBER
246 ,resp_id IN NUMBER
247 ,resp_appl_id IN NUMBER
248 ,security_group_id IN NUMBER default 0
249 ) ;
250 --Invoker for Export_BOM
251 /*#
252 * This is the invoke call for the Export_BOM method in BOMPXINQ API.
253 * @see BOMPXINQ.Export_BOM
254 * @param P_org_hierarchy_name IN Organization Hierarchy Name
255 * @param P_assembly_item_name IN Assembly Item Name
256 * @param P_organization_code IN Organizaion Code
257 * @param P_alternate_bm_designator IN Alternate BOM Designator
258 * @param P_Costs IN Costs
259 * @param P_Cost_type_id IN Coste Type Id
260 * @param X_bom_header_tbl OUT NOCOPY processed BOM Header Exposed Column Table
261 * @paraminfo {@rep:innertype BOM_BO_PUB.BOM_HEADER_TBL_TYPE}
262 * @param X_bom_revisions_tbl OUT NOCOPY BOM Revision Table
263 * @paraminfo {@rep:innertype BOM_BO_PUB.BOM_REVISION_TBL_TYPE}
264 * @param X_bom_components_tbl OUT NOCOPY BOM Components Table
265 * @paraminfo {@rep:innertype BOM_BO_PUB.BOM_COMPS_TBL_TYPE}
266 * @param X_bom_ref_designators_tbl OUT NOCOPY BOM Reference Designator Table
267 * @paraminfo {@rep:innertype BOM_BO_PUB.BOM_REF_DESIGNATOR_TBL_TYPE}
268 * @param X_bom_sub_components_tbl OUT NOCOPY BOM Substitute Components Table
269 * @paraminfo {@rep:innertype BOM_BO_PUB.BOM_SUB_COMPONENT_TBL_TYPE}
270 * @param X_bom_comp_ops_tbl OUT NOCOPY BOM Component Operation Table
271 * @paraminfo {@rep:innertype BOM_BO_PUB.BOM_COMP_OPS_TBL_TYPE}
272 * @param X_Err_Msg OUT NOCOPY Error Message
273 * @param X_Error_Code OUT NOCOPY Error Code
274 * @rep:scope public
275 * @rep:lifecycle active
276 * @rep:category BUSINESS_ENTITY BOM_BILL_OF_MATERIAL
277 * @rep:compatibility S
278 * @rep:displayname Invoke Export BOM
279 */
280 PROCEDURE Export_BOM(P_org_hierarchy_name IN VARCHAR2 DEFAULT NULL,
281 P_assembly_item_name IN VARCHAR2,
282 P_organization_code IN VARCHAR2,
283 P_alternate_bm_designator IN VARCHAR2 DEFAULT NULL,
284 P_Costs IN NUMBER DEFAULT 2,
285 P_Cost_type_id IN NUMBER DEFAULT 0,
286 X_bom_header_tbl OUT NOCOPY BOM_BO_PUB.BOM_HEADER_TBL_TYPE,
287 X_bom_revisions_tbl OUT NOCOPY BOM_BO_PUB.BOM_REVISION_TBL_TYPE,
288 X_bom_components_tbl OUT NOCOPY BOM_BO_PUB.BOM_COMPS_TBL_TYPE,
289 X_bom_ref_designators_tbl OUT NOCOPY BOM_BO_PUB.BOM_REF_DESIGNATOR_TBL_TYPE,
290 X_bom_sub_components_tbl OUT NOCOPY BOM_BO_PUB.BOM_SUB_COMPONENT_TBL_TYPE,
291 X_bom_comp_ops_tbl OUT NOCOPY BOM_BO_PUB.BOM_COMP_OPS_TBL_TYPE,
292 X_Err_Msg OUT NOCOPY VARCHAR2,
293 X_Error_Code OUT NOCOPY NUMBER);
294
295 END Bom_Invoke_Bo;
[Home] [Help]