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

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