Language Asturianu (ast) Català (ca) Čeština (cs) Dansk (da) Deutsch (de) English [US] (en-US) Español (es) Esperanto (eo) Eesti keel (et) Euskara (eu) Français (fr) Gàidhlig (gd) Galego (gl) Italiano (it) Lietuvių (lt) Magyar (hu) Nederlands (nl) Norsk (no) Polski (pl) Português [do Brasil] (pt-BR) Português [Europeu] (pt) Română (ro) Slovenčina (sk) Slovenščina (sl) Suomi (fi) Svenska (sv) Yкраїнська (uk) Tiếng Việt (vi) Türkçe (tr) ኦሮሚኛ (om) Հայերեն (hy) Ελληνικά (el) български език (bg) Русский (ru) Cрпски [ћирилицом] (sr) עברית (he) हिन्दी (hi) ភាសាខ្មែរ (km) தமிழ் (ta) ภาษาไทย (th) 简体中文 (zh-CN) 正體中文 (zh-TW) 日本語 (ja) 한국어 (ko)

The Free and Open Productivity Suite

• Product
• Download
• Support
• Blog
• Extensions & Templates
• Get Involved
• Focus Areas
• Native Languages

home » api » docs » common » ref » com » sun » star » sdb

Overview

Module

Use

Devguide

Index

Methods' Summary

Attributes' Summary

Methods' Details

Attributes' Details

---

:: com :: sun :: star :: sdb ::

interface XSQLQueryComposer

Description should be provided by a tool which simplifies the handling with SQL select statements. The interface can be used for composing SELECT statements without knowing the structure of the used query.

---

Methods' Summary
getQuery	returns the query used for composing.
setQuery	sets a new query for the composer, which may be expanded by filters and sort criteria.
getComposedQuery	returns the query composed with filters and sort criterias.
getFilter	returns the currently used filter.
getStructuredFilter	returns the currently used filter.
getOrder	returns the currently used sort order.
appendFilterByColumn	appends a new filter condition by a DataColumn providing the name and the value for the filter.
appendOrderByColumn	appends an additional part to the sort order criteria of the select statement.
setFilter	makes it possible to set a filter condition for the query.
setOrder	makes it possibile to set a sort condition for the query.

Methods' Details

getQuery string getQuery(); Description returns the query used for composing. Returns the query

setQuery void setQuery( [in] string  command ) raises( ::com::sun::star::sdbc::SQLException ); Description sets a new query for the composer, which may be expanded by filters and sort criteria. Parameter command the command to set Throws com::sun::star::sdbc::SQLException if a database access error occurs.

getComposedQuery string getComposedQuery(); Description returns the query composed with filters and sort criterias. Returns the composed query

getFilter string getFilter(); Description returns the currently used filter. The filter criteria returned is part of the where condition of the select command, but it does not contain the where token. Returns the filter

getStructuredFilter sequence< sequence< ::com::sun::star::beans::PropertyValue > > getStructuredFilter(); Description returns the currently used filter. The filter criteria is split into levels. Each level represents the OR criterias. Within each level, the filters are provided as an AND criteria with the name of the column and the filter condition. The filter condition is of type string. Returns the structured filter

getOrder string getOrder(); Description returns the currently used sort order. The order criteria returned is part of the ORDER BY clause of the select command, but it does not contain the ORDER BY keyword . Returns the order

appendFilterByColumn void appendFilterByColumn( [in] ::com::sun::star::beans::XPropertySet  column ) raises( ::com::sun::star::sdbc::SQLException ); Description appends a new filter condition by a DataColumn providing the name and the value for the filter. Parameter column the column which is used to create a filter Throws com::sun::star::sdbc::SQLException if a database access error occurs.

appendOrderByColumn void appendOrderByColumn( [in] ::com::sun::star::beans::XPropertySet  column, [in] boolean  ascending ) raises( ::com::sun::star::sdbc::SQLException ); Description appends an additional part to the sort order criteria of the select statement. Parameter column the column which is used to create a order part Parameter ascending true when the order should be ascending, otherwise false Throws com::sun::star::sdbc::SQLException if a database access error occurs.

setFilter void setFilter( [in] string  filter ) raises( ::com::sun::star::sdbc::SQLException ); Description makes it possible to set a filter condition for the query. Parameter filter the filter to set Throws com::sun::star::sdbc::SQLException if a database access error occurs.

setOrder void setOrder( [in] string  order ) raises( ::com::sun::star::sdbc::SQLException ); Description makes it possibile to set a sort condition for the query. Parameter order the order part to set Throws com::sun::star::sdbc::SQLException if a database access error occurs.

Top of Page

---

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.