Overview | Module | Use | Devguide | Index

Methods' Summary | Methods' Details | Attributes' Summary | Attributes' Details

:: com :: sun :: star :: sdb ::
interface XSQLQueryComposer
  Base Hierarchy
      ::com::sun::star::uno::XInterface
       |
       +-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 raises( | command ) ::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 raises( | column ) ::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 [in] boolean raises( | column, ascending ) ::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 raises( | filter ) ::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 raises( | order ) ::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 © 2003 Sun Microsystems, Inc.