LibreOffice: com/sun/star/sdb/DataAccessDescriptor.idl Source File

LibreOffice LibreOffice 24.2 SDK API Reference

Loading...
Searching...
No Matches
DataAccessDescriptor.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
20module com { module sun { module star { module sdb {
21
37published service DataAccessDescriptor
38{
48 [optional, property] string DataSourceName;
49
58 [optional, property] string DatabaseLocation;
59
68 [optional, property] string ConnectionResource;
69
79 [optional, property] sequence< ::com::sun::star::beans::PropertyValue > ConnectionInfo;
80
94 [optional, property] com::sun::star::sdbc::XConnection ActiveConnection;
95
103 [optional, property] string Command;
104
105
115 [optional, property] long CommandType;
116
132 [optional, property] string Filter;
133
139 [optional, property] string Order;
140
146 [optional, property] string HavingClause;
147
153 [optional, property] string GroupBy;
154
165 [optional, property] boolean EscapeProcessing;
166
186 [optional, property] com::sun::star::sdbc::XResultSet ResultSet;
187
204 [optional, property] sequence< any > Selection;
205
218 [optional, property] boolean BookmarkSelection;
219
227 [optional, property] string ColumnName;
228
238 [optional, property] com::sun::star::beans::XPropertySet Column;
239};
240
241}; }; }; };
242
243/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::beans::XPropertySet
provides information about and access to the properties from an implementation.
Definition XPropertySet.idl:46
com::sun::star::sdbc::XConnection
represents a connection (session) with a specific database.
Definition XConnection.idl:50
com::sun::star::sdbc::XResultSet
provides the navigation on a table of data.
Definition XResultSet.idl:38
com
Definition Ambiguous.idl:20
com::sun::star::sdb::DataAccessDescriptor
descriptor for accessing basic data access objects.
Definition DataAccessDescriptor.idl:38
com::sun::star::sdb::DataAccessDescriptor::CommandType
long CommandType
specifies the type of the command to be executed to retrieve a result set.
Definition DataAccessDescriptor.idl:115
com::sun::star::sdb::DataAccessDescriptor::DatabaseLocation
string DatabaseLocation
specifies the URL of the database file.
Definition DataAccessDescriptor.idl:58
com::sun::star::sdb::DataAccessDescriptor::GroupBy
string GroupBy
specifies an additional GROUP BY clause which should be applied on top of the given Command.
Definition DataAccessDescriptor.idl:153
com::sun::star::sdb::DataAccessDescriptor::Filter
string Filter
specifies an additional filter to optionally use.
Definition DataAccessDescriptor.idl:132
com::sun::star::sdb::DataAccessDescriptor::Order
string Order
specifies an additional ORDER BY clause which should be applied on top of the given Command.
Definition DataAccessDescriptor.idl:139
com::sun::star::sdb::DataAccessDescriptor::Selection
sequence< any > Selection
specifies a selection to confine the records in a result set.
Definition DataAccessDescriptor.idl:204
com::sun::star::sdb::DataAccessDescriptor::Command
string Command
specifies the command to execute to retrieve a result set.
Definition DataAccessDescriptor.idl:103
com::sun::star::sdb::DataAccessDescriptor::Column
com::sun::star::beans::XPropertySet Column
specifies a column object
Definition DataAccessDescriptor.idl:238
com::sun::star::sdb::DataAccessDescriptor::BookmarkSelection
boolean BookmarkSelection
specifies how to interpret Selection
Definition DataAccessDescriptor.idl:218
com::sun::star::sdb::DataAccessDescriptor::ConnectionResource
string ConnectionResource
specifies the database URL which locates a database driver.
Definition DataAccessDescriptor.idl:68
com::sun::star::sdb::DataAccessDescriptor::ActiveConnection
com::sun::star::sdbc::XConnection ActiveConnection
is a connection to use.
Definition DataAccessDescriptor.idl:94
com::sun::star::sdb::DataAccessDescriptor::HavingClause
string HavingClause
specifies an additional HAVING clause which should be applied on top of the given Command.
Definition DataAccessDescriptor.idl:146
com::sun::star::sdb::DataAccessDescriptor::ColumnName
string ColumnName
specifies a column name.
Definition DataAccessDescriptor.idl:227
com::sun::star::sdb::DataAccessDescriptor::EscapeProcessing
boolean EscapeProcessing
specifies if the Command should be analyzed on the client side before sending it to the database serv...
Definition DataAccessDescriptor.idl:165
com::sun::star::sdb::DataAccessDescriptor::ConnectionInfo
sequence< ::com::sun::star::beans::PropertyValue > ConnectionInfo
specifies additional info to use when creating a connection from a ConnectionResource
Definition DataAccessDescriptor.idl:79
com::sun::star::sdb::DataAccessDescriptor::ResultSet
com::sun::star::sdbc::XResultSet ResultSet
specifies an already existent result set to use.
Definition DataAccessDescriptor.idl:186
com::sun::star::sdb::DataAccessDescriptor::DataSourceName
string DataSourceName
specifies the name of the datasource to access.
Definition DataAccessDescriptor.idl:48