220 lines
8.5 KiB
Text
220 lines
8.5 KiB
Text
/*************************************************************************
|
|
*
|
|
* $RCSfile: XSQLQueryComposer.idl,v $
|
|
*
|
|
* $Revision: 1.7 $
|
|
*
|
|
* last change: $Author: hr $ $Date: 2003-03-26 13:55:10 $
|
|
*
|
|
* The Contents of this file are made available subject to the terms of
|
|
* either of the following licenses
|
|
*
|
|
* - GNU Lesser General Public License Version 2.1
|
|
* - Sun Industry Standards Source License Version 1.1
|
|
*
|
|
* Sun Microsystems Inc., October, 2000
|
|
*
|
|
* GNU Lesser General Public License Version 2.1
|
|
* =============================================
|
|
* Copyright 2000 by Sun Microsystems, Inc.
|
|
* 901 San Antonio Road, Palo Alto, CA 94303, USA
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License version 2.1, as published by the Free Software Foundation.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
|
|
* MA 02111-1307 USA
|
|
*
|
|
*
|
|
* Sun Industry Standards Source License Version 1.1
|
|
* =================================================
|
|
* The contents of this file are subject to the Sun Industry Standards
|
|
* Source License Version 1.1 (the "License"); You may not use this file
|
|
* except in compliance with the License. You may obtain a copy of the
|
|
* License at http://www.openoffice.org/license.html.
|
|
*
|
|
* Software provided under this License is provided on an "AS IS" basis,
|
|
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
|
|
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
|
|
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
|
|
* See the License for the specific provisions governing your rights and
|
|
* obligations concerning the Software.
|
|
*
|
|
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
|
|
*
|
|
* Copyright: 2000 by Sun Microsystems, Inc.
|
|
*
|
|
* All Rights Reserved.
|
|
*
|
|
* Contributor(s): _______________________________________
|
|
*
|
|
*
|
|
************************************************************************/
|
|
#ifndef __com_sun_star_sdb_XSQLQueryComposer_idl__
|
|
#define __com_sun_star_sdb_XSQLQueryComposer_idl__
|
|
|
|
#ifndef __com_sun_star_beans_XPropertySet_idl__
|
|
#include <com/sun/star/beans/XPropertySet.idl>
|
|
#endif
|
|
|
|
#ifndef __com_sun_star_beans_PropertyValue_idl__
|
|
#include <com/sun/star/beans/PropertyValue.idl>
|
|
#endif
|
|
|
|
#ifndef __com_sun_star_sdbc_SQLException_idl__
|
|
#include <com/sun/star/sdbc/SQLException.idl>
|
|
#endif
|
|
|
|
//=============================================================================
|
|
|
|
module com { module sun { module star { module sdb {
|
|
|
|
//=============================================================================
|
|
|
|
// DocMerge from xml: interface com::sun::star::sdb::XSQLQueryComposer
|
|
/** should be provided by a tool which simplifies the handling with SQL select statements.
|
|
|
|
<p>
|
|
The interface can be used for composing SELECT statements without knowing the
|
|
structure of the used query.
|
|
</p>
|
|
*/
|
|
interface XSQLQueryComposer: com::sun::star::uno::XInterface
|
|
{
|
|
|
|
// DocMerge from xml: method com::sun::star::sdb::XSQLQueryComposer::getQuery
|
|
/** returns the query used for composing.
|
|
@returns
|
|
the query
|
|
*/
|
|
string getQuery();
|
|
//-------------------------------------------------------------------------
|
|
|
|
// DocMerge from xml: method com::sun::star::sdb::XSQLQueryComposer::setQuery
|
|
/** sets a new query for the composer, which may be expanded by filters
|
|
and sort criteria.
|
|
@param command
|
|
the command to set
|
|
@throws com::sun::star::sdbc::SQLException
|
|
if a database access error occurs.
|
|
*/
|
|
void setQuery([in] string command )
|
|
raises (com::sun::star::sdbc::SQLException);
|
|
//-------------------------------------------------------------------------
|
|
|
|
// DocMerge from xml: method com::sun::star::sdb::XSQLQueryComposer::getComposedQuery
|
|
/** returns the query composed with filters and sort criterias.
|
|
@returns
|
|
the composed query
|
|
*/
|
|
string getComposedQuery();
|
|
//-------------------------------------------------------------------------
|
|
|
|
// DocMerge from xml: method com::sun::star::sdb::XSQLQueryComposer::getFilter
|
|
/** returns the currently used filter.
|
|
|
|
<p>
|
|
The filter criteria returned is part of the where condition of the
|
|
select command, but it does not contain the where token.
|
|
</p>
|
|
@returns
|
|
the filter
|
|
*/
|
|
string getFilter();
|
|
//-------------------------------------------------------------------------
|
|
|
|
// DocMerge from idl: method com::sun::star::sdb::XSQLQueryComposer::getStructuredFilter
|
|
/** returns the currently used filter.
|
|
<p>
|
|
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.
|
|
</p>
|
|
@returns
|
|
the structured filter
|
|
*/
|
|
sequence< sequence<com::sun::star::beans::PropertyValue> >
|
|
getStructuredFilter();
|
|
//-------------------------------------------------------------------------
|
|
|
|
// DocMerge from xml: method com::sun::star::sdb::XSQLQueryComposer::getOrder
|
|
/** returns the currently used sort order.
|
|
|
|
|
|
<p>
|
|
The order criteria returned is part of the ORDER BY clause of the
|
|
select command, but it does not contain the ORDER BY keyword .
|
|
</p>
|
|
@returns
|
|
the order
|
|
*/
|
|
string getOrder();
|
|
//-------------------------------------------------------------------------
|
|
|
|
// DocMerge from xml: method com::sun::star::sdb::XSQLQueryComposer::appendFilterByColumn
|
|
/** appends a new filter condition by a
|
|
<type scope="com::sun::star::sdb">DataColumn</type>
|
|
providing the name and the value for the filter.
|
|
@param column
|
|
the column which is used to create a filter
|
|
@throws com::sun::star::sdbc::SQLException
|
|
if a database access error occurs.
|
|
*/
|
|
void appendFilterByColumn([in] com::sun::star::beans::XPropertySet column)
|
|
raises (com::sun::star::sdbc::SQLException);
|
|
//-------------------------------------------------------------------------
|
|
|
|
// DocMerge from xml: method com::sun::star::sdb::XSQLQueryComposer::appendOrderByColumn
|
|
/** appends an additional part to the sort order criteria of the select
|
|
statement.
|
|
@param column
|
|
the column which is used to create a order part
|
|
@param ascending
|
|
<TRUE/> when the order should be ascending, otherwise <FALSE/>
|
|
@throws com::sun::star::sdbc::SQLException
|
|
if a database access error occurs.
|
|
*/
|
|
void appendOrderByColumn([in] com::sun::star::beans::XPropertySet column,
|
|
[in] boolean ascending)
|
|
raises (com::sun::star::sdbc::SQLException);
|
|
//-------------------------------------------------------------------------
|
|
|
|
// DocMerge from xml: method com::sun::star::sdb::XSQLQueryComposer::setFilter
|
|
/** makes it possible to set a filter condition for the query.
|
|
@param filter
|
|
the filter to set
|
|
@throws com::sun::star::sdbc::SQLException
|
|
if a database access error occurs.
|
|
*/
|
|
void setFilter([in] string filter)
|
|
raises (com::sun::star::sdbc::SQLException);
|
|
//-------------------------------------------------------------------------
|
|
|
|
// DocMerge from xml: method com::sun::star::sdb::XSQLQueryComposer::setOrder
|
|
/** makes it possibile to set a sort condition for the query.
|
|
@param order
|
|
the order part to set
|
|
@throws com::sun::star::sdbc::SQLException
|
|
if a database access error occurs.
|
|
*/
|
|
void setOrder([in] string order)
|
|
raises (com::sun::star::sdbc::SQLException);
|
|
};
|
|
|
|
//=============================================================================
|
|
|
|
}; }; }; };
|
|
|
|
/*=============================================================================
|
|
|
|
=============================================================================*/
|
|
#endif
|