org.firebirdsql.gds

Interface IscDbHandle

public interface IscDbHandle

The interface isc_db_handle represents a socket connection to the database server.

Version:

1.0

Author:

Alejandro Alberola, David Jencks

Method Summary

Modifier and Type	Method and Description
void	addWarning(GDSException warning) Add a warning from the server to this connection.
void	clearWarnings() Clear warning list associated with this connection.
int	getDatabaseProductMajorVersion() Get the major version number of the database product to which this handle is attached.
int	getDatabaseProductMinorVersion() Get the minor version number of the database product to which this handle is attached.
java.lang.String	getDatabaseProductName() Get the product name for the database to which this handle is attached.
java.lang.String	getDatabaseProductVersion() Get the product version for the database to which this handle is attached.
int	getDialect() Get the Firebird dialect that is being used with this handle.
int	getODSMajorVersion()
int	getODSMinorVersion()
int	getProtocol() Get the Firebird protocol version that is used for this handle
java.lang.String	getVersion()
java.util.List	getWarnings() Get list of warnings that were returned by the server.
boolean	isValid() Retrieve whether this handle is valid.
void	setDialect(int value)
void	setODSMajorVersion(int value)
void	setODSMinorVersion(int value)
void	setVersion(java.lang.String... version)
void	setVersion(java.lang.String version)

Method Detail

getWarnings

java.util.List getWarnings()

Get list of warnings that were returned by the server.

Returns:

instance of List containing instances of GDSException representing server warnings (method GDSException.isWarning() returns true).

addWarning

void addWarning(GDSException warning)

Add a warning from the server to this connection.

Parameters:

warning - GDSException representing a server warning

clearWarnings

void clearWarnings()

Clear warning list associated with this connection.

getDatabaseProductMajorVersion

int getDatabaseProductMajorVersion()

Get the major version number of the database product to which this handle is attached.

Returns:

The major product version number

getDatabaseProductMinorVersion

int getDatabaseProductMinorVersion()

Get the minor version number of the database product to which this handle is attached.

Returns:

The minor product version number

getDatabaseProductName

java.lang.String getDatabaseProductName()

Get the product name for the database to which this handle is attached.

Returns:

The product name of the database

getDatabaseProductVersion

java.lang.String getDatabaseProductVersion()

Get the product version for the database to which this handle is attached.

Returns:

The product version of the database

getDialect

int getDialect()

Get the Firebird dialect that is being used with this handle.

Returns:

The dialect being used

setDialect

void setDialect(int value)

getProtocol

int getProtocol()

Get the Firebird protocol version that is used for this handle

Returns:

Protocol version number

getODSMajorVersion

int getODSMajorVersion()

Returns:

the major ODS version of the database.

setODSMajorVersion

void setODSMajorVersion(int value)

getODSMinorVersion

int getODSMinorVersion()

Returns:

the minor ODS version of the database.

setODSMinorVersion

void setODSMinorVersion(int value)

getVersion

java.lang.String getVersion()

Returns:

database server version.

setVersion

void setVersion(java.lang.String version)
         throws GDSException

Parameters:

version - Version string

Throws:

GDSException - For failures to parse or process the version string

setVersion

void setVersion(java.lang.String... version)
         throws GDSException

Parameters:

version - Version strings

Throws:

GDSException - For failures to parse or process the version string

isValid

boolean isValid()

Retrieve whether this handle is valid.

Returns:

true if this handle is valid, false otherwise