LibreOffice: com/sun/star/sdb/XDatabaseRegistrations.idl Source File

LibreOffice LibreOffice 7.3 SDK API Reference

XDatabaseRegistrations.idl
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20#ifndef __com_sun_star_sdb_XDatabaseRegistrations_idl__
21#define __com_sun_star_sdb_XDatabaseRegistrations_idl__
22
23#include <com/sun/star/container/NoSuchElementException.idl>
24#include <com/sun/star/container/ElementExistException.idl>
25#include <com/sun/star/lang/IllegalArgumentException.idl>
26#include <com/sun/star/lang/IllegalAccessException.idl>
27
28
29module com { module sun { module star { module sdb {
30
31published interface XDatabaseRegistrationsListener;
32
33
43published interface XDatabaseRegistrations
44{
50 boolean hasRegisteredDatabase( [in] string Name )
51 raises ( ::com::sun::star::lang::IllegalArgumentException
52 );
53
56 sequence< string >
57 getRegistrationNames();
58
67 string getDatabaseLocation( [in] string Name )
68 raises ( ::com::sun::star::lang::IllegalArgumentException
69 , ::com::sun::star::container::NoSuchElementException
70 );
71
80 void registerDatabaseLocation( [in] string Name, [in] string Location )
81 raises ( ::com::sun::star::lang::IllegalArgumentException
82 , ::com::sun::star::container::ElementExistException
83 );
84
96 void revokeDatabaseLocation( [in] string Name )
97 raises ( ::com::sun::star::lang::IllegalArgumentException
98 , ::com::sun::star::container::NoSuchElementException
99 , ::com::sun::star::lang::IllegalAccessException
100 );
101
113 void changeDatabaseLocation( [in] string Name, [in] string NewLocation )
114 raises ( ::com::sun::star::lang::IllegalArgumentException
115 , ::com::sun::star::container::NoSuchElementException
116 , ::com::sun::star::lang::IllegalAccessException
117 );
118
130 boolean isDatabaseRegistrationReadOnly( [in] string Name )
131 raises ( ::com::sun::star::lang::IllegalArgumentException
132 , ::com::sun::star::container::NoSuchElementException
133 );
134
137 void addDatabaseRegistrationsListener( [in] XDatabaseRegistrationsListener Listener );
138
141 void removeDatabaseRegistrationsListener( [in] XDatabaseRegistrationsListener Listener );
142};
143
144
145}; }; }; };
146
147
148#endif
149
150/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
ElementExistException.idl
IllegalAccessException.idl
IllegalArgumentException.idl
NoSuchElementException.idl
com::sun::star::container::ElementExistException
is thrown by container methods, if an element is added which is already a child of the container.
Definition: ElementExistException.idl:39
com::sun::star::container::NoSuchElementException
is thrown by child access methods of collections, if the addressed child does not exist.
Definition: NoSuchElementException.idl:35
com::sun::star::lang::IllegalAccessException
This exception is thrown when an application tries to change a constant property.
Definition: IllegalAccessException.idl:32
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:31
com::sun::star::sdb::XDatabaseRegistrationsListener
implemented by components which want to be notified of changes in the application-wide registered dat...
Definition: XDatabaseRegistrationsListener.idl:38
com::sun::star::sdb::XDatabaseRegistrations
provides access to the application-wide registered databases.
Definition: XDatabaseRegistrations.idl:44
com::sun::star::sdb::XDatabaseRegistrations::getRegistrationNames
sequence< string > getRegistrationNames()
returns the names of all registered databases
com::sun::star::sdb::XDatabaseRegistrations::isDatabaseRegistrationReadOnly
boolean isDatabaseRegistrationReadOnly([in] string Name)
determines whether the registration data for a database given by name is read-only.
com::sun::star::sdb::XDatabaseRegistrations::addDatabaseRegistrationsListener
void addDatabaseRegistrationsListener([in] XDatabaseRegistrationsListener Listener)
registers a listener which is notified of changes in the registered databases
com::sun::star::sdb::XDatabaseRegistrations::changeDatabaseLocation
void changeDatabaseLocation([in] string Name, [in] string NewLocation)
changes the location of a given database registration
com::sun::star::sdb::XDatabaseRegistrations::revokeDatabaseLocation
void revokeDatabaseLocation([in] string Name)
revokes the registration of a database, given by name
com::sun::star::sdb::XDatabaseRegistrations::registerDatabaseLocation
void registerDatabaseLocation([in] string Name, [in] string Location)
registers a database, given by location, under a given name
com::sun::star::sdb::XDatabaseRegistrations::hasRegisteredDatabase
boolean hasRegisteredDatabase([in] string Name)
determines whether a database is registered under the given name.
com::sun::star::sdb::XDatabaseRegistrations::removeDatabaseRegistrationsListener
void removeDatabaseRegistrationsListener([in] XDatabaseRegistrationsListener Listener)
revokes a previously registered listener
com::sun::star::sdb::XDatabaseRegistrations::getDatabaseLocation
string getDatabaseLocation([in] string Name)
returns the location of the database registered under the given name
com
Definition: Accessible.idl:22