Overview | Module | Use | Devguide | Index

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

:: com :: sun :: star :: sdb ::
interface XDatabaseRegistrations
Description provides access to the application-wide registered databases. This interface provides a mere wrapper around the respective configuration data, this way hiding the concrete configuration structure from its clients. You should, if possible at all, use this interface, instead of modifying or querying the configuration data directly. Since OOo 3.3

Methods' Summary
hasRegisteredDatabase | determines whether a database is registered under the given name.
getRegistrationNames | returns the names of all registered databases
getDatabaseLocation | returns the location of the database registered under the given name
registerDatabaseLocation | registers a database, given by location, under a given name
revokeDatabaseLocation | revokes the registration of a database, given by name
changeDatabaseLocation | changes the location of a given database registration
isDatabaseRegistrationReadOnly | determines whether the registration data for a database given by name is read-only.
addDatabaseRegistrationsListener | registers a listener which is notified of changes in the registered databases
removeDatabaseRegistrationsListener | revokes a previously registered listener

Methods' Details
hasRegisteredDatabase
boolean
hasRegisteredDatabase( | [in] string | Name )
raises( | ::com::sun::star::lang::IllegalArgumentException );
Description determines whether a database is registered under the given name. Throws ::com::sun::star::lang::IllegalArgumentException if the given name is empty
getRegistrationNames
sequence< string >
getRegistrationNames();
Description returns the names of all registered databases
getDatabaseLocation
string
getDatabaseLocation( | [in] string | Name )
raises( | ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::container::NoSuchElementException );
Description returns the location of the database registered under the given name Throws ::com::sun::star::lang::IllegalArgumentException if the given name is empty Throws ::com::sun::star::container::NoSuchElementException if there is no database registered under this name
registerDatabaseLocation
void
registerDatabaseLocation( | [in] string | Name,
| [in] string | Location )
raises( | ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::container::ElementExistException );
Description registers a database, given by location, under a given name Throws ::com::sun::star::lang::IllegalArgumentException if the given name is empty, or the given location is invalid. Throws ::com::sun::star::container::ElementExistException if there already is a databases registered under the given name.
revokeDatabaseLocation
void
revokeDatabaseLocation( | [in] string | Name )
raises( | ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::container::NoSuchElementException, ::com::sun::star::lang::IllegalAccessException );
Description revokes the registration of a database, given by name Throws ::com::sun::star::lang::IllegalArgumentException if the given name is empty Throws ::com::sun::star::container::NoSuchElementException if there is no database registered under this name Throws ::com::sun::star::lang::IllegalAccessException if the registration data for this database is read-only
changeDatabaseLocation
void
changeDatabaseLocation( | [in] string | Name,
| [in] string | NewLocation )
raises( | ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::container::NoSuchElementException, ::com::sun::star::lang::IllegalAccessException );
Description changes the location of a given database registration Throws ::com::sun::star::lang::IllegalArgumentException if the given name is empty, or the given location is invalid. Throws ::com::sun::star::container::NoSuchElementException if there is no database registered under this name Throws ::com::sun::star::lang::IllegalAccessException if the registration data for this database is read-only
isDatabaseRegistrationReadOnly
boolean
isDatabaseRegistrationReadOnly( | [in] string | Name )
raises( | ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::container::NoSuchElementException );
Description determines whether the registration data for a database given by name is read-only. In this case, attempts to revoke this registration will fail. Throws ::com::sun::star::lang::IllegalArgumentException if the given name is empty Throws ::com::sun::star::container::NoSuchElementException if there is no database registered under this name
addDatabaseRegistrationsListener
void
addDatabaseRegistrationsListener( | [in] XDatabaseRegistrationsListener | Listener );
Description registers a listener which is notified of changes in the registered databases
removeDatabaseRegistrationsListener
void
removeDatabaseRegistrationsListener( | [in] XDatabaseRegistrationsListener | Listener );
Description revokes a previously registered listener

Top of Page

Copyright © 2000, 2014 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.