summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/ucb/XCachedDynamicResultSetFactory.idl
blob: 7949f837be514a20b107fe96a0a6410d2cf2c4fd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
/*************************************************************************
 *
 *  $RCSfile: XCachedDynamicResultSetFactory.idl,v $
 *
 *  $Revision: 1.3 $
 *
 *  last change: $Author: mi $ $Date: 2000-11-08 12:44:52 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library 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 for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (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.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_ucb_XCachedDynamicResultSetFactory_idl__
#define __com_sun_star_ucb_XCachedDynamicResultSetFactory_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_XContentIdentifierMapping_idl__
#include <com/sun/star/ucb/XContentIdentifierMapping.idl>
#endif

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

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

//=============================================================================
/** helps to get an remote optimized access for a given <type>DynamicResultSet
</type>.

<p>Pay attention to instanciate this helper on clientside where your want to
read the data respectively where you have instantiated the listener to the
<type>XDynamicResultSet</type>.

<p>The needed stub on server side you can create with
<type>XCachedDynamicResultSetStubFactory</type>.
*/

[ uik(D5F56011-5298-11d4-8B1B0010-4BCAF449), ident( "XCachedDynamicResultSetFactory", 1.0 ) ]
interface XCachedDynamicResultSetFactory: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------
    /** provides the creation of a <type>CachedDynamicResultSet</type>.

        <p>The returned interface is a implementations of
        service <type>CachedDynamicResultSet</type>.

        <p><paramter>SourceStub</parameter> has to be an implememntation of
        service <type>CachedDynamicResultSetStub</type>. It can be NULL also,
        in this case you can use the interface <type>XSourceInitialization</type>
        of <type>CachedDynamicResultSet</type> to set the stub afterwards.

        <p><parameter>ContentIdentifierMapping</parameter> is not required
        but can be set if it is necessary to change the identity of the contents
        accessable via the interface <type>XContentAccess</type> of the
        <type>ContentResultSet</type> (e.g., if merging two sources of the
        same type).
    */
    com::sun::star::ucb::XDynamicResultSet  createCachedDynamicResultSet(
          [in] com::sun::star::ucb::XDynamicResultSet SourceStub
        , [in] com::sun::star::ucb::XContentIdentifierMapping ContentIdentifierMapping );
};

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

}; }; }; };

#endif