/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: CachedContentResultSet.idl,v $
 *
 *  $Revision: 1.7 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 07:11:27 $
 *
 *  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_ucb_CachedContentResultSet_idl__
#define __com_sun_star_ucb_CachedContentResultSet_idl__

#ifndef __com_sun_star_ucb_ContentResultSet_idl__
#include <com/sun/star/ucb/ContentResultSet.idl>
#endif

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

module com { module sun { module star { module ucb {

//=============================================================================
/** is used on client side to access a <type>ContentResultSet</type>
    remote optimized.

    <p>The <type>CachedContentResultSet</type> will not load every single
    property or even row just in that moment you ask for it, but load the data
    for some rows beforehand.

    <p>Every time when a new package of data is loaded, the so far loaded data
    will be released, so the cash will not grow and grow and grow.
*/

published service CachedContentResultSet
{
    service com::sun::star::ucb::ContentResultSet;

    //-------------------------------------------------------------------------
    /** contains the number of result set rows that should be fethched from
    an underlying database.

    <p>The default fetch size is implementation specific.

    <p>Every negative value for parameter <member>FetchSize</member> will
    force an implementation specific value to be set.
    */
    [property] long FetchSize;

     //-------------------------------------------------------------------------
    /** contains the direction for fetching rows from an underlying database.

    <p>The value can be one of the
    <type scope="com::sun::star::sdbc">FetchDirection</type> constants group.

    <p>The default value is implementation specific.

    <p>If you set the value to
    <member scope="com::sun::star::sdbc">FetchDirection::UNKNOWN</member> an
    implementation specific direction will be used.
    */
    [property] long FetchDirection;
};

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

}; }; }; };

#endif
