offapi/com/sun/star/ucb/XSortedDynamicResultSetFactory.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_XSortedDynamicResultSetFactory_idl__
  20 #define __com_sun_star_ucb_XSortedDynamicResultSetFactory_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 /** Provides a method to create an XDynamicResultSet which
  31     will be sorted according to the given sorting options.
  32 */
  33
  34 published interface XSortedDynamicResultSetFactory: com::sun::star::uno::XInterface
  35 {
  36     /** creates a sorted XDynamicResultSet depending on internal
  37         data, an (unsorted) XDynamicResultSet and the sorting info.
  38
  39         @returns
  40         a sorted result set.
  41
  42         @param Source
  43         the (unsorted) source result set
  44
  45         @param Info
  46         the sort criteria
  47
  48         @param CompareFactory
  49         a factory for compare objects.
  50     */
  51     com::sun::star::ucb::XDynamicResultSet  createSortedDynamicResultSet(
  52                 [in] com::sun::star::ucb::XDynamicResultSet Source,
  53                 [in] sequence<com::sun::star::ucb::NumberedSortingInfo> Info,
  54                 [in] com::sun::star::ucb::XAnyCompareFactory CompareFactory );
  55 };
  56
  57
  58 }; }; }; };
  59
  60 #endif
  61
  62 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */