1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_sdb_XDatabaseRegistrations_idl__ 25*b1cdbd2cSJim Jagielski#define __com_sun_star_sdb_XDatabaseRegistrations_idl__ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski#include <com/sun/star/container/NoSuchElementException.idl> 28*b1cdbd2cSJim Jagielski#include <com/sun/star/container/ElementExistException.idl> 29*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/IllegalArgumentException.idl> 30*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/IllegalAccessException.idl> 31*b1cdbd2cSJim Jagielski 32*b1cdbd2cSJim Jagielski//============================================================================= 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module sdb { 35*b1cdbd2cSJim Jagielski 36*b1cdbd2cSJim Jagielskiinterface XDatabaseRegistrationsListener; 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski//============================================================================= 39*b1cdbd2cSJim Jagielski 40*b1cdbd2cSJim Jagielski/** provides access to the application-wide registered databases. 41*b1cdbd2cSJim Jagielski 42*b1cdbd2cSJim Jagielski <p>This interface provides a mere wrapper around the respective configuration data, 43*b1cdbd2cSJim Jagielski this way hiding the concrete configuration structure from its clients. You should, 44*b1cdbd2cSJim Jagielski if possible at all, use this interface, instead of modifying or querying the configuration 45*b1cdbd2cSJim Jagielski data directly.</p> 46*b1cdbd2cSJim Jagielski 47*b1cdbd2cSJim Jagielski @since OpenOffice 3.3 48*b1cdbd2cSJim Jagielski */ 49*b1cdbd2cSJim Jagielskiinterface XDatabaseRegistrations 50*b1cdbd2cSJim Jagielski{ 51*b1cdbd2cSJim Jagielski /** determines whether a database is registered under the given name. 52*b1cdbd2cSJim Jagielski 53*b1cdbd2cSJim Jagielski @throws ::com::sun::star::lang::IllegalArgumentException 54*b1cdbd2cSJim Jagielski if the given name is empty 55*b1cdbd2cSJim Jagielski */ 56*b1cdbd2cSJim Jagielski boolean hasRegisteredDatabase( [in] string Name ) 57*b1cdbd2cSJim Jagielski raises ( ::com::sun::star::lang::IllegalArgumentException 58*b1cdbd2cSJim Jagielski ); 59*b1cdbd2cSJim Jagielski 60*b1cdbd2cSJim Jagielski /** returns the names of all registered databases 61*b1cdbd2cSJim Jagielski */ 62*b1cdbd2cSJim Jagielski sequence< string > 63*b1cdbd2cSJim Jagielski getRegistrationNames(); 64*b1cdbd2cSJim Jagielski 65*b1cdbd2cSJim Jagielski /** returns the location of the database registered under the given name 66*b1cdbd2cSJim Jagielski 67*b1cdbd2cSJim Jagielski @throws ::com::sun::star::lang::IllegalArgumentException 68*b1cdbd2cSJim Jagielski if the given name is empty 69*b1cdbd2cSJim Jagielski 70*b1cdbd2cSJim Jagielski @throws ::com::sun::star::container::NoSuchElementException 71*b1cdbd2cSJim Jagielski if there is no database registered under this name 72*b1cdbd2cSJim Jagielski */ 73*b1cdbd2cSJim Jagielski string getDatabaseLocation( [in] string Name ) 74*b1cdbd2cSJim Jagielski raises ( ::com::sun::star::lang::IllegalArgumentException 75*b1cdbd2cSJim Jagielski , ::com::sun::star::container::NoSuchElementException 76*b1cdbd2cSJim Jagielski ); 77*b1cdbd2cSJim Jagielski 78*b1cdbd2cSJim Jagielski /** registers a database, given by location, under a given name 79*b1cdbd2cSJim Jagielski 80*b1cdbd2cSJim Jagielski @throws ::com::sun::star::lang::IllegalArgumentException 81*b1cdbd2cSJim Jagielski if the given name is empty, or the given location is invalid. 82*b1cdbd2cSJim Jagielski 83*b1cdbd2cSJim Jagielski @throws ::com::sun::star::container::ElementExistException 84*b1cdbd2cSJim Jagielski if there already is a databases registered under the given name. 85*b1cdbd2cSJim Jagielski */ 86*b1cdbd2cSJim Jagielski void registerDatabaseLocation( [in] string Name, [in] string Location ) 87*b1cdbd2cSJim Jagielski raises ( ::com::sun::star::lang::IllegalArgumentException 88*b1cdbd2cSJim Jagielski , ::com::sun::star::container::ElementExistException 89*b1cdbd2cSJim Jagielski ); 90*b1cdbd2cSJim Jagielski 91*b1cdbd2cSJim Jagielski /** revokes the registration of a database, given by name 92*b1cdbd2cSJim Jagielski 93*b1cdbd2cSJim Jagielski @throws ::com::sun::star::lang::IllegalArgumentException 94*b1cdbd2cSJim Jagielski if the given name is empty 95*b1cdbd2cSJim Jagielski 96*b1cdbd2cSJim Jagielski @throws ::com::sun::star::container::NoSuchElementException 97*b1cdbd2cSJim Jagielski if there is no database registered under this name 98*b1cdbd2cSJim Jagielski 99*b1cdbd2cSJim Jagielski @throws ::com::sun::star::lang::IllegalAccessException 100*b1cdbd2cSJim Jagielski if the registration data for this database is read-only 101*b1cdbd2cSJim Jagielski */ 102*b1cdbd2cSJim Jagielski void revokeDatabaseLocation( [in] string Name ) 103*b1cdbd2cSJim Jagielski raises ( ::com::sun::star::lang::IllegalArgumentException 104*b1cdbd2cSJim Jagielski , ::com::sun::star::container::NoSuchElementException 105*b1cdbd2cSJim Jagielski , ::com::sun::star::lang::IllegalAccessException 106*b1cdbd2cSJim Jagielski ); 107*b1cdbd2cSJim Jagielski 108*b1cdbd2cSJim Jagielski /** changes the location of a given database registration 109*b1cdbd2cSJim Jagielski 110*b1cdbd2cSJim Jagielski @throws ::com::sun::star::lang::IllegalArgumentException 111*b1cdbd2cSJim Jagielski if the given name is empty, or the given location is invalid. 112*b1cdbd2cSJim Jagielski 113*b1cdbd2cSJim Jagielski @throws ::com::sun::star::container::NoSuchElementException 114*b1cdbd2cSJim Jagielski if there is no database registered under this name 115*b1cdbd2cSJim Jagielski 116*b1cdbd2cSJim Jagielski @throws ::com::sun::star::lang::IllegalAccessException 117*b1cdbd2cSJim Jagielski if the registration data for this database is read-only 118*b1cdbd2cSJim Jagielski */ 119*b1cdbd2cSJim Jagielski void changeDatabaseLocation( [in] string Name, [in] string NewLocation ) 120*b1cdbd2cSJim Jagielski raises ( ::com::sun::star::lang::IllegalArgumentException 121*b1cdbd2cSJim Jagielski , ::com::sun::star::container::NoSuchElementException 122*b1cdbd2cSJim Jagielski , ::com::sun::star::lang::IllegalAccessException 123*b1cdbd2cSJim Jagielski ); 124*b1cdbd2cSJim Jagielski 125*b1cdbd2cSJim Jagielski /** determines whether the registration data for a database given by name is 126*b1cdbd2cSJim Jagielski read-only. 127*b1cdbd2cSJim Jagielski 128*b1cdbd2cSJim Jagielski <p>In this case, attempts to revoke this registration will fail.</p> 129*b1cdbd2cSJim Jagielski 130*b1cdbd2cSJim Jagielski @throws ::com::sun::star::lang::IllegalArgumentException 131*b1cdbd2cSJim Jagielski if the given name is empty 132*b1cdbd2cSJim Jagielski 133*b1cdbd2cSJim Jagielski @throws ::com::sun::star::container::NoSuchElementException 134*b1cdbd2cSJim Jagielski if there is no database registered under this name 135*b1cdbd2cSJim Jagielski */ 136*b1cdbd2cSJim Jagielski boolean isDatabaseRegistrationReadOnly( [in] string Name ) 137*b1cdbd2cSJim Jagielski raises ( ::com::sun::star::lang::IllegalArgumentException 138*b1cdbd2cSJim Jagielski , ::com::sun::star::container::NoSuchElementException 139*b1cdbd2cSJim Jagielski ); 140*b1cdbd2cSJim Jagielski 141*b1cdbd2cSJim Jagielski /** registers a listener which is notified of changes in the registered databases 142*b1cdbd2cSJim Jagielski */ 143*b1cdbd2cSJim Jagielski void addDatabaseRegistrationsListener( [in] XDatabaseRegistrationsListener Listener ); 144*b1cdbd2cSJim Jagielski 145*b1cdbd2cSJim Jagielski /** revokes a previously registered listener 146*b1cdbd2cSJim Jagielski */ 147*b1cdbd2cSJim Jagielski void removeDatabaseRegistrationsListener( [in] XDatabaseRegistrationsListener Listener ); 148*b1cdbd2cSJim Jagielski}; 149*b1cdbd2cSJim Jagielski 150*b1cdbd2cSJim Jagielski//============================================================================= 151*b1cdbd2cSJim Jagielski 152*b1cdbd2cSJim Jagielski}; }; }; }; 153*b1cdbd2cSJim Jagielski 154*b1cdbd2cSJim Jagielski//============================================================================= 155*b1cdbd2cSJim Jagielski 156*b1cdbd2cSJim Jagielski#endif 157