LibreOffice
LibreOffice 24.8 SDK API Reference
Loading...
Searching...
No Matches
DatabaseAccess Service Referencepublished

specifies a component, which controls DatabaseAccessConnections and acts like a shared DataSource. More...

import <DatabaseAccess.idl;

Inheritance diagram for DatabaseAccess:
XPropertySet XDatabaseAccess XCompletedConnection XInterface XDataSource XInterface XInterface

Public Types

typedef sequence< com::sun::star::beans::PropertyValueConnectInfo
 is a list of arbitrary string tag/value pairs as connection arguments; normally at least a "user" and "password" property should be included.
 
typedef sequence< string > TableFilter
 defines a list of tables, on which the bean should have it's focus.
 
typedef sequence< string > TableTypeFilter
 defines a list of table types, on which the bean should have it's focus.
 

Exported Interfaces

interface com::sun::star::beans::XPropertySet
 
interface XDatabaseAccess
 controls the establishing of the connections.
 
interface XCompletedConnection
 establishing a connection with user interaction, the implementation is optional.
 

Public Attributes

string URL
 is the URL of the bean.
 
string Title
 is the title of the bean.
 
string ConnectURL
 indicates a database url of the form
jdbc:subprotocol:subname or sdbc:subprotocol:subname
 
boolean IsReadOnly
 determines whether modifications on the data access bean are allowed or not.
 
com::sun::star::util::XNumberFormatsSupplier NumberFormatsSupplier
 provides an object for formatting numbers.
 
boolean IsPasswordRequired
 indicates that a password is always necessary.
 

Additional Inherited Members

- 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.
 
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.
 
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.
 
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.
 
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.
 
- 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.
 
- Public Member Functions inherited from XDatabaseAccess
boolean hasConnections ()
 
com::sun::star::sdbc::XConnection getIsolatedConnection ([in]string user, [in]string password) raises (com::sun::star::sdbc::SQLException)
 
boolean suspendConnections () raises (com::sun::star::sdbc::SQLException)
 
void addDatabaseAccessListener ([in]XDatabaseAccessListener listener)
 
void removeDatabaseAccessListener ([in]XDatabaseAccessListener listener)
 
- Public Member Functions inherited from XDataSource
XConnection getConnection ([in]string user, [in]string password) raises (SQLException)
 attempts to establish a database connection.
 
void setLoginTimeout ([in]long seconds) raises (SQLException)
 sets the maximum time in seconds that this data source will wait while attempting to connect to a database.
 
long getLoginTimeout () raises (SQLException)
 gets the maximum time in seconds that this data source can wait while attempting to connect to a database.
 
- Protected Member Functions inherited from XCompletedConnection
com::sun::star::sdbc::XConnection connectWithCompletion ([in]com::sun::star::task::XInteractionHandler handler) raises (com::sun::star::sdbc::SQLException)
 attempts to establish a database connection.
 

Detailed Description

specifies a component, which controls DatabaseAccessConnections and acts like a shared DataSource.

Deprecated

Member Typedef Documentation

◆ ConnectInfo

is a list of arbitrary string tag/value pairs as connection arguments; normally at least a "user" and "password" property should be included.

◆ TableFilter

sequence<string> TableFilter
optionalproperty

defines a list of tables, on which the bean should have it's focus.

If empty, all tables are rejected.

◆ TableTypeFilter

sequence<string> TableTypeFilter
optionalproperty

defines a list of table types, on which the bean should have it's focus.

If empty, all tables types are rejected.

Exported Interfaces

◆ com::sun::star::beans::XPropertySet

◆ XCompletedConnection

interface XCompletedConnection
optional

establishing a connection with user interaction, the implementation is optional.

◆ XDatabaseAccess

interface XDatabaseAccess

controls the establishing of the connections.

Member Data Documentation

◆ ConnectURL

string ConnectURL
property

indicates a database url of the form
jdbc:subprotocol:subname or sdbc:subprotocol:subname

◆ IsPasswordRequired

boolean IsPasswordRequired
optionalproperty

indicates that a password is always necessary.

◆ IsReadOnly

boolean IsReadOnly
propertyreadonly

determines whether modifications on the data access bean are allowed or not.

◆ NumberFormatsSupplier

com::sun::star::util::XNumberFormatsSupplier NumberFormatsSupplier
property

provides an object for formatting numbers.

◆ Title

string Title
property

is the title of the bean.

◆ URL

string URL
propertyreadonly

is the URL of the bean.


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