LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | List of all members
XResultSetMetaData Interface Referencepublished

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:
XInterface

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 - ResultSetMetaData

Member Function Documentation

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

gets a column's table's catalog name.

Parameters
columnthe first column is 1, the second is 2,
Returns
the catalog name
Exceptions
SQLExceptionif a database access error occurs.
long getColumnCount ( )
raises (SQLException
)

returns the number of columns in this ResultSet.

Returns
the column count
Exceptions
SQLExceptionif a database access error occurs.
long getColumnDisplaySize ( [in] long  column)
raises (SQLException
)

indicates the column's normal max width in chars.

Parameters
columnthe first column is 1, the second is 2,
Returns
the normal maximum number of characters allowed as the width of the designated column
Exceptions
SQLExceptionif a database access error occurs.
string getColumnLabel ( [in] long  column)
raises (SQLException
)

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

Parameters
columnthe first column is 1, the second is 2,
Returns
the suggested column title
Exceptions
SQLExceptionif a database access error occurs.
string getColumnName ( [in] long  column)
raises (SQLException
)

gets a column's name.

Parameters
columnthe first column is 1, the second is 2,
Returns
the column name
Exceptions
SQLExceptionif a database access error occurs.
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
columnthe first column is 1, the second is 2,
Returns
the service name
Exceptions
SQLExceptionif a database access error occurs.
long getColumnType ( [in] long  column)
raises (SQLException
)

retrieves a column's SQL type.

Parameters
columnthe first column is 1, the second is 2,
Returns
the column type
Exceptions
SQLExceptionif a database access error occurs.
string getColumnTypeName ( [in] long  column)
raises (SQLException
)

retrieves a column's database-specific type name.

Parameters
columnthe first column is 1, the second is 2,
Returns
the type name
Exceptions
SQLExceptionif a database access error occurs.
long getPrecision ( [in] long  column)
raises (SQLException
)

gets a column's number of decimal digits.

Parameters
columnthe first column is 1, the second is 2,
Returns
precision
Exceptions
SQLExceptionif a database access error occurs.
long getScale ( [in] long  column)
raises (SQLException
)

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

Parameters
columnthe first column is 1, the second is 2,
Returns
scale
Exceptions
SQLExceptionif a database access error occurs.
string getSchemaName ( [in] long  column)
raises (SQLException
)

gets a column's table's schema.

Parameters
columnthe first column is 1, the second is 2,
Returns
the schema name
Exceptions
SQLExceptionif a database access error occurs.
string getTableName ( [in] long  column)
raises (SQLException
)

gets a column's table name.

Parameters
columnthe first column is 1, the second is 2,
Returns
the table name
Exceptions
SQLExceptionif a database access error occurs.
boolean isAutoIncrement ( [in] long  column)
raises (SQLException
)

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

Parameters
columnthe first column is 1, the second is 2,
Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean isCaseSensitive ( [in] long  column)
raises (SQLException
)

indicates whether a column's case matters.

Parameters
columnthe first column is 1, the second is 2,
Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean isCurrency ( [in] long  column)
raises (SQLException
)

indicates whether the column is a cash value.

Parameters
columnthe first column is 1, the second is 2,
Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean isDefinitelyWritable ( [in] long  column)
raises (SQLException
)

indicates whether a write on the column will definitely succeed.

Parameters
columnthe first column is 1, the second is 2,
Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
long isNullable ( [in] long  column)
raises (SQLException
)

indicates the nullability of values in the designated column.

See also
com::sun::star::sdbc::ColumnValue
Parameters
columnthe first column is 1, the second is 2,
Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean isReadOnly ( [in] long  column)
raises (SQLException
)

indicates whether a column is definitely not writable.

Parameters
columnthe first column is 1, the second is 2,
Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean isSearchable ( [in] long  column)
raises (SQLException
)

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

Parameters
columnthe first column is 1, the second is 2,
Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean isSigned ( [in] long  column)
raises (SQLException
)

indicates whether values in the column are signed numbers.

Parameters
columnthe first column is 1, the second is 2,
Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean isWritable ( [in] long  column)
raises (SQLException
)

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

Parameters
columnthe first column is 1, the second is 2,
Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.

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