:: com :: sun :: star :: sdb ::

interface XDatabaseRegistrations

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