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

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