xref: /trunk/main/offapi/com/sun/star/sdb/DatabaseAccess.idl (revision ffd38472365e95f6a578737bc9a5eb0fac624a86)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_sdb_DatabaseAccess_idl__
#define __com_sun_star_sdb_DatabaseAccess_idl__

#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif

#ifndef __com_sun_star_beans_PropertyValue_idl__
#include <com/sun/star/beans/PropertyValue.idl>
#endif

#ifndef __com_sun_star_util_XNumberFormatsSupplier_idl__
#include <com/sun/star/util/XNumberFormatsSupplier.idl>
#endif


 module com {  module sun {  module star {  module sdb {

 published interface XDatabaseAccess;
 published interface XCompletedConnection;


/** specifies a component, which controls DatabaseAccessConnections and acts like a
    shared DataSource.

    @deprecated
 */
published service DatabaseAccess
{
    // gives access to the properties.
    interface com::sun::star::beans::XPropertySet;

    /** controls the establishing of the connections.
     */
    interface XDatabaseAccess;

    /** establishing a connection with user interaction, the implementation
             is optional.
     */
    [optional] interface XCompletedConnection;

    /** is the URL of the bean.
     */
    [readonly, property] string URL;

    /** is the title of the bean.
     */
    [property] string Title;

    /** indicates a database url of the form <br>
        <code> jdbc:<em>subprotocol</em>:<em>subname</em></code> or
        <code> sdbc:<em>subprotocol</em>:<em>subname</em></code>
     */
    [property] string ConnectURL;

    /** is a list of arbitrary string tag/value pairs as
             connection arguments; normally at least a "user" and
             "password" property should be included.
     */
    [property] sequence<com::sun::star::beans::PropertyValue> ConnectInfo;

    /** determines whether modifications on the data access bean are allowed
        or not.
     */
    [readonly, property] boolean IsReadOnly;

    /** provides an object for formatting numbers.
     */
    [property] com::sun::star::util::XNumberFormatsSupplier
                        NumberFormatsSupplier;

    /** indicates that a password is always necessary.
     */
    [optional, property] boolean IsPasswordRequired;

    /** defines a list of tables, on which the bean should have it's focus.
        If empty, all tables are rejected.
    */
    [optional, property] sequence<string> TableFilter;

    /** defines a list of table types, on which the bean should have it's focus.
         If empty, all tables types are rejected.
     */
    [optional, property] sequence<string> TableTypeFilter;
};

//=============================================================================

}; }; }; };

/*===========================================================================
===========================================================================*/
#endif