1 PACKAGE GMO_INSTRUCTION_GRP AUTHID CURRENT_USER AS
2 /*$Header: GMOGINTS.pls 120.3 2006/07/12 04:50:43 rahugupt noship $*/
3
4 -- API Name constant
5 G_PKG_NAME CONSTANT VARCHAR2(30) := 'GMO_INSTRUCTION_GRP';
6
7 -- This API is called to create a definition context with multiple
8 -- entity name, entity key, entity display names, and Instruction
9 -- types. It is called before definition UI is invoked to create
10 -- the necessary context for definition
11
12 -- Start of comments
13 -- API name : CREATE_DEFN_CONTEXT
14 -- Type : Group API
15 -- Function : Create the definition context for list
16 -- of entity name and key pairs
17
18 -- Pre-reqs : None.
19 -- Parameters
20 -- P_API_VERSION API Version
21 -- P_INIT_MSG_LIST Initialize message list default = false
22 -- P_VALIDATION_LEVEL Default validation level = FULL
23
24 -- P_CURR_INSTR_PROCSS_ID Current instruction proces id for session
25 -- P_ENTITY_NAME Table of entity names to be used during definition
26 -- P_ENTITY_KEY Table of entity keys
27 -- P_ENTITY_DISPLAYNAME Table of MLS Compliant Entity display names
28 -- P_INSTRUCTION_TYPE Table of Instruction Types to support in definition
29 -- P_MODE Mode of operation in definition UI = READ | UPDATE
30 -- P_CONTEXT_PARAMETERS Table of context parameters
31
32 -- X_INSTRUCTION_PROCESS_ID The transaction/ process id, used in the definition
33 -- process to identify a particular session
34
35 -- X_RETURN_STATUS The return status based on standard API convention
36 -- X_MSG_COUNT Message count
37 -- X_MSG_DATA Return messages
38
39 -- End of comments
40
41
42 PROCEDURE CREATE_DEFN_CONTEXT
43 (
44 P_API_VERSION IN NUMBER,
45 P_INIT_MSG_LIST IN VARCHAR2 DEFAULT FND_API.G_FALSE,
46 P_VALIDATION_LEVEL IN NUMBER DEFAULT FND_API.G_VALID_LEVEL_FULL,
47 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
48 X_MSG_COUNT OUT NOCOPY NUMBER,
49 X_MSG_DATA OUT NOCOPY VARCHAR2,
50
51 P_CURR_INSTR_PROCESS_ID IN NUMBER DEFAULT NULL,
52 P_ENTITY_NAME IN FND_TABLE_OF_VARCHAR2_255,
53 P_ENTITY_KEY IN FND_TABLE_OF_VARCHAR2_255,
54 P_ENTITY_DISPLAYNAME IN FND_TABLE_OF_VARCHAR2_255,
55 P_INSTRUCTION_TYPE IN FND_TABLE_OF_VARCHAR2_255,
56 P_MODE IN VARCHAR2 DEFAULT GMO_CONSTANTS_GRP.G_INSTR_DEFN_MODE_UPDATE,
57 P_CONTEXT_PARAMETERS IN GMO_DATATYPES_GRP.GMO_DEFINITION_PARAM_TBL_TYPE,
58 X_INSTRUCTION_PROCESS_ID OUT NOCOPY NUMBER
59
60 );
61
62
63 -- This API is called to create a definition context with single
64 -- entity name, entity key, entity display name, and Instruction
65 -- type. It is called before definition UI is invoked to create
66 -- the necessary context for definition.
67
68 -- Start of comments
69 -- API name : CREATE_DEFN_CONTEXT
70 -- Type : Group API
71 -- Function : Create the definition context for single
72 -- of entity name and key pair
73
74 -- Pre-reqs : None.
75 -- Parameters
76 -- P_API_VERSION API Version
77 -- P_INIT_MSG_LIST Initialize message list default = false
78 -- P_VALIDATION_LEVEL Default validation level = FULL
79
80 -- P_CURR_INSTR_PROCSS_ID Current instruction proces id for session
81 -- P_ENTITY_NAME Entity name to be used during definition
82 -- P_ENTITY_KEY Entity key
83 -- P_ENTITY_DISPLAYNAME MLS Compliant Entity display name
84 -- P_INSTRUCTION_TYPE Instruction Type to support in definition
85 -- P_MODE Mode of operation in definition UI = READ | UPDATE
86 -- P_CONTEXT_PARAMETERS Table of context parameters
87
88 -- X_INSTRUCTION_PROCESS_ID The transaction/ process id, used in the definition
89 -- process to identify a particular session
90
91 -- X_RETURN_STATUS The return status based on standard API convention
92 -- X_MSG_COUNT Message count
93 -- X_MSG_DATA Return messages
94
95 -- End of comments
96
97
98 PROCEDURE CREATE_DEFN_CONTEXT
99 (
100 P_API_VERSION IN NUMBER,
101 P_INIT_MSG_LIST IN VARCHAR2 DEFAULT FND_API.G_FALSE,
102 P_VALIDATION_LEVEL IN NUMBER DEFAULT FND_API.G_VALID_LEVEL_FULL,
103 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
104 X_MSG_COUNT OUT NOCOPY NUMBER,
105 X_MSG_DATA OUT NOCOPY VARCHAR2,
106
107 P_CURR_INSTR_PROCESS_ID IN NUMBER DEFAULT NULL,
108 P_ENTITY_NAME IN VARCHAR2,
109 P_ENTITY_KEY IN VARCHAR2,
110 P_ENTITY_DISPLAYNAME IN VARCHAR2,
111 P_INSTRUCTION_TYPE IN VARCHAR2,
112 P_MODE IN VARCHAR2 DEFAULT GMO_CONSTANTS_GRP.G_INSTR_DEFN_MODE_UPDATE,
113 P_CONTEXT_PARAMETERS IN GMO_DATATYPES_GRP.GMO_DEFINITION_PARAM_TBL_TYPE,
114 X_INSTRUCTION_PROCESS_ID OUT NOCOPY NUMBER
115
116 );
117
118 -- This API is called to create a definition context with multiple
119 -- entity name, entity key, entity display names, and Instruction
120 -- types. It is called before definition UI is invoked to create
121 -- the necessary context for definition. This flavor is used by
122 -- GMO_INSTR_GRP PLL Package, as FORMS does not support
123 -- FND_TABLE_OF_VARCHAR2_255
124
125 -- Start of comments
126 -- API name : CREATE_DEFN_CONTEXT
127 -- Type : Group API
128 -- Function : Create the definition context for list
129 -- of entity name and key pairs
130
131 -- Pre-reqs : None.
132 -- Parameters
133 -- P_API_VERSION API Version
134 -- P_INIT_MSG_LIST Initialize message list default = false
135 -- P_VALIDATION_LEVEL Default validation level = FULL
136
137 -- P_CURR_INSTR_PROCSS_ID Current instruction proces id for session
138 -- P_ENTITY_NAME Table of entity names to be used during definition
139 -- P_ENTITY_KEY Table of entity keys
140 -- P_ENTITY_DISPLAYNAME Table of MLS Compliant Entity display names
141 -- P_INSTRUCTION_TYPE Table of Instruction Types to support in definition
142 -- P_MODE Mode of operation in definition UI = READ | UPDATE
143 -- P_CONTEXT_PARAMETERS Table of context parameters
144
145 -- X_INSTRUCTION_PROCESS_ID The transaction/ process id, used in the definition
146 -- process to identify a particular session
147
148 -- X_RETURN_STATUS The return status based on standard API convention
149 -- X_MSG_COUNT Message count
150 -- X_MSG_DATA Return messages
151
152 -- End of comments
153
154 PROCEDURE CREATE_DEFN_CONTEXT
155 (
156 P_API_VERSION IN NUMBER,
157 P_INIT_MSG_LIST IN VARCHAR2 DEFAULT FND_API.G_FALSE,
158 P_VALIDATION_LEVEL IN NUMBER DEFAULT FND_API.G_VALID_LEVEL_FULL,
159 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
160 X_MSG_COUNT OUT NOCOPY NUMBER,
161 X_MSG_DATA OUT NOCOPY VARCHAR2,
162
163 P_CURR_INSTR_PROCESS_ID IN NUMBER DEFAULT NULL,
164 P_ENTITY_NAME IN GMO_DATATYPES_GRP.GMO_TABLE_OF_VARCHAR2_255,
165 P_ENTITY_KEY IN GMO_DATATYPES_GRP.GMO_TABLE_OF_VARCHAR2_255,
166 P_ENTITY_DISPLAYNAME IN GMO_DATATYPES_GRP.GMO_TABLE_OF_VARCHAR2_255,
167 P_INSTRUCTION_TYPE IN GMO_DATATYPES_GRP.GMO_TABLE_OF_VARCHAR2_255,
168 P_MODE IN VARCHAR2 DEFAULT GMO_CONSTANTS_GRP.G_INSTR_DEFN_MODE_UPDATE,
169 P_CONTEXT_PARAMETERS IN GMO_DATATYPES_GRP.GMO_DEFINITION_PARAM_TBL_TYPE,
170 X_INSTRUCTION_PROCESS_ID OUT NOCOPY NUMBER
171 );
172
173
174
175 -- This API is called to delete the instructions related to an entity
176 -- from the Process Instructions System.
177 -- Start of comments
178 -- API name : CREATE_DEFN_CONTEXT
179 -- Type : Group API
180 -- Function : Create the definition context for list
181 -- of entity name and key pairs
182
183 -- Pre-reqs : None.
184 -- Parameters
185 -- P_API_VERSION API Version
186 -- P_INIT_MSG_LIST Initialize message list default = false
187 -- P_VALIDATION_LEVEL Default validation level = FULL
188
189 -- P_CURR_INSTR_PROCESS_ID The current instruction process id for session.
190 -- P_ENTITY_NAME Table of entity names to be used during definition
191 -- P_ENTITY_KEY Table of entity keys
192 -- X_INSTRUCTION_PROCESS_ID The transaction/ process id, used in the definition
193 -- process to identify a particular session
194
195 -- X_RETURN_STATUS The return status based on standard API convention
196 -- X_MSG_COUNT Message count
197 -- X_MSG_DATA Return messages
198
199 -- End of comments
200
201 PROCEDURE DELETE_ENTITY_FOR_PROCESS
202 (
203 P_API_VERSION IN NUMBER,
204 P_INIT_MSG_LIST IN VARCHAR2 DEFAULT FND_API.G_FALSE,
205 P_VALIDATION_LEVEL IN NUMBER DEFAULT FND_API.G_VALID_LEVEL_FULL,
206 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
207 X_MSG_COUNT OUT NOCOPY NUMBER,
208 X_MSG_DATA OUT NOCOPY VARCHAR2,
209
210 P_CURR_INSTR_PROCESS_ID IN NUMBER,
211 P_ENTITY_NAME IN GMO_DATATYPES_GRP.GMO_TABLE_OF_VARCHAR2_255,
212 P_ENTITY_KEY IN GMO_DATATYPES_GRP.GMO_TABLE_OF_VARCHAR2_255,
213 X_INSTRUCTION_PROCESS_ID OUT NOCOPY NUMBER
214 );
215
216 -- This API is called to create a definition from existing
217 -- definition. It is called by the entity application to create
218 -- a new definition from existing ones
219
220 -- Start of comments
221 -- API name : CREATE_DEFN_FROM_DEFN
222 -- Type : Group API
223 -- Function : Create the definition from existing definition
224
225 -- Pre-reqs : None.
226 -- Parameters
227 -- P_API_VERSION API Version
228 -- P_INIT_MSG_LIST Initialize message list default = false
229 -- P_VALIDATION_LEVEL Default validation level = FULL
230
231 -- P_SOURCE_ENTITY_NAME Source entity name
232 -- P_SOURCE_ENTITY_KEY Source entity key
233
234 -- P_TARGET_ENTITY_NAME Target entity name
235 -- P_TARGET_ENTITY_KEY Target entity key
236
237 -- P_INSTRUCTION_TYPE Instruction Type
238
239 -- X_INSTRUCTION_SET_ID The INSTRUCTION_SET_ID of newly created definition
240
241 -- X_RETURN_STATUS The return status based on standard API convention
242 -- X_MSG_COUNT Message count
243 -- X_MSG_DATA Return messages
244
245 -- End of comments
246
247 PROCEDURE CREATE_DEFN_FROM_DEFN
248 (
249 P_API_VERSION IN NUMBER,
250 P_INIT_MSG_LIST IN VARCHAR2 DEFAULT FND_API.G_FALSE,
251 P_COMMIT IN VARCHAR2 DEFAULT FND_API.G_FALSE,
252 P_VALIDATION_LEVEL IN NUMBER DEFAULT FND_API.G_VALID_LEVEL_FULL,
253 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
254 X_MSG_COUNT OUT NOCOPY NUMBER,
255 X_MSG_DATA OUT NOCOPY VARCHAR2,
256
257 P_SOURCE_ENTITY_NAME IN VARCHAR2,
258 P_SOURCE_ENTITY_KEY IN VARCHAR2,
259 P_TARGET_ENTITY_NAME IN VARCHAR2,
260 P_TARGET_ENTITY_KEY IN VARCHAR2,
261 P_INSTRUCTION_TYPE IN VARCHAR2,
262 X_INSTRUCTION_SET_ID OUT NOCOPY NUMBER
263
264 );
265
266 -- This API is called to send the definition acknowledgement
267 -- This API also copies the data from temporary tables to permenant
268 -- tables
269
270 -- Start of comments
271 -- API name : SEND_DEFN_ACKN
272 -- Type : Group API
273 -- Function : Send definition acknowledgement
274
275 -- Pre-reqs : None
276 -- Parameters
277
278 -- P_API_VERSION API Version
279 -- P_INIT_MSG_LIST Initialize message list default = FALSE
280 -- P_VALIDATION_LEVEL Default validation level = FULL
281
282 -- P_INSTRUCTION_PROCESS_ID The instruction process id
283 -- P_ENTITY_NAME The entity name
284
285 -- P_SOURCE_ENTITY_KEY Source entity key
286 -- P_TARGET_ENTITY_KEY Target entity key
287
288 -- X_RETURN_STATUS The return status based on standard API convention
289 -- X_MSG_COUNT Message count
290 -- X_MSG_DATA Return messages
291
292 -- End of comments
293
294 PROCEDURE SEND_DEFN_ACKN
295 (
296 P_API_VERSION IN NUMBER,
297 P_INIT_MSG_LIST IN VARCHAR2 DEFAULT FND_API.G_FALSE,
298 P_COMMIT IN VARCHAR2 DEFAULT FND_API.G_FALSE,
299 P_VALIDATION_LEVEL IN NUMBER DEFAULT FND_API.G_VALID_LEVEL_FULL,
300 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
301 X_MSG_COUNT OUT NOCOPY NUMBER,
302 X_MSG_DATA OUT NOCOPY VARCHAR2,
303
304 P_INSTRUCTION_PROCESS_ID IN NUMBER,
305 P_ENTITY_NAME IN VARCHAR2,
306 P_SOURCE_ENTITY_KEY IN VARCHAR2,
307 P_TARGET_ENTITY_KEY IN VARCHAR2
308
309 );
310
311 -- This API is called to send the definition acknowledgement
312 -- for multiple entity name and key values
313
314 -- This API also copies the data from temporary tables to permenant
315 -- tables
316
317 -- Start of comments
318 -- API name : SEND_DEFN_ACKN
319 -- Type : Group API
320 -- Function : Send definition acknowledgement
321
322 -- Pre-reqs : None
323 -- Parameters
324
325 -- P_API_VERSION API Version
326 -- P_INIT_MSG_LIST Initialize message list default = FALSE
327 -- P_VALIDATION_LEVEL Default validation level = FULL
328
329 -- P_INSTRUCTION_PROCESS_ID The instruction process id
330 -- P_ENTITY_NAME The entity name as FND_TABLE_OF_VARCHAR2_255
331 -- P_SOURCE_ENTITY_KEY Source entity key
332 -- P_TARGET_ENTITY_KEY Target entity key
333
334 -- X_RETURN_STATUS The return status based on standard API convention
335 -- X_MSG_COUNT Message count
336 -- X_MSG_DATA Return messages
337
338 -- End of comments
339
340 PROCEDURE SEND_DEFN_ACKN
341 (
342 P_API_VERSION IN NUMBER,
343 P_INIT_MSG_LIST IN VARCHAR2 DEFAULT FND_API.G_FALSE,
344 P_COMMIT IN VARCHAR2 DEFAULT FND_API.G_FALSE,
345 P_VALIDATION_LEVEL IN NUMBER DEFAULT FND_API.G_VALID_LEVEL_FULL,
346 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
347 X_MSG_COUNT OUT NOCOPY NUMBER,
348 X_MSG_DATA OUT NOCOPY VARCHAR2,
349
350 P_INSTRUCTION_PROCESS_ID IN NUMBER,
351 P_ENTITY_NAME IN FND_TABLE_OF_VARCHAR2_255,
352 P_SOURCE_ENTITY_KEY IN FND_TABLE_OF_VARCHAR2_255,
353 P_TARGET_ENTITY_KEY IN FND_TABLE_OF_VARCHAR2_255
354
355 );
356
357 -- This API is called to send the definition acknowledgement
358 -- for multiple entity name and key values
359 -- This flavor is used by GMO_INSTR pll interface
360
361 -- This API also copies the data from temporary tables to permenant
362 -- tables
363
364 -- Start of comments
365 -- API name : SEND_DEFN_ACKN
366 -- Type : Group API
367 -- Function : Send definition acknowledgement
368
369 -- Pre-reqs : None
370 -- Parameters
371
372 -- P_API_VERSION API Version
373 -- P_INIT_MSG_LIST Initialize message list default = FALSE
374 -- P_VALIDATION_LEVEL Default validation level = FULL
375
376 -- P_INSTRUCTION_PROCESS_ID The instruction process id
377 -- P_ENTITY_NAME The entity name as GMO_TABLE_OF_VARCHAR2_255
378 -- P_SOURCE_ENTITY_KEY Source entity key
379 -- P_TARGET_ENTITY_KEY Target entity key
380
381 -- X_RETURN_STATUS The return status based on standard API convention
382 -- X_MSG_COUNT Message count
383 -- X_MSG_DATA Return messages
384
385 -- End of comments
386
387 PROCEDURE SEND_DEFN_ACKN
388 (
389 P_API_VERSION IN NUMBER,
390 P_INIT_MSG_LIST IN VARCHAR2 DEFAULT FND_API.G_FALSE,
391 P_COMMIT IN VARCHAR2 DEFAULT FND_API.G_FALSE,
392 P_VALIDATION_LEVEL IN NUMBER DEFAULT FND_API.G_VALID_LEVEL_FULL,
393 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
394 X_MSG_COUNT OUT NOCOPY NUMBER,
395 X_MSG_DATA OUT NOCOPY VARCHAR2,
396
397 P_INSTRUCTION_PROCESS_ID IN NUMBER,
398 P_ENTITY_NAME IN GMO_DATATYPES_GRP.GMO_TABLE_OF_VARCHAR2_255,
399 P_SOURCE_ENTITY_KEY IN GMO_DATATYPES_GRP.GMO_TABLE_OF_VARCHAR2_255,
400 P_TARGET_ENTITY_KEY IN GMO_DATATYPES_GRP.GMO_TABLE_OF_VARCHAR2_255
401
402 );
403
404 -- This API will get the definition status := MODIFIED | NO_CHANGE
405
406 -- Start of comments
407 -- API name : GET_DEFN_STATUS
408 -- Type : Group API
409 -- Function : get the definition status := MODIFIED | NO_CHANGE
410 -- Pre-reqs : None
411 -- Parameters
412
413 -- P_API_VERSION API Version
414 -- P_INIT_MSG_LIST Initialize message list default = FALSE
415 -- P_VALIDATION_LEVEL Default validation level = FULL
416
417 -- P_INSTRUCTION_PROCESS_ID The definition time instruction_process_id
418 -- X_DEFINITION_STATUS The definition status for given process id
419
420 -- X_RETURN_STATUS The return status based on standard API convention
421 -- X_MSG_COUNT Message count
422 -- X_MSG_DATA Return messages
423
424 -- End of comments
425
426 PROCEDURE GET_DEFN_STATUS
427 (
428 P_API_VERSION IN NUMBER,
429 P_INIT_MSG_LIST IN VARCHAR2 DEFAULT FND_API.G_FALSE,
430 P_VALIDATION_LEVEL IN NUMBER DEFAULT FND_API.G_VALID_LEVEL_FULL,
431 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
432 X_MSG_COUNT OUT NOCOPY NUMBER,
433 X_MSG_DATA OUT NOCOPY VARCHAR2,
434
435 P_INSTRUCTION_PROCESS_ID IN NUMBER,
436 X_DEFINITION_STATUS OUT NOCOPY VARCHAR2
437
438 );
439
440 -- Start of comments
441 -- API name : GET_INSTR_XML
442 -- Type : Group
443 -- Function : This procedure returns the instruction set and all the related instruction details
444 -- : in XML format for the specified instruction process ID.
445 -- Pre-reqs : None
446 --
447 -- Parameters
448 -- IN : P_INSTRUCTION_PROCESS_ID - The instruction process ID.
449 -- OUT : X_OUTPUT_XML - The final XML.
450
451 -- P_API_VERSION API Version
452 -- P_INIT_MSG_LIST Initialize message list default = FALSE
453 -- P_VALIDATION_LEVEL Default validation level = FULL
454
455 -- X_RETURN_STATUS The return status based on standard API convention
456 -- X_MSG_COUNT Message count
457 -- X_MSG_DATA Return messages
458
459 -- End of comments
460
461 PROCEDURE GET_INSTR_XML
462 (
463 P_API_VERSION IN NUMBER,
464 P_INIT_MSG_LIST IN VARCHAR2 DEFAULT FND_API.G_FALSE,
465 P_VALIDATION_LEVEL IN NUMBER DEFAULT FND_API.G_VALID_LEVEL_FULL,
466 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
467 X_MSG_COUNT OUT NOCOPY NUMBER,
468 X_MSG_DATA OUT NOCOPY VARCHAR2,
469
470
471 P_INSTRUCTION_PROCESS_ID IN NUMBER,
472 X_OUTPUT_XML OUT NOCOPY CLOB
473 );
474
475 -- Start of comments
476 -- API name : GET_INSTR_XML
477 -- Type : Group
478 -- Function : This procedure returns the instruction instance details in XML format for the specified
479 -- instruction process ID.
480 -- Pre-reqs : None
481 --
482 -- Parameters
483 -- IN : P_INSTRUCTION_PROCESS_ID - The instruction process ID.
484 -- OUT : X_OUTPUT_XML - The final XML.
485
486 -- P_API_VERSION API Version
487 -- P_INIT_MSG_LIST Initialize message list default = FALSE
488 -- P_VALIDATION_LEVEL Default validation level = FULL
489
490 -- X_RETURN_STATUS The return status based on standard API convention
491 -- X_MSG_COUNT Message count
492 -- X_MSG_DATA Return messages
493
494 -- End of comments
495
496 PROCEDURE GET_INSTR_INSTANCE_XML
497 (
498 P_API_VERSION IN NUMBER,
499 P_INIT_MSG_LIST IN VARCHAR2 DEFAULT FND_API.G_FALSE,
500 P_VALIDATION_LEVEL IN NUMBER DEFAULT FND_API.G_VALID_LEVEL_FULL,
501 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
502 X_MSG_COUNT OUT NOCOPY NUMBER,
503 X_MSG_DATA OUT NOCOPY VARCHAR2,
504
505
506 P_INSTRUCTION_PROCESS_ID IN NUMBER,
507 X_OUTPUT_XML OUT NOCOPY CLOB
508 );
509
510
511 -- This API is called to create instance from definition
512 -- for given entity name, entity key and instruction type
513
514 -- Start of comments
515 -- API name : CREATE_INSTANCE_FROM_DEFN
516 -- Type : Group API
517 -- Function : Creates an instance from the definition
518
519 -- Pre-reqs : None
520 -- Parameters
521
522 -- P_API_VERSION API Version
523 -- P_INIT_MSG_LIST Initialize message list default = FALSE
524 -- P_VALIDATION_LEVEL Default validation level = FULL
525
526 -- P_DEFINITION_ENTITY_NAME The definition entity name
527 -- P_DEFINITION_ENTITY_KEY The definition entity key
528 -- P_INSTANCE_ENTITY_NAME The instance entity name
529 -- P_INSTANCE_ENTITY_KEY The instance entity key
530
531 -- P_INSTRUCTION_TYPE The instruction type
532 -- X_INSTRUCTION_SET_ID The instruction set id output
533
534 -- X_RETURN_STATUS The return status based on
535 -- standard API convention
536
537 -- X_MSG_COUNT Message count
538 -- X_MSG_DATA Return messages
539
540 -- End of comments
541
542 PROCEDURE CREATE_INSTANCE_FROM_DEFN
543 (
544 P_API_VERSION IN NUMBER,
545 P_INIT_MSG_LIST IN VARCHAR2 DEFAULT FND_API.G_FALSE,
546 P_COMMIT IN VARCHAR2 DEFAULT FND_API.G_FALSE,
547 P_VALIDATION_LEVEL IN NUMBER DEFAULT FND_API.G_VALID_LEVEL_FULL,
548 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
549 X_MSG_COUNT OUT NOCOPY NUMBER,
550 X_MSG_DATA OUT NOCOPY VARCHAR2,
551
552 P_DEFINITION_ENTITY_NAME IN VARCHAR2,
553 P_DEFINITION_ENTITY_KEY IN VARCHAR2,
554 P_INSTANCE_ENTITY_NAME IN VARCHAR2,
555 P_INSTANCE_ENTITY_KEY IN VARCHAR2,
556 P_INSTRUCTION_TYPE IN VARCHAR2,
557 X_INSTRUCTION_SET_ID OUT NOCOPY NUMBER
558
559 );
560
561 -- This API is called to create instance from instance
562
563 -- Start of comments
564 -- API name : CREATE_INSTANCE_FROM_INSTANCE
565 -- Type : Group API
566 -- Function : Creates an instance from the instance
567
568 -- Pre-reqs : None
569 -- Parameters
570
571 -- P_API_VERSION API Version
572 -- P_INIT_MSG_LIST Initialize message list default = FALSE
573 -- P_VALIDATION_LEVEL Default validation level = FULL
574
575 -- P_SOURCE_ENTITY_NAME The INSTANCE entity name
576 -- P_SOURCE_ENTITY_KEY The INSTANCE entity key
577 -- P_TARGET_ENTITY_KEY The instance TARGET entity key
578
579 -- P_INSTRUCTION_TYPE The instruction type
580 -- X_INSTRUCTION_SET_ID The instruction set id
581
582 -- X_RETURN_STATUS The return status based on
583 -- standard API convention
584
585 -- X_MSG_COUNT Message count
586 -- X_MSG_DATA Return messages
587
588 -- End of comments
589
590 PROCEDURE CREATE_INSTANCE_FROM_INSTANCE
591 (
592
593 P_API_VERSION IN NUMBER,
594 P_INIT_MSG_LIST IN VARCHAR2 DEFAULT FND_API.G_FALSE,
595 P_COMMIT IN VARCHAR2 DEFAULT FND_API.G_FALSE,
596 P_VALIDATION_LEVEL IN NUMBER DEFAULT FND_API.G_VALID_LEVEL_FULL,
597 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
598 X_MSG_COUNT OUT NOCOPY NUMBER,
599 X_MSG_DATA OUT NOCOPY VARCHAR2,
600
601 P_SOURCE_ENTITY_NAME IN VARCHAR2,
602 P_SOURCE_ENTITY_KEY IN VARCHAR2,
603 P_TARGET_ENTITY_KEY IN VARCHAR2,
604 P_INSTRUCTION_TYPE IN VARCHAR2,
605 X_INSTRUCTION_SET_ID OUT NOCOPY NUMBER
606
607 );
608
609
610 -- This API is called to send the instance acknowledgment
611 -- It acknowledges the instruction set and copies the temporary
612 -- data to permenant instance tables. It also marks all DONE instructions
613 -- to COMPLETE
614
615 -- Start of comments
616 -- API name : SEND_TASK_ACKN
617 -- Type : Group API
618 -- Function : Send task acknowledgment
619
620 -- Pre-reqs : None
621 -- Parameters
622
623 -- P_API_VERSION API Version
624 -- P_INIT_MSG_LIST Initialize message list default = FALSE
625 -- P_VALIDATION_LEVEL Default validation level = FULL
626
627 -- P_INSTRUCTION_PROCESS_ID The instruction process id
628 -- P_ENTITY_KEY The instance entity key
629
630 -- P_TASK_ERECORD_ID The task e-record id array
631 -- P_TASK_IDENTIFIER The task identifier array
632 -- P_TASK_VALUE The task value array
633
634 -- P_DISABLE_TASK The default value is 'N', set this to 'Y', if the
635 -- manual entry from task is to be disabled
636
637 -- P_MANUAL_ENTRY Whether, the task details being submitted are manually entered
638 -- This parameter IS FOR internal USE only
639
640 -- X_RETURN_STATUS The return status based on standard API convention
641 -- X_MSG_COUNT Message count
642 -- X_MSG_DATA Return messages
643
644 -- End of comments
645
646 PROCEDURE SEND_TASK_ACKN
647 (
648 P_API_VERSION IN NUMBER,
649 P_INIT_MSG_LIST IN VARCHAR2 DEFAULT FND_API.G_FALSE,
650 P_VALIDATION_LEVEL IN NUMBER DEFAULT FND_API.G_VALID_LEVEL_FULL,
651 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
652 X_MSG_COUNT OUT NOCOPY NUMBER,
653 X_MSG_DATA OUT NOCOPY VARCHAR2,
654
655 P_INSTRUCTION_ID IN NUMBER,
656 P_INSTRUCTION_PROCESS_ID IN NUMBER,
657 P_ENTITY_KEY IN VARCHAR2 DEFAULT NULL,
658 P_TASK_ERECORD_ID IN FND_TABLE_OF_VARCHAR2_255,
659 P_TASK_IDENTIFIER IN FND_TABLE_OF_VARCHAR2_255,
660 P_TASK_VALUE IN FND_TABLE_OF_VARCHAR2_255,
661 P_DISABLE_TASK IN VARCHAR2 DEFAULT 'N'
662 );
663
664
665 -- This API will mark all the instruction set for given entity
666 -- as CANCEL
667
668 -- Start of comments
669 -- API name : NULLIFY_INSTR_FOR_ENTITY
670 -- Type : Group API
671 -- Function : Nullifies instructions for entity
672
673 -- Pre-reqs : None
674 -- Parameters
675
676 -- P_API_VERSION API Version
677 -- P_INIT_MSG_LIST Initialize message list default = FALSE
678 -- P_VALIDATION_LEVEL Default validation level = FULL
679
680 -- P_ENTITY_NAME The INSTANCE entity name
681 -- P_ENTITY_KEY The instance entity key
682 -- P_INSTRUCTION_TYPE The instruction type
683
684 -- X_RETURN_STATUS The return status based on standard API convention
685 -- X_MSG_COUNT Message count
686 -- X_MSG_DATA Return messages
687
688 -- End of comments
689
690 PROCEDURE NULLIFY_INSTR_FOR_ENTITY
691 (
692
693 P_API_VERSION IN NUMBER,
694 P_INIT_MSG_LIST IN VARCHAR2 DEFAULT FND_API.G_FALSE,
695 P_VALIDATION_LEVEL IN NUMBER DEFAULT FND_API.G_VALID_LEVEL_FULL,
696 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
697 X_MSG_COUNT OUT NOCOPY NUMBER,
698 X_MSG_DATA OUT NOCOPY VARCHAR2,
699
700 P_ENTITY_NAME IN VARCHAR2,
701 P_ENTITY_KEY IN VARCHAR2,
702 P_INSTRUCTION_TYPE IN VARCHAR2
703
704 );
705
706 -- This API returns the task parameter value for passed
707 -- task parameter name
708
709 -- Start of comments
710 -- API name :
711 -- Type : Group API
712 -- Function : Returns Task Parameter Value
713
714 -- Pre-reqs : None
715 -- Parameters
716
717 -- P_API_VERSION API Version
718 -- P_INIT_MSG_LIST Initialize message list default = FALSE
719 -- P_VALIDATION_LEVEL Default validation level = FULL
720
721 -- P_INSTRUCTION_PROCESS_ID The Instruction Process Id
722 -- P_ATTRIBUTE_NAME Task Parameter Name
723
724 -- X_RETURN_STATUS The return status based on standard API convention
725 -- X_MSG_COUNT Message count
726 -- X_MSG_DATA Return messages
727
728 -- End of comments
729
730 PROCEDURE GET_TASK_PARAMETER
731 (
732 P_API_VERSION IN NUMBER,
733 P_INIT_MSG_LIST IN VARCHAR2 DEFAULT FND_API.G_FALSE,
734 P_VALIDATION_LEVEL IN NUMBER DEFAULT FND_API.G_VALID_LEVEL_FULL,
735 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
736 X_MSG_COUNT OUT NOCOPY NUMBER,
737 X_MSG_DATA OUT NOCOPY VARCHAR2,
738
739 P_INSTRUCTION_PROCESS_ID IN NUMBER,
740 P_ATTRIBUTE_NAME IN VARCHAR2,
741 X_ATTRIBUTE_VALUE OUT NOCOPY VARCHAR2
742
743 );
744
745 --Bug 5383022: start
746
747 -- Start of comments
748 -- API name : is_task_attribute_used
749 -- Type : Group API
750 -- Function : This procedure is used to check if the task attribute is used
751 -- Pre-reqs : None
752 --
753 -- IN : P_API_VERSION API Version
754 -- P_INIT_MSG_LIST Initialize message list default = FALSE
755 -- P_VALIDATION_LEVEL Default validation level = FULL
756 -- P_INSTRUCTION_PROCESS_ID - The instruction process ID
757 -- p_attribute_name - attribute name
758 -- p_attribute_key - attribute key
759 -- OUT : x_used_flag - used flag
760 -- x_return_status - return status
761 -- x_msg_count - message count
762 -- x_msg_data - message data
763 --End of comments
764
765 procedure is_task_attribute_used
766 (
767 P_API_VERSION IN NUMBER,
768 P_INIT_MSG_LIST IN VARCHAR2 DEFAULT FND_API.G_FALSE,
769 P_VALIDATION_LEVEL IN NUMBER DEFAULT FND_API.G_VALID_LEVEL_FULL,
770 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
771 X_MSG_COUNT OUT NOCOPY NUMBER,
772 X_MSG_DATA OUT NOCOPY VARCHAR2,
773
774 p_instruction_process_id IN number,
775 p_attribute_name IN varchar2,
776 p_attribute_key IN varchar2,
777 x_used_flag OUT NOCOPY varchar2
778 );
779 --Bug 5383022: end
780 END GMO_INSTRUCTION_GRP;
781
[Home] [Help]