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