xref: /aoo41x/main/offapi/com/sun/star/ucb/CachedDynamicResultSet.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_ucb_CachedDynamicResultSet_idl__
#define __com_sun_star_ucb_CachedDynamicResultSet_idl__

#ifndef __com_sun_star_ucb_XDynamicResultSet_idl__
#include <com/sun/star/ucb/XDynamicResultSet.idl>
#endif

#ifndef __com_sun_star_ucb_XSourceInitialization_idl__
#include <com/sun/star/ucb/XSourceInitialization.idl>
#endif

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

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

//=============================================================================
/** provides read access to a static or dynamically changing
	<type>ContentResultSet</type>.

	<p>For example, a <type>DynamicResultSet</type> is returned from the
    open-command executed by an <type>XCommandProcessor</type> of the service
    <type>Content</type>.
*/

published service CachedDynamicResultSet
{
	//-------------------------------------------------------------------------
	/** Provides remote optimized read access to a static or a dynamically
	    changing <type>ContentResultSet</type>.

        <p>The <type scope="com::sun::star::sdbc">XResultSet</type>s given to
        the listener in the first notification in the
        <type>WelcomeDynamicResultSetStruct</type> are implementations of the
        <type>CachedContentResultSet</type> service.

		<p>This interface is required.
	 */
	interface com::sun::star::ucb::XDynamicResultSet;

	//-------------------------------------------------------------------------
	/** provides the initialization of the <type>CachedDynamicResultSet</type>
		with a source object.

		<p>The <var>Source</var> in
		<member>XSourceInitialization::setSource</member> has to be an
		implementation of service <type>CachedDynamicResultSetStub</type>

		<p>This interface is required.
	 */
	interface com::sun::star::ucb::XSourceInitialization;
};

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

}; }; }; };

#endif