Top   Module   Use   Manual   Index 
 EXPORTING SERVICES | METHODS' SUMMARY | METHODS' DETAILS 

com :: sun :: star :: sdbc ::

interface XResultSetMetaData

Base Interface
com::sun::star::uno::XInterface

Description
can be used to find out about the types and properties of the columns in a ResultSet.


Methods' Summary

getColumnCount returns the number of columns in this ResultSet.
isAutoIncrement indicates whether the column is automatically numbered, thus read-only.
isCaseSensitive indicates whether a column's case matters.
isSearchable indicates whether the column can be used in a where clause.
isCurrency indicates whether the column is a cash value.
isNullable indicates the nullability of values in the designated column.
isSigned indicates whether values in the column are signed numbers.
getColumnDisplaySize indicates the column's normal max width in chars.
getColumnLabel gets the suggested column title for use in printouts and displays.
getColumnName gets a column's name.
getSchemaName gets a column's table's schema.
getPrecision gets a column's number of decimal digits.
getScale gets a column's number of digits to right of the decimal point.
getTableName gets a column's table name.
getCatalogName gets a column's table's catalog name.
getColumnType retrieves a column's SQL type.
getColumnTypeName retrieves a column's database-specific type name.
isReadOnly indicates whether a column is definitely not writable.
isWritable indicates whether it is possible for a write on the column to succeed.
isDefinitelyWritable indicates whether a write on the column will definitely succeed.
getColumnServiceName returns the fully-qualified name of the service whose instances are manufactured if the method XResultSet::.getObject() is called to retrieve a value from the column.

Methods' Details

getColumnCount
 
long
getColumnCount( )
raises ( com::sun::star::sdbc::SQLException );

Description
returns the number of columns in this ResultSet.
Returns
the column count
Throws
SQLException if a database access error occurs.
isAutoIncrement
 
boolean
isAutoIncrement(
[ in ] long column )
raises ( com::sun::star::sdbc::SQLException );

Description
indicates whether the column is automatically numbered, thus read-only.
Parameter column
the first column is 1, the second is 2,
Returns
true if so
Throws
SQLException if a database access error occurs.
isCaseSensitive
 
boolean
isCaseSensitive(
[ in ] long column )
raises ( com::sun::star::sdbc::SQLException );

Description
indicates whether a column's case matters.
Parameter column
the first column is 1, the second is 2,
Returns
true if so
Throws
SQLException if a database access error occurs.
isSearchable
 
boolean
isSearchable(
[ in ] long column )
raises ( com::sun::star::sdbc::SQLException );

Description
indicates whether the column can be used in a where clause.
Parameter column
the first column is 1, the second is 2,
Returns
true if so
Throws
SQLException if a database access error occurs.
isCurrency
 
boolean
isCurrency(
[ in ] long column )
raises ( com::sun::star::sdbc::SQLException );

Description
indicates whether the column is a cash value.
Parameter column
the first column is 1, the second is 2,
Returns
true if so
Throws
SQLException if a database access error occurs.
isNullable
 
long
isNullable(
[ in ] long column )
raises ( com::sun::star::sdbc::SQLException );

Description
indicates the nullability of values in the designated column.
See also
com::sun::star::sdbc::ColumnValue
Parameter column
the first column is 1, the second is 2,
Returns
true if so
Throws
SQLException if a database access error occurs.
isSigned
 
boolean
isSigned(
[ in ] long column )
raises ( com::sun::star::sdbc::SQLException );

Description
indicates whether values in the column are signed numbers.
Parameter column
the first column is 1, the second is 2,
Returns
true if so
Throws
SQLException if a database access error occurs.
getColumnDisplaySize
 
long
getColumnDisplaySize(
[ in ] long column )
raises ( com::sun::star::sdbc::SQLException );

Description
indicates the column's normal max width in chars.
Parameter column
the first column is 1, the second is 2,
Returns
the normal maximum number of characters allowed as the width of the designated column
Throws
SQLException if a database access error occurs.
getColumnLabel
 
