blob: 0f835706042aa5a4737d4945aa3f72f58a667843 (
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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* 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 .
*/
#ifndef __com_sun_star_ucb_XDynamicResultSet_idl__
#define __com_sun_star_ucb_XDynamicResultSet_idl__
#include <com/sun/star/lang/XComponent.idl>
#include <com/sun/star/ucb/XDynamicResultSetListener.idl>
#include <com/sun/star/ucb/ListenerAlreadySetException.idl>
#include <com/sun/star/sdbc/XResultSet.idl>
#include <com/sun/star/ucb/AlreadyInitializedException.idl>
#include <com/sun/star/ucb/ServiceNotFoundException.idl>
module com { module sun { module star { module ucb {
/** Provides read access to a <type>ContentResultSet</type>.
<p>
You can either get a simple static <type>ContentResultSet</type> or you can
listen to change-notifications and than swap from the old to a new
<type>ContentResultSet</type>.
</p>
<p>The following describes the dynamic use:</p>
<p>
<type>XDynamicResultSet</type> provides the possibility to get notifications
about changes on a <type>ContentResultSet</type> and have an
listener-controlled update from one version to the next version. Two
<type>ContentResultSet</type> implementations were given to the listener in
the first notification as interface
<type scope="com::sun::star::sdbc">XResultSet</type>.
</p>
<p>
To get notifications the listener has to be of type
<type>XDynamicResultSetListener</type>.
</p>
<p>
After registration you will get notifications for events of type
<type>ListEvent</type>.
</p>
<p>
The calling of <member>XDynamicResultSetListener::notify</member> has
to happen in an own thread, because it could take a longer time and any
actions ??? until the listener returns the call. So don't block the notify-causing
action.
</p>
<p>
While one notify-call is going on:
</p>
<ol>
<li> The listener is allowed to access both <type>ContentResultSet</type>s,
they must be both valid.</li>
<li> It is not allowed to start a second notify-call.</li>
<li> All additional things we want to send as notification are to be
queued.</li>
<li> Any other calls are to be accepted and treated.</li>
</ol>
<p>
After the listener has returned the notify-call:
</p>
<ol>
<li> The listener is allowed to access the new
<type>ContentResultSet</type>. The new one is first assigned in the
WELCOME-event and than the ResultSets are always swapped.</li>
<li> The listener is not allowed to access the old
<type>ContentResultSet</type>.</li>
</ol>
*/
published interface XDynamicResultSet: com::sun::star::lang::XComponent
{
/** Call this, if you don't care about any changes.
@returns
an <type scope="com::sun::star::sdbc">XResultSet</type> that is
implemented as <type>ContentResultSet</type>. Its content will never
change.
@trows ListenerAlreadySetException
if someone already has registered as listener via
<member>XDynamicResultSet::setListener</member> or if someone has
established a connection to a <type>CachedDynamicResultSet</type>
via <member>XDynamicResultSet::connectToCache</member>.
*/
com::sun::star::sdbc::XResultSet getStaticResultSet()
raises( com::sun::star::ucb::ListenerAlreadySetException );
/** Call this, if you want to get notifications about changes.
<p>The implementor has to call
<member scope="com::sun::star::lang">XComponent::addEventListener</member>
in this method, so that we can call
<member scope="com::sun::star::lang">XEventListener::disposing</member>
at the listener
@param Listener
a listener for result set notifications
@throws ListenerAlreadySetException
if this method is called more than once during the life of the
implementation object or if this method is called if someone already
has fetched the <type>ContentResultSet</type> via
<member>XDynamicResultSet::getStaticResultSet</member>.
*/
void setListener( [in] XDynamicResultSetListener Listener )
raises( com::sun::star::ucb::ListenerAlreadySetException );
/** Connects this to a <type>CachedDynamicResultSet</type> for optimized
remote data transport.
<p>This method creates a <type>CachedDynamicResultSetStub</type>
and sets it as Source to the given cache.
<p>After this method has returned you can and have to use the given
result set cache for further access.
@param Cache
has to be an implementation of the service
<type>CachedDynamicResultSet</type>. In particular it has to support
the interface <type>XSourceInitialization</type>.
@throws ListenerAlreadySetException
if if someone already has fetched the <type>ContentResultSet</type> via
<member>XDynamicResultSet::getStaticResultSet</member>.
@throws AlreadyInitializedException
if <var>Cache</var> was already initialized with another source.
@throws ServiceNotFoundException
*/
void connectToCache( [in] XDynamicResultSet Cache )
raises( com::sun::star::ucb::ListenerAlreadySetException
, com::sun::star::ucb::AlreadyInitializedException
, com::sun::star::ucb::ServiceNotFoundException );
/** Using this method you can get information, whether the offered
<type>ContentResultSet</type>s are sorted or filtered etc correctly as
demanded during the creation of the <type>XDynamicResultSet</type>.
@returns
zero or more constants of the <type>ContentResultSetCapability</type>
constants group.
*/
short getCapabilities();
};
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
