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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_ucb_CachedContentResultSet_idl__
  20 #define __com_sun_star_ucb_CachedContentResultSet_idl__
  21
  22 #include <com/sun/star/ucb/ContentResultSet.idl>
  23
  24
  25 module com { module sun { module star { module ucb {
  26
  27 /** is used on client side to access a ContentResultSet
  28     remote optimized.
  29
  30     <p>The CachedContentResultSet will not load every single
  31     property or even row just in that moment you ask for it, but load the data
  32     for some rows beforehand.
  33
  34     <p>Every time when a new package of data is loaded, the so far loaded data
  35     will be released, so the cash will not grow and grow and grow.
  36 */
  37
  38 published service CachedContentResultSet
  39 {
  40     service com::sun::star::ucb::ContentResultSet;
  41
  42     /** contains the number of result set rows that should be fetched from
  43     an underlying database.
  44
  45     <p>The default fetch size is implementation specific.
  46
  47     <p>Every negative value for parameter #FetchSize will
  48     force an implementation specific value to be set.
  49     */
  50     [property] long FetchSize;
  51
  52     /** contains the direction for fetching rows from an underlying database.
  53
  54     <p>The value can be one of the
  55     com::sun::star::sdbc::FetchDirection constants group.
  56
  57     <p>The default value is implementation specific.
  58
  59     <p>If you set the value to
  60     com::sun::star::sdbc::FetchDirection::UNKNOWN an
  61     implementation specific direction will be used.
  62     */
  63     [property] long FetchDirection;
  64 };
  65
  66
  67 }; }; }; };
  68
  69 #endif
  70
  71 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */