DBA Data[Home] [Help]

PACKAGE: APPS.XDP_ENG_UTIL

Source


1 PACKAGE XDP_ENG_UTIL AUTHID CURRENT_USER AS
2 /* $Header: XDPENGUS.pls 120.1 2005/06/15 22:57:33 appldev  $ */
3 
4 -- PL/SQL Specification
5 -- Datastructure Definitions
6 
7 
8  -- API specifications
9 
10 -- Start of comments
11 --	API name 	: Add_FA_toWI
12 --	Type		: Public
13 --	Function	: Add a fulfillment action instnace to a workitem instance.
14 --	Pre-reqs	: None.
15 --	Parameters	:
16 --
17 --	IN		:	p_wi_instance_id:	NUMBER	Required
18 --					The internal ID for a given work item instance
19 --				p_fa_name:	VARCHAR2 	Required
20 --					The name of the fulfillment action
21 --				p_fe_name:	VARCHAR2 	Optional
22 --					The name of the fulfillment element to be provisioned
23 --				p_priority:	NUMBER 	Optional
24 --					The provisioning priority of the fulfillment action
25 --					Default to be 100.
26 --				p_provisioning_seq:	NUMBER 	Optional
27 --					The provisioning sequence of the fulfillment action
28 --					Default to be 0 which means it has no dependency with
29 --					other fulfillment actions associated with the work item.
30 --  @return  	The runtime ID of the fulfillment action instance
31 --
32 --	Version	: Current version	11.5
33 --	Notes	:
34 -- End of comments
35  FUNCTION Add_FA_toWI(
36 	p_wi_instance_id IN NUMBER,
37 	p_fa_name   IN VARCHAR2,
38 	p_fe_name  IN VARCHAR2 DEFAULT NULL,
39 	p_priority  IN number default 100,
40 	p_provisioning_seq  IN NUMBER default 0)
41    return NUMBER;
42 
43 
44 -- Start of comments
45 --	API name 	: Add_FA_toWI
46 --	Type		: Private
47 --	Function	: Overload function. Add a fulfillment action instnace to a workitem instance.
48 --	Pre-reqs	: None.
49 --	Parameters	:
50 --
51 --	IN		:	p_wi_instance_id:	NUMBER	Required
52 --					The internal ID for a given work item instance
53 --				p_fulfillment_action_id:	NUMBER 	Required
54 --					The internal ID of the fulfillment action
55 --				p_fe_name:	VARCHAR2 	Optional
56 --					The name of the fulfillment element to be provisioned
57 --				p_priority:	NUMBER 	Optional
58 --					The provisioning priority of the fulfillment action
59 --					Default to be 100.
60 --				p_provisioning_seq:	NUMBER 	Optional
61 --					The provisioning sequence of the fulfillment action
62 --					Default to be 0 which means it has no dependency with
63 --					other fulfillment actions associated with the work item.
64 --  @return  	The runtime ID of the fulfillment action instance
65 --	Version	: Current version	11.5
66 --	Notes	:
67 -- End of comments
68  FUNCTION Add_FA_toWI(
69 	p_wi_instance_id 		IN   NUMBER,
70 	p_fulfillment_action_id IN   NUMBER,
71 	p_fe_name  IN VARCHAR2 DEFAULT NULL,
72 	p_priority  IN number default 100,
73 	p_provisioning_seq  IN NUMBER default 0)
74    return NUMBER;
75 
76 -- Start of comments
77 --	API name 	: Add_FA_toWI
78 --	Type		: Public
79 --	Function	: Add a fulfillment action instnace to a workitem instance.
80 --	Pre-reqs	: None.
81 --	Parameters	:
82 --
83 --	IN		:	p_wi_instance_id:	NUMBER	Required
84 --					The internal ID for a given work item instance
85 --				p_fa_name:	VARCHAR2 	Required
86 --					The name of the fulfillment action
87 --				p_fe_id:	NUMBER 	Optional
88 --					The ID of the fulfillment element to be provisioned
89 --				p_priority:	NUMBER 	Optional
90 --					The provisioning priority of the fulfillment action
91 --					Default to be 100.
92 --				p_provisioning_seq:	NUMBER 	Optional
93 --					The provisioning sequence of the fulfillment action
94 --					Default to be 0 which means it has no dependency with
95 --					other fulfillment actions associated with the work item.
96 --  @return  	The runtime ID of the fulfillment action instance
97 --
98 --	Version	: Current version	11.5
99 --	Notes	:
100 -- End of comments
101  FUNCTION Add_FA_toWI(
102 	p_wi_instance_id IN NUMBER,
103 	p_fa_name   IN VARCHAR2,
104 	p_fe_id  IN NUMBER DEFAULT NULL,
105 	p_priority  IN number default 100,
106 	p_provisioning_seq  IN NUMBER default 0)
107    return NUMBER;
108 
109 -- Start of comments
110 --	API name 	: Resubmit_FA
111 --	Type		: Private
112 --	Function	: Re-execute a fulfillment action for a workitem instance.
113 --	Pre-reqs	: None.
114 --  @return  	The new runtime ID of the fulfillment action instance
115 --
116 --	Version	: Current version	11.5
117 --	Notes	:
118 --				The fulfillment action instance to be resubmitted must
119 --				have been completed previously.
120 -- End of comments
121  FUNCTION Resubmit_FA(
122 	p_resubmission_job_id 	IN   NUMBER,
123 	p_resub_fa_instance_id  IN   NUMBER)
124    return NUMBER;
125 
126 
127 -- Start of comments
128 --	API name 	: Execute_FA
129 --	Type		: Group
130 --	Function	: Execute the fulfillment action provisioning process.
131 --	Pre-reqs	: None.
132 --	Version	: Current version	11.5
133 --	Notes	:
134 --   This procedure will execute the fulfillment action
135 --   provisioning process.  The workflow item type and
136 --	 item key for the workitem are needed to establish parent
137 --   child relationship between the WI workflow and the FA
138 --   process.  At the end of the FA process, a call
139 --   to CONTINUEFLOW will be made to notify its parent
140 --   to continue process.
141 -- End of comments
142  PROCEDURE Execute_FA(
143 		p_order_id       IN NUMBER,
144 		p_wi_instance_id IN NUMBER,
145 		p_fa_instance_id IN NUMBER,
146 		p_wi_item_type   IN varchar2,
147 		p_wi_item_key    IN varchar2,
148 		p_return_code    OUT NOCOPY NUMBER,
149 		p_error_description  OUT NOCOPY VARCHAR2,
150 		p_fa_caller  IN VARCHAR2 DEFAULT 'EXTERNAL');
151 
152 -- Start of comments
153 --	API name 	: Execute_FA
154 --	Type		: Group
155 --	Function	: Execute the fulfillment action provisioning process.
156 --	Pre-reqs	: None.
157 --	Version	: Current version	11.5
158 --	Notes	:
159 --   This procedure will execute the fulfillment action
160 --   provisioning process for resubmission.  The workflow item type and
161 --	 item key for the workitem are needed to establish parent
162 --   child relationship between the WI workflow and the FA
163 --   process.  At the end of the FA process, a call
164 --   to CONTINUEFLOW will be made to notify its parent
165 --   to continue process.
166 -- End of comments
167  PROCEDURE Execute_Resubmit_FA(
168 		p_order_id       IN NUMBER,
169 		p_line_item_id   IN NUMBER,
170 		p_wi_instance_id IN NUMBER,
171 		p_fa_instance_id IN NUMBER,
172 		p_oru_item_type   IN varchar2,
173 		p_oru_item_key    IN varchar2,
174 		p_fa_master		IN VARCHAR2,
175 		p_resubmission_job_id IN NUMBER,
176 		p_return_code    OUT NOCOPY NUMBER,
177 		p_error_description  OUT NOCOPY VARCHAR2,
178 		p_fa_caller  IN VARCHAR2 DEFAULT 'EXTERNAL');
179 
180 END XDP_ENG_UTIL;