LibreOffice
LibreOffice 7.4 SDK API Reference
XSQLQueryComposer.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_XSQLQueryComposer_idl__
20 #define __com_sun_star_sdb_XSQLQueryComposer_idl__
21 
23 
25 
27 
28 
29  module com { module sun { module star { module sdb {
30 
31 
40 {
41 
46  string getQuery();
47 
55  void setQuery([in] string command )
57 
62  string getComposedQuery();
63 
73  string getFilter();
74 
85  sequence< sequence<com::sun::star::beans::PropertyValue> >
87 
98  string getOrder();
99 
110 
121  [in] boolean ascending)
123 
130  void setFilter([in] string filter)
132 
139  void setOrder([in] string order)
141 };
142 
143 
144 }; }; }; };
145 
146 #endif
147 
148 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
is an exception that provides information on a database access error.
Definition: SQLException.idl:45
provides information about and access to the properties from an implementation.
Definition: XPropertySet.idl:64
should be provided by a tool which simplifies the handling with SQL select statements.
Definition: XSQLQueryComposer.idl:40
string getComposedQuery()
returns the query composed with filters and sort criteria.
sequence< sequence< com::sun::star::beans::PropertyValue > > getStructuredFilter()
returns the currently used filter.
string getOrder()
returns the currently used sort order.
void setFilter([in] string filter)
makes it possible to set a filter condition for the query.
void setQuery([in] string command)
sets a new query for the composer, which may be expanded by filters and sort criteria.
void appendFilterByColumn([in] com::sun::star::beans::XPropertySet column)
appends a new filter condition by a com::sun::star::sdb::DataColumn providing the name and the value ...
void appendOrderByColumn([in] com::sun::star::beans::XPropertySet column, [in] boolean ascending)
appends an additional part to the sort order criteria of the select statement.
void setOrder([in] string order)
makes it possible to set a sort condition for the query.
string getFilter()
returns the currently used filter.
string getQuery()
returns the query used for composing.
base interface of all UNO interfaces
Definition: XInterface.idl:48
Definition: Ambiguous.idl:22