1 PACKAGE XDP_ENGINE AUTHID CURRENT_USER AS
2 /* $Header: XDPENGNS.pls 120.1 2005/06/15 22:56:36 appldev $ */
3
4
5 -- Datastructure Definitions
6
7 TYPE PARAMETER_REC IS RECORD(
8 PARAMETER_NAME VARCHAR2(80),
9 IS_VALUE_EVALUATED_FLAG Varchar2(1),
10 PARAMETER_VALUE VARCHAR2(2000),
11 PARAMETER_REFERENCE_VALUE VARCHAR2(2000) DEFAULT NULL);
12
13 -- list of the activation parameter
14 TYPE PARAMETER_LIST IS TABLE OF PARAMETER_REC
15 INDEX BY BINARY_INTEGER;
16
17
18 pv_FeAttributeList XDP_TYPES.ORDER_PARAMETER_LIST;
19
20 pv_evalModeUponReceipt varchar2(80) := 'ON_ORDER_RECEIPT';
21 pv_evalModeDeferred varchar2(80) := 'ON_PROCESS_ORDER';
22 pv_evalModeWIStart varchar2(80) := 'ON_WORKITEM_START';
23
24 -- API specifications
25
26 -- Start of comments
27 -- API name : GET_WORKITEM_PARAM_VALUE
28 -- Type : Public
29 -- Function : Get a workitem parameter value.
30 -- Pre-reqs : None.
31 -- Parameters :
32 --
33 -- IN : p_wi_instance_id: NUMBER Required
34 -- The runtime ID for a given work item instance
35 -- p_parameter_name: VARCHAR2 Required
36 -- The name of the work item parameter
37 -- @return The value of the parameter will be returned.
38 --
39 -- Version : Current version 11.5
40 -- Notes :
41 -- Get a workitem parameter value. The macro
42 -- $WI.<parameter_name> in FP actually uses this
43 -- function for runtime value substitution.
44 -- End of comments
45 FUNCTION GET_WORKITEM_PARAM_VALUE(
46 p_wi_instance_id IN NUMBER,
47 p_parameter_name IN VARCHAR2)
48 RETURN VARCHAR2;
49
50 -- Start of comments
51 -- API name : GET_WORKITEM_PARAM_REF_VALUE
52 -- Type : Public
53 -- Function : Get a workitem parameter reference value.
54 -- Pre-reqs : None.
55 -- Parameters :
56 --
57 -- IN : p_wi_instance_id: NUMBER Required
58 -- The runtime ID for a given work item instance
59 -- p_parameter_name: VARCHAR2 Required
60 -- The name of the work item parameter
61 -- @return The reference value of the parameter will be returned.
62 --
63 -- Version : Current version 11.5
64 -- Notes :
65 -- Get a workitem parameter reference value. The macro
66 -- $WI_REF.<parameter_name> in FP actually uses this
67 -- function for runtime value substitution.
68 -- End of comments
69 FUNCTION GET_WORKITEM_PARAM_REF_VALUE(
70 p_wi_instance_id IN NUMBER,
71 p_parameter_name IN VARCHAR2)
72 RETURN VARCHAR2;
73
74 -- Start of comments
75 -- API name : GET_WORKITEM_PARAM_VALUE
76 -- Type : Private
77 -- Function : Get the additional information for a work item parameter.
78 -- Pre-reqs : None.
79 -- Parameters :
80 --
81 -- IN : p_wi_instance_id: NUMBER Required
82 -- The runtime ID for a given work item instance
83 -- p_parameter_name: VARCHAR2 Required
84 -- The name of the work item parameter
85 -- OUT : p_param_val: VARCHAR2
86 -- The value of the parameter.
87 -- p_parameter_ref_val: VARCHAR2
88 -- The reference value of the parameter.
89 -- p_log_value_flag: BOOLEAN
90 -- Indicate that the value should be stored in audit trail table or not
91 -- p_return_code: NUMBER
92 -- Indicate the status of the API call. Any non-zero values represents error.
93 -- p_error_description: VARCHAR2
94 -- The description of error which is raised by the API
95 --
96 -- Version : Current version 11.5
97 -- Notes :
98 -- This procedure is used by SEND function to
99 -- get the additional information regarding
100 -- an workitem parameter. It will also return a flag
101 -- to indicate if the parameter contains value
102 -- for a data sensitive parameter. If it does, the command
103 -- string which SFM is about to send will not be logged
104 -- in our command audit trail tables.
105 -- End of comments
106 PROCEDURE GET_WORKITEM_PARAM_VALUE(
107 p_wi_instance_id IN NUMBER,
108 p_parameter_name IN VARCHAR2,
109 p_param_val OUT NOCOPY VARCHAR2,
110 p_param_ref_val OUT NOCOPY VARCHAR2,
111 p_log_value_flag OUT NOCOPY BOOLEAN,
112 p_return_code OUT NOCOPY number,
113 p_error_description OUT NOCOPY VARCHAR2);
114
115 -- Start of comments
116 -- API name : GET_WORKITEM_PARAM_List
117 -- Type : Private
118 -- Function : Get a list of parameter value for a given work item.
119 -- Pre-reqs : None.
120 -- Parameters :
121 --
122 -- IN : p_wi_instance_id: NUMBER Required
123 -- The runtime ID for a given work item instance
124 -- @return The list of values for all the parameters of a given work item
125 -- Version : Current version 11.5
126 -- Notes :
127 -- Get a list of the parameter values for
128 -- a given workitem instance
129 -- End of comments
130 FUNCTION GET_WORKITEM_PARAM_List(
131 p_wi_instance_id IN NUMBER)
132 RETURN XDP_ENGINE.PARAMETER_LIST;
133
134 -- Start of comments
135 -- API name : SET_WORKITEM_PARAM_VALUE
136 -- Type : Public
137 -- Function : Set the value for a work item parameter.
138 -- Pre-reqs : None.
139 -- Parameters :
140 --
141 -- IN : p_wi_instance_id: NUMBER Required
142 -- The runtime ID for a given work item instance
143 -- p_parameter_name: VARCHAR2 Required
144 -- The name of the work item parameter
145 -- p_parameter_value: VARCHAR2 Required
146 -- The new value of the work item parameter
147 -- p_parameter_reference_value: VARCHAR2 Optional
148 -- The new reference value of the work item parameter
149 -- Default to be NULL.
150 -- p_evaluation_required: BOOLEAN Optional
151 -- Indicate that the evaluation procedure should be executed if applicable.
152 -- Default to be FALSE.
153 --
154 -- Version : Current version 11.5
155 -- Notes :
156 -- Set the workitem parameter value for
157 -- a given workitem instance. The parameter
158 -- evaluation procedure will be executed if
159 -- applicable.
160 -- End of comments
161 PROCEDURE Set_Workitem_Param_value(
162 p_wi_instance_id IN NUMBER,
163 p_parameter_name IN VARCHAR2,
164 p_parameter_value IN VARCHAR2,
165 p_parameter_reference_value IN VARCHAR2 DEFAULT NULL,
166 p_evaluation_required IN BOOLEAN DEFAULT FALSE);
167
168 -- Start of comments
169 -- API name : GET_WORKITEM_PROV_DATE
170 -- Type : Public
171 -- Function : Get the Fulfillment Date for a Workitem Instance.
172 -- Pre-reqs : None.
173 -- Parameters :
174 --
175 -- IN : p_wi_instance_id: NUMBER Required
176 -- The runtime ID for a given work item instance
177 -- @return The work item Fulfillment date.
178 --
179 -- Version : Current version 11.5
180 -- Notes :
181 -- Get the Fulfillment Date for a Workitem Instance
182 -- End of comments
183 FUNCTION GET_WORKITEM_PROV_DATE(
184 p_wi_instance_id IN NUMBER)
185 RETURN DATE;
186
187 -- Start of comments
188 -- API name : SET_WORKITEM_PROV_DATE
189 -- Type : Public
190 -- Function : Set the Fulfillment Date for a Workitem Instance.
191 -- Pre-reqs : None.
192 -- Parameters :
193 --
194 -- IN : p_wi_instance_id: NUMBER Required
195 -- The runtime ID for a given work item instance
196 -- p_prov_date DATE Required
197 -- The Fulfillment Date for a Workitem Instance
198 -- OUT : p_return_code: NUMBER
199 -- Indicate the status of the API call. Any non-zero values represents error.
200 -- p_error_description: VARCHAR2
201 -- The description of error which is raised by the API
202 --
203 -- Version : Current version 11.5
204 -- Notes :
205 -- Set the Fulfillment Date for a Workitem Instance
206 -- If the Workitem is being processed or already processed an error code is returned
207 -- End of comments
208 PROCEDURE SET_WORKITEM_PROV_DATE(
209 p_wi_instance_id in NUMBER,
210 p_prov_date IN DATE,
211 p_return_code OUT NOCOPY NUMBER,
212 p_error_description OUT NOCOPY VARCHAR2);
213
214 -- Start of comments
215 -- API name : GET_FA_PARAM_VALUE
216 -- Type : Public
217 -- Function : Get a fulfillment action parameter value.
218 -- Pre-reqs : None.
219 -- Parameters :
220 --
221 -- IN : p_fa_instance_id: NUMBER Required
222 -- The runtime ID for a given fulfillment action instance
223 -- p_parameter_name: VARCHAR2 Required
224 -- The name of the fulfillment action parameter
225 -- @return The value of the parameter will be returned.
226 --
227 -- Version : Current version 11.5
228 -- Notes :
229 -- Get an FA parameter value. The macro
230 -- $FA.<parameter_name> in FP actually uses this
231 -- function for runtime value substitution.
232 -- End of comments
233 FUNCTION GET_FA_PARAM_VALUE(
234 p_fa_instance_id IN NUMBER,
235 p_parameter_name IN VARCHAR2)
236 RETURN VARCHAR2;
237
238 -- Start of comments
239 -- API name : GET_FA_PARAM_REF_VALUE
240 -- Type : Public
241 -- Function : Get a fulfillment action parameter reference value.
242 -- Pre-reqs : None.
243 -- Parameters :
244 --
245 -- IN : p_fa_instance_id: NUMBER Required
246 -- The runtime ID for a given fulfillment action instance
247 -- p_parameter_name: VARCHAR2 Required
248 -- The name of the fulfillment action parameter
249 -- @return The reference value of the parameter will be returned.
250 --
251 -- Version : Current version 11.5
252 -- Notes :
253 -- Get an FA parameter reference value. The macro
254 -- $FA_REF.<parameter_name> in FP actually uses this
255 -- function for runtime value substitution.
256 -- End of comments
257 FUNCTION GET_FA_PARAM_REF_VALUE(
258 p_fa_instance_id IN NUMBER,
259 p_parameter_name IN VARCHAR2)
260 RETURN VARCHAR2;
261
262 -- Start of comments
263 -- API name : GET_FA_PARAM_VALUE
264 -- Type : Private
265 -- Function : Get the additional information for FA parameter.
266 -- Pre-reqs : None.
267 -- Parameters :
268 --
269 -- IN : p_fa_instance_id: NUMBER Required
270 -- The runtime ID for a given fulfillment action instance
271 -- p_parameter_name: VARCHAR2 Required
272 -- The name of the fulfillment action parameter
273 -- OUT : p_param_val: VARCHAR2
274 -- The value of the parameter.
275 -- p_parameter_ref_val: VARCHAR2
276 -- The reference value of the parameter.
277 -- p_log_value_flag: BOOLEAN
278 -- Indicate that the value should be stored in audit trail table or not
279 -- p_return_code: NUMBER
280 -- Indicate the status of the API call. Any non-zero values represents error.
281 -- p_error_description: VARCHAR2
282 -- The description of error which is raised by the API
283 --
284 -- Version : Current version 11.5
285 -- Notes :
286 -- This procedure is used by SEND function to
287 -- get the additional information regarding
288 -- an FA parameter. It will also return a flag
289 -- to indicate if the parameter contains decrypted value
290 -- for an encypted parameter. If it does, the command
291 -- string which SFM is about to send will not be logged
292 -- in our command audit trail tables.
293 -- End of comments
294 PROCEDURE GET_FA_PARAM(
295 p_fa_instance_id IN NUMBER,
296 p_parameter_name IN VARCHAR2,
297 p_param_val OUT NOCOPY VARCHAR2,
298 p_param_ref_val OUT NOCOPY VARCHAR2,
299 p_log_value_flag OUT NOCOPY BOOLEAN,
300 p_return_code OUT NOCOPY number,
301 p_error_description OUT NOCOPY VARCHAR2);
302
303 -- Start of comments
304 -- API name : GET_FA_PARAM_List
305 -- Type : Private
306 -- Function : Get a list of parameter values for a given fulfillment action instance.
307 -- Pre-reqs : None.
308 -- Parameters :
309 --
310 -- IN : p_fa_instance_id: NUMBER Required
311 -- The runtime ID for a given fulfillment action instance
312 -- @return The list of values for all the parameters of a given fulfillment action
313 --
314 -- Version : Current version 11.5
315 -- Notes :
316 -- Get a list of the parameter values for
317 -- a given FA instance
318 -- End of comments
319 FUNCTION GET_FA_PARAM_List(
320 p_fa_instance_id IN NUMBER)
321 RETURN XDP_ENGINE.PARAMETER_LIST;
322
323 -- Start of comments
324 -- API name : SET_FA_PARAM_VALUE
325 -- Type : Public
326 -- Function : Set the value for a fulfillment action parameter.
327 -- Pre-reqs : None.
328 -- Parameters :
329 --
330 -- IN : p_fa_instance_id: NUMBER Required
331 -- The runtime ID for a given fulfillment action instance
332 -- p_fa_parameter_name: VARCHAR2 Required
333 -- The name of the fulfillment action parameter
334 -- p_parameter_value: VARCHAR2 Required
335 -- The new value of the fulfillment action parameter
336 -- p_parameter_reference_value: VARCHAR2 Optional
337 -- The new reference value of the fulfillment action parameter
338 -- Default to be NULL.
339 -- p_evaluation_required: BOOLEAN Optional
340 -- Indicate that the evaluation procedure should be executed if applicable.
341 --
342 -- Version : Current version 11.5
343 -- Notes :
344 -- Set the FA parameter value for
345 -- a given FA instance. The parameter
346 -- evaluation procedure will be executed if
347 -- applicable.
348 -- End of comments
349 PROCEDURE Set_FA_Param_value(
350 p_fa_instance_id IN NUMBER,
351 p_parameter_name IN VARCHAR2,
352 p_parameter_value IN VARCHAR2,
353 p_parameter_reference_value IN VARCHAR2 DEFAULT NULL,
354 p_evaluation_required IN BOOLEAN DEFAULT FALSE);
355
356
357 -- Start of comments
358 -- API name : GET_ORDER_PARAM_VALUE
359 -- Type : Public
360 -- Function : Get an order parameter value.
361 -- Pre-reqs : None.
362 -- Parameters :
363 --
364 -- IN : p_order_id: NUMBER Required
365 -- The internal ID for a given order
366 -- p_parameter_name: VARCHAR2 Required
367 -- The name of the order parameter
368 -- @return The value of the parameter will be returned.
369 --
370 -- Version : Current version 11.5
371 -- Notes :
372 -- Get the value of an order parameter
373 -- End of comments
374 FUNCTION GET_ORDER_PARAM_VALUE(
375 p_order_id IN NUMBER,
376 p_parameter_name IN VARCHAR2)
377 RETURN VARCHAR2;
378
379 -- Start of comments
380 --
381 -- Version : Current version 11.5
382 -- API name : GET_ORDER_PARAM_List
383 -- Type : Private
384 -- Function : Get a list of parameter values for a given order.
385 -- Pre-reqs : None.
386 -- Parameters :
387 --
388 -- IN : p_order_id: NUMBER Required
389 -- The internal ID for a given order
390 -- @return The list of values for all the order parameters of a given order
391 --
392 -- Notes :
393 -- End of comments
394 FUNCTION GET_ORDER_PARAM_List(
395 p_order_id IN NUMBER )
396 RETURN XDP_ENGINE.PARAMETER_LIST;
397
398 -- Start of comments
399 -- API name : SET_ORDER_PARAM_VALUE
400 -- Type : Public
401 -- Function : Set the value for an order parameter.
402 -- Pre-reqs : None.
403 -- Parameters :
404 --
405 -- IN : p_order_id: NUMBER Required
406 -- The internal ID for a given order
407 -- p_parameter_name: VARCHAR2 Required
408 -- The name of the order parameter
409 -- p_parameter_value: VARCHAR2 Required
410 -- The new value of the order parameter
411 --
412 -- Version : Current version 11.5
413 -- Notes :
414 -- Set an order parameter value
415 -- End of comments
416 PROCEDURE Set_ORDER_Param_value(
417 p_order_id IN NUMBER,
418 p_parameter_name IN VARCHAR2,
419 p_parameter_value IN VARCHAR2);
420
424 -- Function : Get an order line parameter value.
421 -- Start of comments
422 -- API name : GET_LINE_PARAM_VALUE
423 -- Type : Public
425 -- Pre-reqs : None.
426 -- Parameters :
427 --
428 -- IN : p_line_item_id: NUMBER Required
429 -- The internal ID for a given order line
430 -- p_parameter_name: VARCHAR2 Required
431 -- The name of the order line parameter
432 -- @return The value of the parameter will be returned.
433 --
434 -- Version : Current version 11.5
435 -- Notes :
436 -- Get the value of a line parameter
437 -- End of comments
438 FUNCTION GET_LINE_PARAM_VALUE(
439 p_line_item_id IN NUMBER,
440 p_parameter_name IN VARCHAR2)
441 RETURN VARCHAR2;
442
443 -- Start of comments
444 -- API name : GET_LINE_PARAM_REF_VALUE
445 -- Type : Public
446 -- Function : Get an order line parameter reference value.
447 -- Pre-reqs : None.
448 -- Parameters :
449 --
450 -- IN : p_line_item_id: NUMBER Required
451 -- The internal ID for a given order line
452 -- p_parameter_name: VARCHAR2 Required
453 -- The name of the order line parameter
454 -- @return The reference value of the parameter will be returned.
455 --
456 -- Version : Current version 11.5
457 -- Notes :
458 -- End of comments
459 FUNCTION GET_LINE_PARAM_REF_VALUE(
460 p_line_item_id IN NUMBER,
461 p_parameter_name IN VARCHAR2)
462 RETURN VARCHAR2;
463
464 -- Start of comments
465 -- API name : ADD_LINE_PARAM
466 -- Type : Public
467 -- Function : Add a new runtime parameter to a given line.
468 -- Pre-reqs : None.
469 -- Parameters :
470 --
471 -- IN : p_line_item_id: NUMBER Required
472 -- The internal ID for a given order line
473 -- p_parameter_name: VARCHAR2 Required
474 -- The name of the order line parameter
475 -- p_parameter_value: VARCHAR2 Required
476 -- The value of the order line parameter
477 -- p_parameter_reference_value: VARCHAR2 Optional
478 -- The reference value of the order line parameter
479 --
480 -- Version : Current version 11.5
481 -- Notes :
482 -- End of comments
483 PROCEDURE ADD_LINE_PARAM(
484 p_line_item_id IN NUMBER,
485 p_parameter_name IN VARCHAR2,
486 p_parameter_value IN VARCHAR2,
487 p_parameter_reference_value IN VARCHAR2 DEFAULT NULL);
488
489 -- Start of comments
490 -- API name : SET_LINE_PARAM_VALUE
491 -- Type : Public
492 -- Function : Update an existing parameter value for a given line.
493 -- Pre-reqs : None.
494 -- Parameters :
495 --
496 -- IN : p_line_item_id: NUMBER Required
497 -- The internal ID for a given order line
498 -- p_parameter_name: VARCHAR2 Required
499 -- The name of the order line parameter
500 -- p_parameter_value: VARCHAR2 Required
501 -- The value of the order line parameter
502 -- p_parameter_reference_value: VARCHAR2 Optional
503 -- The reference value of the order line parameter
504 --
505 -- Version : Current version 11.5
506 -- Notes :
507 -- End of comments
508 PROCEDURE Set_LINE_PARAM_Value(
509 p_line_item_id IN NUMBER,
510 p_parameter_name IN VARCHAR2,
511 p_parameter_value IN VARCHAR2,
512 p_parameter_reference_value IN VARCHAR2 DEFAULT NULL);
513
514 -- Start of comments
515 -- API name : Get_FE_ConfigInfo
516 -- Type : Public
517 -- Function : Retrieve the configuration data for a given fulfillment element.
518 -- Pre-reqs : None.
519 -- Parameters :
520 --
521 -- IN : p_fe: VARCHAR2 Required
522 -- The name of the fulfillment element
523 -- OUT : p_fe_id: NUMBER
524 -- Internal ID for the FE.
525 -- p_fetype_id: NUMBER
526 -- Internal id for the Fulfillment Element type
527 -- p_fetype: VARCHAR2
528 -- Name of the Fulfillment Element TYPE.
529 -- p_fe_sw_generic: VARCHAR2
530 -- The current software generic of the Fulfillment Element.
531 -- p_adapter_type: VARCHAR2
532 -- The current adapter type of the Fulfillment Element.
533 --
534 -- Version : Current version 11.5
535 -- Notes :
536 -- Retrieve the configuration data
537 -- for a given fulfillment element
538 -- End of comments
539 PROCEDURE Get_FE_ConfigInfo(
540 p_fe IN VARCHAR2,
541 p_fe_id OUT NOCOPY NUMBER,
542 p_fetype_id OUT NOCOPY NUMBER,
543 p_fetype OUT NOCOPY VARCHAR2,
544 p_fe_sw_generic OUT NOCOPY varchar2,
545 p_adapter_type OUT NOCOPY varchar2 );
546
547 -- Start of comments
548 -- API name : Get_FE_ConfigInfo
549 -- Type : Public
550 -- Function : Retrieve the configuration data for a given fulfillment element.
551 -- Pre-reqs : None.
552 -- Parameters :
553 --
554 -- IN : p_fe_id: NUMBER Required
555 -- Internal ID for the FE.
556 -- OUT : p_fe_name: VARCHAR2
557 -- The name of the fulfillment element
558 -- p_fetype_id: NUMBER
559 -- Internal id for the Fulfillment Element type
560 -- p_fetype: VARCHAR2
561 -- Name of the Fulfillment Element TYPE.
562 -- p_fe_sw_generic: VARCHAR2
563 -- The current software generic of the Fulfillment Element.
564 -- p_adapter_type: VARCHAR2
565 -- The current adapter type of the Fulfillment Element.
566 --
567 -- Version : Current version 11.5
568 -- Notes :
569 -- Retrieve the configuration data
570 -- for a given fulfillment element
571 -- End of comments
575 p_fetype_id OUT NOCOPY NUMBER,
572 PROCEDURE Get_FE_ConfigInfo(
573 p_fe_id IN NUMBER,
574 p_fe_name OUT NOCOPY VARCHAR2,
576 p_fetype OUT NOCOPY VARCHAR2,
577 p_fe_sw_generic OUT NOCOPY varchar2,
578 p_adapter_type OUT NOCOPY varchar2 );
579
580
581 -- Start of comments
582 -- API name : Get_FE_AttributeVal
583 -- Type : Group
584 -- Function : Retrieve the FE Attribute value for a given fulfillment element.
585 -- Pre-reqs : None.
586 --
587 -- Version : Current version 11.5
588 -- Notes :
589 -- Retrieve the FE Attribute value
590 -- for a given fulfillment element
591 -- End of comments
592 FUNCTION Get_FE_AttributeVal(
593 p_fe_name IN VARCHAR2,
594 p_attribute_name IN VARCHAR2)
595 return varchar2;
596
597 -- Start of comments
598 -- API name : Get_FE_AttributeVal
599 -- Type : Group
600 -- Function : Overload function. Retrieve the FE Attribute value for a given fulfillment element.
601 -- Pre-reqs : None.
602 --
603 -- Version : Current version 11.5
604 -- Notes :
605 -- Retrieve the FE Attribute value
606 -- for a given fulfillment element
607 -- End of comments
608 FUNCTION Get_FE_AttributeVal(
609 p_fe_id IN NUMBER,
610 p_attribute_name IN VARCHAR2)
611 return varchar2;
612
613 -- Start of comments
614 -- API name : Get_FE_AttributeVal_List
615 -- Type : Group
616 -- Function : Retrieve all the FE Attribute value for a given fulfillment element.
617 -- Pre-reqs : None.
618 --
619 -- Version : Current version 11.5
620 -- Notes :
621 -- End of comments
622 FUNCTION Get_FE_AttributeVal_List(
623 p_fe_name in varchar2)
624 RETURN XDP_TYPES.ORDER_PARAMETER_LIST;
625
626
627 -- Start of comments
628 -- API name : Get_FE_AttributeVal_List
629 -- Type : Group
630 -- Function : Retrieve all the FE Attribute value for a given
631 -- fulfillment element ID.
632 -- Pre-reqs : None.
633 --
634 -- Version : Current version 11.5
635 -- Notes :
636 -- End of comments
637 FUNCTION Get_FE_AttributeVal_List(
638 p_fe_id in number)
639 RETURN XDP_TYPES.ORDER_PARAMETER_LIST;
640
641
642 Procedure PreFetch_FeAttrList( p_fe_name in varchar2,
643 p_attr_count OUT NOCOPY number);
644
645 Procedure Fetch_FeAttrFromList(p_index in number,
646 p_attr_name OUT NOCOPY varchar2,
647 p_attr_value OUT NOCOPY varchar2);
648
649
650 -- Start of comments
651 -- API name : Get_FE_ConnectionProc
652 -- Type : Group
653 -- Function : Retrieve the connect/disconnect procedure name for a given fulfillment element.
654 -- Pre-reqs : None.
655 --
656 -- Version : Current version 11.5
657 -- Notes :
658 -- End of comments
659 PROCEDURE Get_FE_ConnectionProc(
660 p_fe_name IN VARCHAR2,
661 p_connect_proc_name OUT NOCOPY VARCHAR2,
662 p_disconnect_proc_name OUT NOCOPY VARCHAR2);
663
664 -- Start of comments
665 -- API name : Get_FE_ConnectionProc
666 -- Type : Group
667 -- Function : Overload Function. Get the connect/disconnect procedure name for a given fulfillment element.
668 -- Pre-reqs : None.
669 --
670 -- Version : Current version 11.5
671 -- Notes :
672 -- Retrieve the FE connect/disconnect procedure name
673 -- for a given fulfillment element
674 -- End of comments
675 PROCEDURE Get_FE_ConnectionProc(
676 p_fe_id IN NUMBER,
677 p_connect_proc_name OUT NOCOPY VARCHAR2,
678 p_disconnect_proc_name OUT NOCOPY VARCHAR2);
679
680 -- Start of comments
681 -- API name : Is_fe_valid
682 -- Type : Public
683 -- Function : Check if a Fulfillment is valid as of today
684 -- Pre-reqs : None.
685 --
686 -- Version : Current version 11.5
687 -- Notes :
688 -- End of comments
689 Function Is_Fe_Valid(p_fe_name in varchar2) return BOOLEAN;
690
691 -- Start of comments
692 -- API name : Is_fe_valid
693 -- Type : Public
694 -- Function : Check if a Fulfillment is valid as of today
695 -- Pre-reqs : None.
696 --
697 -- Version : Current version 11.5
698 -- Notes :
699 -- End of comments
700 Function Is_Fe_Valid(p_fe_id in number) return BOOLEAN;
701
702
703 -- Start of comments
704 -- API name : Get_Workitem_List
705 -- Type : Public
706 -- Function : Retrieve the list of the workitems SFM has executed for the given order.
707 -- Pre-reqs : None.
708 --
709 -- Version : Current version 11.5
710 -- Notes :
711 -- End of comments
712 Function Get_Workitem_List(
713 p_sdp_order_id NUMBER)
714 return XDP_TYPES.WORKITEM_LIST;
715
716 -- Start of comments
717 -- API name : Get_FA_List
718 -- Type : Public
719 -- Function : Retrieve the list of the fulfillment actions SFM has executed for the given workitem.
720 -- Pre-reqs : None.
721 --
722 -- Version : Current version 11.5
723 -- Notes :
724 -- End of comments
725 Function Get_FA_List(
726 p_wi_instance_id NUMBER)
727 return XDP_TYPES.FULFILLMENT_ACTION_LIST;
728
729 -- Start of comments
730 -- API name : Get_FA_AUDIT_TRAILS
731 -- Type : Public
735 -- Version : Current version 11.5
732 -- Function : Get the list of commands wnd responses which have been sent and received by the given FA
733 -- Pre-reqs : None.
734 --
736 -- Notes :
737 -- End of comments
738 Function Get_FA_AUDIT_TRAILS(
739 p_fa_instance_id NUMBER)
740 return XDP_TYPES.FA_COMMAND_AUDIT_TRAIL;
741
742 -- Start of comments
743 -- API name : Reset_Sync_Registration
744 -- Type : Public
745 -- Function : Reset a Synchronisation Request
746 -- Pre-reqs : None.
747 --
748 -- Version : Current version 11.5
749 -- Notes :
750 -- End of comments
751 PROCEDURE Reset_Sync_Registration (
752 pp_sync_label IN VARCHAR2
753 ,po_error_code OUT NOCOPY NUMBER
754 ,po_error_msg OUT NOCOPY VARCHAR2
755 );
756
757 -- Start of comments
758 -- API name : RECALCULATE
759 -- Type : Public
760 -- Function : Recalculate timers
761 -- Pre-reqs : None.
762 --
763 -- Version : Current version 11.5
764 -- Notes :
765 -- End of comments
766 PROCEDURE recalculate
767 (
768 p_reference_id IN VARCHAR2
769 ,p_timer_message_code IN VARCHAR2
770 ,x_error_code OUT NOCOPY NUMBER
771 ,x_error_message OUT NOCOPY VARCHAR2
772 );
773
774 -- Start of comments
775 -- API name : RECALCULATE_ALL
776 -- Type : Public
777 -- Function : Recalculate all timers.
778 -- Pre-reqs : None.
779 --
780 -- Version : Current version 11.5
781 -- Notes :
782 -- End of comments
783 PROCEDURE recalculate_all
784 (
785 p_reference_id IN VARCHAR2
786 ,x_error_code OUT NOCOPY NUMBER
787 ,x_error_message OUT NOCOPY VARCHAR2
788 );
789
790 -- Start of comments
791 -- API name : GET_TIMER_STATUS
792 -- Type : Public
793 -- Function : Get timer status using reference_id and timer message code.
794 -- Pre-reqs : None.
795 --
796 -- Version : Current version 11.5
797 -- Notes :
798 -- End of comments
799 PROCEDURE get_timer_status
800 (
801 p_reference_id IN VARCHAR2
802 ,p_timer_message_code IN VARCHAR2
803 ,x_timer_id OUT NOCOPY NUMBER
804 ,x_status OUT NOCOPY VARCHAR2
805 ,x_error_code OUT NOCOPY NUMBER
806 ,x_error_message OUT NOCOPY VARCHAR2
807 );
808
809 -- Start of comments
810 -- API name : UPDATE_TIMER_STATUS
811 -- Type : Public
812 -- Function : Update timer status using reference_id and timer_message_code.
813 -- Pre-reqs : None.
814 --
815 -- Version : Current version 11.5
816 -- Notes :
817 -- End of comments
818 PROCEDURE update_timer_status
819 (
820 p_reference_id IN VARCHAR2
821 ,p_timer_message_code IN VARCHAR2
822 ,p_status IN VARCHAR2
823 ,x_error_code OUT NOCOPY NUMBER
824 ,x_error_message OUT NOCOPY VARCHAR2
825 );
826
827 -- Start of comments
828 -- API name : REMOVE_TIMER
829 -- Type : Public
830 -- Function : Remove timer using reference_id and timer_message_code.
831 -- Pre-reqs : None.
832 --
833 -- Version : Current version 11.5
834 -- Notes :
835 -- End of comments
836 PROCEDURE remove_timer
837 (
838 p_reference_id IN VARCHAR2
839 ,p_timer_message_code IN VARCHAR2
840 ,x_error_code OUT NOCOPY NUMBER
841 ,x_error_message OUT NOCOPY VARCHAR2
842 );
843
844 -- Start of comments
845 -- API name : RESTART
846 -- Type : Public
847 -- Function : Restart a timer using a reference_id and timer_message_code.
848 -- Pre-reqs : None.
849 --
850 -- Version : Current version 11.5
851 -- Notes :
852 -- End of comments
853 PROCEDURE restart
854 (
855 p_reference_id IN VARCHAR2
856 ,p_timer_message_code IN VARCHAR2
857 ,x_error_code OUT NOCOPY NUMBER
858 ,x_error_message OUT NOCOPY VARCHAR2
859 );
860
861 -- Start of comments
862 -- API name : DEREGISTER
863 -- Type : Public
864 -- Function : Deregister timers for an order_id.
865 -- Pre-reqs : None.
866 --
867 -- Version : Current version 11.5
868 -- Notes :
869 -- End of comments
870 PROCEDURE deregister
871 (
872 p_order_id IN NUMBER
873 ,x_error_code OUT NOCOPY NUMBER
874 ,x_error_message OUT NOCOPY VARCHAR2
875 );
876
877 -- Start of comments
878 -- API name : RESTART_ALL
879 -- Type : Public
880 -- Function : Restart all timers using reference_id.
881 -- Pre-reqs : None.
882 --
883 -- Version : Current version 11.5
884 -- Notes :
885 -- End of comments
886 PROCEDURE restart_all
887 (
888 p_reference_id IN VARCHAR2
889 ,x_error_code OUT NOCOPY NUMBER
890 ,x_error_message OUT NOCOPY VARCHAR2
891
892 );
893
894 -- Start of comments
895 -- API name : START_RELATED_TIMERS
896 -- Type : Public
897 -- Function : Start timers related to a message.
898 -- Pre-reqs : None.
899 --
900 -- Version : Current version 11.5
901 -- Notes :
902 -- End of comments
903 PROCEDURE start_related_timers
904 (
905 p_message_code IN VARCHAR2
906 ,p_reference_id IN VARCHAR2
910 ,p_sender_name IN VARCHAR2 DEFAULT NULL
907 ,x_error_code OUT NOCOPY NUMBER
908 ,x_error_message OUT NOCOPY VARCHAR2
909 ,p_opp_reference_id IN VARCHAR2 DEFAULT NULL
911 ,p_recipient_name IN VARCHAR2 DEFAULT NULL
912 ,p_order_id IN NUMBER DEFAULT NULL
913 ,p_wi_instance_id IN NUMBER DEFAULT NULL
914 ,p_fa_instance_id IN NUMBER DEFAULT NULL
915 );
916
917 -- Start of Comment
918 -- API name : Set_Order_Reference
919 -- Type : Group
920 -- Function : API to set the order reference information.
921 -- Pre-reqs : None.
922 -- Notes :
923 -- API to set the order reference information such as order
924 -- reference name, order reference value, service provider
925 -- order number, and service provider user ID
926 -- End of Comment
927 PROCEDURE Set_Order_Reference
928 (
929 p_order_id IN NUMBER,
930 p_order_ref_name IN VARCHAR2,
931 p_order_ref_value IN VARCHAR2,
932 p_sp_order_number IN VARCHAR2 DEFAULT NULL,
933 p_sp_user_id IN NUMBER DEFAULT NULL,
934 x_return_code OUT NOCOPY NUMBER,
935 x_error_description OUT NOCOPY VARCHAR2
936 );
937
938 -- Start of Comment
939 -- API name : XDP_SYNC_LINE_ITEM_PV
940 -- Type : Group
941 -- Function : API to change parameter values for line items according to their workitems
942 -- Parameters :
943 --
944 -- IN : p_line_item_id line item id in XDP.
945 -- Pre-reqs : None.
946 -- Notes :
947 --
948 -- End of Comment
949 PROCEDURE XDP_SYNC_LINE_ITEM_PV(
950 p_line_item_id IN XDP_ORDER_LINE_ITEMS.LINE_ITEM_ID%TYPE,
951 x_return_code OUT NOCOPY NUMBER,
952 x_error_description OUT NOCOPY VARCHAR2
953 );
954
955
956 -- Start of Comment
957 -- API name : EvaluateWIParamsOnStart
958 -- Type : Group
959 -- Function : API to Evaluate all Workitem Parameters marked as
960 -- "Upon Workitem Start"
961 -- Parameters :
962 --
963 -- IN : p_wi_instance_id workitem instance id
964 -- Pre-reqs : None.
965 -- Notes :
966 --
967 -- End of Comment
968 PROCEDURE EvaluateWIParamsOnStart(p_wi_instance_id in number);
969
970 END XDP_ENGINE;
[Home] [Help]