1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
|
/*
*
* Derby - Class org.apache.derbyTesting.system.oe.client.Operations
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* either express or implied. See the License for the specific
* language governing permissions and limitations under the License.
*/
package org.apache.derbyTesting.system.oe.client;
/**
* Interface for a client to execute the logical operations. Various
* implementations can be provided, e.g. client side SQL, procedure, etc.
* <P>
* Typical model is that each client has its own instance of an object that
* implements Operations. For example the implementation in a client side SQL
* implementation would have a reference to its own JDBC connection and prepared
* statements.
* <P>
* Implementations of the execution methods must perform the following:
* <OL>
* <LI>Execute business transaction
* <LI>Populate POJO objects required by display method
* <LI>Commit the database transaction(s)
* <LI>Call the appropriate display method from Display
* </UL>
*
* <P>
* DECIMAL values are represented as String objects to allow Order Entry to be
* run on J2ME/CDC/Foundation which does not support BigDecimal.
*/
public interface Operations {
/**
* Execute stock level. Stock level is described in clause 2.8.
*
* @param display
* Where to display the results, if null results are not
* displayed.
* @param displayData
* Any client specific display information, such as servlet
* context.
* @param w
* Warehouse for transaction
* @param d
* District for transaction
* @param threshold
* Threshold for transaction.
* @see Display#displayStockLevel(Object, short, short, int, int)
*/
public void stockLevel(Display display, Object displayData, short w,
short d, int threshold) throws Exception;
/**
* Execute order status by last name. Order status is described in clause
* 2.6.
*
* @param display
* Where to display the results, if null results are not
* displayed.
* @param displayData
* Any client specific display information, such as servlet
* context.
* @param w
* Warehouse identifier
* @param d
* District identifier
* @param customerLast
* Customer's last name.
*/
public void orderStatus(Display display, Object displayData, short w,
short d, String customerLast) throws Exception;
/**
* Execute order status by customer identifer. Order status is described in
* clause 2.6.
*
* @param display
* Where to display the results, if null results are not
* displayed.
* @param displayData
* Any client specific display information, such as servlet
* context.
* @param w
* Warehouse identifier
* @param d
* District identifier
* @param c
* Customer identifer.
*/
public void orderStatus(Display display, Object displayData, short w,
short d, int c) throws Exception;
/**
* Execute payment by last name. Payment is described in clause 2.5.
*
* @param display
* Where to display the results, if null results are not
* displayed.
* @param displayData
* Any client specific display information, such as servlet
* context.
* @param w
* Home warehouse identifier
* @param d
* Home district identifier
* @param cw
* Customer warehouse identifier
* @param cd
* Customer district identifier
* @param customerLast
* Customer's last name.
* @param amount
* Payment amount
*/
public void payment(Display display, Object displayData, short w, short d,
short cw, short cd, String customerLast, String amount)
throws Exception;
/**
* Execute payment by customer identifer. Payment is described in clause
* 2.5.
*
* @param display
* Where to display the results, if null results are not
* displayed.
* @param displayData
* Any client specific display information, such as servlet
* context.
* @param w
* Home warehouse identifier
* @param d
* Home district identifier
* @param cw
* Customer warehouse identifier
* @param cd
* Customer district identifier
* @param c
* Customer identifer.
* @param amount
* Payment amount
*/
public void payment(Display display, Object displayData, short w, short d,
short cw, short cd, int c, String amount) throws Exception;
/**
* Execute new order. New order is described in clause 2.4.
* <P>
* Assumption is that items.length == quanties.length == supplyW.length.
*
* @param display
* Where to display the results, if null results are not
* displayed.
* @param displayData
* Client specific display information, such as servlet
* context.
* @param w
* Warehouse identifier
* @param d
* District identifier
* @param c
* Customer identifier
* @param items
* array of item numbers
* @param quantities
* quanties for each item
* @param supplyW
* Supply warehouse for each item.
* @throws Exception
*/
public void newOrder(Display display, Object displayData, short w, short d,
int c, int[] items, short[] quantities, short[] supplyW)
throws Exception;
/**
* Queue a delivery request. Queuing of delivery requests is described in
* clause 2.7.2.
* <P>
* The implementation of Operations is responsible for managing the FIFO
* queue of requests, which could be in a flat file, the database or
* memory etc.
*
* @param display
* Where to display the results, if null results are not
* displayed.
* @param displayData
* Any client specific display information, such as servlet
* context.
* @param w
* Warehouse identifier
* @param carrier
* Carrier identifier
* @throws Exception
*/
public void scheduleDelivery(Display display, Object displayData, short w,
short carrier) throws Exception;
/**
* Execute a single delivery from the FIFO queue. Processing a delivery
* request is described in clause 2.7.4.
*
* @throws Exception
*/
public void delivery() throws Exception;
/**
* Release any resources.
*
*/
public void close() throws Exception;
}
|
