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_XCachedDynamicResultSetFactory_idl__
24#define __com_sun_star_ucb_XCachedDynamicResultSetFactory_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
34#ifndef __com_sun_star_ucb_XContentIdentifierMapping_idl__
35#include <com/sun/star/ucb/XContentIdentifierMapping.idl>
36#endif
37
38//=============================================================================
39
40module com { module sun { module star { module ucb {
41
42//=============================================================================
43/** creates a <type>CachedDynamicResultSet</type>.
44
45	<p>Pay attention to instanciate this helper on clientside where your want
46	to read the data respectively where you have instantiated the listener to
47	the	<type>XDynamicResultSet</type>.
48
49	<p>The needed stub on server side can be created using
50	<type>XCachedDynamicResultSetStubFactory</type>.
51*/
52
53published interface XCachedDynamicResultSetFactory: com::sun::star::uno::XInterface
54{
55	//-------------------------------------------------------------------------
56	/**	creates a remote optimizes <type>XDynamicResultSet</type>.
57
58		@param SourceStub
59		must be an instance of service <type>CachedDynamicResultSetStub</type>.
60		It can be <NULL/>. In this case you can use the interface
61		<type>XSourceInitialization</type> of the returned
62		<type>CachedDynamicResultSet</type> to set the stub later.
63
64		@param ContentIdentifierMapping
65		is not required, but can be set if it is necessary to change the
66		identity of the contents accessable via the interface
67		<type>XContentAccess</type> of the <type>ContentResultSet</type>
68		(e.g., if merging two sources of the same type).
69
70		@returns
71		an instance of service <type>CachedDynamicResultSet</type>.
72	*/
73	com::sun::star::ucb::XDynamicResultSet	createCachedDynamicResultSet(
74		  [in] com::sun::star::ucb::XDynamicResultSet SourceStub
75		, [in] com::sun::star::ucb::XContentIdentifierMapping ContentIdentifierMapping );
76};
77
78//=============================================================================
79
80}; }; }; };
81
82#endif
83