LibreOffice
LibreOffice 6.2 SDK API Reference
Exported Interfaces | List of all members
SQLQueryComposer Service Referencepublished

represents a tool for composing SQL select statements. More...

import"SQLQueryComposer.idl";

Inheritance diagram for SQLQueryComposer:
XSQLQueryComposer XTablesSupplier XColumnsSupplier XInterface XInterface XInterface

Exported Interfaces

interface XSQLQueryComposer
 access to the composer interface. More...
 
interface com::sun::star::sdbcx::XTablesSupplier
 access to the selected tables. More...
 
interface com::sun::star::sdbcx::XColumnsSupplier
 access the selected columns. More...
 

Additional Inherited Members

- Public Member Functions inherited from XSQLQueryComposer
string getQuery ()
 returns the query used for composing. More...
 
void setQuery ([in] string command) raises (com::sun::star::sdbc::SQLException)
 sets a new query for the composer, which may be expanded by filters and sort criteria. More...
 
string getComposedQuery ()
 returns the query composed with filters and sort criteria. More...
 
string getFilter ()
 returns the currently used filter. More...
 
sequence< sequence< com::sun::star::beans::PropertyValue > > getStructuredFilter ()
 returns the currently used filter. More...
 
string getOrder ()
 returns the currently used sort order. More...
 
void appendFilterByColumn ([in] com::sun::star::beans::XPropertySet column) raises (com::sun::star::sdbc::SQLException)
 appends a new filter condition by a com::sun::star::sdb::DataColumn providing the name and the value for the filter. More...
 
void appendOrderByColumn ([in] com::sun::star::beans::XPropertySet column, [in] boolean ascending) raises (com::sun::star::sdbc::SQLException)
 appends an additional part to the sort order criteria of the select statement. More...
 
void setFilter ([in] string filter) raises (com::sun::star::sdbc::SQLException)
 makes it possible to set a filter condition for the query. More...
 
void setOrder ([in] string order) raises (com::sun::star::sdbc::SQLException)
 makes it possible to set a sort condition for the query. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 
- Public Member Functions inherited from XTablesSupplier
com::sun::star::container::XNameAccess getTables ()
 returns the container of tables. More...
 
- Public Member Functions inherited from XColumnsSupplier
com::sun::star::container::XNameAccess getColumns ()
 returns the container of columns. More...
 

Detailed Description

represents a tool for composing SQL select statements.

It hides the complexity of parsing and evaluating SQL Statements and provides sophisticated methods for expanding a SQL-Statement with filter and order criteria.

Developers Guide
Database - The SQLQueryComposer

Exported Interfaces

access the selected columns.

access to the selected tables.

interface XSQLQueryComposer

access to the composer interface.


The documentation for this service was generated from the following file: