LibreOffice
LibreOffice 6.2 SDK API Reference
Exported Interfaces | List of all members
XDatabaseContext Interface Referencepublished

Provides an interface for the new-style DatabaseContext service to implement. More...

import"XDatabaseContext.idl";

Inheritance diagram for XDatabaseContext:
XEnumerationAccess XNameAccess XNamingService XContainer XSingleServiceFactory XDatabaseRegistrations XElementAccess XElementAccess XInterface XInterface XInterface XInterface XInterface DatabaseContext

Exported Interfaces

interface com::sun::star::container::XEnumerationAccess
 Enumeration on all registered data sources. More...
 
interface com::sun::star::container::XNameAccess
 NameAccess on all registered data sources. More...
 
interface com::sun::star::uno::XNamingService
 Interface for registering new datasources. More...
 
interface com::sun::star::container::XContainer
 Interface for registering listener to get notified when new datasources are created or removed. More...
 
interface com::sun::star::lang::XSingleServiceFactory
 Interface for creation of new datasources. More...
 
interface XDatabaseRegistrations
 allows to access and modify the configuration data for registered data source. More...
 

Additional Inherited Members

- Public Member Functions inherited from XEnumerationAccess
com::sun::star::container::XEnumeration createEnumeration ()
 
- Public Member Functions inherited from XElementAccess
type getElementType ()
 
boolean hasElements ()
 
- 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 XNameAccess
any getByName ([in] string aName) raises ( com::sun::star::container::NoSuchElementException, com::sun::star::lang::WrappedTargetException )
 
sequence< string > getElementNames ()
 
boolean hasByName ([in] string aName)
 
- Public Member Functions inherited from XNamingService
com::sun::star::uno::XInterface getRegisteredObject ([in] string Name) raises (Exception)
 provides a previous registered object. More...
 
void registerObject ([in]string Name, [in]com::sun::star::uno::XInterface Object) raises (Exception)
 registers one object under the specified name. More...
 
void revokeObject ([in]string Name) raises (Exception)
 revokes the registration of an object. More...
 
- Public Member Functions inherited from XContainer
void addContainerListener ([in] com::sun::star::container::XContainerListener xListener)
 adds the specified listener to receive events when elements are inserted or removed. More...
 
void removeContainerListener ([in] com::sun::star::container::XContainerListener xListener)
 removes the specified listener so it does not receive any events from this container. More...
 
- Public Member Functions inherited from XSingleServiceFactory
com::sun::star::uno::XInterface createInstance () raises ( com::sun::star::uno::Exception )
 Creates an instance of a service implementation. More...
 
com::sun::star::uno::XInterface createInstanceWithArguments ([in] sequence< any > aArguments) raises ( com::sun::star::uno::Exception )
 Creates an instance of a service implementation initialized with some arguments. More...
 
- Public Member Functions inherited from XDatabaseRegistrations
boolean hasRegisteredDatabase ([in] string Name) raises ( ::com::sun::star::lang::IllegalArgumentException )
 determines whether a database is registered under the given name. More...
 
sequence< string > getRegistrationNames ()
 returns the names of all registered databases More...
 
string getDatabaseLocation ([in] string Name) raises ( ::com::sun::star::lang::IllegalArgumentException , ::com::sun::star::container::NoSuchElementException )
 returns the location of the database registered under the given name More...
 
void registerDatabaseLocation ([in] string Name, [in] string Location) raises ( ::com::sun::star::lang::IllegalArgumentException , ::com::sun::star::container::ElementExistException )
 registers a database, given by location, under a given name More...
 
void revokeDatabaseLocation ([in] string Name) raises ( ::com::sun::star::lang::IllegalArgumentException , ::com::sun::star::container::NoSuchElementException , ::com::sun::star::lang::IllegalAccessException )
 revokes the registration of a database, given by name More...
 
void changeDatabaseLocation ([in] string Name, [in] string NewLocation) raises ( ::com::sun::star::lang::IllegalArgumentException , ::com::sun::star::container::NoSuchElementException , ::com::sun::star::lang::IllegalAccessException )
 changes the location of a given database registration More...
 
boolean isDatabaseRegistrationReadOnly ([in] string Name) raises ( ::com::sun::star::lang::IllegalArgumentException , ::com::sun::star::container::NoSuchElementException )
 determines whether the registration data for a database given by name is read-only. More...
 
void addDatabaseRegistrationsListener ([in] XDatabaseRegistrationsListener Listener)
 registers a listener which is notified of changes in the registered databases More...
 
void removeDatabaseRegistrationsListener ([in] XDatabaseRegistrationsListener Listener)
 revokes a previously registered listener More...
 

Detailed Description

Provides an interface for the new-style DatabaseContext service to implement.

Since
LibreOffice 4.0

Exported Interfaces

Interface for registering listener to get notified when new datasources are created or removed.

Enumeration on all registered data sources.

NameAccess on all registered data sources.

One exception is the com.sun.star.container.XNameAccess::getByName(). This method also allows to ask for a DataAccessDescriptor::DatabaseLocation.

Interface for creation of new datasources.

Interface for registering new datasources.

allows to access and modify the configuration data for registered data source.

The main purpose of this interface is to allow you to register data sources which you know by URL only, and have not yet loaded.

Also, it hides the details of the configuration data where the data source registrations are maintained, so if possible at all, you should use this interface, instead of modifying or querying the configuration data directly.

Since
OOo 3.3

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