offapi/com/sun/star/ucb/CachedDynamicResultSet.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_CachedDynamicResultSet_idl__
  20 #define __com_sun_star_ucb_CachedDynamicResultSet_idl__
  21
  22 #include <com/sun/star/ucb/XDynamicResultSet.idl>
  23 #include <com/sun/star/ucb/XSourceInitialization.idl>
  24
  25
  26 module com { module sun { module star { module ucb {
  27
  28 /** provides read access to a static or dynamically changing
  29     ContentResultSet.
  30
  31     <p>For example, a DynamicResultSet is returned from the
  32     open-command executed by an XCommandProcessor of the service
  33     Content.
  34 */
  35
  36 published service CachedDynamicResultSet
  37 {
  38     /** Provides remote optimized read access to a static or a dynamically
  39         changing ContentResultSet.
  40
  41         <p>The com::sun::star::sdbc::XResultSets given to
  42         the listener in the first notification in the
  43         WelcomeDynamicResultSetStruct are implementations of the
  44         CachedContentResultSet service.
  45
  46         <p>This interface is required.
  47      */
  48     interface com::sun::star::ucb::XDynamicResultSet;
  49
  50     /** provides the initialization of the CachedDynamicResultSet
  51         with a source object.
  52
  53         <p>The <var>Source</var> in
  54         XSourceInitialization::setSource() has to be an
  55         implementation of service CachedDynamicResultSetStub
  56
  57         <p>This interface is required.
  58      */
  59     interface com::sun::star::ucb::XSourceInitialization;
  60 };
  61
  62
  63 }; }; }; };
  64
  65 #endif
  66
  67 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */