offapi/com/sun/star/ucb/CachedContentResultSet.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: CachedContentResultSet.idl,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_ucb_CachedContentResultSet_idl__
  31 #define __com_sun_star_ucb_CachedContentResultSet_idl__
  32
  33 #ifndef __com_sun_star_ucb_ContentResultSet_idl__
  34 #include <com/sun/star/ucb/ContentResultSet.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39 module com { module sun { module star { module ucb {
  40
  41 //=============================================================================
  42 /** is used on client side to access a <type>ContentResultSet</type>
  43     remote optimized.
  44
  45     <p>The <type>CachedContentResultSet</type> will not load every single
  46     property or even row just in that moment you ask for it, but load the data
  47     for some rows beforehand.
  48
  49     <p>Every time when a new package of data is loaded, the so far loaded data
  50     will be released, so the cash will not grow and grow and grow.
  51 */
  52
  53 published service CachedContentResultSet
  54 {
  55     service com::sun::star::ucb::ContentResultSet;
  56
  57     //-------------------------------------------------------------------------
  58     /** contains the number of result set rows that should be fethched from
  59     an underlying database.
  60
  61     <p>The default fetch size is implementation specific.
  62
  63     <p>Every negative value for parameter <member>FetchSize</member> will
  64     force an implementation specific value to be set.
  65     */
  66     [property] long FetchSize;
  67
  68      //-------------------------------------------------------------------------
  69     /** contains the direction for fetching rows from an underlying database.
  70
  71     <p>The value can be one of the
  72     <type scope="com::sun::star::sdbc">FetchDirection</type> constants group.
  73
  74     <p>The default value is implementation specific.
  75
  76     <p>If you set the value to
  77     <member scope="com::sun::star::sdbc">FetchDirection::UNKNOWN</member> an
  78     implementation specific direction will be used.
  79     */
  80     [property] long FetchDirection;
  81 };
  82
  83 //=============================================================================
  84
  85 }; }; }; };
  86
  87 #endif