string
getColumnLabel(
[ in ] long column )
raises ( com::sun::star::sdbc::SQLException );

Description
gets the suggested column title for use in printouts and displays.
Parameter column
the first column is 1, the second is 2,
Returns
the suggested column title
Throws
SQLException if a database access error occurs.
getColumnName
 
string
getColumnName(
[ in ] long column )
raises ( com::sun::star::sdbc::SQLException );

Description
gets a column's name.
Parameter column
the first column is 1, the second is 2,
Returns
the column name
Throws
SQLException if a database access error occurs.
getSchemaName
 
string
getSchemaName(
[ in ] long column )
raises ( com::sun::star::sdbc::SQLException );

Description
gets a column's table's schema.
Parameter column
the first column is 1, the second is 2,
Returns
the schema name
Throws
SQLException if a database access error occurs.
getPrecision
 
long
getPrecision(
[ in ] long column )
raises ( com::sun::star::sdbc::SQLException );

Description
gets a column's number of decimal digits.
Parameter column
the first column is 1, the second is 2,
Returns
precision
Throws
SQLException if a database access error occurs.
getScale
 
long
getScale(
[ in ] long column )
raises ( com::sun::star::sdbc::SQLException );

Description
gets a column's number of digits to right of the decimal point.
Parameter column
the first column is 1, the second is 2,
Returns
scale
Throws
SQLException if a database access error occurs.
getTableName
 
string
getTableName(
[ in ] long column )
raises ( com::sun::star::sdbc::SQLException );

Description
gets a column's table name.
Parameter column
the first column is 1, the second is 2,
Returns
the table name
Throws
SQLException if a database access error occurs.
getCatalogName
 
string
getCatalogName(
[ in ] long column )
raises ( com::sun::star::sdbc::SQLException );

Description
gets a column's table's catalog name.
Parameter column
the first column is 1, the second is 2,
Returns
the catalog name
Throws
SQLException if a database access error occurs.
getColumnType
 
long
getColumnType(
[ in ] long column )
raises ( com::sun::star::sdbc::SQLException );

Description
retrieves a column's SQL type.
Parameter column
the first column is 1, the second is 2,
Returns
the column type
Throws
SQLException if a database access error occurs.
getColumnTypeName
 
string
getColumnTypeName(
[ in ] long column )
raises ( com::sun::star::sdbc::SQLException );

Description
retrieves a column's database-specific type name.
Parameter column
the first column is 1, the second is 2,
Returns
the type name
Throws
SQLException if a database access error occurs.
isReadOnly
 
boolean
isReadOnly(
[ in ] long column )
raises ( com::sun::star::sdbc::SQLException );

Description
indicates whether a column is definitely not writable.
Parameter column
the first column is 1, the second is 2,
Returns
true if so
Throws
SQLException if a database access error occurs.
isWritable
 
boolean
isWritable(
[ in ] long column )
raises ( com::sun::star::sdbc::SQLException );

Description
indicates whether it is possible for a write on the column to succeed.
Parameter column
the first column is 1, the second is 2,
Returns
true if so
Throws
SQLException if a database access error occurs.
isDefinitelyWritable
 
boolean
isDefinitelyWritable(
[ in ] long column )
raises ( com::sun::star::sdbc::SQLException );

Description
indicates whether a write on the column will definitely succeed.
Parameter column
the first column is 1, the second is 2,
Returns
true if so
Throws
SQLException if a database access error occurs.
getColumnServiceName
 
string
getColumnServiceName(
[ in ] long column )
raises ( com::sun::star::sdbc::SQLException );

Description
returns the fully-qualified name of the service whose instances are manufactured if the method XResultSet::.getObject() is called to retrieve a value from the column.
Parameter column
the first column is 1, the second is 2,
Returns
the service name
Throws
SQLException if a database access error occurs.

Top of Page