1 PACKAGE EDR_PSIG_PAGE_FLOW AUTHID CURRENT_USER AS
2 /* $Header: EDRESGPS.pls 120.1.12000000.1 2007/01/18 05:52:54 appldev ship $ */
3
4 /* Package variable status will be set before calling Post Operation API
5 Value of this variable is used in Post Operation APIs
6 */
7
8 SIGNATURE_STATUS VARCHAR2(30);
9
10
11 /*************************************************************************
12 *** Following Procedure Returns current page flow process status ****
13 *** It accepts Event ID as in parameter ****
14 *************************************************************************/
15
16 PROCEDURE GET_PAGE_FLOW_STATUS(P_EVENT_ID IN NUMBER ,
17 P_SIGNATURE_STATUS OUT NOCOPY VARCHAR2);
18
19
20
21 /*********************************************************************************************************
22 Description for workflow user documentation for common parameters used in this package
23
24 p_itemtype : The internal name for the item type. Item types are defined in the Oracle Workflow Builder.
25 p_itemkey : A string that represents a primary key generated by the workflow-enabled application
26 for the item type. The string uniquely identifies the item within an item type.
27 p_actid : The ID number of the activity from which this procedure is called.
28 p_funcmode : The execution mode of the activity. If the activity is a function activity, the mode is
29 either 'RUN' or 'CANCEL'. If the activity is a notification activity, with a post-notification
30 function, then the mode can be 'RESPOND', 'FORWARD', 'TRANSFER', 'TIMEOUT', or 'RUN'. Other
31 execution modes may be added in the future.
32 p_resultout : If a result type is specified in the Activities properties page for the activity in the
33 Oracle Workflow Builder, this parameter represents the expected result that is returned when
34 the procedure completes. The possible results are:
35
36
37 ************************************************************************************************************/
38
39 /*******************************************************************************
40 *** This procedure is associated with EDRESGPF workflow. This code will **
41 *** execute when user clicks on Authenticate Button in list of signer page **
42 *******************************************************************************/
43
44 PROCEDURE AUTHENTICATE_RESPONSE(
45 p_itemtype IN VARCHAR2,
46 p_itemkey IN VARCHAR2,
47 p_actid IN NUMBER,
48 p_funcmode IN VARCHAR2,
49 p_resultout OUT NOCOPY VARCHAR2
50 ) ;
51
52 /*******************************************************************************************
53 ***** Update record status to cancel assuming EVENT_ID and Workflow ITEM_KEY is Same ***
54 ********************************************************************************************/
55
56 PROCEDURE CANCEL_RESPONSE(
57 p_itemtype IN VARCHAR2,
58 p_itemkey IN VARCHAR2,
59 p_actid IN NUMBER,
60 p_funcmode IN VARCHAR2,
61 p_resultout OUT NOCOPY VARCHAR2
62 ) ;
63
64
65 /******************************************************************************************
66 *** This is the main procedure which controls total offline flow and response to done ***
67 *** incase of on-line. When user clicks on done button and still some responses are ***
68 *** pending then this procedure verifies deferred mode is allowed or not. if deferred ***
69 *** mode is allowed sets the workflow mode to OFFLINE. ***
70 ******************************************************************************************/
71
72 PROCEDURE PROCESS_RESPONSE(
73 p_itemtype IN VARCHAR2,
74 p_itemkey IN VARCHAR2,
75 p_actid IN NUMBER,
76 p_funcmode IN VARCHAR2,
77 p_resultout OUT NOCOPY VARCHAR2
78 ) ;
79
80 /****************************************************************
81 ***** This procedure associated with Notification as of now ****
82 ***** we are not processing any response in this. ****
83 *****************************************************************/
84
85 PROCEDURE UPDATE_NOTIF_RESPONSE(
86 p_itemtype IN VARCHAR2,
87 p_itemkey IN VARCHAR2,
88 p_actid IN NUMBER,
89 p_funcmode IN VARCHAR2,
90 p_resultout OUT NOCOPY VARCHAR2
91 ) ;
92
93 /******************************************************************************
94 *** This procedure is associated with EDRESGPF workflow. This code will **
95 *** execute when user clicks on Approve Button in response to notification **
96 ******************************************************************************/
97
98 PROCEDURE NOTIF_APPROVED(
99 p_itemtype IN VARCHAR2,
100 p_itemkey IN VARCHAR2,
101 p_actid IN NUMBER,
102 p_funcmode IN VARCHAR2,
103 p_resultout OUT NOCOPY VARCHAR2
104 );
105
106
107 /*******************************************************************************
108 *** This procedure is associated with EDRESGPF workflow. This code will **
109 *** execute when user clicks on Cancel Button in response to notification **
110 *** No processing is done here. **
111 *******************************************************************************/
112
113 PROCEDURE NOTIF_CANCELED(
114 p_itemtype IN VARCHAR2,
115 p_itemkey IN VARCHAR2,
116 p_actid IN NUMBER,
117 p_funcmode IN VARCHAR2,
118 p_resultout OUT NOCOPY VARCHAR2
119 );
120
121
122 /*****************************************************************************
123 *** This procedure is associated with EDRESGPF workflow. This code will **
124 *** executed when use click on Reject Button in response to notification **
125 *****************************************************************************/
126
127 PROCEDURE NOTIF_REJECTED(
128 p_itemtype IN VARCHAR2,
129 p_itemkey IN VARCHAR2,
130 p_actid IN NUMBER,
131 p_funcmode IN VARCHAR2,
132 p_resultout OUT NOCOPY VARCHAR2
133 );
134
135 /************************************************************************************************
136 ****** Following Procedure is to spwan child process to get off-line electronic signatures ***
137 ****** It gets the current level to process and sends the notifications to all signers ***
138 ****** of current level. It also copies required attributes parent process to child process ***
139 *************************************************************************************************/
140
141 PROCEDURE SPWAN_OFFLINE_PROCESS(
142 p_itemtype IN VARCHAR2,
143 p_itemkey IN VARCHAR2,
144 p_actid IN NUMBER,
145 p_funcmode IN VARCHAR2,
146 p_resultout OUT NOCOPY VARCHAR2
147 );
148 /****************************************************************
149 *** Following procedure is associated to workflow activity. **
150 *** This procedure set the mode os signature process. **
151 *** If 'WF_SOURCE_APPLICATION_TYPE' is "DB" and Deferred **
152 *** mode is allowed then we should not pop up List of signers **
153 *** page. In this case This procedure simulates done button **
154 *** on list of signers page. **
155 *****************************************************************/
156
157 PROCEDURE IS_IT_TOTAL_OFFLINE(
158 p_itemtype IN VARCHAR2,
159 p_itemkey IN VARCHAR2,
160 p_actid IN NUMBER,
161 p_funcmode IN VARCHAR2,
162 p_resultout OUT NOCOPY VARCHAR2
163 );
164
165 /****************************************************************
166 *** Following procedure is associated to workflow activity. **
167 *** This procedure Checksif an offiline notificaiton has **
168 *** exceeded the timeout parameters. **
169 *****************************************************************/
170
171 PROCEDURE CHECK_TIMEOUT(
172 p_itemtype IN VARCHAR2,
173 p_itemkey IN VARCHAR2,
174 p_actid IN NUMBER,
175 p_funcmode IN VARCHAR2,
176 p_resultout OUT NOCOPY VARCHAR2
177 );
178
179
180 /************************************************************************************
181 **** Following Procedure is used by sign-on screen. it accepts notification id ***
182 **** and returns workflow item type ane item key these values are used to set ***
183 **** page context in offline case. ***
184 *************************************************************************************/
185
186 -- procedure : getItemKey
187 -- Parameters
188 -- IN
189 -- p_notif -- Notification ID
190 -- OUT
191 -- p_item_key -- Workflow instance Item key
192 -- p_item_type -- Workflow item type
193
194 PROCEDURE getItemKey(p_notif in varchar2,
195 p_item_key out NOCOPY varchar2,
196 p_item_type out NOCOPY varchar2);
197
198
199 -- Function : getItemKey
200 -- Parameters
201 -- IN
202 -- p_item_key -- Workflow instance Item key
203 -- p_item_type -- Workflow item type
204 -- OUT
205 -- Returns Notification ID
206
207
208 FUNCTION getNotificationID (p_itemtype IN VARCHAR2,
209 p_itemkey IN VARCHAR2) RETURN VARCHAR2;
210
211 --Bug 3072401: Start
212 PROCEDURE SEND_FINAL_APPROVAL_NTF
213 ( p_itemtype VARCHAR2,
214 p_itemkey VARCHAR2,
215 p_actid NUMBER,
216 p_funcmode VARCHAR2,
217 p_resultout OUT NOCOPY VARCHAR2
218 );
219
220 PROCEDURE SEND_INDV_APPROVAL_NTF
221 ( p_itemtype VARCHAR2,
222 p_itemkey VARCHAR2,
223 p_actid NUMBER,
224 p_funcmode VARCHAR2,
225 p_resultout OUT NOCOPY VARCHAR2
226 );
227 --Bug 3072401: End
228
229
230 --Bug 3207385: Start
231 /************************************************************************************
232 **** This procedure is associated with the function activity ***
233 **** RAISE_APPROVAL_COMPLETION. It would raise the EDR Approval Completion event***
234 *************************************************************************************/
235
236 PROCEDURE RAISE_APPR_COMPLETION_EVT
237 ( p_itemtype VARCHAR2,
238 p_itemkey VARCHAR2,
239 p_actid NUMBER,
240 p_funcmode VARCHAR2,
241 p_resultout OUT NOCOPY VARCHAR2
242 );
243 --Bug 3207385: End
244
245 -- Bug 5166723 : start
246 /************************************************************************************
247 **** This procedure is used for moving the WF activity node manually ***
248 *************************************************************************************/
249
250 PROCEDURE MOVE_WF_ACTIVITY(P_ITEMTYPE IN VARCHAR2,
251 P_ITEMKEY IN VARCHAR2,
252 P_CURRENT_ACTIVITY IN VARCHAR2,
253 P_RESULT_CODE IN VARCHAR2);
254 --Bug 5166723: End
255 END EDR_PSIG_PAGE_FLOW;
[Home] [Help]