offapi/com/sun/star/sdb/XDatabaseContext.idl

   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 module com {  module sun {  module star {  module sdb {
  21
  22 /**
  23     Provides an interface for the new-style DatabaseContext service to implement.
  24
  25     @since LibreOffice 4.0
  26  */
  27 published interface XDatabaseContext
  28 {
  29     /** Enumeration on all registered data sources.
  30      */
  31     interface com::sun::star::container::XEnumerationAccess;
  32
  33     /** NameAccess on all registered data sources.
  34         <p>One exception is the com.sun.star.container.XNameAccess::getByName().
  35         This method also allows to ask
  36         for a DataAccessDescriptor::DatabaseLocation.
  37         </p>
  38      */
  39     interface com::sun::star::container::XNameAccess;
  40
  41     /** Interface for registering new datasources.
  42      */
  43     interface com::sun::star::uno::XNamingService;
  44
  45     /** Interface for registering listener to get notified when new datasources are created or removed.
  46     */
  47     interface com::sun::star::container::XContainer;
  48
  49     /** Interface for creation of new datasources.
  50     */
  51     interface com::sun::star::lang::XSingleServiceFactory;
  52
  53     /** allows to access and modify the configuration data for registered data source.
  54
  55         <p>The main purpose of this interface is to allow you to register data sources which you know
  56         by URL only, and have not yet loaded.</p>
  57
  58         <p>Also, it hides the details of the configuration data where the data source registrations
  59         are maintained, so if possible at all, you should use this interface, instead of modifying or
  60         querying the configuration data directly.</p>
  61
  62         @since OOo 3.3
  63     */
  64     interface XDatabaseRegistrations;
  65 };
  66
  67
  68 }; }; }; };
  69
  70 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */