offapi/com/sun/star/sdbcx/DatabaseDefinition.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_sdbcx_DatabaseDefinition_idl__
  29 #define __com_sun_star_sdbcx_DatabaseDefinition_idl__
  30
  31  module com {  module sun {  module star {  module sdbcx {
  32
  33  published interface XTablesSupplier;
  34  published interface XViewsSupplier;
  35  published interface XUsersSupplier;
  36  published interface XGroupsSupplier;
  37
  38
  39 /** could be used as an extension for performing data definition tasks on
  40     databases, and to control the access rights on database objects.
  41
  42
  43     <p>
  44     It may be implemented by a database driver provider, to encapsulate the
  45     complexity of data definition, and to give a common way for data definition as
  46     the DDL of most DBMS differs.
  47     </p>
  48     <p>
  49     At least, the access to the tables of a database should be implemented.
  50     The implementation of other known database objects like views is optional.
  51     </p>
  52     <p>
  53     To control the access rights of users, there is the possibility to
  54     implement objects like users and groups.
  55     </p>
  56  */
  57 published service DatabaseDefinition
  58 {
  59     // gives access to the tables.
  60     interface XTablesSupplier;
  61
  62     /** The implementation is optional.
  63      */
  64     [optional] interface XViewsSupplier;
  65
  66     /** The implementation is optional.
  67      */
  68     [optional] interface XUsersSupplier;
  69
  70     /** The implementation is optional.
  71      */
  72     [optional] interface XGroupsSupplier;
  73 };
  74
  75 //=============================================================================
  76
  77 }; }; }; };
  78
  79 /*===========================================================================
  80 ===========================================================================*/
  81 #endif
  82
  83 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */