xref: /aoo41x/main/offapi/com/sun/star/ucb/XCachedContentResultSetFactory.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_XCachedContentResultSetFactory_idl__
#define __com_sun_star_ucb_XCachedContentResultSetFactory_idl__

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

#ifndef __com_sun_star_sdbc_XResultSet_idl__
#include <com/sun/star/sdbc/XResultSet.idl>
#endif

#ifndef __com_sun_star_ucb_XContentIdentifierMapping_idl__
#include <com/sun/star/ucb/XContentIdentifierMapping.idl>
#endif

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

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

//=============================================================================
/** creates a <type>CachedContentResultSet</type>.
*/

published interface XCachedContentResultSetFactory: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------
	/**	creates a remote optimized
        <type scope="com::sun::star::sdbc">XResultSet</type>.

		@param xSource
		must be an instance of service <type>CachedContentResultSetStub</type>.

		@param xMapping
		can be used for optimization of remote access via the interface
		<type>XContentAccess</type> of the <type>CachedContentResultSet</type>.
		This paramter can be <NULL/>.

		@returns
		an instance of service <type>CachedContentResultSet</type>.
	*/
	com::sun::star::sdbc::XResultSet	createCachedContentResultSet(
				[in] com::sun::star::sdbc::XResultSet xSource,
				[in] com::sun::star::ucb::XContentIdentifierMapping xMapping );
};

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

}; }; }; };

#endif