offapi/com/sun/star/ucb/XCachedDynamicResultSetFactory.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_XCachedDynamicResultSetFactory_idl__
  20 #define __com_sun_star_ucb_XCachedDynamicResultSetFactory_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/ucb/XDynamicResultSet.idl>
  24 #include <com/sun/star/ucb/XContentIdentifierMapping.idl>
  25
  26
  27 module com { module sun { module star { module ucb {
  28
  29 /** creates a CachedDynamicResultSet.
  30
  31     <p>Pay attention to instantiate this helper on client side where your want
  32     to read the data respectively where you have instantiated the listener to
  33     the XDynamicResultSet.
  34
  35     <p>The needed stub on server side can be created using
  36     XCachedDynamicResultSetStubFactory.
  37 */
  38
  39 published interface XCachedDynamicResultSetFactory: com::sun::star::uno::XInterface
  40 {
  41     /** creates a remote optimizes XDynamicResultSet.
  42
  43         @param SourceStub
  44         must be an instance of service CachedDynamicResultSetStub.
  45         It can be `NULL`. In this case you can use the interface
  46         XSourceInitialization of the returned
  47         CachedDynamicResultSet to set the stub later.
  48
  49         @param ContentIdentifierMapping
  50         is not required, but can be set if it is necessary to change the
  51         identity of the contents accessible via the interface
  52         XContentAccess of the ContentResultSet
  53         (e.g., if merging two sources of the same type).
  54
  55         @returns
  56         an instance of service CachedDynamicResultSet.
  57     */
  58     com::sun::star::ucb::XDynamicResultSet  createCachedDynamicResultSet(
  59           [in] com::sun::star::ucb::XDynamicResultSet SourceStub
  60         , [in] com::sun::star::ucb::XContentIdentifierMapping ContentIdentifierMapping );
  61 };
  62
  63
  64 }; }; }; };
  65
  66 #endif
  67
  68 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */