| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface IParameterMetaData
An interface that represents the meta-data of input/output parameters defined in a prepared query. Its implementation is required only if the driver supports query parameters.
Note: All parameter indices in this interface are 1-based.
| Field Summary | |
|---|---|
| static int | parameterModeInThe constant indicating that the parameter is an input parameter. | 
| static int | parameterModeInOutThe constant indicating that the parameter is both input and output. | 
| static int | parameterModeOutThe constant indicating that the parameter is an output parameter. | 
| static int | parameterModeUnknownThe constant indicating that the input/output mode of the parameter is unknown. | 
| static int | parameterNoNullsThe constant indicating that the parameter will not allow NULL values. | 
| static int | parameterNullableThe constant indicating that the parameter will allow NULL values. | 
| static int | parameterNullableUnknownThe constant indicating that the nullability of the parameter is unknown. | 
| Method Summary | |
|---|---|
|  int | getParameterCount()Returns the number of parameters defined in the prepared IQuery object. | 
|  int | getParameterMode(int param)Returns the input/output mode of the specified parameter. | 
|  java.lang.String | getParameterName(int param)Returns the name of the specific parameter. | 
|  int | getParameterType(int param)Returns the data provider specific code of the parameter's data type. | 
|  java.lang.String | getParameterTypeName(int param)Returns the data provider specific name of the parameter's data type. | 
|  int | getPrecision(int param)Returns the maximum number of decimal digits for the specified parameter. | 
|  int | getScale(int param)Returns the maximum number of digits to the right of the decimal point for the specified parameter. | 
|  int | isNullable(int param)Returns whether null values are allowed for the specified parameter. | 
| Field Detail | 
|---|
static final int parameterModeUnknown
static final int parameterModeIn
static final int parameterModeInOut
static final int parameterModeOut
static final int parameterNullableUnknown
static final int parameterNoNulls
static final int parameterNullable
| Method Detail | 
|---|
int getParameterCount()
                      throws OdaException
OdaException - if data source error occurs.
int getParameterMode(int param)
                     throws OdaException
param - 1-based index of the parameter.
OdaException - if data source error occurs.
java.lang.String getParameterName(int param)
                                  throws OdaException
param - 1-based index of the parameter.
OdaException - if data source error occurs.
int getParameterType(int param)
                     throws OdaException
param - 1-based index of the parameter.
OdaException - if data source error occurs.
java.lang.String getParameterTypeName(int param)
                                      throws OdaException
param - 1-based index of the parameter.
OdaException - if data source error occurs.
int getPrecision(int param)
                 throws OdaException
param - 1-based index of the parameter.
OdaException - if data source error occurs.
int getScale(int param)
             throws OdaException
param - 1-based index of the parameter.
OdaException - if data source error occurs.
int isNullable(int param)
               throws OdaException
param - 1-based index of the parameter.
OdaException - if data source error occurs.| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||