blob: 20eab14740069b04703bf35c66ca0b5912748d13 (
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
|
/* -*- 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_configuration_backend_XBackend_idl__
#define __com_sun_star_configuration_backend_XBackend_idl__
#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/configuration/backend/XUpdateHandler.idl>
#include <com/sun/star/configuration/backend/XLayer.idl>
#include <com/sun/star/configuration/backend/XSchema.idl>
#include <com/sun/star/configuration/backend/BackendAccessException.idl>
#include <com/sun/star/lang/IllegalArgumentException.idl>
#include <com/sun/star/lang/NoSupportException.idl>
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
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
