offapi/com/sun/star/ucb/CachedDynamicResultSetStub.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: CachedDynamicResultSetStub.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_CachedDynamicResultSetStub_idl__
  31 #define __com_sun_star_ucb_CachedDynamicResultSetStub_idl__
  32
  33 #ifndef __com_sun_star_ucb_XDynamicResultSet_idl__
  34 #include <com/sun/star/ucb/XDynamicResultSet.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_ucb_XSourceInitialization_idl__
  38 #include <com/sun/star/ucb/XSourceInitialization.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43 module com { module sun { module star { module ucb {
  44
  45 //=============================================================================
  46 /** provides read access to a static or dynamicallly changing
  47     <type>ContentResultSet</type>.
  48
  49     <p>For example, a <type>DynamicResultSet</type> is returned from the
  50     open-command executed by an <type>XCommandProcessor</type> of the service
  51     <type>Content</type>.
  52 */
  53
  54 published service CachedDynamicResultSetStub
  55 {
  56     //-------------------------------------------------------------------------
  57     /** In Combination with a <type>CachedDynamicResultSet</type> this provides
  58         remote optimized read access to a static or dynamically changing
  59         <type>ContentResultSet</type>.
  60
  61         <p>The <type scope="com::sun::star::sdbc">XResultSet</type>s given to
  62         the listener in the first notification in the
  63         <type>WelcomeDynamicResultSetStruct</type> are implementations of
  64         <type>CachedContentResultSetStub</type>.
  65
  66         <p>This interface is required.
  67     */
  68     interface com::sun::star::ucb::XDynamicResultSet;
  69
  70     //-------------------------------------------------------------------------
  71     /** provides the initialization of the <type>CachedDynamicResultSetStub</type>
  72         with a source object.
  73
  74         <p>The <var>Source</var> in
  75         <member>XSourceInitialization::setSource</member> has to be an
  76         implementation of service <type>DynamicResultSet</type>
  77
  78         <p>This interface is required.
  79      */
  80     interface com::sun::star::ucb::XSourceInitialization;
  81 };
  82
  83 //=============================================================================
  84
  85 }; }; }; };
  86
  87 #endif