1 package EGO_PUB_FWK_PK AUTHID CURRENT_USER AS
2 /* $Header: EGOPFWKS.pls 120.8.12020000.6 2013/05/22 09:01:32 qyou ship $*/
3 /*#
4 * The package provides procedures to create a batch, copy a batch, publish batches
5 * and delete batches.
6 * <br>
7 *
8 * Each of the following data types is defined as an Oracle table type
9 * that exists independently in the database. They are discussed here
10 * because all of these types were created for use by this package.
11 * <br>
12 * ==========================
13 * = TBL_OF_BAT_PARAM_TYPE =
14 * ==========================
15 * <code><pre>
16 TYPE BAT_PARAM_REC_TYPE IS RECORD
17 (
18 param_name Varchar2(4000),
19 char_value Varchar2(4000),
20 number_value Number,
21 date_value Date,
22 data_type Number,
23 param_type Number
24 );
25
26 TYPE TBL_OF_BAT_PARAM_TYPE IS TABLE OF BAT_PARAM_REC_TYPE
27 INDEX BY BINARY_INTEGER;
28 * </pre></code>
29 * <br>
30 * BAT_PARAM_REC_TYPE is a record type that contains data for a parameter
31 * value in a batch. TBL_OF_BAT_PARAM_TYPE is a table type that contains data
32 * for parameters in a batch. The param_name is the parameter name; char_value
33 * is the value of a string type parameter; number_value is the value of a
34 * number type parameter, date_value is the value of a date type parameter;
35 * data_type indicates the parameter type, with one of the following values:
36 * C_NUMBER_TYPE, C_STRING_TYPE, C_DATE_TYPE; param_type is the parameter type,
37 * with one of the following values: C_PARAM_TYPE_BATCH, C_PARAM_TYPE_DEST.
38 * The valid param_name, data_type, param_type and value combinations are
39 * listed below (the API checks param_name and value, then resets
40 * data_type and param_type with correct value):
41 * <br>
42 * The C_PARAM_WKSPNAME is Workspace Name, data_type is C_STRING_TYPE,
43 * param_type is C_PARAM_TYPE_DEST. Enter the value in the char_value field.
44 * The C_PARAM_AUTOREL is Auto-Release, data_type is C_STRING_TYPE,
45 * param_type is C_PARAM_TYPE_DEST. Enter one of the following values in the
46 * char_value field:
47 * null, C_PARAM_VAL_AUTOREL_DEFAULT, C_PARAM_VAL_YES, or C_PARAM_VAL_NO.
48 * The C_PARAM_PUBTOPIM is Launch Sync Program, data_type is C_STRING_TYPE,
49 * param_type is C_PARAM_TYPE_DEST. Enter one of the following values in the
50 * char_value field:
51 * null, C_PARAM_VAL_YES, or C_PARAM_VAL_NO.
52 * The C_PARAM_PUBTYPE is Publish to PIM Systems Only, data_type is C_STRING_TYPE,
53 * param_type is C_PARAM_TYPE_BATCH. Enter one of the following values in the
54 * char_value field:
55 * null, C_PARAM_VAL_YES, or C_PARAM_VAL_NO.
56 * The C_PARAM_STRUCTN is Structure Name, data_type is C_STRING_TYPE,
57 * param_type is C_PARAM_TYPE_BATCH. Enter the value in the char_value field.
58 * The C_PARAM_EXPLDATE is Explosion Date, data_type is C_DATE_TYPE,
59 * param_type is C_PARAM_TYPE_BATCH. Enter the value in the date_value field.
60 * The C_PARAM_LEVLEXPL is Number of Levels to Publish, data_type is
61 * C_NUMBER_TYPE, param_type is C_PARAM_TYPE_BATCH. Enter the value
62 * in the number_value field with a value between 0 to 60.
63 * The C_PARAM_EXPLSTDB is Explode Standard BOM, data_type is C_STRING_TYPE,
64 * param_type is C_PARAM_TYPE_BATCH. Enter one of the following values in the
65 * char_value field: C_PARAM_VAL_YES, C_PARAM_VAL_NO.
66 * The C_PARAM_EXPLOPTN is Explode Option, data_type is C_STRING_TYPE,
67 * param_type is C_PARAM_TYPE_BATCH. Enter one of the following values in the
68 * char_value field:
69 * C_PARAM_VAL_EXPLTYPE_ALL (all), C_PARAM_VAL_EXPLTYPE_CUR (current),
70 * C_PARAM_VAL_EXPLTYPE_CUF (current and furture).
71 * The C_PARAM_PUBPARENT is Publish Parent Heirarchy, data_type is C_STRING_TYPE,
72 * param_type is C_PARAM_TYPE_BATCH. Enter one of the following values in the
73 * char_value field: C_PARAM_VAL_TRUE, C_PARAM_VAL_FALSE.
74 * The C_PARAM_PUBCHILD is Publish Child Heirarchy, data_type is C_STRING_TYPE,
75 * param_type is C_PARAM_TYPE_BATCH. Enter one of the following values in the
76 * char_value field: C_PARAM_VAL_TRUE, C_PARAM_VAL_FALSE.
77 *
78 * <br>
79 * ==========================
80 * = TBL_OF_BAT_ENT_OBJ_TYPE =
81 * ==========================
82 * <code><pre>
83 TYPE BAT_ENT_OBJ_TYPE IS RECORD
84 (
85 batch_id NUMBER,
86 pk1_value VARCHAR2(150),
87 pk2_value VARCHAR2(150),
88 pk3_value VARCHAR2(150),
89 pk4_value VARCHAR2(150),
90 pk5_value VARCHAR2(150),
91 user_entered VARCHAR2(1),
92 entity_type_id NUMBER
93 );
94
95 TYPE TBL_OF_BAT_ENT_OBJ_TYPE IS TABLE OF BAT_ENT_OBJ_TYPE
96 INDEX BY BINARY_INTEGER;
97 * </pre></code>
98 * <br>
99 * BAT_ENT_OBJ_TYPE is a record type that contains data for an entity in a
100 * batch. TBL_OF_BAT_ENT_OBJ_TYPE is a table type that contains data for
101 * entities in a batch. The batch_id is used internally and the caller does
102 * not need to specify it; pk1_value, pk2_value, pk3_value, pk4_value, pk5_value
103 * are the entity id values. For an item, pk1_value is the INVENTORY_ITEM_ID
104 * value, pk2_value is the ORAGNIZATION_ID value, pk3_value is the
105 * MTL_ITEM_REVISIONS_B.REVISION_ID value. For an item catalog category,
106 * pk1_value is the MTL_ITEM_CATALOG_GROUPS_B.ITEM_CATALOG_GROUP_ID value,
107 * pk2_value is the EGO_MTL_CATALOG_GRP_VERS_B.VERSION_SEQ_ID value. For
108 * an attribute group, pk1_value is the EGO_ATTRS_V.ATTR_ID. For a valueset,
109 * pk1_value is the EGO_VALUE_SETS_V.VALUE_SET_ID.
110 *
111 * <br>
112 * ==========================
113 * = TBL_OF_BAT_SYS_CODE_TYPE =
114 * ==========================
115 * <code><pre>
116 Type BAT_SYS_CODE IS RECORD
117 (
118 system_name varchar2(100),
119 system_code varchar(30)
120 );
121
122 TYPE TBL_OF_BAT_SYS_CODE_TYPE IS TABLE OF BAT_SYS_CODE
123 INDEX BY BINARY_INTEGER;
124 * </pre></code>
125 * <br>
126 * BAT_SYS_CODE is a record type that contains data for a target system in a
127 * batch. TBL_OF_BAT_SYS_CODE_TYPE is a table type that contains data for
128 * target systems in a batch. The system_name is the system's display name,
129 * the system_code is the system internal name. The API uses system_code to
130 * validate the system. If the system_code has no value, the API uses
131 * the system_name to retrieve a valid system_code.
132 *
133 *
134 *
135 *
136 * @rep:scope public
137 * @rep:product EGO
138 * @rep:displayname PIM Publish APIs
139 * @rep:lifecycle active
140 * @rep:category BUSINESS_ENTITY EGO_ITEM_METADATA_PUBLISH
141 */
142
143 -- EGO_ITEM_METADATA_PUBLISH
144 -- This interface creates, publishes, copies and deletes item and metadata (Item Catalog Category, Attribute Group, Value Set) batches.
145
146 -- added for public api
147 TYPE BAT_PARAM_REC_TYPE IS RECORD
148 (
149 param_name Varchar2(4000),--EGO_PUB_BAT_PARAMS_B.PARAMETER_NAME%TYPE;
150 char_value Varchar2(4000),--EGO_PUB_BAT_PARAMS_B.CHAR_VALUE%TYPE;
151 number_value Number,
152 date_value Date,
153 data_type Number,
154 param_type Number
155 );
156
157 TYPE TBL_OF_BAT_PARAM_TYPE IS TABLE OF BAT_PARAM_REC_TYPE
158 INDEX BY BINARY_INTEGER;
159
160 -- use system_code, or use system_name to find a valid system_code
161 Type BAT_SYS_CODE IS RECORD
162 (
163 system_name varchar2(100),
164 system_code varchar(30)
165 );
166
167 TYPE TBL_OF_BAT_SYS_CODE_TYPE IS TABLE OF BAT_SYS_CODE
168 INDEX BY BINARY_INTEGER;
169
170 TYPE TBL_OF_BAT_BATCH_NAME_TYPE is Table of varchar2(100)
171 INDEX BY BINARY_INTEGER;
172
173 TYPE TBL_OF_BAT_BATCH_ID_TYPE is Table of Number
174 INDEX BY BINARY_INTEGER;
175
176 C_BATCH_ENTITY_ICC NUMBER := 1;
177 C_BATCH_ENTITY_VS NUMBER := 2;
178 C_BATCH_ENTITY_ITEM NUMBER := 3;
179 C_BATCH_ENTITY_AG NUMBER := 4;
180
181 C_NUMBER_TYPE NUMBER := 1;
182 C_STRING_TYPE NUMBER := 2;
183 C_DATE_TYPE NUMBER := 3;
184
185 C_STATUS_DRAFT VARCHAR2(1) := 'D';
186 C_STATUS_SUBMITTED VARCHAR2(1) := 'B';
187
188 C_SRV_WSDL_URL CONSTANT VARCHAR2(30) := 'SERVICE_WSDL_URL';
189 C_SRV_NAME CONSTANT VARCHAR2(30) := 'SERVICE_NAME';
190 C_SRV_PORT CONSTANT VARCHAR2(30) := 'SERVICE_PORT';
191 C_SRV_PORT_TYPE CONSTANT VARCHAR2(30) := 'SERVICE_PORTTYPE';
192 C_SRV_OPERATION CONSTANT VARCHAR2(30) := 'SERVICE_OPERATION';
193
194 C_PARAM_WKSPNAME CONSTANT VARCHAR2(30) := 'Workspace Name';--char_value
195 C_PARAM_AUTOREL CONSTANT VARCHAR2(30) := 'Auto-Release';--char_value, D/N/Y/null
196 C_PARAM_PUBTYPE CONSTANT VARCHAR2(30) := 'BATCH_PROCESS_TYPE';--UI: Publish to PIM Systems Only, char_value, PUBLISH/SYNC
197 C_PARAM_STRUCTN CONSTANT VARCHAR2(30) := 'STRUCTURE_NAME';--char_value, valid it with item structure
198 C_PARAM_EXPLDATE CONSTANT VARCHAR2(30) := 'EXPLOSION_DATE';--date_value
199 C_PARAM_LEVLEXPL CONSTANT VARCHAR2(30) := 'LEVELS_TO_EXPLODE';--number_value, 1-60
200 C_PARAM_EXPLSTDB CONSTANT VARCHAR2(30) := 'EXPLODE_STD_BOM';--char_value, Y/N
201 C_PARAM_EXPLOPTN CONSTANT VARCHAR2(20) := 'EXPLODE_OPTION';--number_value,
202 C_PARAM_PUBTOPIM CONSTANT VARCHAR2(30) := 'Launch Sync Program'; --UI: Auto Import char_value, Y/N/null
203 C_PARAM_PUBPARENT CONSTANT VARCHAR2(30) := 'PublishParent';-- char_value, true/false
204 C_PARAM_PUBCHILD CONSTANT VARCHAR2(30) := 'PublishChild';-- char_value, true/false
205 C_PARAM_VAL_EXPLTYPE_ALL CONSTANT NUMBER := 1;
206 C_PARAM_VAL_EXPLTYPE_CUR CONSTANT NUMBER := 2;
207 C_PARAM_VAL_EXPLTYPE_CUF CONSTANT NUMBER := 3;
208 C_PARAM_VAL_PUBTYPE_SYNC CONSTANT VARCHAR2(4) := 'SYNC';
209 C_PARAM_VAL_PUBTYPE_PUBL CONSTANT VARCHAR2(7) := 'PUBLISH';
210 C_PARAM_VAL_AUTOREL_DEFAULT CONSTANT VARCHAR2(1) := 'D';
211 C_PARAM_VAL_TRUE CONSTANT VARCHAR2(4) := 'true';
212 C_PARAM_VAL_FALSE CONSTANT VARCHAR2(5) := 'false';
213 C_PARAM_VAL_YES CONSTANT VARCHAR2(4) := 'Y';
214 C_PARAM_VAL_NO CONSTANT VARCHAR2(4) := 'N';
215
216 EGO_PUB_PUBLISH_FAILED EXCEPTION;
217 -- end of public api changes
218
219 -- Adding column for entity_type_id . Added for Metadata Sync
220
221 TYPE BAT_ENT_OBJ_TYPE IS RECORD
222 (
223 batch_id NUMBER,
224 pk1_value VARCHAR2(150),
225 pk2_value VARCHAR2(150),
226 pk3_value VARCHAR2(150),
227 pk4_value VARCHAR2(150),
228 pk5_value VARCHAR2(150),
229 user_entered VARCHAR2(1),
230 entity_type_id NUMBER
231 );
232
233 TYPE TBL_OF_BAT_ENT_OBJ_TYPE IS TABLE OF BAT_ENT_OBJ_TYPE INDEX BY BINARY_INTEGER;
234
235 TYPE BAT_ENT_OBJ_STAT_TYPE IS RECORD
236 (
237 batch_id NUMBER
238 ,pk1_value VARCHAR2(150)
239 ,pk2_value VARCHAR2(150)
240 ,pk3_value VARCHAR2(150)
241 ,pk4_value VARCHAR2(150)
242 ,pk5_value VARCHAR2(150)
243 ,system_code VARCHAR2(30)
244 ,status VARCHAR2(1)
245 ,message VARCHAR2(4000)
246 );
247 TYPE TBL_OF_BAT_ENT_OBJ_STAT_TYPE IS TABLE OF BAT_ENT_OBJ_STAT_TYPE INDEX BY BINARY_INTEGER;
248
249 TYPE BAT_ENT_OBJ_RET_STAT_TYPE IS RECORD
250 (
251 batch_id NUMBER
252 ,pk1_value VARCHAR2(150)
253 ,pk2_value VARCHAR2(150)
254 ,pk3_value VARCHAR2(150)
255 ,pk4_value VARCHAR2(150)
256 ,pk5_value VARCHAR2(150)
257 ,system_code VARCHAR2(30)
258 ,ret_status VARCHAR2(1)
259 ,ret_err_msg VARCHAR2(4000)
260 ,ret_err_code VARCHAR2(4000) --!!!!!! TYPE from Ego_Publication_Batch_GT
261 ,ret_err_msg_lang VARCHAR2(4) --!!!!!!!! TYPE fromm Ego_Publication_Batch_GT
262 );
263 TYPE TBL_OF_BAT_ENT_OBJ_RSTS_TYPE IS TABLE OF BAT_ENT_OBJ_RET_STAT_TYPE INDEX BY BINARY_INTEGER;
264
265 TYPE NUMBER_ARR_TBL_TYPE IS TABLE OF NUMBER INDEX BY BINARY_INTEGER;
266 TYPE CHAR_ARR_TBL_TYPE IS TABLE OF VARCHAR2(4000) INDEX BY BINARY_INTEGER;
267 TYPE CHAR1_ARR_TBL_TYPE IS TABLE OF VARCHAR2(1) INDEX BY BINARY_INTEGER;
268 TYPE CHAR4_ARR_TBL_TYPE IS TABLE OF VARCHAR2(4) INDEX BY BINARY_INTEGER;
269 TYPE CHAR30_ARR_TBL_TYPE IS TABLE OF VARCHAR2(30) INDEX BY BINARY_INTEGER;
270 TYPE CHAR150_ARR_TBL_TYPE IS TABLE OF VARCHAR2(150) INDEX BY BINARY_INTEGER;
271
272 C_NO CONSTANT VARCHAR(1) := 'N';
273 C_YES CONSTANT VARCHAR(1) := 'Y';
274 C_IN_PROCESS CONSTANT VARCHAR(1) := 'I';
275 C_BATCH_MODE NUMBER := 0; -- 8773131
276 C_BATCH_SYSTEM_MODE NUMBER := 1;
277 C_BATCH_SYSTEM_ENTITY_MODE NUMBER := 2;
278 C_SUCCESS VARCHAR2(1) := 'S';
279 C_FAILED VARCHAR2(1) := 'F';
280 C_WARNING VARCHAR2(1) := 'W';
281
282 C_PARAM_TYPE_BATCH NUMBER(1) := 1; --batch parameter type
283 C_PARAM_TYPE_DEST NUMBER(1) :=2; --Dest parameters or System Type
284
285
286 -- Insert Entity Rows from Table of record into GT Table
287 PROCEDURE add_derived_entities
288 (
289 der_bat_ent_objs IN TBL_OF_BAT_ENT_OBJ_TYPE
290 ,x_return_status OUT NOCOPY VARCHAR2
291 ,x_msg_count OUT NOCOPY NUMBER
292 ,x_msg_data OUT NOCOPY VARCHAR2
293 );
294
295
296
297 Procedure Update_Pub_Status_Thru_AIA(p_batch_id IN NUMBER
298 ,p_mode In Number
299 ,x_return_status OUT NOCOPY VARCHAR2
300 ,x_msg_count OUT NOCOPY NUMBER
301 ,x_msg_data OUT NOCOPY VARCHAR2);
302
303 Procedure Update_Pub_Status( p_batch_id IN NUMBER
304 ,p_mode IN NUMBER
305 ,p_bat_status_in IN TBL_OF_BAT_ENT_OBJ_STAT_TYPE
306 ,x_bat_status_out OUT NOCOPY TBL_OF_BAT_ENT_OBJ_RSTS_TYPE
307 ,x_return_status OUT NOCOPY VARCHAR2
308 ,x_msg_count OUT NOCOPY NUMBER
309 ,x_msg_data OUT NOCOPY VARCHAR2);
310
314 -- public apis
311 Procedure DeleteGTTableData(x_return_status OUT NOCOPY VARCHAR2);
312
313
315
316 ----------------
317 -- Procedures --
318 ----------------
319
320 /*#
321 * This API creates the batch with provided information. Parameters provide
322 * the information to build a valid batch.
323 * Current version: 1.0
324 *
325 * @param p_api_version Pass the value listed as 'Current version' above.
326 * @param p_batch_name Pass the batch name to be created. The batch_name
327 * must be unique, and not a duplicate of an existing batch.
328 * @param p_batch_type Pass the batch type, with one of the following values:
329 * C_BATCH_ENTITY_ICC, C_BATCH_ENTITY_VS, C_BATCH_ENTITY_ITEM,
330 * C_BATCH_ENTITY_AG.
331 * @param p_pub_params Pass the batch parameters.
332 * @param p_batch_entities Pass the batch entities. The entities must
333 * be valid, with no duplicate entities. For items, the item, organization,
334 * revision combination should be unique. For item catalog category,
335 * application only supports one ICC per batch.
336 * @param p_target_systems Pass the batch target systems. Each target system
337 * name must be unique.
338 * @param p_submit_flag Submits the new created batch if the value is true.
339 * Saves the batch in draft status if the value is false.
340 * @param x_new_batch_id The newly created batch id.
341 * @param x_return_status Returns one of the following three values,
342 * indicating the most serious error encountered during processing:
343 * FND_API.G_RET_STS_SUCCESS if no errors occurred.
344 * FND_API.G_RET_STS_ERROR if the batch encountered an error.
345 * FND_API.G_RET_STS_UNEXP_ERROR if the batch encountered an
346 * unexpected error.
347 * @param x_msg_count Indicates how many messages exist in the ERROR_HANDLER
348 * message stack upon completion of processing.
349 * @param x_msg_data If exactly one message exists in the ERROR_HANDLER
350 * message stack upon completion of processing, this parameter contains
351 * that message.
352 *
353 * @rep:scope public
354 * @rep:lifecycle active
355 * @rep:displayname Create batch
356 */
357 PROCEDURE Create_batch (p_api_version IN NUMBER,
358 p_batch_name IN VARCHAR2,
359 p_batch_type IN NUMBER,
360 p_pub_params IN TBL_OF_BAT_PARAM_TYPE,
361 p_batch_entities IN TBL_OF_BAT_ENT_OBJ_TYPE,
362 p_target_systems IN TBL_OF_BAT_SYS_CODE_TYPE,
363 p_submit_flag IN boolean,
364 x_new_batch_id OUT NOCOPY NUMBER,
365 x_return_status OUT NOCOPY VARCHAR2,
366 x_msg_count OUT NOCOPY NUMBER,
367 x_msg_data OUT NOCOPY varchar2
368 );
369
370
371 /*#
372 * This API publishes the un-submitted batches. Any names, ids, or name and
373 * id pair provided by caller must be valid.
374 * Current version: 1.0
375 *
376 * @param p_api_version Pass the value listed as 'Current version' above.
377 * @param p_batch_names Pass the draft batch names.
378 * @param p_batch_ids Pass the draft batch ids. Any names, ids, or name and
379 * id pair provided by caller must be valid.
380 * @param x_return_status Returns one of the following three values,
381 * indicating the most serious error encountered during processing:
382 * FND_API.G_RET_STS_SUCCESS if no errors occurred.
383 * FND_API.G_RET_STS_ERROR if the batch encountered an error.
384 * FND_API.G_RET_STS_UNEXP_ERROR if the batch encountered an
385 * unexpected error.
386 * @param x_msg_count Indicates how many messages exist in the ERROR_HANDLER
387 * message stack upon completion of processing.
388 * @param x_msg_data If exactly one message exists in the ERROR_HANDLER
389 * message stack upon completion of processing, this parameter contains
390 * that message.
391 *
392 * @rep:scope public
393 * @rep:lifecycle active
394 * @rep:displayname Publish batch
395 */
396 PROCEDURE publish_batch (p_api_version IN NUMBER,
397 p_batch_names IN dbms_sql.varchar2_table,
398 p_batch_ids IN dbms_sql.number_table,
399 x_return_status OUT NOCOPY VARCHAR2,
400 x_msg_count OUT NOCOPY NUMBER,
401 x_msg_data OUT NOCOPY varchar2
402 );
403
404 -- refer to EgoPublishBatchItemAMImpl.CopyEntityFromBatchId
405 -- impl the item view/publis priv check
406 /*#
407 * This API creates a new batch by copying batch details from existing batch.
408 * The API uses the batch_name, batch_id, or the batch_name and batch_id pair
409 * to find an existing batch. If it finds a match, it creates a new batch
410 * using the existing batch's details. Otherwise, it returns an error.
411 * Current version: 1.0
412 *
413 * @param p_api_version Pass the value listed as 'Current version' above.
414 * @param p_batch_name Pass the batch name to be copied.
415 * @param p_batch_id Pass the batch id to be copied. If the name and id pair
416 * is provided by the caller, the pair must be valid.
417 * @param p_submit_flag Submits the new created batch if the value is true.
418 * Saves it in draft status if the value is false.
419 * @param x_new_batch_id The newly created batch id.
420 * @param x_return_status Returns one of the following three values,
421 * indicating the most serious error encountered during processing:
422 * FND_API.G_RET_STS_SUCCESS if no errors occurred.
423 * FND_API.G_RET_STS_ERROR if the batch encountered an error.
427 * message stack upon completion of processing.
424 * FND_API.G_RET_STS_UNEXP_ERROR if the batch encountered an
425 * unexpected error.
426 * @param x_msg_count Indicates how many messages exist in the ERROR_HANDLER
428 * @param x_msg_data If exactly one message exists in the ERROR_HANDLER
429 * message stack upon completion of processing, this parameter contains
430 * that message.
431 *
432 * @rep:scope public
433 * @rep:lifecycle active
434 * @rep:displayname Copy batch
435 */
436 PROCEDURE copy_batch (p_api_version IN NUMBER,
437 p_batch_name IN VARCHAR2,
438 p_batch_id IN NUMBER,
439 p_submit_flag IN boolean,
440 x_new_batch_id OUT NOCOPY NUMBER,
441 x_return_status OUT NOCOPY VARCHAR2,
442 x_msg_count OUT NOCOPY NUMBER,
443 x_msg_data OUT NOCOPY varchar2
444 );
445
446 /*#
447 * This API deletes the existing batches by launching the purge concurrent
448 * request. It uses batch names and/or batch ids to determine if the batches
449 * are valid. If they are valid, the purge concurrent request deletes these
450 * batches. If no batch names or IDs are provided, but a purge days value
451 * is provided, then any batches older than the specified number of days
452 * will be purged.
453 * The purge concurrent request deletes batches with draft status.
454 * Current version: 1.0
455 *
456 * @param p_api_version Pass the value listed as 'Current version' above.
457 * @param p_batch_names Pass the batch names to be deleted.
458 * @param p_batch_ids Pass the batch ids to be deleted. The name and id pair
459 * must be valid if the caller provides both p_batch_names and p_batch_ids.
460 * The purge concurrent request deletes these batches.
461 * @param p_purge_days Pass the days value. If only the p_purge_days is
462 * provided, batches that are older than this specified number of days will be
463 * deleted. Otherwise the purge concurrent request ignores the parameter.
464 * @param x_con_req_id The launched batch purge concurrent request id.
465 * @param x_return_status Returns one of the following three values,
466 * indicating the most serious error encountered during processing:
467 * FND_API.G_RET_STS_SUCCESS if no errors occurred.
468 * FND_API.G_RET_STS_ERROR if the batch encountered an error.
469 * FND_API.G_RET_STS_UNEXP_ERROR if the batch encountered an
470 * unexpected error.
471 * @param x_msg_count Indicates how many messages exist in the ERROR_HANDLER
472 * message stack upon completion of processing.
473 * @param x_msg_data If exactly one message exists in the ERROR_HANDLER
474 * message stack upon completion of processing, this parameter contains
475 * that message.
476 *
477 * @rep:scope public
478 * @rep:lifecycle active
479 * @rep:displayname Delete batch
480 */
481 PROCEDURE delete_batch (p_api_version IN NUMBER,
482 p_batch_names IN dbms_sql.varchar2_table,
483 p_batch_ids IN dbms_sql.number_table,
484 p_purge_days IN NUMBER,
485 x_con_req_id OUT NOCOPY NUMBER,
486 x_return_status OUT NOCOPY VARCHAR2,
487 x_msg_count OUT NOCOPY NUMBER,
488 x_msg_data OUT NOCOPY varchar2
489 );
490 -- end of public apis
491
492 END EGO_PUB_FWK_PK;
[Home] [Help]