01: /*
02: * This software is released under a licence similar to the Apache Software Licence.
03: * See org.logicalcobwebs.proxool.package.html for details.
04: * The latest version is available at http://proxool.sourceforge.net
05: */
06: package org.logicalcobwebs.dbscript;
07:
08: /**
09: * An SQL command to run.
10: *
11: * @version $Revision: 1.5 $, $Date: 2003/03/03 11:12:03 $
12: * @author Bill Horsman (bill@logicalcobwebs.co.uk)
13: * @author $Author: billhorsman $ (current maintainer)
14: * @since Proxool 0.5
15: */
16: public interface CommandIF {
17:
18: /**
19: * The SQL statement to run
20: * @return sql
21: */
22: String getSql();
23:
24: /**
25: * How many "threads" to simulate. See {@link org.logicalcobwebs.dbscript.Script} to see how
26: * it actually implements thread-like behaviour.
27: * @return load
28: */
29: int getLoad();
30:
31: /**
32: * The number of loops to perform. Each loop will run the {@link #getSql sql}
33: * {@link #getLoad load} times.
34: * @return loops
35: */
36: int getLoops();
37:
38: /**
39: * If true then errors that occur during this command are ignored silently
40: * and do not stop the {@link org.logicalcobwebs.dbscript.Script script} running.
41: * @return true if exceptions should be ignored
42: */
43: boolean isIgnoreException();
44:
45: /**
46: * If true then errors that occur during this command are logged as debug
47: * messages but do not stop the {@link org.logicalcobwebs.dbscript.Script script} running.
48: * @return true if exceptions should be logged
49: */
50: boolean isLogException();
51:
52: /**
53: * A convenient name to call this command to help logging.
54: * @return name
55: */
56: String getName();
57:
58: }
59:
60: /*
61: Revision history:
62: $Log: CommandIF.java,v $
63: Revision 1.5 2003/03/03 11:12:03 billhorsman
64: fixed licence
65:
66: Revision 1.4 2003/02/19 15:14:19 billhorsman
67: fixed copyright (copy and paste error,
68: not copyright change)
69:
70: Revision 1.3 2002/11/09 15:58:54 billhorsman
71: fix and added doc
72:
73: Revision 1.2 2002/11/09 14:45:07 billhorsman
74: now threaded and better exception handling
75:
76: Revision 1.1 2002/11/06 21:07:42 billhorsman
77: New interfaces to allow filtering of commands
78:
79: */
|