|
LibreOffice
LibreOffice 24.8 SDK API Reference
|
is used to access data which is collected in a row. More...
import "XRow.idl";
Public Member Functions | |
| boolean | wasNull () raises (SQLException) |
| reports whether the last column read had a value of SQL NULL. | |
| string | getString ([in]long columnIndex) raises (SQLException) |
| gets the value of a column in the current row as a string. | |
| boolean | getBoolean ([in]long columnIndex) raises (SQLException) |
| gets the value of a column in the current row as boolean. | |
| byte | getByte ([in]long columnIndex) raises (SQLException) |
| get the value of a column in the current row as a byte. | |
| short | getShort ([in]long columnIndex) raises (SQLException) |
| gets the value of a column in the current row as a short. | |
| long | getInt ([in]long columnIndex) raises (SQLException) |
| get the value of a column in the current row as an integer. | |
| hyper | getLong ([in]long columnIndex) raises (SQLException) |
| get the value of a column in the current row as a long. | |
| float | getFloat ([in]long columnIndex) raises (SQLException) |
| gets the value of a column in the current row as a float. | |
| double | getDouble ([in]long columnIndex) raises (SQLException) |
| gets the value of a column in the current row as a double. | |
| sequence< byte > | getBytes ([in]long columnIndex) raises (SQLException) |
| gets the value of a column in the current row as a byte array. | |
| com::sun::star::util::Date | getDate ([in]long columnIndex) raises (SQLException) |
| gets the value of a column in the current row as a date object. | |
| com::sun::star::util::Time | getTime ([in]long columnIndex) raises (SQLException) |
| gets the value of a column in the current row as a time object. | |
| com::sun::star::util::DateTime | getTimestamp ([in]long columnIndex) raises (SQLException) |
| gets the value of a column in the current row as a datetime object. | |
| com::sun::star::io::XInputStream | getBinaryStream ([in]long columnIndex) raises (SQLException) |
| gets the value of a column in the current row as a stream of uninterpreted bytes. | |
| com::sun::star::io::XInputStream | getCharacterStream ([in]long columnIndex) raises (SQLException) |
| gets the value of a column in the current row as a stream of uninterpreted bytes. | |
| any | getObject ([in]long columnIndex, [in]com::sun::star::container::XNameAccess typeMap) raises (SQLException) |
| returns the value of a column in the current row as an object. | |
| XRef | getRef ([in]long columnIndex) raises (SQLException) |
| gets a REF(<structured-type>) column value from the current row. | |
| XBlob | getBlob ([in]long columnIndex) raises (SQLException) |
| gets a BLOB value in the current row. | |
| XClob | getClob ([in]long columnIndex) raises (SQLException) |
gets a CLOB value in the current row of this ResultSet object. | |
| XArray | getArray ([in]long columnIndex) raises (SQLException) |
gets a SQL ARRAY value from the current row of this ResultSet object. | |
| Public Member Functions inherited from XInterface | |
| any | queryInterface ([in] type aType) |
| queries for a new interface to an existing UNO object. | |
| void | acquire () |
| increases the reference counter by one. | |
| void | release () |
| decreases the reference counter by one. | |
is used to access data which is collected in a row.
All methods raise a com::sun::star::sdbc::SQLException if a database access error occurs.
| XArray getArray | ( | [in] long | columnIndex | ) | ||
| raises | ( | SQLException ) | ||||
gets a SQL ARRAY value from the current row of this ResultSet object.
| columnIndex | the first column is 1, the second is 2, |
| SQLException | if a database access error occurs. |
| com::sun::star::io::XInputStream getBinaryStream | ( | [in] long | columnIndex | ) | ||
| raises | ( | SQLException ) | ||||
gets the value of a column in the current row as a stream of uninterpreted bytes.
The value can then be read in chunks from the stream. This method is particularly suitable for retrieving large LONGVARBINARY values.
Note: All the data in the returned stream must be read prior to getting the value of any other column. The next call to a get method implicitly closes the stream. Also, a stream may return 0 when the method com::sun::star::io::XInputStream::available() is called whether there is data available or not.
| columnIndex | the first column is 1, the second is 2, |
| SQLException | if a database access error occurs. |
| XBlob getBlob | ( | [in] long | columnIndex | ) | ||
| raises | ( | SQLException ) | ||||
gets a BLOB value in the current row.
| columnIndex | the first column is 1, the second is 2, |
| SQLException | if a database access error occurs. |
| boolean getBoolean | ( | [in] long | columnIndex | ) | ||
| raises | ( | SQLException ) | ||||
gets the value of a column in the current row as boolean.
| columnIndex | the first column is 1, the second is 2, |
| SQLException | if a database access error occurs. |
| byte getByte | ( | [in] long | columnIndex | ) | ||
| raises | ( | SQLException ) | ||||
get the value of a column in the current row as a byte.
| columnIndex | the first column is 1, the second is 2, |
| SQLException | if a database access error occurs. |
| sequence< byte > getBytes | ( | [in] long | columnIndex | ) | ||
| raises | ( | SQLException ) | ||||
gets the value of a column in the current row as a byte array.
The bytes represent the raw values returned by the driver.
| columnIndex | the first column is 1, the second is 2, ... |
| SQLException | if a database access error occurs. |
| com::sun::star::io::XInputStream getCharacterStream | ( | [in] long | columnIndex | ) | ||
| raises | ( | SQLException ) | ||||
gets the value of a column in the current row as a stream of uninterpreted bytes.
The value can then be read in chunks from the stream. This method is particularly suitable for retrieving large LONGVARBINARY or LONGVARCHAR values.
Note: All the data in the returned stream must be read prior to getting the value of any other column. The next call to a get method implicitly closes the stream. Also, a stream may return 0 when the method com::sun::star::io::XInputStream::available() is called whether there is data available or not.
| columnIndex | the first column is 1, the second is 2, |
| SQLException | if a database access error occurs. |
| XClob getClob | ( | [in] long | columnIndex | ) | ||
| raises | ( | SQLException ) | ||||
gets a CLOB value in the current row of this ResultSet object.
| columnIndex | the first column is 1, the second is 2, |
| SQLException | if a database access error occurs. |
| com::sun::star::util::Date getDate | ( | [in] long | columnIndex | ) | ||
| raises | ( | SQLException ) | ||||
gets the value of a column in the current row as a date object.
| columnIndex | the first column is 1, the second is 2, |
| SQLException | if a database access error occurs. |
| double getDouble | ( | [in] long | columnIndex | ) | ||
| raises | ( | SQLException ) | ||||
gets the value of a column in the current row as a double.
| columnIndex | the first column is 1, the second is 2, |
| SQLException | if a database access error occurs. |
| float getFloat | ( | [in] long | columnIndex | ) | ||
| raises | ( | SQLException ) | ||||
gets the value of a column in the current row as a float.
| columnIndex | the first column is 1, the second is 2, |
| SQLException | if a database access error occurs. |
| long getInt | ( | [in] long | columnIndex | ) | ||
| raises | ( | SQLException ) | ||||
get the value of a column in the current row as an integer.
| columnIndex | the first column is 1, the second is 2, |
| SQLException | if a database access error occurs. |
| hyper getLong | ( | [in] long | columnIndex | ) | ||
| raises | ( | SQLException ) | ||||
get the value of a column in the current row as a long.
| columnIndex | the first column is 1, the second is 2, |
| SQLException | if a database access error occurs. |
| any getObject | ( | [in] long | columnIndex, | |||
| [in] com::sun::star::container::XNameAccess | typeMap ) | |||||
| raises | ( | SQLException ) | ||||
returns the value of a column in the current row as an object.
This method uses the given Map object for the custom mapping of the SQL structure or distinct type that is being retrieved.
| columnIndex | the first column is 1, the second is 2, |
| typeMap | the map of types which should be used to get the column value |
| SQLException | if a database access error occurs. |
| XRef getRef | ( | [in] long | columnIndex | ) | ||
| raises | ( | SQLException ) | ||||
gets a REF(<structured-type>) column value from the current row.
| columnIndex | the first column is 1, the second is 2, |
| SQLException | if a database access error occurs. |
| short getShort | ( | [in] long | columnIndex | ) | ||
| raises | ( | SQLException ) | ||||
gets the value of a column in the current row as a short.
| columnIndex | the first column is 1, the second is 2, |
| SQLException | if a database access error occurs. |
| string getString | ( | [in] long | columnIndex | ) | ||
| raises | ( | SQLException ) | ||||
gets the value of a column in the current row as a string.
| columnIndex | the first column is 1, the second is 2, |
| SQLException | if a database access error occurs. |
| com::sun::star::util::Time getTime | ( | [in] long | columnIndex | ) | ||
| raises | ( | SQLException ) | ||||
gets the value of a column in the current row as a time object.
| columnIndex | the first column is 1, the second is 2, |
| SQLException | if a database access error occurs. |
| com::sun::star::util::DateTime getTimestamp | ( | [in] long | columnIndex | ) | ||
| raises | ( | SQLException ) | ||||
gets the value of a column in the current row as a datetime object.
| columnIndex | the first column is 1, the second is 2, |
| SQLException | if a database access error occurs. |
| boolean wasNull | ( | ) | ||||
| raises | ( | SQLException ) | ||||
reports whether the last column read had a value of SQL NULL.
Note that you must first call getXXX on a column to try to read its value and then call wasNull() to see if the value read was SQL NULL.
| SQLException | if a database access error occurs. |