1 PACKAGE GMO_VBATCH_PVT AUTHID CURRENT_USER AS
2 /* $Header: GMOVVBTS.pls 120.10.12020000.2 2012/07/17 09:16:03 maychen ship $ */
3
4 --This function would verify if the step is locked or not.
5
6 -- Start of comments
7 -- API name : is_step_locked
8 -- Type : Private Utility.
9 -- Function : verify if the step is locked or not
10 -- Pre-reqs : None.
11 -- Parameters :
12 -- IN : p_batchstep_id in number
13 -- p_requestor in varchar2
14 -- OUT : Y or N
15 -- End of comments
16
17 function IS_STEP_LOCKED (P_BATCHSTEP_ID IN NUMBER,
18 P_REQUESTER IN NUMBER DEFAULT NULL) RETURN VARCHAR2;
19
20
21 --This function would verify if the step is locked or not.
22
23 -- Start of comments
24 -- API name : is_step_locked
25 -- Type : Private Utility.
26 -- Function : verify if the step is locked or not
27 -- Pre-reqs : None.
28 -- Parameters :
29 -- IN : p_vbatch_mode in varchar2
30 -- p_batchstep_id in number
31 -- p_requestor in varchar2
32 -- OUT : Y or N
33 -- End of comments
34
35 function IS_STEP_LOCKED (P_VBATCH_MODE IN VARCHAR2,
36 P_BATCHSTEP_ID IN NUMBER,
37 P_REQUESTER IN NUMBER) RETURN VARCHAR2;
38
39 --This function would return the reserved quantity for the material.
40
41 -- Start of comments
42 -- API name : get_material_reservation_qty
43 -- Type : Private Utility.
44 -- Function : gets the context information for the task
45 -- Pre-reqs : None.
46 -- Parameters :
47 -- IN : p_organization_id in number
48 -- p_batch_id in number
49 -- p_material_detail_id in number
50 -- OUT : material reserved quantity
51 -- End of comments
52
53
54
55 function GET_MATERIAL_RESERVATION_QTY (P_ORGANIZATION_ID IN NUMBER,
56 P_BATCH_ID IN NUMBER,
57 P_MATERIAL_DETAIL_ID IN NUMBER) RETURN NUMBER;
58
59 --Bug 4609365: start
60 --This function would return the dispensed quantity for the material.
61
62 -- Start of comments
63 -- API name : get_material_dispensed_qty
64 -- Type : Private Utility.
65 -- Function : gets the dispensed quantity
66 -- Pre-reqs : None.
67 -- Parameters :
68 -- IN : p_material_detail_id in number
69 -- P_UOM in varchar2
70 -- OUT : material dispensed quantity
71 -- End of comments
72 function GET_MATERIAL_DISPENSED_QTY (P_MATERIAL_DETAIL_ID NUMBER, P_UOM VARCHAR2) RETURN NUMBER;
73
74 --Bug 4609365: end
75 --Bug 13388249 : start
76 --This function would return the dispensed quantity for the material.
77
78 -- Start of comments
79 -- API name : get_actual_quantity
80 -- Type : Private Utility.
81 -- Function : gets the actual quantity
82 -- Pre-reqs : None.
83 -- Parameters :
84 -- IN : p_material_detail_id in number
85 -- P_INVENTORY_ITEM_ID in number
86 -- OUT : actual quantity
87 -- End of comments
88
89
90 function get_actual_quantity(p_material_detail_id NUMBER, p_inventory_item_id NUMBER) RETURN NUMBER;
91
92 --Bug 13388249: end
93
94 --This procedure would verify if batch step material is available.
95
96 -- Start of comments
97 -- API name : get_step_material_availability
98 -- Type : Private Utility.
99 -- Function : verify if the batch step material is available or not.
100 -- Pre-reqs : None.
101 -- Parameters :
102 -- IN : p_batchstep_id in number
103 -- OUT : x_material_available out varchar2
104 -- x_return_status out varchar2
105 -- x_msg_count out number
106 -- x_msg_data out varchar2
107 -- End of comments
108
109
110 PROCEDURE GET_STEP_MATERIAL_AVAILABILITY (P_BATCHSTEP_ID IN NUMBER,
111 X_MATERIAL_AVAILABLE OUT NOCOPY VARCHAR2,
112 X_UNAVAL_MATERIAL_ID OUT NOCOPY FND_TABLE_OF_VARCHAR2_255,
113 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
114 X_MSG_COUNT OUT NOCOPY NUMBER,
115 X_MSG_DATA OUT NOCOPY VARCHAR2);
116
117 --This procedure would verify if batch step material is available.
118
119 -- Start of comments
120 -- API name : get_step_material_availability
121 -- Type : Private Utility.
122 -- Function : verify if the batch step material is available or not.
123 -- Pre-reqs : None.
124 -- Parameters :
125 -- IN : p_batchstep_id in number
126 -- OUT : x_material_available out varchar2
127 -- x_return_status out varchar2
128 -- x_msg_count out number
129 -- x_msg_data out varchar2
130 -- End of comments
131
132
133 PROCEDURE GET_STEP_MATERIAL_AVAILABILITY (P_BATCHSTEP_ID IN NUMBER,
134 X_MATERIAL_AVAILABLE OUT NOCOPY VARCHAR2,
135 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
136 X_MSG_COUNT OUT NOCOPY NUMBER,
137 X_MSG_DATA OUT NOCOPY VARCHAR2);
138
139 --This function would return the name for the user who has locked the step.
140
141 -- Start of comments
142 -- API name : GET_STEP_LOCKED_BY
143 -- Type : Private Utility.
144 -- Function : return the name for the user who has locked the step.
145 -- Pre-reqs : None.
146 -- Parameters :
147 -- IN : p_batchstep_id in number
148 -- OUT : user display name
149 -- End of comments
150
151
152
153 function GET_STEP_LOCKED_BY (P_BATCHSTEP_ID IN NUMBER) RETURN VARCHAR2;
154
155
156 --This procdeure would lock the step and do an autonomous commit.
157
158 -- Start of comments
159 -- API name : lock_step
160 -- Type : Private Utility.
161 -- Function : lock the step for the user
162 -- Pre-reqs : None.
163 -- Parameters :
164 -- IN : p_batchstep_id in number
165 -- p_requestor in number
166 -- OUT : x_return_status out varchar2
167 -- x_msg_count out number
168 -- x_msg_data out varchar2
169 -- End of comments
170
171
172 procedure LOCK_STEP (P_BATCHSTEP_ID IN NUMBER,
173 P_REQUESTER IN NUMBER,
174 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
175 X_MSG_COUNT OUT NOCOPY NUMBER,
176 X_MSG_DATA OUT NOCOPY VARCHAR2);
177
178
179 --This procdeure would lock the (array) step and do an autonomous commit.
180
181 -- Start of comments
182 -- API name : lock_step
183 -- Type : Private Utility.
184 -- Function : lock the step for the user
185 -- Pre-reqs : None.
186 -- Parameters :
187 -- IN : p_batchstep_id in fnd_table_of_varchar2_255
188 -- p_requestor in number
189 -- OUT : x_return_status out varchar2
190 -- x_msg_count out number
191 -- x_msg_data out varchar2
192 -- End of comments
193
194
195 procedure LOCK_STEP (P_BATCHSTEP_ID IN FND_TABLE_OF_VARCHAR2_255,
196 P_REQUESTER IN NUMBER,
197 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
198 X_MSG_COUNT OUT NOCOPY NUMBER,
199 X_MSG_DATA OUT NOCOPY VARCHAR2);
200
201
202
203 --This procdeure would unlock the step and do an autonomous commit.
204
205 -- Start of comments
206 -- API name : unlock_step
207 -- Type : Private Utility.
208 -- Function : unlock the step for the user
209 -- Pre-reqs : None.
210 -- Parameters :
211 -- IN : p_batchstep_id in number
212 -- p_requestor in number
213 -- OUT : x_return_status out varchar2
214 -- x_msg_count out number
215 -- x_msg_data out varchar2
216 -- End of comments
217
218 procedure UNLOCK_STEP (P_BATCHSTEP_ID IN NUMBER,
219 P_REQUESTER IN NUMBER,
220 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
221 X_MSG_COUNT OUT NOCOPY NUMBER,
222 X_MSG_DATA OUT NOCOPY VARCHAR2);
223
224
225 --This procdeure would unlock the (array) step and do an autonomous commit..
226
227 -- Start of comments
228 -- API name : unlock_step
229 -- Type : Private Utility.
230 -- Function : unlock the step for the user
231 -- Pre-reqs : None.
232 -- Parameters :
233 -- IN : p_batchstep_id in fnd_table_of_varchar2_255
234 -- p_requestor in number
235 -- OUT : x_return_status out varchar2
236 -- x_msg_count out number
237 -- x_msg_data out varchar2
238 -- End of comments
239
240 procedure UNLOCK_STEP (P_BATCHSTEP_ID IN FND_TABLE_OF_VARCHAR2_255,
241 P_REQUESTER IN NUMBER,
242 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
243 X_MSG_COUNT OUT NOCOPY NUMBER,
244 X_MSG_DATA OUT NOCOPY VARCHAR2);
245
246
247 --This procdeure returns the batch id for the entity..
248
249 -- Start of comments
250 -- API name : get_batch_id_for_entity
251 -- Type : Private Utility.
252 -- Function : returns the batch id
253 -- Pre-reqs : None.
254 -- Parameters :
255 -- IN : p_entity_name in varchar2
256 -- p_entity_key in varchar2
257 -- OUT : x_batch_id out number
258 -- x_return_status out varchar2
259 -- x_msg_count out number
260 -- x_msg_data out varchar2
261 -- End of comments
262
263 procedure GET_BATCH_ID_FOR_ENTITY (P_ENTITY_NAME IN VARCHAR2,
264 P_ENTITY_KEY IN VARCHAR2,
265 X_BATCH_ID OUT NOCOPY NUMBER,
266 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
267 X_MSG_COUNT OUT NOCOPY NUMBER,
268 X_MSG_DATA OUT NOCOPY VARCHAR2);
269
270
271 --This procdeure returns the batchstep id for the entity..
272
273 -- Start of comments
274 -- API name : get_batchstep_id_for_entity
275 -- Type : Private Utility.
276 -- Function : returns the batchstep id
277 -- Pre-reqs : None.
278 -- Parameters :
279 -- IN : p_entity_name in varchar2
280 -- p_entity_key in varchar2
281 -- OUT : x_batchstep_id out number
282 -- x_return_status out varchar2
283 -- x_msg_count out number
284 -- x_msg_data out varchar2
285 -- End of comments
286
287 procedure GET_BATCHSTEP_ID_FOR_ENTITY (P_ENTITY_NAME IN VARCHAR2,
288 P_ENTITY_KEY IN VARCHAR2,
289 X_BATCHSTEP_ID OUT NOCOPY NUMBER,
290 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
291 X_MSG_COUNT OUT NOCOPY NUMBER,
295
292 X_MSG_DATA OUT NOCOPY VARCHAR2);
293
294
296 --This procdeure would instantiate the process instructions for the batch.
297
298 -- Start of comments
299 -- API name : instantiate_advanced_pi
300 -- Type : Group Utility.
301 -- Function : Instantiates the process instructions
302 -- Pre-reqs : None.
303 -- Parameters :
304 -- IN : p_entity_name in varchar2
305 -- p_entity_key in varchar2
306 -- OUT : x_return_status out varchar2
307 -- x_msg_count out number
308 -- x_msg_data out varchar2
309 -- End of comments
310
311 procedure INSTANTIATE_ADVANCED_PI (P_ENTITY_NAME IN VARCHAR2,
312 P_ENTITY_KEY IN VARCHAR2,
313 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
314 X_MSG_COUNT OUT NOCOPY NUMBER,
315 X_MSG_DATA OUT NOCOPY VARCHAR2
316 );
317
318
319 --This procdeure would get the context information for the task.
320
321 -- Start of comments
322 -- API name : on_task_load
323 -- Type : Group Utility.
324 -- Function : gets the context information for the task
325 -- Pre-reqs : None.
326 -- Parameters :
327 -- IN : p_from_module in varchar2
328 -- p_entity_name in varchar2
329 -- p_entity_key in varchar2
330 -- p_task in varchar2
331 -- P_TASK_ATTRIBUTE in varchar2 default null
332 -- p_instruction_id in number default null
333 -- OUT : x_entity_name out varchar2
334 -- x_entity_key out varchar2
335 -- x_task out varchar2
336 -- x_task_key out varchar2
337 -- x_read_only out VARCHAR2
338 -- x_context_params_tbl out GMO_DATATYPES_GRP.CONTEXT_PARAMS_TBL_TYPE
339 -- x_return_status out varchar2
340 -- x_msg_count out number
341 -- x_msg_data out varchar2
342 -- End of comments
343
344 procedure ON_TASK_LOAD (P_FROM_MODULE IN VARCHAR2,
345 P_ENTITY_NAME IN VARCHAR2,
346 P_ENTITY_KEY IN VARCHAR2,
347 P_TASK IN VARCHAR2,
348 P_TASK_ATTRIBUTE IN VARCHAR2,
349 P_INSTRUCTION_ID IN NUMBER,
350 P_INSTRUCTION_PROCESS_ID IN NUMBER,
351 P_REQUESTER IN NUMBER,
352 P_VBATCH_MODE IN VARCHAR2,
353 X_TASK_ENTITY_NAME OUT NOCOPY VARCHAR2,
354 X_TASK_ENTITY_KEY OUT NOCOPY VARCHAR2,
355 X_TASK_NAME OUT NOCOPY VARCHAR2,
356 X_TASK_KEY OUT NOCOPY VARCHAR2,
357 X_READ_ONLY OUT NOCOPY VARCHAR2,
358 X_CONTEXT_PARAMS_TBL OUT NOCOPY GMO_DATATYPES_GRP.CONTEXT_PARAMS_TBL_TYPE,
359 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
360 X_MSG_COUNT OUT NOCOPY NUMBER,
361 X_MSG_DATA OUT NOCOPY VARCHAR2
362 );
363
364
365 --This procdeure would process the action performed by the task.
366
367 -- Start of comments
368 -- API name : on_task_action
369 -- Type : Group Utility.
370 -- Function : process the action performed by the task
371 -- Pre-reqs : None.
372 -- Parameters :
373 -- IN : p_entity_name in varchar2
374 -- p_entity_key in varchar2
375 -- p_task in varchar2
376 -- P_TASK_ATTRIBUTE in varchar2 default null
377 -- OUT : x_return_status out varchar2
378 -- x_msg_count out number
379 -- x_msg_data out varchar2
380 -- End of comments
381
382 procedure ON_TASK_ACTION (P_ENTITY_NAME IN VARCHAR2,
383 P_ENTITY_KEY IN VARCHAR2,
384 P_TASK IN VARCHAR2,
385 P_TASK_ATTRIBUTE IN VARCHAR2,
386 P_REQUESTER IN NUMBER,
387 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
388 X_MSG_COUNT OUT NOCOPY NUMBER,
389 X_MSG_DATA OUT NOCOPY VARCHAR2
390
391 );
392
393
394 --This procdeure would process the save event of the task.
395
396 -- Start of comments
397 -- API name : on_task_save
398 -- Type : Group Utility.
399 -- Function : process the save event of the task.
400 -- Pre-reqs : None.
401 -- Parameters :
402 -- IN : p_from_module in varchar2
403 -- p_entity_name in varchar2
404 -- p_entity_key in varchar2
405 -- p_task in varchar2
406 -- P_TASK_ATTRIBUTE in varchar2 default null
407 -- p_instruction_id in number
408 -- p_task_identifier in fnd_table_of_varchar2
409 -- p_task_value in fnd_table_of_varchar2
410 -- p_task_erecord in fnd_table_of_varchar2
411 -- OUT : x_return_status out varchar2
412 -- x_msg_count out number
413 -- x_msg_data out varchar2
414 -- End of comments
415
416
417 procedure ON_TASK_SAVE (P_FROM_MODULE IN VARCHAR2,
418 P_ENTITY_NAME IN VARCHAR2,
419 P_ENTITY_KEY IN VARCHAR2,
420 P_TASK IN VARCHAR2,
424 P_TASK_IDENTIFIER IN FND_TABLE_OF_VARCHAR2_255,
421 P_TASK_ATTRIBUTE IN VARCHAR2,
422 P_INSTRUCTION_ID IN NUMBER ,
423 P_INSTRUCTION_PROCESS_ID IN NUMBER ,
425 P_TASK_VALUE IN FND_TABLE_OF_VARCHAR2_255,
426 P_TASK_ERECORD IN FND_TABLE_OF_VARCHAR2_255,
427 P_REQUESTER IN NUMBER,
428 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
429 X_MSG_COUNT OUT NOCOPY NUMBER,
430 X_MSG_DATA OUT NOCOPY VARCHAR2
431 );
432
433
434 --This procdeure would check if the entity is locked or not
435
436 -- Start of comments
437 -- API name : get_entity_lock_status
438 -- Type : Group Utility.
439 -- Function : checks if the entity is locked or not
440 -- Pre-reqs : None.
441 -- Parameters :
442 -- IN : p_entity_name in varchar2
443 -- p_entity_key in varchar2
444 -- p_requester in varchar2
445 -- OUT : x_lock_status out char
446 -- x_locked_by_status out char
447 -- x_lock_allowed out char
448 -- x_return_status out varchar2
449 -- x_msg_count out number
450 -- x_msg_data out varchar2
451 -- End of comments
452
453 procedure GET_ENTITY_LOCK_STATUS (P_ENTITY_NAME IN VARCHAR2,
454 P_ENTITY_KEY IN VARCHAR2,
455 P_REQUESTER IN NUMBER,
456 X_LOCK_STATUS OUT NOCOPY VARCHAR2,
457 X_LOCKED_BY_STATUS OUT NOCOPY VARCHAR2,
458 X_LOCK_ALLOWED OUT NOCOPY VARCHAR2,
459 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
460 X_MSG_COUNT OUT NOCOPY NUMBER,
461 X_MSG_DATA OUT NOCOPY VARCHAR2
462 );
463 --Bug 5224634: start
464 --This procedure returns the batch step nodes
465 -- Start of comments
466 -- API name : get_batchstep_nodes
467 -- Type : Group Utility
468 -- Function : Get batch step nodes
469 -- Pre-reqs : None
470 -- IN : P_BATCH_ID in number
471 -- P_BATCHSTEP_ID in number
472 -- OUT : x_name out fnd_table_of_varchar2_255
473 -- x_entity_name out fnd_table_of_varchar2_255
474 -- x_entity_key out fnd_table_of_varchar2_255
475 -- x_entity_level out fnd_table_of_varchar2_255
476 -- x_return_status out varchar2
477 -- x_msg_count out number
478 -- x_msg_data out varchar2
479 -- End of comments
480
481 procedure GET_BATCHSTEP_NODES ( P_BATCH_ID IN NUMBER,
482 P_BATCHSTEP_ID IN NUMBER,
483 X_NAME OUT NOCOPY FND_TABLE_OF_VARCHAR2_255,
484 X_ENTITY_NAME OUT NOCOPY FND_TABLE_OF_VARCHAR2_255,
485 X_ENTITY_KEY OUT NOCOPY FND_TABLE_OF_VARCHAR2_255,
486 X_ENTITY_LEVEL OUT NOCOPY FND_TABLE_OF_VARCHAR2_255,
487 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
488 X_MSG_COUNT OUT NOCOPY NUMBER,
489 X_MSG_DATA OUT NOCOPY VARCHAR2);
490 --Bug 5224634: end
491
492 -- Kapil ME GMO-LCF
493 procedure INSTANTIATE_INSTR_FOR_LCF (P_ENTITY_NAME IN VARCHAR2,
494 P_ENTITY_KEY IN VARCHAR2,
495 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
496 X_MSG_COUNT OUT NOCOPY NUMBER,
497 X_MSG_DATA OUT NOCOPY VARCHAR2);
498
499 END GMO_VBATCH_PVT;
[Home] [Help]