01: /*-------------------------------------------------------------------------
02: *
03: * Copyright (c) 2004-2005, PostgreSQL Global Development Group
04: * Copyright (c) 2004, Open Cloud Limited.
05: *
06: * IDENTIFICATION
07: * $PostgreSQL: pgjdbc/org/postgresql/core/v3/V3ParameterList.java,v 1.5 2005/07/04 18:50:29 davec Exp $
08: *
09: *-------------------------------------------------------------------------
10: */
11: package org.postgresql.core.v3;
12:
13: import java.sql.SQLException;
14: import org.postgresql.core.ParameterList;
15:
16: /**
17: * Common interface for all V3 parameter list implementations.
18: *
19: * @author Oliver Jowett (oliver@opencloud.com)
20: */
21: interface V3ParameterList extends ParameterList {
22: /**
23: * Ensure that all parameters in this list have been
24: * assigned values. Return silently if all is well, otherwise
25: * throw an appropriate exception.
26: *
27: * @throws SQLException if not all parameters are set.
28: */
29: void checkAllParametersSet() throws SQLException;
30:
31: /**
32: * Return a list of the SimpleParameterList objects that
33: * make up this parameter list. If this object is already a
34: * SimpleParameterList, returns null (avoids an extra array
35: * construction in the common case).
36: *
37: * @return an array of single-statement parameter lists, or
38: * <code>null</code> if this object is already a single-statement
39: * parameter list.
40: */
41: SimpleParameterList[] getSubparams();
42:
43: }
|