PreparedStatement Service Reference

represents a precompiled SQL statement. More...

import"PreparedStatement.idl";

Inheritance diagram for PreparedStatement:

Included Services
service	com::sun::star::sdbc::PreparedStatement

Exported Interfaces
interface	com::sun::star::sdbcx::XColumnsSupplier
	access to the resulting columns of the statement. More...
Exported Interfaces inherited from PreparedStatement
interface	com::sun::star::lang::XComponent
	optional for implementation, controls the releasing of resources and the notification of registered listeners. More...
interface	XCloseable
	freeing all resources of a statement. More...
interface	com::sun::star::beans::XPropertySet
interface	com::sun::star::util::XCancellable
	could be used for canceling the execution of SQL statements, if both the DBMS and the driver support aborting an SQL statement. More...
interface	XPreparedStatement
	is the interface for executing SQL prepared commands. More...
interface	XResultSetMetaDataSupplier
	provides access to the description of the result set which would be generated by executing the PreparedStatement. More...
interface	XParameters
	is used for setting parameters before execution of the precompiled statement. More...
interface	XPreparedBatchExecution
	provides the ability of batch execution. More...
interface	XWarningsSupplier
	controls the chaining of warnings, which may occur on every call to the connected database. More...
interface	XMultipleResults
	covers the handling of multiple results after executing an SQL command. More...

Additional Inherited Members
Public Member Functions inherited from XCloseable
void	close () raises (SQLException)
	releases all resources connected to an object. 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...
Public Member Functions inherited from XPropertySet
com::sun::star::beans::XPropertySetInfo	getPropertySetInfo ()
void	setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
	sets the value of the property with the specified name. More...
any	getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
void	addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
	adds an XPropertyChangeListener to the specified property. More...
void	removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
	removes an XPropertyChangeListener from the listener list. More...
void	addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
	adds an XVetoableChangeListener to the specified property with the name PropertyName. More...
void	removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
	removes an XVetoableChangeListener from the listener list. More...
Public Member Functions inherited from XPreparedStatement
XResultSet	executeQuery () raises (SQLException)
	executes the SQL query in this PreparedStatement object and returns the result set generated by the query. More...
long	executeUpdate () raises (SQLException)
	executes the SQL INSERT, UPDATE or DELETE statement in this com::sun::star::sdbc::PreparedStatement object. More...
boolean	execute () raises (SQLException)
	executes any kind of SQL statement. More...
XConnection	getConnection () raises (SQLException)
	returns the com::sun::star::sdbc::Connection object that produced this com::sun::star::sdbc::Statement object. More...
Public Member Functions inherited from XResultSetMetaDataSupplier
XResultSetMetaData	getMetaData () raises (SQLException)
	retrieves the number, types, and properties of a ResultSet's columns. More...
Public Member Functions inherited from XParameters
void	setNull ([in]long parameterIndex, [in]long sqlType) raises (SQLException)
	sets the designated parameter to SQL NULL. More...
void	setObjectNull ([in]long parameterIndex, [in]long sqlType, [in]string typeName) raises (SQLException)
	sets the designated parameter to SQL NULL. More...
void	setBoolean ([in]long parameterIndex, [in]boolean x) raises (SQLException)
	sets the designated parameter to a boolean value. More...
void	setByte ([in]long parameterIndex, [in]byte x) raises (SQLException)
	sets the designated parameter to a byte value. More...
void	setShort ([in]long parameterIndex, [in]short x) raises (SQLException)
	sets the designated parameter to a short value. More...
void	setInt ([in]long parameterIndex, [in]long x) raises (SQLException)
	sets the designated parameter to a long value. More...
void	setLong ([in]long parameterIndex, [in]hyper x) raises (SQLException)
	sets the designated parameter to a hyper value. More...
void	setFloat ([in]long parameterIndex, [in]float x) raises (SQLException)
	sets the designated parameter to a float value. More...
void	setDouble ([in]long parameterIndex, [in]double x) raises (SQLException)
	sets the designated parameter to a double value. More...
void	setString ([in]long parameterIndex, [in]string x) raises (SQLException)
	sets the designated parameter to a string value. More...
void	setBytes ([in]long parameterIndex, [in]sequence< byte > x) raises (SQLException)
	sets the designated parameter to a sequence of bytes. More...
void	setDate ([in]long parameterIndex, [in]com::sun::star::util::Date x) raises (SQLException)
	sets the designated parameter to a date value. More...
void	setTime ([in]long parameterIndex, [in]com::sun::star::util::Time x) raises (SQLException)
	sets the designated parameter to a time value. More...
void	setTimestamp ([in]long parameterIndex, [in]com::sun::star::util::DateTime x) raises (SQLException)
	sets the designated parameter to a datetime value. More...
