LibreOffice LibreOffice 25.8 SDK API Reference

XDatabaseDataProvider.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
21 module com { module sun { module star { module chart2 { module data {
22
23
29 interface XDatabaseDataProvider
30{
34 interface XDataProvider;
35
39 interface XRangeXMLConversion;
40
43 interface com::sun::star::lang::XInitialization;
44
47 interface com::sun::star::lang::XComponent;
48
51 interface com::sun::star::beans::XPropertySet;
52
53 interface com::sun::star::sdbc::XParameters;
54 interface com::sun::star::sdbc::XRowSet;
55
65 [attribute,bound] sequence<string> MasterFields;
66
90 [attribute,bound] sequence<string> DetailFields;
91
107 [attribute,bound] string Command;
108
118 [attribute,bound] long CommandType;
119
134 [attribute,bound] string Filter;
135
139 [attribute,bound] boolean ApplyFilter;
140
143 [attribute,bound] string HavingClause
144 {
145 set raises (com::sun::star::beans::UnknownPropertyException);
146 };
147
150 [attribute,bound] string GroupBy
151 {
152 set raises (com::sun::star::beans::UnknownPropertyException);
153 };
154
157 [attribute,bound] string Order;
158
169 [attribute,bound] boolean EscapeProcessing;
170
174 [attribute,bound] long RowLimit;
175
178 [attribute,bound] com::sun::star::sdbc::XConnection ActiveConnection
179 {
180 set raises (com::sun::star::lang::IllegalArgumentException);
181 };
185 [attribute,bound] string DataSourceName;
186};
187
188
189 }; }; }; }; };
190
191/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::beans::UnknownPropertyException
This exception is thrown to indicate that the property name is unknown to the implementation.
Definition: UnknownPropertyException.idl:31
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:27
com::sun::star::beans::XPropertySet
provides information about and access to the properties from an implementation.
Definition: XPropertySet.idl:46
com::sun::star::chart2::data::XDataProvider
An application that provides data for a chart must implement this interface.
Definition: XDataProvider.idl:35
com::sun::star::chart2::data::XDatabaseDataProvider
identifies a XDataProvider for result sets.
Definition: XDatabaseDataProvider.idl:30
com::sun::star::chart2::data::XDatabaseDataProvider::CommandType
long CommandType
specifies the type of the command to be executed to retrieve a result set.
Definition: XDatabaseDataProvider.idl:118
com::sun::star::chart2::data::XDatabaseDataProvider::RowLimit
long RowLimit
specifies the maximal count of rows which should be fetched.
Definition: XDatabaseDataProvider.idl:174
com::sun::star::chart2::data::XDatabaseDataProvider::Filter
string Filter
specifies an additional filter to optionally use.
Definition: XDatabaseDataProvider.idl:134
com::sun::star::chart2::data::XDatabaseDataProvider::ApplyFilter
boolean ApplyFilter
indicates whether the filter should be applied or not, default is FALSE.
Definition: XDatabaseDataProvider.idl:139
com::sun::star::chart2::data::XDatabaseDataProvider::Order
string Order
is an additional sort order definition for a row set.
Definition: XDatabaseDataProvider.idl:157
com::sun::star::chart2::data::XDatabaseDataProvider::DetailFields
sequence< string > DetailFields
is used for subreports and contains the names of the columns of the subreport which are related to th...
Definition: XDatabaseDataProvider.idl:90
com::sun::star::chart2::data::XDatabaseDataProvider::Command
string Command
is the command which should be executed, the type of command depends on the CommandType.
Definition: XDatabaseDataProvider.idl:107
com::sun::star::chart2::data::XDatabaseDataProvider::EscapeProcessing
boolean EscapeProcessing
specifies if the Command should be analyzed on the client side before sending it to the database serv...
Definition: XDatabaseDataProvider.idl:169
com::sun::star::chart2::data::XDatabaseDataProvider::MasterFields
sequence< string > MasterFields
is used for subreports and contains the names of columns of the parent report.
Definition: XDatabaseDataProvider.idl:54
com::sun::star::chart2::data::XDatabaseDataProvider::DataSourceName
string DataSourceName
is the name of the data source to use, this could be a named data source or the URL of a data access ...
Definition: XDatabaseDataProvider.idl:185
com::sun::star::chart2::data::XRangeXMLConversion
An application that provides data for a chart must implement this interface.
Definition: XRangeXMLConversion.idl:35
com::sun::star::lang::XComponent
allows to explicitly free resources and break cyclic references.
Definition: XComponent.idl:39
com::sun::star::lang::XInitialization
initializes an object directly after its creation.
Definition: XInitialization.idl:41
com::sun::star::sdbc::XConnection
represents a connection (session) with a specific database.
Definition: XConnection.idl:50
com::sun::star::sdbc::XParameters
is used for parameter setting, commonly implemented in conjunction with PreparedStatements.
Definition: XParameters.idl:65
com::sun::star::sdbc::XRowSet
enhances the functionality of a result set.
Definition: XRowSet.idl:39
com
Definition: Ambiguous.idl:20