xref: /AOO41X/main/offapi/com/sun/star/ucb/XSortedDynamicResultSetFactory.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_ucb_XSortedDynamicResultSetFactory_idl__
24#define __com_sun_star_ucb_XSortedDynamicResultSetFactory_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_ucb_XDynamicResultSet_idl__
31#include <com/sun/star/ucb/XDynamicResultSet.idl>
32#endif
33#ifndef __com_sun_star_ucb_NumberedSortingInfo_idl__
34#include <com/sun/star/ucb/NumberedSortingInfo.idl>
35#endif
36#ifndef __com_sun_star_ucb_XAnyCompareFactory_idl__
37#include <com/sun/star/ucb/XAnyCompareFactory.idl>
38#endif
39
40//=============================================================================
41
42module com { module sun { module star { module ucb {
43
44//=============================================================================
45/** Provides a method to create an <type>XDynamicResultSet</type> which
46    will be sorted according to the given sorting options.
47*/
48
49published interface XSortedDynamicResultSetFactory: com::sun::star::uno::XInterface
50{
51    //-------------------------------------------------------------------------
52    /** creates a sorted <type>XDynamicResultSet</type> depending on internal
53        data, an (unsorted) XDynamicResultSet and the sorting info.
54
55        @returns
56        a sorted resultset.
57
58        @param Source
59        the (unsorted) source resultset
60
61        @param Info
62        the sort criteria
63
64        @param CompareFactory
65        a factory for compare objects.
66    */
67    com::sun::star::ucb::XDynamicResultSet  createSortedDynamicResultSet(
68                [in] com::sun::star::ucb::XDynamicResultSet Source,
69                [in] sequence<com::sun::star::ucb::NumberedSortingInfo> Info,
70                [in] com::sun::star::ucb::XAnyCompareFactory CompareFactory );
71};
72
73//=============================================================================
74
75}; }; }; };
76
77#endif
78