xref: /trunk/main/offapi/com/sun/star/ucb/XSortedDynamicResultSetFactory.idl (revision d1766043)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_ucb_XSortedDynamicResultSetFactory_idl__
#define __com_sun_star_ucb_XSortedDynamicResultSetFactory_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_ucb_XDynamicResultSet_idl__
#include <com/sun/star/ucb/XDynamicResultSet.idl>
#endif
#ifndef __com_sun_star_ucb_NumberedSortingInfo_idl__
#include <com/sun/star/ucb/NumberedSortingInfo.idl>
#endif
#ifndef __com_sun_star_ucb_XAnyCompareFactory_idl__
#include <com/sun/star/ucb/XAnyCompareFactory.idl>
#endif

//=============================================================================

module com { module sun { module star { module ucb {

//=============================================================================
/** Provides a method to create an <type>XDynamicResultSet</type> which
    will be sorted according to the given sorting options.
*/

published interface XSortedDynamicResultSetFactory: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------
	/**	creates a sorted <type>XDynamicResultSet</type> depending on internal
	    data, an (unsorted) XDynamicResultSet and the sorting info.

		@returns
		a sorted resultset.

		@param Source
		the (unsorted) source resultset

		@param Info
		the sort criteria

		@param CompareFactory
		a factory for compare objects.
	*/
	com::sun::star::ucb::XDynamicResultSet	createSortedDynamicResultSet(
				[in] com::sun::star::ucb::XDynamicResultSet Source,
				[in] sequence<com::sun::star::ucb::NumberedSortingInfo> Info,
				[in] com::sun::star::ucb::XAnyCompareFactory CompareFactory );
};

//=============================================================================

}; }; }; };

#endif