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