offapi/com/sun/star/ucb/XFetchProviderForContentAccess.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: XFetchProviderForContentAccess.idl,v $
  10  * $Revision: 1.10 $
  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_XFetchProviderForContentAccess_idl__
  31 #define __com_sun_star_ucb_XFetchProviderForContentAccess_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_ucb_FetchResult_idl__
  38 #include <com/sun/star/ucb/FetchResult.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43 module com { module sun { module star { module ucb {
  44
  45 //=============================================================================
  46 /** provides the possibility to load information offered by a
  47     <type>XContentAccess</type> for several rows of a
  48     <type>ContentResultSet</type> with a single function call.
  49 */
  50 published interface XFetchProviderForContentAccess: com::sun::star::uno::XInterface
  51 {
  52     //-------------------------------------------------------------------------
  53     /** returns the content identifier strings of the columns of the indicated
  54         rows
  55
  56         @returns
  57         <member>FetchResult::Rows</member> contains a sequence of anys. Each
  58         of these anys contains a string.
  59
  60         @param nRowStartPosition
  61         the starting row of the resultset
  62
  63         @param nRowCount
  64         the count of rows
  65
  66         @param bDirection
  67         <TRUE/>, if you want the rows to be read in the same order, as they
  68         are contained in the result set ( <TRUE/> &lt;-&gt; forward step;
  69         <FALSE/> &lt;-&gt; backward step )
  70     */
  71     com::sun::star::ucb::FetchResult
  72          fetchContentIdentifierStrings( [in] long nRowStartPosition
  73                                       , [in] long nRowCount
  74                                       , [in] boolean bDirection );
  75
  76     //-------------------------------------------------------------------------
  77     /** returns the <type>XContentIdentifier</type>s of the columns of the
  78         indicated rows
  79
  80         @returns
  81         <member>FetchResult::Rows</member> contains a sequence of anys. Each
  82         of these anys contains an <type>XContentIdentifier</type>.
  83
  84         @param nRowStartPosition
  85         the starting row of the resultset
  86
  87         @param nRowCount
  88         the count of rows
  89
  90         @param bDirection
  91         <TRUE/>, if you want the rows to be read in the same order, as they
  92         are contained in the result set ( <TRUE/> &lt;-&gt; forward step;
  93         <FALSE/> &lt;-&gt; backward step )
  94     */
  95     com::sun::star::ucb::FetchResult
  96          fetchContentIdentifiers( [in] long nRowStartPosition
  97                                 , [in] long nRowCount
  98                                 , [in] boolean bDirection );
  99
 100     //-------------------------------------------------------------------------
 101     /** returns the <type>XContent</types>s of the columns of the indicated rows
 102
 103         @returns
 104         <member>FetchResult::Rows</member> contains a sequence of anys. Each
 105         of these anys contains an <type>XContent</type>.
 106
 107         @param nRowStartPosition
 108         the starting row of the resultset
 109
 110         @param nRowCount
 111         the count of rows
 112
 113         @param bDirection
 114         <TRUE/>, if you want the rows to be read in the same order, as they
 115         are contained in the result set ( <TRUE/> &lt;-&gt; forward step;
 116         <FALSE/> &lt;-&gt; backward step )
 117     */
 118     com::sun::star::ucb::FetchResult
 119          fetchContents( [in] long nRowStartPosition
 120                       , [in] long nRowCount
 121                       , [in] boolean bDirection );
 122 };
 123
 124 //=============================================================================
 125
 126 }; }; }; };
 127
 128 #endif