1 package OKC_ASYNC_PUB AUTHID CURRENT_USER as
2 /* $Header: OKCPASNS.pls 120.1 2005/12/14 21:10:25 npalepu noship $ */
3
4 /*
5 PROC_CALL - asynchronous execution of pl/sql code
6
7 p_proc - 'begin pl/sql code end;' varchar2(4000)
8 p_period_days - if scheduled execution by period in days
9 p_stop_date - truncated to day to stop scheduled execution
10 x_key_to_stop - returned key could be used by proc_stop
11
12 */
13 procedure proc_call(
14 --
15 -- common API parameters
16 --
17 p_api_version IN NUMBER,
18 p_init_msg_list IN VARCHAR2 default OKC_API.G_FALSE,
19 x_return_status OUT NOCOPY VARCHAR2,
20 x_msg_count OUT NOCOPY NUMBER,
21 x_msg_data OUT NOCOPY VARCHAR2,
22 --
23 -- specific parameters
24 --
25 p_proc IN VARCHAR2,
26 p_period_days IN NUMBER default NULL,
27 p_stop_date IN DATE default sysdate,
28 x_key_to_stop OUT NOCOPY VARCHAR2 --can be used later by proc_stop
29 );
30
31 /*
32 PROC_STOP - to stop or change stop date of scheduled execution
33
34 p_stop_date - truncated to day new stop date (default means immediate stop)
35 p_key_to_stop - key issued by call_proc
36 */
37 procedure proc_stop(
38 --
39 -- common API parameters
40 --
41 p_api_version IN NUMBER,
42 p_init_msg_list IN VARCHAR2 default OKC_API.G_FALSE,
43 x_return_status OUT NOCOPY VARCHAR2,
44 x_msg_count OUT NOCOPY NUMBER,
45 x_msg_data OUT NOCOPY VARCHAR2,
46 --
47 -- specific parameters
48 --
49 p_stop_date IN DATE default sysdate, -- new stop_date
50 p_key_to_stop IN VARCHAR2
51 );
52
53 /*
54 MSG_CALL - sending notification
55
56 p_recipient - recipient (one of wf_roles)
57 p_msg_subj - message subject varchar2(4000)
58 p_msg_body - message body varchar2(4000)
59 p_ntf_type - only for launchpad usage instead of internal notification name
60 p_contract_id - Contract Id to navigate from launchpad to the contract
61 other parameters- reserved for future
62 */
63 procedure msg_call(
64 --
65 -- common API parameters
66 --
67 p_api_version IN NUMBER,
68 p_init_msg_list IN VARCHAR2 default OKC_API.G_FALSE,
69 x_return_status OUT NOCOPY VARCHAR2,
70 x_msg_count OUT NOCOPY NUMBER,
71 x_msg_data OUT NOCOPY VARCHAR2,
72 --
73 -- specific parameters
74 --
75 p_recipient IN VARCHAR2,
76 p_msg_subj IN VARCHAR2,
77 p_msg_body IN VARCHAR2,
78 --
79 -- hidden notification attributes
80 --
81 p_ntf_type IN VARCHAR2 default NULL,
82 p_contract_id IN NUMBER default NULL,
83 p_task_id IN NUMBER default NULL,
84 p_extra_attr_num IN NUMBER default NULL,
85 p_extra_attr_text IN VARCHAR2 default NULL,
86 p_extra_attr_date IN DATE default NULL
87 );
88
89 /*
90 PROC_MSG_CALL - asynchronous pl/sql execution + sending fnd_message stack as notification
91
92 p_proc - pl/sql 'begin pl/sql code end;'
93 or 'begin pl/sql code with :1 in out bound buffer for return status end;'
94 returned status 'S' stands for success, others - for error
95 p_subj_first_msg- first/last fnd_message from stack will form notification subject
96 p_s_recipient - normal (success) recipient
97 p_s_recipient - error message recipient
98 p_ntf_type - only for launchpad usage instead of internal notification name
99 p_contract_id - Contract Id to navigate from launchpad to the contract
100 other parameters- reserved for future
101
102 if p_proc has no oubound buffer return status considered as 'S';
103 if return status = error then rollback will be executed internally;
104
105 */
106 procedure proc_msg_call(
107 --
108 -- common API parameters
109 --
110 p_api_version IN NUMBER,
111 p_init_msg_list IN VARCHAR2 default OKC_API.G_FALSE,
112 x_return_status OUT NOCOPY VARCHAR2,
113 x_msg_count OUT NOCOPY NUMBER,
114 x_msg_data OUT NOCOPY VARCHAR2,
115 --
116 -- specific parameters
117 --
118 p_proc IN VARCHAR2,
119 p_subj_first_msg IN VARCHAR2 default 'T', -- 'F' for last fnd_msg as msg subject
120 p_s_recipient IN VARCHAR2, -- normal recipient
121 p_e_recipient IN VARCHAR2, -- error recipient
122 --
123 -- hidden notification attributes
124 --
125 p_ntf_type IN VARCHAR2 default NULL,
126 p_contract_id IN NUMBER default NULL,
127 p_task_id IN NUMBER default NULL,
128 p_extra_attr_num IN NUMBER default NULL,
129 p_extra_attr_text IN VARCHAR2 default NULL,
130 p_extra_attr_date IN DATE default NULL
131 );
132
133 /*
134 RESOLVER_CALL - sending notification that requires yes/no reply
135
136 p_resolver - wf_role
137 p_msg_subj - subject
138 p_msg_body - body
139 p_note - usually not used as an in variable, but could be used as body extension
140 p_accept_proc - pl/sql block to be executed if response was yes
141 block could have at most one inbound buffer to place note from resolver
142 p_reject_proc - similar for answer='no'
143 p_timeout_proc - if timeout or error
144 p_timeout_minutes-timeout period
145 ...
146 */
147 procedure resolver_call(
148 --
149 -- common API parameters
150 --
151 p_api_version IN NUMBER,
152 p_init_msg_list IN VARCHAR2 default OKC_API.G_FALSE,
153 x_return_status OUT NOCOPY VARCHAR2,
154 x_msg_count OUT NOCOPY NUMBER,
155 x_msg_data OUT NOCOPY VARCHAR2,
156 --
157 -- wf attributes
158 --
159 p_resolver IN VARCHAR2,
160 p_msg_subj IN VARCHAR2,
161 p_msg_body IN VARCHAR2,
162 p_note IN VARCHAR2 default NULL,-- usually null
163 p_accept_proc IN VARCHAR2,
164 p_reject_proc IN VARCHAR2,
165 p_timeout_proc IN VARCHAR2 default NULL,--if null p_reject_proc used instead
166 p_timeout_minutes IN NUMBER default 45000,--month default to force wf end
167 --
168 -- hidden notification attributes
169 --
170 p_ntf_type IN VARCHAR2 default NULL,
171 p_contract_id IN NUMBER default NULL,
172 p_task_id IN NUMBER default NULL,
173 p_extra_attr_num IN NUMBER default NULL,
174 p_extra_attr_text IN VARCHAR2 default NULL,
175 p_extra_attr_date IN DATE default NULL
176 );
177 /*
178 SEND_DOC - for sending pl/sql doc
179
180 p_recipient - wf_role
181 p_msg_subj - message subject
182 p_msg_body - message body
183 p_proc - pl/sql block with one outbound buffer up to 32K for returned doc,
184 that will be embeded in message
185 */
186 procedure send_doc(
187 --
188 -- common API parameters
189 --
190 p_api_version IN NUMBER,
191 p_init_msg_list IN VARCHAR2 default OKC_API.G_FALSE,
192 x_return_status OUT NOCOPY VARCHAR2,
193 x_msg_count OUT NOCOPY NUMBER,
194 x_msg_data OUT NOCOPY VARCHAR2,
195 --
196 -- specific parameters
197 --
198 p_recipient IN VARCHAR2,
199 p_msg_subj IN VARCHAR2,
200 p_msg_body IN VARCHAR2,
201 p_proc IN VARCHAR2,--with single in/out bind for doc
202 --
203 -- hidden notification attributes
204 --
205 p_ntf_type IN VARCHAR2 default NULL,
206 p_contract_id IN NUMBER default NULL,
207 p_task_id IN NUMBER default NULL,
208 p_extra_attr_num IN NUMBER default NULL,
209 p_extra_attr_text IN VARCHAR2 default NULL,
210 p_extra_attr_date IN DATE default NULL
211 );
212
213 procedure loop_call(
214 --
215 -- common API parameters
216 --
217 p_api_version IN NUMBER,
218 p_init_msg_list IN VARCHAR2 default OKC_API.G_FALSE,
219 x_return_status OUT NOCOPY VARCHAR2,
220 x_msg_count OUT NOCOPY NUMBER,
221 x_msg_data OUT NOCOPY VARCHAR2,
222 --
223 -- specific parameters
224 --
225 p_proc IN VARCHAR2,
226 p_s_recipient IN VARCHAR2 default NULL, -- normal recipient
227 p_e_recipient IN VARCHAR2 default NULL, -- error recipient
228 p_timeout_minutes IN NUMBER default NULL,
229 p_loops IN NUMBER default 0,--limit for loopbacks
230 p_subj_first_msg IN VARCHAR2 default 'T', -- 'F' for last fnd_msg as msg subject
231 --
232 -- hidden notification attributes
233 --
234 p_ntf_type IN VARCHAR2 default NULL,
235 p_contract_id IN NUMBER default NULL,
236 p_task_id IN NUMBER default NULL,
237 p_extra_attr_num IN NUMBER default NULL,
238 p_extra_attr_text IN VARCHAR2 default NULL,
239 p_extra_attr_date IN DATE default NULL
240 );
241
242 --NPALEPU
243 --14-DEC-2005
244 --For Bug # 4699009, Added Overloaded LOOP_CALL API.
245 procedure loop_call(
246 --
247 -- common API parameters
248 --
249 p_api_version IN NUMBER,
250 p_init_msg_list IN VARCHAR2 default OKC_API.G_FALSE,
251 x_return_status OUT NOCOPY VARCHAR2,
252 x_msg_count OUT NOCOPY NUMBER,
253 x_msg_data OUT NOCOPY VARCHAR2,
254 --
255 -- specific parameters
256 --
257 p_proc IN VARCHAR2,
258 p_proc_name IN VARCHAR2,
259 p_s_recipient IN VARCHAR2 default NULL, -- normal recipient
260 p_e_recipient IN VARCHAR2 default NULL, -- error recipient
261 p_timeout_minutes IN NUMBER default NULL,
262 p_loops IN NUMBER default 0,--limit for loopbacks
263 p_subj_first_msg IN VARCHAR2 default 'T', -- 'F' for last fnd_msg as msg subject
264 --
265 -- hidden notification attributes
266 --
267 p_ntf_type IN VARCHAR2 default NULL,
268 p_contract_id IN NUMBER default NULL,
269 p_task_id IN NUMBER default NULL,
270 p_extra_attr_num IN NUMBER default NULL,
271 p_extra_attr_text IN VARCHAR2 default NULL,
272 p_extra_attr_date IN DATE default NULL
273 );
274 --END NPALEPU
275
276 end OKC_ASYNC_PUB;
[Home] [Help]