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

import"XResultSetMetaData.idl";

Inheritance diagram for XResultSetMetaData:

Public Member Functions
long	getColumnCount () raises (SQLException)
	returns the number of columns in this ResultSet. More...

boolean	isAutoIncrement ([in]long column) raises (SQLException)
	indicates whether the column is automatically numbered, thus read-only. More...

boolean	isCaseSensitive ([in]long column) raises (SQLException)
	indicates whether a column's case matters. More...

boolean	isSearchable ([in]long column) raises (SQLException)
	indicates whether the column can be used in a where clause. More...

boolean	isCurrency ([in]long column) raises (SQLException)
	indicates whether the column is a cash value. More...

long	isNullable ([in]long column) raises (SQLException)
	indicates the nullability of values in the designated column. More...

boolean	isSigned ([in]long column) raises (SQLException)
	indicates whether values in the column are signed numbers. More...

long	getColumnDisplaySize ([in]long column) raises (SQLException)
	indicates the column's normal max width in chars. More...

string	getColumnLabel ([in]long column) raises (SQLException)
	gets the suggested column title for use in printouts and displays. More...

string	getColumnName ([in]long column) raises (SQLException)
	gets a column's name. More...

string	getSchemaName ([in]long column) raises (SQLException)
	gets a column's table's schema. More...

long	getPrecision ([in]long column) raises (SQLException)
	gets a column's number of decimal digits. More...

long	getScale ([in]long column) raises (SQLException)
	gets a column's number of digits to right of the decimal point. More...

string	getTableName ([in]long column) raises (SQLException)
	gets a column's table name. More...

string	getCatalogName ([in]long column) raises (SQLException)
	gets a column's table's catalog name. More...

long	getColumnType ([in]long column) raises (SQLException)
	retrieves a column's SQL type. More...

string	getColumnTypeName ([in]long column) raises (SQLException)
	retrieves a column's database-specific type name. More...

boolean	isReadOnly ([in]long column) raises (SQLException)
	indicates whether a column is definitely not writable. More...

boolean	isWritable ([in]long column) raises (SQLException)
	indicates whether it is possible for a write on the column to succeed. More...

boolean	isDefinitelyWritable ([in]long column) raises (SQLException)
	indicates whether a write on the column will definitely succeed. More...

string	getColumnServiceName ([in]long column) raises (SQLException)
	returns the fully-qualified name of the service whose instances are manufactured if the method com::sun::star::sdbc::XResultSet::.getObject() is called to retrieve a value from the column. More...

Public Member Functions inherited from XInterface
any	queryInterface ([in] type aType)
	queries for a new interface to an existing UNO object. More...

void	acquire ()
	increases the reference counter by one. More...

void	release ()
	decreases the reference counter by one. More...

Detailed Description

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

Developers Guide: Database Access - ResultSetMetaData

Member Function Documentation

◆ getCatalogName()

string getCatalogName	(	[in] long	column	)
raises	(	SQLException
	)

gets a column's table's catalog name.

Parameters

column the first column is 1, the second is 2,

Returns: the catalog name

Exceptions

SQLException if a database access error occurs.

◆ getColumnCount()

long getColumnCount	(		)
raises	(	SQLException
	)

returns the number of columns in this ResultSet.

Returns: the column count

Exceptions

SQLException if a database access error occurs.

◆ getColumnDisplaySize()

long getColumnDisplaySize	(	[in] long	column	)
raises	(	SQLException
	)

indicates the column's normal max width in chars.

Parameters

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

Exceptions

SQLException if a database access error occurs.

◆ getColumnLabel()

string getColumnLabel	(	[in] long	column	)
raises	(	SQLException
	)

gets the suggested column title for use in printouts and displays.

Parameters

column the first column is 1, the second is 2,

Returns: the suggested column title

Exceptions

SQLException if a database access error occurs.

◆ getColumnName()

string getColumnName	(	[in] long	column	)
raises	(	SQLException
	)

gets a column's name.

Parameters

column the first column is 1, the second is 2,

Returns: the column name

Exceptions

SQLException if a database access error occurs.

◆ getColumnServiceName()

string getColumnServiceName	(	[in] long	column	)
raises	(	SQLException
	)

returns the fully-qualified name of the service whose instances are manufactured if the method com::sun::star::sdbc::XResultSet::.getObject() is called to retrieve a value from the column.

Parameters

column the first column is 1, the second is 2,

Returns: the service name

Exceptions

SQLException if a database access error occurs.

◆ getColumnType()

long getColumnType	(	[in] long	column	)
raises	(	SQLException
	)

retrieves a column's SQL type.

Parameters

column the first column is 1, the second is 2,

Returns: the column type

Exceptions

