LibreOffice LibreOffice 25.2 SDK API Reference

XSingleSelectQueryAnalyzer.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 container {
21published interface XIndexAccess;
22};};};};
23
24 module com { module sun { module star { module sdb {
25
26
34 interface XSingleSelectQueryAnalyzer : com::sun::star::uno::XInterface
35{
36
41 string getQuery();
42
53 void setQuery([in] string command )
54 raises (com::sun::star::sdbc::SQLException);
55 // FILTER
56
65 string getFilter();
66
77 sequence< sequence<com::sun::star::beans::PropertyValue> >
78 getStructuredFilter();
79
80 // GROUP BY
81
90 string getGroup();
91
99 com::sun::star::container::XIndexAccess getGroupColumns();
100
101 // HAVING
102
111 string getHavingClause();
112
123 sequence< sequence<com::sun::star::beans::PropertyValue> >
124 getStructuredHavingClause();
125
126 // ORDER BY
135 string getOrder();
136
145 com::sun::star::container::XIndexAccess getOrderColumns();
146
182 string getQueryWithSubstitution()
183 raises (com::sun::star::sdbc::SQLException);
184
212 void setCommand([in] string Command ,[in] long CommandType)
213 raises (com::sun::star::sdbc::SQLException);
214};
215
216
217}; }; }; };
218
219/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::sdbc::SQLException
is an exception that provides information on a database access error.
Definition: SQLException.idl:41
com::sun::star::container::XIndexAccess
provides access to the elements of a collection through an index.
Definition: XIndexAccess.idl:32
com::sun::star::sdb::XSingleSelectQueryAnalyzer
simplifies the analyzing of single select statements.
Definition: XSingleSelectQueryAnalyzer.idl:35
com::sun::star::sdb::XSingleSelectQueryAnalyzer::getGroupColumns
com::sun::star::container::XIndexAccess getGroupColumns()
returns the currently used group.
com::sun::star::sdb::XSingleSelectQueryAnalyzer::getQueryWithSubstitution
string getQueryWithSubstitution()
returns the query previously set at the analyzer, with all application-level features being substitut...
com::sun::star::sdb::XSingleSelectQueryAnalyzer::getOrder
string getOrder()
returns the currently used sort order.
com::sun::star::sdb::XSingleSelectQueryAnalyzer::getGroup
string getGroup()
returns the currently used GROUP BY.
com::sun::star::sdb::XSingleSelectQueryAnalyzer::getStructuredHavingClause
sequence< sequence< com::sun::star::beans::PropertyValue > > getStructuredHavingClause()
returns the currently used HAVING filter.
com::sun::star::sdb::XSingleSelectQueryAnalyzer::getStructuredFilter
sequence< sequence< com::sun::star::beans::PropertyValue > > getStructuredFilter()
returns the currently used filter.
com::sun::star::sdb::XSingleSelectQueryAnalyzer::getOrderColumns
com::sun::star::container::XIndexAccess getOrderColumns()
returns the currently used sort order.
com::sun::star::sdb::XSingleSelectQueryAnalyzer::setQuery
void setQuery([in] string command)
sets a new query for the composer, which may be expanded by filters, group by, having and sort criter...
com::sun::star::sdb::XSingleSelectQueryAnalyzer::getHavingClause
string getHavingClause()
returns the used HAVING filter.
com::sun::star::sdb::XSingleSelectQueryAnalyzer::getFilter
string getFilter()
returns the used filter.
com::sun::star::sdb::XSingleSelectQueryAnalyzer::getQuery
string getQuery()
returns the query.
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:46
com
Definition: Ambiguous.idl:20