void	setBinaryStream ([in]long parameterIndex, [in]com::sun::star::io::XInputStream x, [in]long length) raises (SQLException)
	sets the designated parameter to the given input stream, which will have the specified number of bytes. More...
void	setCharacterStream ([in]long parameterIndex, [in]com::sun::star::io::XInputStream x, [in]long length) raises (SQLException)
	sets the designated parameter to the given input stream, which will have the specified number of bytes. More...
void	setObject ([in]long parameterIndex, [in]any x) raises (SQLException)
	sets the value of a parameter using an any. More...
void	setObjectWithInfo ([in]long parameterIndex, [in]any x, [in]long targetSqlType, [in]long scale) raises (SQLException)
	set a value from the Datatype ANY for a parameter. More...
void	setRef ([in]long parameterIndex, [in]XRef x) raises (SQLException)
	sets a REF(&lt;structured-type&gt;) parameter. More...
void	setBlob ([in]long parameterIndex, [in]XBlob x) raises (SQLException)
	sets a BLOB parameter. More...
void	setClob ([in]long parameterIndex, [in]XClob x) raises (SQLException)
	sets a CLOB parameter. More...
void	setArray ([in]long parameterIndex, [in]XArray x) raises (SQLException)
	sets an Array parameter. More...
void	clearParameters () raises (SQLException)
	clears the current parameter values immediately. More...
Public Member Functions inherited from XWarningsSupplier
any	getWarnings () raises (SQLException)
	returns the first warning reported by calls on an object that supports the usage of warnings. More...
void	clearWarnings () raises (SQLException)
	clears all warnings reported for the object implementing the interface. More...
Public Member Functions inherited from XMultipleResults
XResultSet	getResultSet () raises (SQLException)
	returns the current result as a com::sun::star::sdbc::ResultSet object. More...
long	getUpdateCount () raises (SQLException)
	returns the current result as an update count. More...
boolean	getMoreResults () raises (SQLException)
	moves to a Statement's next result. More...
Public Member Functions inherited from XColumnsSupplier
com::sun::star::container::XNameAccess	getColumns ()
	returns the container of columns. More...
Public Attributes inherited from PreparedStatement
long	QueryTimeOut
	retrieves the number of seconds the driver will wait for a Statement to execute. More...
long	MaxFieldSize
	returns the maximum number of bytes allowed for any column value. More...
long	MaxRows
	retrieves the maximum number of rows that a ResultSet can contain. More...
string	CursorName
	defines the SQL cursor name that will be used by subsequent Statement execute methods. More...
long	ResultSetConcurrency
	retrieves the result set concurrency. More...
long	ResultSetType
	Determine the result set type. More...
long	FetchDirection
	retrieves the direction for fetching rows from database tables that is the default for result sets generated from this Statement object. More...
long	FetchSize
	retrieves the number of result set rows that is the default fetch size for result sets generated from this Statement object. More...
Protected Member Functions inherited from XComponent
void	dispose ()
	The owner of an object calls this method to explicitly free all resources kept by this object and thus break cyclic references. More...
void	addEventListener ([in] XEventListener xListener)
	adds an event listener to the object. More...
void	removeEventListener ([in] XEventListener aListener)
	removes an event listener from the listener list. More...
Protected 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...
Protected Member Functions inherited from XCloseable
void	close () raises (SQLException)
	releases all resources connected to an object. More...
Protected Member Functions inherited from XPropertySet
com::sun::star::beans::XPropertySetInfo	getPropertySetInfo ()
void	setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
	sets the value of the property with the specified name. More...
any	getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
void	addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
	adds an XPropertyChangeListener to the specified property. More...
void	removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
	removes an XPropertyChangeListener from the listener list. More...
void	addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
	adds an XVetoableChangeListener to the specified property with the name PropertyName. More...
void	removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
	removes an XVetoableChangeListener from the listener list. More...
Protected Member Functions inherited from XCancellable
void	cancel ()
	cancels the current job of the object. More...
Protected Member Functions inherited from XPreparedStatement
XResultSet	executeQuery () raises (SQLException)
	executes the SQL query in this PreparedStatement object and returns the result set generated by the query. More...
long	executeUpdate () raises (SQLException)
	executes the SQL INSERT, UPDATE or DELETE statement in this com::sun::star::sdbc::PreparedStatement object. More...
boolean	execute () raises (SQLException)
	executes any kind of SQL statement. More...
XConnection	getConnection () raises (SQLException)
	returns the com::sun::star::sdbc::Connection object that produced this com::sun::star::sdbc::Statement object. More...
Protected Member Functions inherited from XResultSetMetaDataSupplier
XResultSetMetaData	getMetaData () raises (SQLException)
	retrieves the number, types, and properties of a ResultSet's columns. More...
