LibreOffice
LibreOffice 7.3 SDK API Reference
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 
20 #ifndef __com_sun_star_sdb_DataAccessDescriptor_idl__
21 #define __com_sun_star_sdb_DataAccessDescriptor_idl__
22 
27 
28 module com { module sun { module star { module sdb {
29 
45 published service DataAccessDescriptor
46 {
56  [optional, property] string DataSourceName;
57 
66  [optional, property] string DatabaseLocation;
67 
76  [optional, property] string ConnectionResource;
77 
87  [optional, property] sequence< ::com::sun::star::beans::PropertyValue > ConnectionInfo;
88 
103 
111  [optional, property] string Command;
112 
113 
123  [optional, property] long CommandType;
124 
140  [optional, property] string Filter;
141 
147  [optional, property] string Order;
148 
154  [optional, property] string HavingClause;
155 
161  [optional, property] string GroupBy;
162 
173  [optional, property] boolean EscapeProcessing;
174 
195 
212  [optional, property] sequence< any > Selection;
213 
226  [optional, property] boolean BookmarkSelection;
227 
235  [optional, property] string ColumnName;
236 
247 };
248 
249 }; }; }; };
250 
251 #endif
252 
253 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
provides information about and access to the properties from an implementation.
Definition: XPropertySet.idl:64
represents a connection (session) with a specific database.
Definition: XConnection.idl:58
provides the navigation on a table of data.
Definition: XResultSet.idl:44
Definition: Ambiguous.idl:22
descriptor for accessing basic data access objects.
Definition: DataAccessDescriptor.idl:46
long CommandType
specifies the type of the command to be executed to retrieve a result set.
Definition: DataAccessDescriptor.idl:123
string DatabaseLocation
specifies the URL of the database file.
Definition: DataAccessDescriptor.idl:66
string GroupBy
specifies an additional GROUP BY clause which should be applied on top of the given Command.
Definition: DataAccessDescriptor.idl:161
string Filter
specifies an additional filter to optionally use.
Definition: DataAccessDescriptor.idl:140
string Order
specifies an additional ORDER BY clause which should be applied on top of the given Command.
Definition: DataAccessDescriptor.idl:147
sequence< any > Selection
specifies a selection to confine the records in a result set.
Definition: DataAccessDescriptor.idl:212
string Command
specifies the command to execute to retrieve a result set.
Definition: DataAccessDescriptor.idl:111
com::sun::star::beans::XPropertySet Column
specifies a column object
Definition: DataAccessDescriptor.idl:246
boolean BookmarkSelection
specifies how to interpret Selection
Definition: DataAccessDescriptor.idl:226
string ConnectionResource
specifies the database URL which locates a database driver.
Definition: DataAccessDescriptor.idl:76
com::sun::star::sdbc::XConnection ActiveConnection
is a connection to use.
Definition: DataAccessDescriptor.idl:102
string HavingClause
specifies an additional HAVING clause which should be applied on top of the given Command.
Definition: DataAccessDescriptor.idl:154
string ColumnName
specifies a column name.
Definition: DataAccessDescriptor.idl:235
boolean EscapeProcessing
specifies if the Command should be analyzed on the client side before sending it to the database serv...
Definition: DataAccessDescriptor.idl:173
sequence< ::com::sun::star::beans::PropertyValue > ConnectionInfo
specifies additional info to use when creating a connection from a ConnectionResource
Definition: DataAccessDescriptor.idl:87
com::sun::star::sdbc::XResultSet ResultSet
specifies an already existent result set to use.
Definition: DataAccessDescriptor.idl:194
string DataSourceName
specifies the name of the datasource to access.
Definition: DataAccessDescriptor.idl:56