SQLException if a database access error occurs.

◆ getColumnTypeName()

string getColumnTypeName	(	[in] long	column	)
raises	(	SQLException
	)

retrieves a column's database-specific type name.

Parameters

column the first column is 1, the second is 2,

Returns: the type name

Exceptions

SQLException if a database access error occurs.

◆ getPrecision()

long getPrecision	(	[in] long	column	)
raises	(	SQLException
	)

gets a column's number of decimal digits.

Parameters

column the first column is 1, the second is 2,

Returns: precision

Exceptions

SQLException if a database access error occurs.

◆ getScale()

long getScale	(	[in] long	column	)
raises	(	SQLException
	)

gets a column's number of digits to right of the decimal point.

Parameters

column the first column is 1, the second is 2,

Returns: scale

Exceptions

SQLException if a database access error occurs.

◆ getSchemaName()

string getSchemaName	(	[in] long	column	)
raises	(	SQLException
	)

gets a column's table's schema.

Parameters

column the first column is 1, the second is 2,

Returns: the schema name

Exceptions

SQLException if a database access error occurs.

◆ getTableName()

string getTableName	(	[in] long	column	)
raises	(	SQLException
	)

gets a column's table name.

Parameters

column the first column is 1, the second is 2,

Returns: the table name

Exceptions

SQLException if a database access error occurs.

◆ isAutoIncrement()

boolean isAutoIncrement	(	[in] long	column	)
raises	(	SQLException
	)

indicates whether the column is automatically numbered, thus read-only.

Parameters

column the first column is 1, the second is 2,

Returns: TRUE if so

Exceptions

SQLException if a database access error occurs.

◆ isCaseSensitive()

boolean isCaseSensitive	(	[in] long	column	)
raises	(	SQLException
	)

indicates whether a column's case matters.

Parameters

column the first column is 1, the second is 2,

Returns: TRUE if so

Exceptions

SQLException if a database access error occurs.

◆ isCurrency()

boolean isCurrency	(	[in] long	column	)
raises	(	SQLException
	)

indicates whether the column is a cash value.

Parameters

column the first column is 1, the second is 2,

Returns: TRUE if so

Exceptions

SQLException if a database access error occurs.

◆ isDefinitelyWritable()

boolean isDefinitelyWritable	(	[in] long	column	)
raises	(	SQLException
	)

indicates whether a write on the column will definitely succeed.

Parameters

column the first column is 1, the second is 2,

Returns: TRUE if so

Exceptions

SQLException if a database access error occurs.

◆ isNullable()

long isNullable	(	[in] long	column	)
raises	(	SQLException
	)

indicates the nullability of values in the designated column.

See also: com::sun::star::sdbc::ColumnValue

Parameters

column the first column is 1, the second is 2,

Returns: TRUE if so

Exceptions

SQLException if a database access error occurs.

◆ isReadOnly()

boolean isReadOnly	(	[in] long	column	)
raises	(	SQLException
	)

indicates whether a column is definitely not writable.

Parameters

column the first column is 1, the second is 2,

Returns: TRUE if so

Exceptions

SQLException if a database access error occurs.

◆ isSearchable()

boolean isSearchable	(	[in] long	column	)
raises	(	SQLException
	)

indicates whether the column can be used in a where clause.

Parameters

column the first column is 1, the second is 2,

Returns: TRUE if so

Exceptions

SQLException if a database access error occurs.

◆ isSigned()

boolean isSigned	(	[in] long	column	)
raises	(	SQLException
	)

indicates whether values in the column are signed numbers.

Parameters

column the first column is 1, the second is 2,

Returns: TRUE if so

Exceptions

SQLException if a database access error occurs.

◆ isWritable()

boolean isWritable	(	[in] long	column	)
raises	(	SQLException
	)

indicates whether it is possible for a write on the column to succeed.

Parameters

column the first column is 1, the second is 2,

Returns: TRUE if so

Exceptions

SQLException if a database access error occurs.

The documentation for this interface was generated from the following file:

com/sun/star/sdbc/XResultSetMetaData.idl

Public Member Functions

Detailed Description

Member Function Documentation

◆ getCatalogName()

◆ getColumnCount()

◆ getColumnDisplaySize()

◆ getColumnLabel()

◆ getColumnName()

◆ getColumnServiceName()

◆ getColumnType()

◆ getColumnTypeName()

◆ getPrecision()

◆ getScale()

◆ getSchemaName()

◆ getTableName()

◆ isAutoIncrement()

◆ isCaseSensitive()

◆ isCurrency()

◆ isDefinitelyWritable()

◆ isNullable()

◆ isReadOnly()

◆ isSearchable()

◆ isSigned()

◆ isWritable()