LibreOffice LibreOffice 7.2 SDK API Reference

DatabaseAccess.idl
Go to the documentation of this file.
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#ifndef __com_sun_star_sdb_DatabaseAccess_idl__
20#define __com_sun_star_sdb_DatabaseAccess_idl__
21
22#include <com/sun/star/beans/XPropertySet.idl>
23
24#include <com/sun/star/beans/PropertyValue.idl>
25
26#include <com/sun/star/util/XNumberFormatsSupplier.idl>
27
28
29 module com { module sun { module star { module sdb {
30
31 published interface XDatabaseAccess;
32 published interface XCompletedConnection;
33
34
40published service DatabaseAccess
41{
42 // gives access to the properties.
43 interface com::sun::star::beans::XPropertySet;
44
47 interface XDatabaseAccess;
48
52 [optional] interface XCompletedConnection;
53
56 [readonly, property] string URL;
57
60 [property] string Title;
61
66 [property] string ConnectURL;
67
72 [property] sequence<com::sun::star::beans::PropertyValue> ConnectInfo;
73
77 [readonly, property] boolean IsReadOnly;
78
81 [property] com::sun::star::util::XNumberFormatsSupplier
82 NumberFormatsSupplier;
83
86 [optional, property] boolean IsPasswordRequired;
87
91 [optional, property] sequence<string> TableFilter;
92
96 [optional, property] sequence<string> TableTypeFilter;
97};
98
99
100}; }; }; };
101
102/*===========================================================================
103===========================================================================*/
104#endif
105
106/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
PropertyValue.idl
XNumberFormatsSupplier.idl
XPropertySet.idl
com::sun::star::beans::XPropertySet
provides information about and access to the properties from an implementation.
Definition: XPropertySet.idl:64
com::sun::star::sdb::XCompletedConnection
is used for establishing connections via a factory which is identified by its name.
Definition: XCompletedConnection.idl:38
com::sun::star::sdb::XDatabaseAccess
is not to be used anymore
Definition: XDatabaseAccess.idl:42
com::sun::star::util::XNumberFormatsSupplier
supplies the collection of NumberFormats (for example, in a document) and the settings belonging to t...
Definition: XNumberFormatsSupplier.idl:37
com
Definition: Accessible.idl:22
com::sun::star::sdb::DatabaseAccess
specifies a component, which controls DatabaseAccessConnections and acts like a shared DataSource.
Definition: DatabaseAccess.idl:41
com::sun::star::sdb::DatabaseAccess::TableTypeFilter
sequence< string > TableTypeFilter
defines a list of table types, on which the bean should have it's focus.
Definition: DatabaseAccess.idl:96
com::sun::star::sdb::DatabaseAccess::IsPasswordRequired
boolean IsPasswordRequired
indicates that a password is always necessary.
Definition: DatabaseAccess.idl:86
com::sun::star::sdb::DatabaseAccess::ConnectURL
string ConnectURL
indicates a database url of the form jdbc:subprotocol:subname or sdbc:subprotocol:subname
Definition: DatabaseAccess.idl:66
com::sun::star::sdb::DatabaseAccess::Title
string Title
is the title of the bean.
Definition: DatabaseAccess.idl:60
com::sun::star::sdb::DatabaseAccess::IsReadOnly
boolean IsReadOnly
determines whether modifications on the data access bean are allowed or not.
Definition: DatabaseAccess.idl:77
com::sun::star::sdb::DatabaseAccess::ConnectInfo
sequence< com::sun::star::beans::PropertyValue > ConnectInfo
is a list of arbitrary string tag/value pairs as connection arguments; normally at least a "user" and...
Definition: DatabaseAccess.idl:72
com::sun::star::sdb::DatabaseAccess::NumberFormatsSupplier
com::sun::star::util::XNumberFormatsSupplier NumberFormatsSupplier
provides an object for formatting numbers.
Definition: DatabaseAccess.idl:82
com::sun::star::sdb::DatabaseAccess::TableFilter
sequence< string > TableFilter
defines a list of tables, on which the bean should have it's focus.
Definition: DatabaseAccess.idl:91
com::sun::star::sdb::DatabaseAccess::URL
string URL
is the URL of the bean.
Definition: DatabaseAccess.idl:52