offapi/com/sun/star/sdb/DatabaseAccess.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
  21  module com {  module sun {  module star {  module sdb {
  22
  23  published interface XDatabaseAccess;
  24  published interface XCompletedConnection;
  25
  26
  27 /** specifies a component, which controls DatabaseAccessConnections and acts like a
  28     shared DataSource.
  29
  30     @deprecated
  31  */
  32 published service DatabaseAccess
  33 {
  34     // gives access to the properties.
  35     interface com::sun::star::beans::XPropertySet;
  36
  37     /** controls the establishing of the connections.
  38      */
  39     interface XDatabaseAccess;
  40
  41     /** establishing a connection with user interaction, the implementation
  42              is optional.
  43      */
  44     [optional] interface XCompletedConnection;
  45
  46     /** is the URL of the bean.
  47      */
  48     [readonly, property] string URL;
  49
  50     /** is the title of the bean.
  51      */
  52     [property] string Title;
  53
  54     /** indicates a database url of the form <br>
  55         <code> jdbc:<em>subprotocol</em>:<em>subname</em></code> or
  56         <code> sdbc:<em>subprotocol</em>:<em>subname</em></code>
  57      */
  58     [property] string ConnectURL;
  59
  60     /** is a list of arbitrary string tag/value pairs as
  61              connection arguments; normally at least a "user" and
  62              "password" property should be included.
  63      */
  64     [property] sequence<com::sun::star::beans::PropertyValue> ConnectInfo;
  65
  66     /** determines whether modifications on the data access bean are allowed
  67         or not.
  68      */
  69     [readonly, property] boolean IsReadOnly;
  70
  71     /** provides an object for formatting numbers.
  72      */
  73     [property] com::sun::star::util::XNumberFormatsSupplier
  74                         NumberFormatsSupplier;
  75
  76     /** indicates that a password is always necessary.
  77      */
  78     [optional, property] boolean IsPasswordRequired;
  79
  80     /** defines a list of tables, on which the bean should have it's focus.
  81         If empty, all tables are rejected.
  82     */
  83     [optional, property] sequence<string> TableFilter;
  84
  85     /** defines a list of table types, on which the bean should have it's focus.
  86          If empty, all tables types are rejected.
  87      */
  88     [optional, property] sequence<string> TableTypeFilter;
  89 };
  90
  91
  92 }; }; }; };
  93
  94 /*===========================================================================
  95 ===========================================================================*/
  96
  97 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */