xref: /AOO41X/main/offapi/com/sun/star/ucb/XCachedDynamicResultSetFactory.idl (revision 1ecadb572e7010ff3b3382ad9bf179dbc6efadbb)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_ucb_XCachedDynamicResultSetFactory_idl__
28#define __com_sun_star_ucb_XCachedDynamicResultSetFactory_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34#ifndef __com_sun_star_ucb_XDynamicResultSet_idl__
35#include <com/sun/star/ucb/XDynamicResultSet.idl>
36#endif
37
38#ifndef __com_sun_star_ucb_XContentIdentifierMapping_idl__
39#include <com/sun/star/ucb/XContentIdentifierMapping.idl>
40#endif
41
42//=============================================================================
43
44module com { module sun { module star { module ucb {
45
46//=============================================================================
47/** creates a <type>CachedDynamicResultSet</type>.
48
49	<p>Pay attention to instanciate this helper on clientside where your want
50	to read the data respectively where you have instantiated the listener to
51	the	<type>XDynamicResultSet</type>.
52
53	<p>The needed stub on server side can be created using
54	<type>XCachedDynamicResultSetStubFactory</type>.
55*/
56
57published interface XCachedDynamicResultSetFactory: com::sun::star::uno::XInterface
58{
59	//-------------------------------------------------------------------------
60	/**	creates a remote optimizes <type>XDynamicResultSet</type>.
61
62		@param SourceStub
63		must be an instance of service <type>CachedDynamicResultSetStub</type>.
64		It can be <NULL/>. In this case you can use the interface
65		<type>XSourceInitialization</type> of the returned
66		<type>CachedDynamicResultSet</type> to set the stub later.
67
68		@param ContentIdentifierMapping
69		is not required, but can be set if it is necessary to change the
70		identity of the contents accessable via the interface
71		<type>XContentAccess</type> of the <type>ContentResultSet</type>
72		(e.g., if merging two sources of the same type).
73
74		@returns
75		an instance of service <type>CachedDynamicResultSet</type>.
76	*/
77	com::sun::star::ucb::XDynamicResultSet	createCachedDynamicResultSet(
78		  [in] com::sun::star::ucb::XDynamicResultSet SourceStub
79		, [in] com::sun::star::ucb::XContentIdentifierMapping ContentIdentifierMapping );
80};
81
82//=============================================================================
83
84}; }; }; };
85
86#endif
87