Protected Member Functions inherited from XParameters
void	setNull ([in]long parameterIndex, [in]long sqlType) raises (SQLException)
	sets the designated parameter to SQL NULL. More...
void	setObjectNull ([in]long parameterIndex, [in]long sqlType, [in]string typeName) raises (SQLException)
	sets the designated parameter to SQL NULL. More...
void	setBoolean ([in]long parameterIndex, [in]boolean x) raises (SQLException)
	sets the designated parameter to a boolean value. More...
void	setByte ([in]long parameterIndex, [in]byte x) raises (SQLException)
	sets the designated parameter to a byte value. More...
void	setShort ([in]long parameterIndex, [in]short x) raises (SQLException)
	sets the designated parameter to a short value. More...
void	setInt ([in]long parameterIndex, [in]long x) raises (SQLException)
	sets the designated parameter to a long value. More...
void	setLong ([in]long parameterIndex, [in]hyper x) raises (SQLException)
	sets the designated parameter to a hyper value. More...
void	setFloat ([in]long parameterIndex, [in]float x) raises (SQLException)
	sets the designated parameter to a float value. More...
void	setDouble ([in]long parameterIndex, [in]double x) raises (SQLException)
	sets the designated parameter to a double value. More...
void	setString ([in]long parameterIndex, [in]string x) raises (SQLException)
	sets the designated parameter to a string value. More...
void	setBytes ([in]long parameterIndex, [in]sequence< byte > x) raises (SQLException)
	sets the designated parameter to a sequence of bytes. More...
void	setDate ([in]long parameterIndex, [in]com::sun::star::util::Date x) raises (SQLException)
	sets the designated parameter to a date value. More...
void	setTime ([in]long parameterIndex, [in]com::sun::star::util::Time x) raises (SQLException)
	sets the designated parameter to a time value. More...
void	setTimestamp ([in]long parameterIndex, [in]com::sun::star::util::DateTime x) raises (SQLException)
	sets the designated parameter to a datetime value. More...
void	setBinaryStream ([in]long parameterIndex, [in]com::sun::star::io::XInputStream x, [in]long length) raises (SQLException)
	sets the designated parameter to the given input stream, which will have the specified number of bytes. More...
void	setCharacterStream ([in]long parameterIndex, [in]com::sun::star::io::XInputStream x, [in]long length) raises (SQLException)
	sets the designated parameter to the given input stream, which will have the specified number of bytes. More...
void	setObject ([in]long parameterIndex, [in]any x) raises (SQLException)
	sets the value of a parameter using an any. More...
void	setObjectWithInfo ([in]long parameterIndex, [in]any x, [in]long targetSqlType, [in]long scale) raises (SQLException)
	set a value from the Datatype ANY for a parameter. More...
void	setRef ([in]long parameterIndex, [in]XRef x) raises (SQLException)
	sets a REF(&lt;structured-type&gt;) parameter. More...
void	setBlob ([in]long parameterIndex, [in]XBlob x) raises (SQLException)
	sets a BLOB parameter. More...
void	setClob ([in]long parameterIndex, [in]XClob x) raises (SQLException)
	sets a CLOB parameter. More...
void	setArray ([in]long parameterIndex, [in]XArray x) raises (SQLException)
	sets an Array parameter. More...
void	clearParameters () raises (SQLException)
	clears the current parameter values immediately. More...
Protected Member Functions inherited from XPreparedBatchExecution
void	addBatch () raises (SQLException)
	adds a set of parameters to the batch. More...
void	clearBatch () raises (SQLException)
	makes the set of commands in the current batch empty. More...
sequence< long >	executeBatch () raises (SQLException)
	submits a batch of commands to the database for execution. More...
Protected Member Functions inherited from XWarningsSupplier
any	getWarnings () raises (SQLException)
	returns the first warning reported by calls on an object that supports the usage of warnings. More...
void	clearWarnings () raises (SQLException)
	clears all warnings reported for the object implementing the interface. More...
Protected Member Functions inherited from XMultipleResults
XResultSet	getResultSet () raises (SQLException)
	returns the current result as a com::sun::star::sdbc::ResultSet object. More...
long	getUpdateCount () raises (SQLException)
	returns the current result as an update count. More...
boolean	getMoreResults () raises (SQLException)
	moves to a Statement's next result. More...

Detailed Description

represents a precompiled SQL statement.

The service differs only in the access of the columns and parameters to the service com::sun::star::sdbc::PreparedStatement.

Exported Interfaces

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

service com::sun::star::sdbc::PreparedStatement

Exported Interfaces

com::sun::star::sdbcx::XColumnsSupplier

interface com::sun::star::sdbcx::XColumnsSupplier

access to the resulting columns of the statement.

---

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

• com/sun/star/sdb/PreparedStatement.idl