offapi/com/sun/star/ucb/XCachedDynamicResultSetFactory.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: XCachedDynamicResultSetFactory.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_XCachedDynamicResultSetFactory_idl__
  31 #define __com_sun_star_ucb_XCachedDynamicResultSetFactory_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_XDynamicResultSet_idl__
  38 #include <com/sun/star/ucb/XDynamicResultSet.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>CachedDynamicResultSet</type>.
  51
  52     <p>Pay attention to instanciate this helper on clientside where your want
  53     to read the data respectively where you have instantiated the listener to
  54     the <type>XDynamicResultSet</type>.
  55
  56     <p>The needed stub on server side can be created using
  57     <type>XCachedDynamicResultSetStubFactory</type>.
  58 */
  59
  60 published interface XCachedDynamicResultSetFactory: com::sun::star::uno::XInterface
  61 {
  62     //-------------------------------------------------------------------------
  63     /** creates a remote optimizes <type>XDynamicResultSet</type>.
  64
  65         @param SourceStub
  66         must be an instance of service <type>CachedDynamicResultSetStub</type>.
  67         It can be <NULL/>. In this case you can use the interface
  68         <type>XSourceInitialization</type> of the returned
  69         <type>CachedDynamicResultSet</type> to set the stub later.
  70
  71         @param ContentIdentifierMapping
  72         is not required, but can be set if it is necessary to change the
  73         identity of the contents accessable via the interface
  74         <type>XContentAccess</type> of the <type>ContentResultSet</type>
  75         (e.g., if merging two sources of the same type).
  76
  77         @returns
  78         an instance of service <type>CachedDynamicResultSet</type>.
  79     */
  80     com::sun::star::ucb::XDynamicResultSet      createCachedDynamicResultSet(
  81           [in] com::sun::star::ucb::XDynamicResultSet SourceStub
  82         , [in] com::sun::star::ucb::XContentIdentifierMapping ContentIdentifierMapping );
  83 };
  84
  85 //=============================================================================
  86
  87 }; }; }; };
  88
  89 #endif