1 package ff_client_engine AUTHID CURRENT_USER as
2 /* $Header: ffcxeng.pkh 115.0 99/07/16 02:02:08 porting ship $ */
3 ---------------------------- init_formula -------------------------------------
4 /*
5 NAME
6 init_formula
7 DESCRIPTION
8 Initialises engine to allow execution of a formula.
9 */
10
11 procedure init_formula
12 (
13 p_formula_id in number,
14 p_effective_date in date
15 );
16
17 ------------------------------- set_input -------------------------------------
18 /*
19 NAME
20 set_input
21 DESCRIPTION
22 Allows the setting of inputs or contexts to the formula.
23
24 There is only one version to avoid problems with calling
25 overloaded functions from forms. Therefore, dates and
26 numbers have to passed in as the appropriate string.
27 */
28
29 procedure set_input
30 (
31 p_input_name in varchar2,
32 p_value in varchar2
33 );
34
35 ------------------------------ run_formula ------------------------------------
36 /*
37 NAME
38 run_formula
39 DESCRIPTION
40 Uses data structures built up to execute Fast Formula.
41 */
42
43 procedure run_formula;
44
45 -------------------------------- get_output -----------------------------------
46 /*
47 NAME
48 get_output
49 DESCRIPTION
50 Allows access to data returned from Fast Formula return variables.
51
52 There is only one version to avoid problems with calling
53 overloaded functions from forms. Therefore, dates and
54 numbers have to converted from strings as appropriate.
55 */
56
57 procedure get_output
58 (
59 p_return_name in varchar2,
60 p_return_value out varchar2
61 );
62
63 ------------------------------- run_id_formula --------------------------------
64 /*
65 NAME
66 run_id_formula
67 DESCRIPTION
68 This procedure is designed specifically to be called from forms,
69 in that it reduces network round trips to a minimum, i.e. it sets
70 inputs and executes the formula in one network round-trip,
71 returning values on the way back.
72
73 This version is to be used when the caller knows the id of the
74 formula they wish to execute.
75
76 Unfortunately, since forms PLSQL is V1 - we cannot have an
77 arbitrarily large number of parameters (using defaults) - so
78 this procedure copes with up to 5 inputs, contexts and
79 outputs.
80
81 The clent will simply pass null values to the parameters
82 that are not needed.
83 */
84 procedure run_id_formula
85 (
86 p_formula_id in number,
87 p_effective_date in date,
88 p_input_name01 in varchar2, p_input_value01 in varchar2,
89 p_input_name02 in varchar2, p_input_value02 in varchar2,
90 p_input_name03 in varchar2, p_input_value03 in varchar2,
91 p_input_name04 in varchar2, p_input_value04 in varchar2,
92 p_input_name05 in varchar2, p_input_value05 in varchar2,
93 p_input_name06 in varchar2, p_input_value06 in varchar2,
94 p_input_name07 in varchar2, p_input_value07 in varchar2,
95 p_input_name08 in varchar2, p_input_value08 in varchar2,
96 p_input_name09 in varchar2, p_input_value09 in varchar2,
97 p_input_name10 in varchar2, p_input_value10 in varchar2,
98
99 p_context_name01 in varchar2, p_context_value01 in varchar2,
100 p_context_name02 in varchar2, p_context_value02 in varchar2,
101 p_context_name03 in varchar2, p_context_value03 in varchar2,
102 p_context_name04 in varchar2, p_context_value04 in varchar2,
103 p_context_name05 in varchar2, p_context_value05 in varchar2,
104 p_context_name06 in varchar2, p_context_value06 in varchar2,
105 p_context_name07 in varchar2, p_context_value07 in varchar2,
106 p_context_name08 in varchar2, p_context_value08 in varchar2,
107 p_context_name09 in varchar2, p_context_value09 in varchar2,
108 p_context_name10 in varchar2, p_context_value10 in varchar2,
109 p_context_name11 in varchar2, p_context_value11 in varchar2,
110 p_context_name12 in varchar2, p_context_value12 in varchar2,
111 p_context_name13 in varchar2, p_context_value13 in varchar2,
112 p_context_name14 in varchar2, p_context_value14 in varchar2,
113
114 p_return_name01 in varchar2, p_return_value01 in out varchar2,
115 p_return_name02 in varchar2, p_return_value02 in out varchar2,
116 p_return_name03 in varchar2, p_return_value03 in out varchar2,
117 p_return_name04 in varchar2, p_return_value04 in out varchar2,
118 p_return_name05 in varchar2, p_return_value05 in out varchar2,
119 p_return_name06 in varchar2, p_return_value06 in out varchar2,
120 p_return_name07 in varchar2, p_return_value07 in out varchar2,
121 p_return_name08 in varchar2, p_return_value08 in out varchar2,
122 p_return_name09 in varchar2, p_return_value09 in out varchar2,
123 p_return_name10 in varchar2, p_return_value10 in out varchar2
124 );
125
126 ------------------------------ run_name_formula -------------------------------
127 /*
128 NAME
129 run_name_formula
130 DESCRIPTION
131 This procedure is designed specifically to be called from forms,
132 in that it reduces network round trips to a minimum, i.e. it sets
133 inputs and executes the formula in one network round-trip,
134 returning values on the way back.
135
136 This version takes formula_name and formula_type_name as a
137 convenience for users who do not know the formula_id.
138
139 Unfortunately, since forms PLSQL is V1 - we cannot have an
140 arbitrarily large number of parameters (using defaults) - so
141 this procedure copes with up to 5 inputs, contexts and
142 outputs.
143
144 The clent will simply pass null values to the parameters
145 that are not needed.
146 */
147 procedure run_name_formula
148 (
149 p_formula_type_name in varchar2,
150 p_formula_name in varchar2,
151 p_effective_date in date,
152 p_input_name01 in varchar2, p_input_value01 in varchar2,
153 p_input_name02 in varchar2, p_input_value02 in varchar2,
154 p_input_name03 in varchar2, p_input_value03 in varchar2,
155 p_input_name04 in varchar2, p_input_value04 in varchar2,
156 p_input_name05 in varchar2, p_input_value05 in varchar2,
157 p_input_name06 in varchar2, p_input_value06 in varchar2,
158 p_input_name07 in varchar2, p_input_value07 in varchar2,
159 p_input_name08 in varchar2, p_input_value08 in varchar2,
160 p_input_name09 in varchar2, p_input_value09 in varchar2,
161 p_input_name10 in varchar2, p_input_value10 in varchar2,
162
163 p_context_name01 in varchar2, p_context_value01 in varchar2,
164 p_context_name02 in varchar2, p_context_value02 in varchar2,
165 p_context_name03 in varchar2, p_context_value03 in varchar2,
166 p_context_name04 in varchar2, p_context_value04 in varchar2,
167 p_context_name05 in varchar2, p_context_value05 in varchar2,
168 p_context_name06 in varchar2, p_context_value06 in varchar2,
169 p_context_name07 in varchar2, p_context_value07 in varchar2,
170 p_context_name08 in varchar2, p_context_value08 in varchar2,
171 p_context_name09 in varchar2, p_context_value09 in varchar2,
172 p_context_name10 in varchar2, p_context_value10 in varchar2,
173 p_context_name11 in varchar2, p_context_value11 in varchar2,
174 p_context_name12 in varchar2, p_context_value12 in varchar2,
175 p_context_name13 in varchar2, p_context_value13 in varchar2,
176 p_context_name14 in varchar2, p_context_value14 in varchar2,
177
178 p_return_name01 in varchar2, p_return_value01 in out varchar2,
179 p_return_name02 in varchar2, p_return_value02 in out varchar2,
180 p_return_name03 in varchar2, p_return_value03 in out varchar2,
181 p_return_name04 in varchar2, p_return_value04 in out varchar2,
182 p_return_name05 in varchar2, p_return_value05 in out varchar2,
183 p_return_name06 in varchar2, p_return_value06 in out varchar2,
184 p_return_name07 in varchar2, p_return_value07 in out varchar2,
185 p_return_name08 in varchar2, p_return_value08 in out varchar2,
186 p_return_name09 in varchar2, p_return_value09 in out varchar2,
187 p_return_name10 in varchar2, p_return_value10 in out varchar2
188 );
189
190 end ff_client_engine;