/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XDatabaseRange.idl,v $
 *
 *  $Revision: 1.9 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 05:08:15 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 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
 *
 ************************************************************************/

#ifndef __com_sun_star_sheet_XDatabaseRange_idl__
#define __com_sun_star_sheet_XDatabaseRange_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_table_CellRangeAddress_idl__
#include <com/sun/star/table/CellRangeAddress.idl>
#endif

#ifndef __com_sun_star_beans_PropertyValue_idl__
#include <com/sun/star/beans/PropertyValue.idl>
#endif

#ifndef __com_sun_star_sheet_XSheetFilterDescriptor_idl__
#include <com/sun/star/sheet/XSheetFilterDescriptor.idl>
#endif

#ifndef __com_sun_star_sheet_XSubTotalDescriptor_idl__
#include <com/sun/star/sheet/XSubTotalDescriptor.idl>
#endif

//=============================================================================

module com {  module sun {  module star {  module sheet {

//=============================================================================

/** provides access to the settings and options of a database range.

    @see com::sun::star::sheet::DatabaseRange
 */
published interface XDatabaseRange: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    /** returns the data area of the database range in the
        spreadsheet document.
     */
    com::sun::star::table::CellRangeAddress getDataArea();

    //-------------------------------------------------------------------------

    /** sets the data area of the database range.
     */
    void setDataArea( [in] com::sun::star::table::CellRangeAddress aDataArea );

    //-------------------------------------------------------------------------

    /** returns the sort descriptor stored with the database range.

        @see com::sun::star::sheet::SheetSortDescriptor2
     */
    sequence< com::sun::star::beans::PropertyValue > getSortDescriptor();

    //-------------------------------------------------------------------------

    /** returns the filter descriptor stored with the database range.

        <p>If the filter descriptor is modified, the new filtering is
        carried out when <member>XDatabaseRange::refresh()</member> is
        called.</p>
     */
    com::sun::star::sheet::XSheetFilterDescriptor getFilterDescriptor();

    //-------------------------------------------------------------------------

    /** returns the subtotal descriptor stored with the database range.

        <p>If the subtotal descriptor is modified, the new subtotals are
        inserted when <member>XDatabaseRange::refresh()</member> is
        called.</p>
     */
    com::sun::star::sheet::XSubTotalDescriptor getSubTotalDescriptor();

    //-------------------------------------------------------------------------

    /** returns the database import descriptor stored with this database
        range.

        @see com::sun::star::sheet::DatabaseImportDescriptor
     */
    sequence< com::sun::star::beans::PropertyValue > getImportDescriptor();

    //-------------------------------------------------------------------------

    /** executes the stored import, filter, sorting, and subtotals
        descriptors again.
     */
    void refresh();

};

//=============================================================================

}; }; }; };

#endif