1 package WF_ENGINE_UTIL AUTHID CURRENT_USER as
2 /* $Header: wfengs.pls 120.8.12020000.2 2012/10/02 21:28:18 alsosa ship $ */
3 /*#
4 * The Workflow Engine Utility APIs can be called by an application program or a
5 * workflow function in the runtime phase to communicate with the engine
6 * and to change the status of each of the activities. These APIs are defined
7 * in a PL/SQL package called WF_ENGINE_UTIL.
8 * @rep:scope private
9 * @rep:product OWF
10 * @rep:displayname Workflow Engine Utility APIs
11 * @rep:lifecycle active
12 * @rep:compatibility S
13 * @rep:category BUSINESS_ENTITY WF_ENGINE
14 * @rep:ihelp FND/@eng_api See the related online help
15 */
16
17 procedure ClearCache;
18
19 procedure AddProcessStack(
20 itemtype in varchar2,
21 itemkey in varchar2,
22 act_itemtype in varchar2,
23 act_name in varchar2,
24 actid in number,
25 rootflag in boolean default FALSE);
26
27 procedure RemoveProcessStack(
28 itemtype in varchar2,
29 itemkey in varchar2,
30 actid in number);
31
32 function activity_parent_process(itemtype in varchar2,
33 itemkey in varchar2,
34 actid in number)
35 return number;
36
37 procedure complete_activity(itemtype in varchar2,
38 itemkey in varchar2,
39 actid in number,
40 result in varchar2,
41 runpntf in boolean default true);
42 --Bug 2259039
43 --Valid values for runmode are : 'START', 'ACTIVITY','EVENT'
44 procedure start_process_internal(
45 itemtype in varchar2,
46 itemkey in varchar2,
47 runmode in varchar2);
48
49
50 procedure process_activity(itemtype in varchar2,
51 itemkey in varchar2,
52 actid in number,
53 threshold in number,
54 activate in boolean default false);
55
56 procedure reset_activities(itemtype in varchar2,
57 itemkey in varchar2,
58 actid in number,
59 cancel in boolean);
60
61 function reset_tree(itemtype in varchar2,
62 itemkey in varchar2,
63 rootid in number,
64 goalid in number,
65 actdate in date)
66 return boolean;
67
68 procedure move_to_history(itemtype in varchar2,
69 itemkey in varchar2,
70 actid in number);
71
72 procedure execute_activity(itemtype in varchar2,
73 itemkey in varchar2,
74 actid in number,
75 funmode in varchar2);
76
77 procedure function_call(funname in varchar2,
78 itemtype in varchar2,
79 itemkey in varchar2,
80 actid in number,
81 funmode in varchar2,
82 result out NOCOPY varchar2);
83
84 function Execute_Selector_Function(
85 itemtype in varchar2,
86 itemkey in varchar2,
87 runmode in varchar2)
88 return varchar2;
89
90 function get_root_process(itemtype in varchar2,
91 itemkey in varchar2,
92 activity in varchar2 default '')
93 return varchar2;
94
95 procedure process_kill_childprocess(itemtype in varchar2,
96 itemkey in varchar2);
97
98 procedure process_kill_children(itemtype in varchar2,
99 itemkey in varchar2,
100 processid in number);
101
102 procedure suspend_child_processes(itemtype in varchar2,
103 itemkey in varchar2,
104 processid in number);
105
106 procedure resume_child_processes(itemtype in varchar2,
107 itemkey in varchar2,
108 processid in number);
109
110 procedure notification(itemtype in varchar2,
111 itemkey in varchar2,
112 actid in number,
113 funcmode in varchar2,
114 result out NOCOPY varchar2);
115
116 procedure notification_send(itemtype in varchar2,
117 itemkey in varchar2,
118 actid in number,
119 msg in varchar2,
120 msgtype in varchar2,
121 prole in varchar2,
122 expand_role in varchar2,
123 result out NOCOPY varchar2);
124
125 procedure notification_copy (
126 copy_nid in number,
127 old_itemkey in varchar2,
128 new_itemkey in varchar2,
129 nid in out NOCOPY number);
130
131 procedure notification_refresh
132 (itemtype in varchar2,
133 itemkey in varchar2);
134
135 procedure execute_error_process (itemtype in varchar2,
136 itemkey in varchar2,
137 actid in number,
138 result in varchar2);
139
140 procedure SetErrorItemAttr (error_type in varchar2,
141 error_key in varchar2,
142 attrtype in varchar2,
143 item_attr in varchar2,
144 avalue in varchar2);
145
146 procedure execute_post_ntf_function (itemtype in varchar2,
147 itemkey in varchar2,
148 actid in number,
149 funmode in varchar2,
150 pntfstatus out NOCOPY varchar2,
151 pntfresult out NOCOPY varchar2);
152
153 procedure Execute_Notification_Callback(
154 funcmode in varchar2,
155 itemtype in varchar2,
156 itemkey in varchar2,
157 actid in number,
158 ctx_nid in number,
159 ctx_text in varchar2);
160
161 function Activity_Timeout(actid in number)
162 return varchar2;
163
164 procedure Event_Activity(
165 itemtype in varchar2,
166 itemkey in varchar2,
167 actid in number,
168 funcmode in varchar2,
169 result out NOCOPY varchar2);
170
171 end WF_ENGINE_UTIL;