offapi/com/sun/star/ucb/XCachedContentResultSetFactory.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: XCachedContentResultSetFactory.idl,v $
  10  * $Revision: 1.9 $
  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_XCachedContentResultSetFactory_idl__
  31 #define __com_sun_star_ucb_XCachedContentResultSetFactory_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_sdbc_XResultSet_idl__
  38 #include <com/sun/star/sdbc/XResultSet.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_ucb_XContentIdentifierMapping_idl__
  42 #include <com/sun/star/ucb/XContentIdentifierMapping.idl>
  43 #endif
  44
  45 //=============================================================================
  46
  47 module com { module sun { module star { module ucb {
  48
  49 //=============================================================================
  50 /** creates a <type>CachedContentResultSet</type>.
  51 */
  52
  53 published interface XCachedContentResultSetFactory: com::sun::star::uno::XInterface
  54 {
  55     //-------------------------------------------------------------------------
  56     /** creates a remote optimized
  57         <type scope="com::sun::star::sdbc">XResultSet</type>.
  58
  59         @param xSource
  60         must be an instance of service <type>CachedContentResultSetStub</type>.
  61
  62         @param xMapping
  63         can be used for optimization of remote access via the interface
  64         <type>XContentAccess</type> of the <type>CachedContentResultSet</type>.
  65         This paramter can be <NULL/>.
  66
  67         @returns
  68         an instance of service <type>CachedContentResultSet</type>.
  69     */
  70     com::sun::star::sdbc::XResultSet    createCachedContentResultSet(
  71                 [in] com::sun::star::sdbc::XResultSet xSource,
  72                 [in] com::sun::star::ucb::XContentIdentifierMapping xMapping );
  73 };
  74
  75 //=============================================================================
  76
  77 }; }; }; };
  78
  79 #endif