LibreOffice
LibreOffice 26.2 SDK API Reference
Toggle main menu visibility
Loading...
Searching...
No Matches
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
20
21
module
com
{ module sun { module star { module sdb {
22
23
31
published
interface
XSQLQueryComposer
:
com::sun::star::uno::XInterface
32
{
33
38
string
getQuery
();
39
47
void
setQuery
([in]
string
command )
48
raises (
com::sun::star::sdbc::SQLException
);
49
54
string
getComposedQuery
();
55
65
string
getFilter
();
66
77
sequence< sequence<com::sun::star::beans::PropertyValue> >
78
getStructuredFilter
();
79
90
string
getOrder
();
91
100
void
appendFilterByColumn
([in]
com::sun::star::beans::XPropertySet
column)
101
raises (
com::sun::star::sdbc::SQLException
);
102
112
void
appendOrderByColumn
([in]
com::sun::star::beans::XPropertySet
column,
113
[in]
boolean
ascending)
114
raises (
com::sun::star::sdbc::SQLException
);
115
122
void
setFilter
([in]
string
filter)
123
raises (
com::sun::star::sdbc::SQLException
);
124
131
void
setOrder
([in]
string
order)
132
raises (
com::sun::star::sdbc::SQLException
);
133
};
134
135
136
}; }; }; };
137
138
/* 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::beans::XPropertySet
provides information about and access to the properties from an implementation.
Definition
XPropertySet.idl:46
com::sun::star::sdb::XSQLQueryComposer
should be provided by a tool which simplifies the handling with SQL select statements.
Definition
XSQLQueryComposer.idl:32
com::sun::star::sdb::XSQLQueryComposer::getComposedQuery
string getComposedQuery()
returns the query composed with filters and sort criteria.
com::sun::star::sdb::XSQLQueryComposer::getOrder
string getOrder()
returns the currently used sort order.
com::sun::star::sdb::XSQLQueryComposer::getStructuredFilter
sequence< sequence< com::sun::star::beans::PropertyValue > > getStructuredFilter()
returns the currently used filter.
com::sun::star::sdb::XSQLQueryComposer::setFilter
void setFilter([in] string filter)
makes it possible to set a filter condition for the query.
com::sun::star::sdb::XSQLQueryComposer::setQuery
void setQuery([in] string command)
sets a new query for the composer, which may be expanded by filters and sort criteria.
com::sun::star::sdb::XSQLQueryComposer::appendFilterByColumn
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 ...
com::sun::star::sdb::XSQLQueryComposer::appendOrderByColumn
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.
com::sun::star::sdb::XSQLQueryComposer::setOrder
void setOrder([in] string order)
makes it possible to set a sort condition for the query.
com::sun::star::sdb::XSQLQueryComposer::getFilter
string getFilter()
returns the currently used filter.
com::sun::star::sdb::XSQLQueryComposer::getQuery
string getQuery()
returns the query used for composing.
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition
XInterface.idl:46
com
Definition
Ambiguous.idl:20
com
sun
star
sdb
XSQLQueryComposer.idl
Generated by
1.17.0