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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
/*************************************************************************
*
* 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_configuration_backend_XBackend_idl__
#define __com_sun_star_configuration_backend_XBackend_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_configuration_backend_XUpdateHandler_idl__
#include <com/sun/star/configuration/backend/XUpdateHandler.idl>
#endif
#ifndef __com_sun_star_configuration_backend_XLayer_idl__
#include <com/sun/star/configuration/backend/XLayer.idl>
#endif
#ifndef __com_sun_star_configuration_backend_XSchema_idl__
#include <com/sun/star/configuration/backend/XSchema.idl>
#endif
#ifndef __com_sun_star_configuration_backend_BackendAccessException_idl__
#include <com/sun/star/configuration/backend/BackendAccessException.idl>
#endif
#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif
#ifndef __com_sun_star_lang_NoSupportException_idl__
#include <com/sun/star/lang/NoSupportException.idl>
#endif
//=============================================================================
module com { module sun { module star { module configuration { module backend {
//=============================================================================
/**
Handles access to layered data stored in a repository.
<p> Data can be retrieved on behalf of one or more entities.</p>
<p> There is an implied owner entity associated to the object
when it is created. This entity should be used for normal data access.
For administrative operations data of other entities can be accessed.
</p>
@see com::sun::star::configuration::backend::XBackendEntities
@see com::sun::star::configuration::backend::XSchemaSupplier
@since OOo 1.1.2
*/
published interface XBackend : ::com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
/**
retrieves the layers associated to the owner
entity for a component.
@param aComponent
component whose data will be accessed
@returns
a list of objects allowing access to the
component data for each layer associated to
the current entity
@throws com::sun::star::lang::IllegalArgumentException
if the component identifier is invalid
@throws com::sun::star::configuration::backend::BackendAccessException
if an error occurs while accessing the data.
@see com::sun::star::configuration::backend::XBackendEntities::getOwnerEntity()
*/
sequence<XLayer> listOwnLayers([in] string aComponent)
raises (BackendAccessException,
com::sun::star::lang::IllegalArgumentException) ;
//-------------------------------------------------------------------------
/**
creates an update handler for the owner entity
layer for a component.
@param aComponent
component whose data will be updated
@returns
an object allowing manipulation of the
component data for the current entity
@throws com::sun::star::lang::IllegalArgumentException
if the component identifier is invalid
@throws com::sun::star::lang::NoSupportException
if updates are not supported for this backend
@throws com::sun::star::configuration::backend::BackendAccessException
if an error occurs while accessing the data.
@see com::sun::star::configuration::backend::XBackendEntities::getOwnerEntity()
*/
XUpdateHandler getOwnUpdateHandler([in] string aComponent)
raises (BackendAccessException,
com::sun::star::lang::NoSupportException,
com::sun::star::lang::IllegalArgumentException) ;
//-------------------------------------------------------------------------
/**
retrieves the layers associated to an entity for a component.
@param aComponent
component whose data will be accessed
@param aEntity
entity whose data will be accessed
@returns
a list of objects allowing access to the
component data for each layer associated
with the entity.
@throws com::sun::star::lang::IllegalArgumentException
if the component identifier is invalid
or if the entity doesn't exist.
@throws com::sun::star::configuration::backend::BackendAccessException
if an error occurs while accessing the data.
@see com::sun::star::configuration::backend::XBackendEntities::supportsEntity()
*/
sequence<XLayer> listLayers([in] string aComponent,
[in] string aEntity)
raises (BackendAccessException,
com::sun::star::lang::IllegalArgumentException) ;
//-------------------------------------------------------------------------
/**
creates an update handler on an entity's layer for a component.
@param aComponent
component whose data will be updated
@param aEntity
entity whose data will be updated
@returns
an object allowing manipulation of the
component data for the entity
@throws com::sun::star::lang::IllegalArgumentException
if the component identifier is invalid
or if the entity doesn't exist.
@throws com::sun::star::lang::NoSupportException
if updates are not supported for this backend
@throws com::sun::star::configuration::backend::BackendAccessException
if an error occurs while accessing the data.
@see com::sun::star::configuration::backend::XBackendEntities::supportsEntity()
*/
XUpdateHandler getUpdateHandler([in] string aComponent,
[in] string aEntity)
raises (BackendAccessException,
com::sun::star::lang::NoSupportException,
com::sun::star::lang::IllegalArgumentException) ;
//-------------------------------------------------------------------------
} ;
//=============================================================================
} ; } ; } ; } ; } ;
#endif
|
