Overview | Module | Use | Devguide | Index

Methods' Summary | Methods' Details | Attributes' Summary | Attributes' Details

:: com :: sun :: star :: sdbc ::
interface XDataSource
  Base Hierarchy
      ::com::sun::star::uno::XInterface
       |
       +-XDataSource
Description is used for establishing connections via a factory which is identified by its name. A DataSource object is typically registered by a naming service provider. Developers Guide 12.2.3 Database Access - Data Sources in OpenOffice.org API - Connections - Understanding Connections - Operation on Application Level

Methods' Summary
getConnection | attempts to establish a database connection.
setLoginTimeout | sets the maximum time in seconds that this data source will wait while attempting to connect to a database.
getLoginTimeout | gets the maximum time in seconds that this data source can wait while attempting to connect to a database.

Methods' Details
getConnection
XConnection getConnection( | [in] string [in] string raises( | user, password ) SQLException );
Description attempts to establish a database connection. Parameter user the user name Parameter password the password Returns the connection object Throws SQLException if a database access error occurs.
setLoginTimeout
void setLoginTimeout( | [in] long raises( | seconds ) SQLException );
Description sets the maximum time in seconds that this data source will wait while attempting to connect to a database. A value of zero specifies that the timeout is the default system timeout if there is one; otherwise, it specifies that there is no timeout. When a DataSource object is created the login timeout is initially zero. Parameter seconds the login time limit in seconds Throws SQLException if a database access error occurs.
getLoginTimeout
long getLoginTimeout() | raises( | SQLException );
Description gets the maximum time in seconds that this data source can wait while attempting to connect to a database. A value of zero means that the timeout is the default system timeout if there is one; otherwise, it means that there is no timeout. When a DataSource object is created the login timeout is initially zero. Returns the login time limit in seconds Throws SQLException if a database access error occurs.

Top of Page

Copyright © 2003 Sun Microsystems, Inc.