offapi/com/sun/star/sdb/DatabaseAccess.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: DatabaseAccess.idl,v $
  10  * $Revision: 1.12 $
  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_sdb_DatabaseAccess_idl__
  31 #define __com_sun_star_sdb_DatabaseAccess_idl__
  32
  33 #ifndef __com_sun_star_beans_XPropertySet_idl__
  34 #include <com/sun/star/beans/XPropertySet.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_beans_PropertyValue_idl__
  38 #include <com/sun/star/beans/PropertyValue.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_util_XNumberFormatsSupplier_idl__
  42 #include <com/sun/star/util/XNumberFormatsSupplier.idl>
  43 #endif
  44
  45
  46  module com {  module sun {  module star {  module sdb {
  47
  48  published interface XDatabaseAccess;
  49  published interface XCompletedConnection;
  50
  51
  52 /** specifies a component, which controls DatabaseAccessConnections and acts like a
  53     shared DataSource.
  54
  55     @deprecated
  56  */
  57 published service DatabaseAccess
  58 {
  59     // gives access to the properties.
  60     interface com::sun::star::beans::XPropertySet;
  61
  62     /** controls the establishing of the connections.
  63      */
  64     interface XDatabaseAccess;
  65
  66     /** establishing a connection with user interaction, the implementation
  67              is optional.
  68      */
  69     [optional] interface XCompletedConnection;
  70
  71     /** is the URL of the bean.
  72      */
  73     [readonly, property] string URL;
  74
  75     /** is the title of the bean.
  76      */
  77     [property] string Title;
  78
  79     /** indicates a database url of the form <br>
  80         <code> jdbc:<em>subprotocol</em>:<em>subname</em></code> or
  81         <code> sdbc:<em>subprotocol</em>:<em>subname</em></code>
  82      */
  83     [property] string ConnectURL;
  84
  85     /** is a list of arbitrary string tag/value pairs as
  86              connection arguments; normally at least a "user" and
  87              "password" property should be included.
  88      */
  89     [property] sequence<com::sun::star::beans::PropertyValue> ConnectInfo;
  90
  91     /** determines whether modifications on the data access bean are allowed
  92         or not.
  93      */
  94     [readonly, property] boolean IsReadOnly;
  95
  96     /** provides an object for formatting numbers.
  97      */
  98     [property] com::sun::star::util::XNumberFormatsSupplier
  99                         NumberFormatsSupplier;
 100
 101     /** indicates that a password is always necessary.
 102      */
 103     [optional, property] boolean IsPasswordRequired;
 104
 105     /** defines a list of tables, on which the bean should have it's focus.
 106         If empty, all tables are rejected.
 107     */
 108     [optional, property] sequence<string> TableFilter;
 109
 110     /** defines a list of table types, on which the bean should have it's focus.
 111          If empty, all tables types are rejected.
 112      */
 113     [optional, property] sequence<string> TableTypeFilter;
 114 };
 115
 116 //=============================================================================
 117
 118 }; }; }; };
 119
 120 /*===========================================================================
 121 ===========================================================================*/
 122 #endif