offapi/com/sun/star/ucb/XCachedContentResultSetFactory.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_XCachedContentResultSetFactory_idl__
  20 #define __com_sun_star_ucb_XCachedContentResultSetFactory_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/sdbc/XResultSet.idl>
  24 #include <com/sun/star/ucb/XContentIdentifierMapping.idl>
  25
  26
  27 module com { module sun { module star { module ucb {
  28
  29 /** creates a CachedContentResultSet.
  30 */
  31
  32 published interface XCachedContentResultSetFactory: com::sun::star::uno::XInterface
  33 {
  34     /** creates a remote optimized
  35         com::sun::star::sdbc::XResultSet.
  36
  37         @param xSource
  38         must be an instance of service CachedContentResultSetStub.
  39
  40         @param xMapping
  41         can be used for optimization of remote access via the interface
  42         XContentAccess of the CachedContentResultSet.
  43         This parameter can be `NULL`.
  44
  45         @returns
  46         an instance of service CachedContentResultSet.
  47     */
  48     com::sun::star::sdbc::XResultSet    createCachedContentResultSet(
  49                 [in] com::sun::star::sdbc::XResultSet xSource,
  50                 [in] com::sun::star::ucb::XContentIdentifierMapping xMapping );
  51 };
  52
  53
  54 }; }; }; };
  55
  56 #endif
  57
  58 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */