com.f1j.data.source
Interface ParameterizedQuery

All Known Implementing Classes:

JDBC

Deprecated. As of 9.0, use DatabaseQueryParamCollection instead.

public interface ParameterizedQuery

This is the basic interface to all data sources that support parameterized queries.

See Also:

Source.getDataQueryCollection(), DataQuery, DatabaseQuery.getParameterCollection(), DatabaseQueryParamCollection, DatabaseQueryParameter

Method Summary

int	getParametersCount() Deprecated. As of 9.0, use DatabaseQueryParamCollection.getInputParameterCount instead.
int	getParameterType(int parameterNumber) Deprecated. As of 9.0, use DatabaseQueryParameter.getType instead.
java.lang.String	getParameterValue(int parameterNumber) Deprecated. As of 9.0, use DatabaseQueryParameter.getValue instead.
void	setParameter(int parameterNumber, int parameterType, java.lang.String parameterValue) Deprecated. As of 9.0, use DatabaseQueryParamCollection.addInputParameter instead.

Method Detail

getParameterType

public int getParameterType(int parameterNumber)

Deprecated. As of 9.0, use DatabaseQueryParameter.getType instead.

Returns the parameter type of the specified index.

Parameters:

parameterNumber - Zero-based index value indicating which query parameter's type to return. The first parameter of the query = 0, the second = 1, etc.

Returns:

an integer indicating the parameter type. The integers returned are the Java java.sql.Types class field values.

Parameterized Query Data Types

string	numeric	bit
date	time	timestamp

See Also:

setParameter(int, int, java.lang.String), DatabaseQuery.getParameterCollection(), DatabaseQueryParamCollection, DatabaseQueryParameter

getParameterValue

public java.lang.String getParameterValue(int parameterNumber)

Deprecated. As of 9.0, use DatabaseQueryParameter.getValue instead.

Returns the parameter value of the specified index.

Parameters:

parameterNumber - Zero-based index value indicating which query parameter's value to return.he first parameter of the query = 0, the second = 1, etc.

Returns:

a string representing the cell location (e.g., A1) or name assigned using the setParameter method.

See Also:

setParameter(int, int, java.lang.String), DatabaseQuery.getParameterCollection(), DatabaseQueryParamCollection, DatabaseQueryParameter

getParametersCount

public int getParametersCount()

Deprecated. As of 9.0, use DatabaseQueryParamCollection.getInputParameterCount instead.

Returns the number of parameters this data source has.

Returns:

an integer indicating the number of parameters in the query.

See Also:

setParameter(int, int, java.lang.String), DatabaseQuery.getParameterCollection(), DatabaseQueryParamCollection

setParameter

public void setParameter(int parameterNumber,
                         int parameterType,
                         java.lang.String parameterValue)
                  throws F1Exception

Deprecated. As of 9.0, use DatabaseQueryParamCollection.addInputParameter instead.

Sets a parameter's index number (place in the data source query), type, and value.

Parameters:

parameterNumber - an integer assigning the ordinal place in the data source query. 0 = 1st, 1 = 2nd, etc.

parameterType - an integer assigning the parameter type. Integers are the java.sql.Types class field values.

Parameterized Query Data Types

string	numeric	bit
date	time	timestamp

parameterValue - a text string representing the cell location. (e.g., A1) or name to assign this parameter.

See Also:

DatabaseQuery.getParameterCollection(), DatabaseQueryParamCollection, DatabaseQueryParameter