offapi/com/sun/star/ucb/XSortedDynamicResultSetFactory.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_ucb_XSortedDynamicResultSetFactory_idl__
  28 #define __com_sun_star_ucb_XSortedDynamicResultSetFactory_idl__
  29
  30 #ifndef __com_sun_star_uno_XInterface_idl__
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_ucb_XDynamicResultSet_idl__
  35 #include <com/sun/star/ucb/XDynamicResultSet.idl>
  36 #endif
  37 #ifndef __com_sun_star_ucb_NumberedSortingInfo_idl__
  38 #include <com/sun/star/ucb/NumberedSortingInfo.idl>
  39 #endif
  40 #ifndef __com_sun_star_ucb_XAnyCompareFactory_idl__
  41 #include <com/sun/star/ucb/XAnyCompareFactory.idl>
  42 #endif
  43
  44 //=============================================================================
  45
  46 module com { module sun { module star { module ucb {
  47
  48 //=============================================================================
  49 /** Provides a method to create an <type>XDynamicResultSet</type> which
  50     will be sorted according to the given sorting options.
  51 */
  52
  53 published interface XSortedDynamicResultSetFactory: com::sun::star::uno::XInterface
  54 {
  55     //-------------------------------------------------------------------------
  56     /** creates a sorted <type>XDynamicResultSet</type> depending on internal
  57         data, an (unsorted) XDynamicResultSet and the sorting info.
  58
  59         @returns
  60         a sorted resultset.
  61
  62         @param Source
  63         the (unsorted) source resultset
  64
  65         @param Info
  66         the sort criteria
  67
  68         @param CompareFactory
  69         a factory for compare objects.
  70     */
  71     com::sun::star::ucb::XDynamicResultSet  createSortedDynamicResultSet(
  72                 [in] com::sun::star::ucb::XDynamicResultSet Source,
  73                 [in] sequence<com::sun::star::ucb::NumberedSortingInfo> Info,
  74                 [in] com::sun::star::ucb::XAnyCompareFactory CompareFactory );
  75 };
  76
  77 //=============================================================================
  78
  79 }; }; }; };
  80
  81 #endif