1 /*
2 * Copyright 2004-2026 the original author or authors.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * https://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package com.ibatis.sqlmap.engine.impl;
17
18 import com.ibatis.common.util.PaginatedList;
19 import com.ibatis.sqlmap.client.SqlMapClient;
20 import com.ibatis.sqlmap.client.SqlMapSession;
21 import com.ibatis.sqlmap.client.event.RowHandler;
22 import com.ibatis.sqlmap.engine.execution.BatchException;
23 import com.ibatis.sqlmap.engine.execution.SqlExecutor;
24 import com.ibatis.sqlmap.engine.mapping.result.ResultObjectFactory;
25 import com.ibatis.sqlmap.engine.mapping.statement.MappedStatement;
26
27 import java.sql.Connection;
28 import java.sql.SQLException;
29 import java.util.List;
30 import java.util.Map;
31
32 import javax.sql.DataSource;
33
34 /**
35 * The Interface ExtendedSqlMapClient.
36 *
37 * @deprecated - this class is unnecessary and should be removed as soon as possible. Currently spring integration
38 * depends on it.
39 */
40 @Deprecated
41 public interface ExtendedSqlMapClient extends SqlMapClient {
42
43 /**
44 * Insert.
45 *
46 * @param id
47 * the id
48 * @param param
49 * the param
50 *
51 * @return the object
52 *
53 * @throws SQLException
54 * the SQL exception
55 */
56 @Deprecated
57 @Override
58 Object insert(String id, Object param) throws SQLException;
59
60 /**
61 * Insert.
62 *
63 * @param id
64 * the id
65 *
66 * @return the object
67 *
68 * @throws SQLException
69 * the SQL exception
70 */
71 @Deprecated
72 @Override
73 Object insert(String id) throws SQLException;
74
75 /**
76 * Update.
77 *
78 * @param id
79 * the id
80 * @param param
81 * the param
82 *
83 * @return the int
84 *
85 * @throws SQLException
86 * the SQL exception
87 */
88 @Deprecated
89 @Override
90 int update(String id, Object param) throws SQLException;
91
92 /**
93 * Update.
94 *
95 * @param id
96 * the id
97 *
98 * @return the int
99 *
100 * @throws SQLException
101 * the SQL exception
102 */
103 @Deprecated
104 @Override
105 int update(String id) throws SQLException;
106
107 /**
108 * Delete.
109 *
110 * @param id
111 * the id
112 * @param param
113 * the param
114 *
115 * @return the int
116 *
117 * @throws SQLException
118 * the SQL exception
119 */
120 @Deprecated
121 @Override
122 int delete(String id, Object param) throws SQLException;
123
124 /**
125 * Delete.
126 *
127 * @param id
128 * the id
129 *
130 * @return the int
131 *
132 * @throws SQLException
133 * the SQL exception
134 */
135 @Deprecated
136 @Override
137 int delete(String id) throws SQLException;
138
139 /**
140 * Query for object.
141 *
142 * @param id
143 * the id
144 * @param paramObject
145 * the param object
146 *
147 * @return the object
148 *
149 * @throws SQLException
150 * the SQL exception
151 */
152 @Deprecated
153 @Override
154 Object queryForObject(String id, Object paramObject) throws SQLException;
155
156 /**
157 * Query for object.
158 *
159 * @param id
160 * the id
161 *
162 * @return the object
163 *
164 * @throws SQLException
165 * the SQL exception
166 */
167 @Deprecated
168 @Override
169 Object queryForObject(String id) throws SQLException;
170
171 /**
172 * Query for object.
173 *
174 * @param id
175 * the id
176 * @param paramObject
177 * the param object
178 * @param resultObject
179 * the result object
180 *
181 * @return the object
182 *
183 * @throws SQLException
184 * the SQL exception
185 */
186 @Deprecated
187 @Override
188 Object queryForObject(String id, Object paramObject, Object resultObject) throws SQLException;
189
190 /**
191 * Query for list.
192 *
193 * @param id
194 * the id
195 * @param paramObject
196 * the param object
197 *
198 * @return the list
199 *
200 * @throws SQLException
201 * the SQL exception
202 */
203 @Deprecated
204 @Override
205 List queryForList(String id, Object paramObject) throws SQLException;
206
207 /**
208 * Query for list.
209 *
210 * @param id
211 * the id
212 *
213 * @return the list
214 *
215 * @throws SQLException
216 * the SQL exception
217 */
218 @Deprecated
219 @Override
220 List queryForList(String id) throws SQLException;
221
222 /**
223 * Query for list.
224 *
225 * @param id
226 * the id
227 * @param paramObject
228 * the param object
229 * @param skip
230 * the skip
231 * @param max
232 * the max
233 *
234 * @return the list
235 *
236 * @throws SQLException
237 * the SQL exception
238 */
239 @Deprecated
240 @Override
241 List queryForList(String id, Object paramObject, int skip, int max) throws SQLException;
242
243 /**
244 * Query for list.
245 *
246 * @param id
247 * the id
248 * @param skip
249 * the skip
250 * @param max
251 * the max
252 *
253 * @return the list
254 *
255 * @throws SQLException
256 * the SQL exception
257 */
258 @Deprecated
259 @Override
260 List queryForList(String id, int skip, int max) throws SQLException;
261
262 /**
263 * Query for paginated list.
264 *
265 * @param id
266 * the id
267 * @param paramObject
268 * the param object
269 * @param pageSize
270 * the page size
271 *
272 * @return the paginated list
273 *
274 * @throws SQLException
275 * the SQL exception
276 */
277 @Deprecated
278 @Override
279 PaginatedList queryForPaginatedList(String id, Object paramObject, int pageSize) throws SQLException;
280
281 /**
282 * Query for paginated list.
283 *
284 * @param id
285 * the id
286 * @param pageSize
287 * the page size
288 *
289 * @return the paginated list
290 *
291 * @throws SQLException
292 * the SQL exception
293 */
294 @Deprecated
295 @Override
296 PaginatedList queryForPaginatedList(String id, int pageSize) throws SQLException;
297
298 /**
299 * Query for map.
300 *
301 * @param id
302 * the id
303 * @param paramObject
304 * the param object
305 * @param keyProp
306 * the key prop
307 *
308 * @return the map
309 *
310 * @throws SQLException
311 * the SQL exception
312 */
313 @Deprecated
314 @Override
315 Map queryForMap(String id, Object paramObject, String keyProp) throws SQLException;
316
317 /**
318 * Query for map.
319 *
320 * @param id
321 * the id
322 * @param paramObject
323 * the param object
324 * @param keyProp
325 * the key prop
326 * @param valueProp
327 * the value prop
328 *
329 * @return the map
330 *
331 * @throws SQLException
332 * the SQL exception
333 */
334 @Deprecated
335 @Override
336 Map queryForMap(String id, Object paramObject, String keyProp, String valueProp) throws SQLException;
337
338 /**
339 * Query with row handler.
340 *
341 * @param id
342 * the id
343 * @param paramObject
344 * the param object
345 * @param rowHandler
346 * the row handler
347 *
348 * @throws SQLException
349 * the SQL exception
350 */
351 @Deprecated
352 @Override
353 void queryWithRowHandler(String id, Object paramObject, RowHandler rowHandler) throws SQLException;
354
355 /**
356 * Query with row handler.
357 *
358 * @param id
359 * the id
360 * @param rowHandler
361 * the row handler
362 *
363 * @throws SQLException
364 * the SQL exception
365 */
366 @Deprecated
367 @Override
368 void queryWithRowHandler(String id, RowHandler rowHandler) throws SQLException;
369
370 /**
371 * Start transaction.
372 *
373 * @throws SQLException
374 * the SQL exception
375 */
376 @Deprecated
377 @Override
378 void startTransaction() throws SQLException;
379
380 /**
381 * Start transaction.
382 *
383 * @param transactionIsolation
384 * the transaction isolation
385 *
386 * @throws SQLException
387 * the SQL exception
388 */
389 @Deprecated
390 @Override
391 void startTransaction(int transactionIsolation) throws SQLException;
392
393 /**
394 * Commit transaction.
395 *
396 * @throws SQLException
397 * the SQL exception
398 */
399 @Deprecated
400 @Override
401 void commitTransaction() throws SQLException;
402
403 /**
404 * End transaction.
405 *
406 * @throws SQLException
407 * the SQL exception
408 */
409 @Deprecated
410 @Override
411 void endTransaction() throws SQLException;
412
413 /**
414 * Start batch.
415 *
416 * @throws SQLException
417 * the SQL exception
418 */
419 @Deprecated
420 @Override
421 void startBatch() throws SQLException;
422
423 /**
424 * Execute batch.
425 *
426 * @return the int
427 *
428 * @throws SQLException
429 * the SQL exception
430 */
431 @Deprecated
432 @Override
433 int executeBatch() throws SQLException;
434
435 /**
436 * Execute batch detailed.
437 *
438 * @return the list
439 *
440 * @throws SQLException
441 * the SQL exception
442 * @throws BatchException
443 * the batch exception
444 */
445 @Deprecated
446 @Override
447 List executeBatchDetailed() throws SQLException, BatchException;
448
449 /**
450 * Sets the user connection.
451 *
452 * @param connection
453 * the new user connection
454 *
455 * @throws SQLException
456 * the SQL exception
457 */
458 @Deprecated
459 @Override
460 void setUserConnection(Connection connection) throws SQLException;
461
462 /**
463 * Gets the user connection.
464 *
465 * @return the user connection
466 *
467 * @throws SQLException
468 * the SQL exception
469 */
470 @Deprecated
471 @Override
472 Connection getUserConnection() throws SQLException;
473
474 /**
475 * Gets the current connection.
476 *
477 * @return the current connection
478 *
479 * @throws SQLException
480 * the SQL exception
481 */
482 @Deprecated
483 @Override
484 Connection getCurrentConnection() throws SQLException;
485
486 /**
487 * Gets the data source.
488 *
489 * @return the data source
490 */
491 @Deprecated
492 @Override
493 DataSource getDataSource();
494
495 /**
496 * Gets the mapped statement.
497 *
498 * @param id
499 * the id
500 *
501 * @return the mapped statement
502 */
503 @Deprecated
504 MappedStatement getMappedStatement(String id);
505
506 /**
507 * Checks if is lazy loading enabled.
508 *
509 * @return true, if is lazy loading enabled
510 */
511 @Deprecated
512 boolean isLazyLoadingEnabled();
513
514 /**
515 * Checks if is enhancement enabled.
516 *
517 * @return true, if is enhancement enabled
518 */
519 @Deprecated
520 boolean isEnhancementEnabled();
521
522 /**
523 * Gets the sql executor.
524 *
525 * @return the sql executor
526 */
527 @Deprecated
528 SqlExecutor getSqlExecutor();
529
530 /**
531 * Gets the delegate.
532 *
533 * @return the delegate
534 */
535 @Deprecated
536 SqlMapExecutorDelegate getDelegate();
537
538 /**
539 * Open session.
540 *
541 * @return the sql map session
542 */
543 @Deprecated
544 @Override
545 SqlMapSession openSession();
546
547 /**
548 * Open session.
549 *
550 * @param conn
551 * the conn
552 *
553 * @return the sql map session
554 */
555 @Deprecated
556 @Override
557 SqlMapSession openSession(Connection conn);
558
559 /**
560 * Gets the session.
561 *
562 * @return the session
563 */
564 @Deprecated
565 @Override
566 SqlMapSession getSession();
567
568 /**
569 * Flush data cache.
570 */
571 @Deprecated
572 @Override
573 void flushDataCache();
574
575 /**
576 * Flush data cache.
577 *
578 * @param cacheId
579 * the cache id
580 */
581 @Deprecated
582 @Override
583 void flushDataCache(String cacheId);
584
585 /**
586 * Gets the result object factory.
587 *
588 * @return the result object factory
589 */
590 @Deprecated
591 ResultObjectFactory getResultObjectFactory();
592
593 }