offapi/com/sun/star/sdbcx/DatabaseDefinition.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 sdbcx {
  21
  22  published interface XTablesSupplier;
  23  published interface XViewsSupplier;
  24  published interface XUsersSupplier;
  25  published interface XGroupsSupplier;
  26
  27
  28 /** could be used as an extension for performing data definition tasks on
  29     databases, and to control the access rights on database objects.
  30
  31
  32     <p>
  33     It may be implemented by a database driver provider, to encapsulate the
  34     complexity of data definition, and to give a common way for data definition as
  35     the DDL of most DBMS differs.
  36     </p>
  37     <p>
  38     At least, the access to the tables of a database should be implemented.
  39     The implementation of other known database objects like views is optional.
  40     </p>
  41     <p>
  42     To control the access rights of users, there is the possibility to
  43     implement objects like users and groups.
  44     </p>
  45  */
  46 published service DatabaseDefinition
  47 {
  48     // gives access to the tables.
  49     interface XTablesSupplier;
  50
  51     /** The implementation is optional.
  52      */
  53     [optional] interface XViewsSupplier;
  54
  55     /** The implementation is optional.
  56      */
  57     [optional] interface XUsersSupplier;
  58
  59     /** The implementation is optional.
  60      */
  61     [optional] interface XGroupsSupplier;
  62 };
  63
  64
  65 }; }; }; };
  66
  67 /*===========================================================================
  68 ===========================================================================*/
  69
  70 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */