offapi/com/sun/star/ucb/XCachedDynamicResultSetStubFactory.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_XCachedDynamicResultSetStubFactory_idl__
  20 #define __com_sun_star_ucb_XCachedDynamicResultSetStubFactory_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/ucb/XDynamicResultSet.idl>
  24 #include <com/sun/star/ucb/NumberedSortingInfo.idl>
  25 #include <com/sun/star/ucb/XAnyCompareFactory.idl>
  26
  27
  28 module com { module sun { module star { module ucb {
  29
  30 /** creates a CachedDynamicResultSetStub and connects a non-remote
  31     optimized DynamicResultSet to a remote optimized
  32     CachedDynamicResultSet.
  33
  34     <p>Pay attention to instantiate this helper on server side where your source
  35     DynamicResultSet was instantiated.
  36
  37     <p>Method
  38     XCachedDynamicResultSetStubFactory::createCachedDynamicResultSetStub()
  39     can be used to create a stub on server side.
  40
  41     <p>If you have instantiated a CachedDynamicResultSet on client
  42     side already, use method connectToCache() to connect your
  43     given DynamicResultSet with this Cache.
  44
  45     <p>The needed cache on server side you can create using
  46     XCachedDynamicResultSetFactory.
  47 */
  48
  49 published interface XCachedDynamicResultSetStubFactory: com::sun::star::uno::XInterface
  50 {
  51     /** creates a remote optimizes XDynamicResultSet.
  52
  53         @param Source
  54         must be an instance of service DynamicResultSet.
  55
  56         @returns
  57         an instance of service CachedDynamicResultSetStub.
  58     */
  59
  60     com::sun::star::ucb::XDynamicResultSet  createCachedDynamicResultSetStub(
  61                 [in] com::sun::star::ucb::XDynamicResultSet Source );
  62
  63     /** If you have instantiated a CachedDynamicResultSet on
  64         client side already, use this to connect your given Source on server
  65         side to the TargetCache.
  66
  67         @param Source
  68         is an instance of service DynamicResultSet.
  69
  70         @param TargetCache
  71         is an instance of service CachedDynamicResultSet.
  72
  73         @param SortingInfo
  74         can be an empty sequence. Otherwise, Source will be sorted according
  75         to the given sorting data.
  76
  77         @param CompareFactory
  78         will be ignored unless SortingInfo is not empty. Then the supplied
  79         factory will be used to instantiate objects used to compare the
  80         properties that are involved in sorting.
  81
  82         @throws ListenerAlreadySetException
  83         if \p Source is already in use.
  84
  85         @throws AlreadyInitializedException
  86         if \p TargetCache already has been initialized.
  87     */
  88     void connectToCache(
  89                   [in] com::sun::star::ucb::XDynamicResultSet Source
  90                 , [in] com::sun::star::ucb::XDynamicResultSet TargetCache
  91                 , [in] sequence< com::sun::star::ucb::NumberedSortingInfo > SortingInfo
  92                 , [in] com::sun::star::ucb::XAnyCompareFactory CompareFactory
  93                 )
  94                 raises(
  95                   com::sun::star::ucb::ListenerAlreadySetException
  96                 , com::sun::star::ucb::AlreadyInitializedException
  97                  );
  98 };
  99
 100
 101 }; }; }; };
 102
 103 #endif
 104
 105 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */