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
|
/*************************************************************************
*
* 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_XBackendEntities_idl__
#define __com_sun_star_configuration_backend_XBackendEntities_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif
#ifndef __com_sun_star_configuration_backend_BackendAccessException_idl__
#include <com/sun/star/configuration/backend/BackendAccessException.idl>
#endif
//=============================================================================
module com { module sun { module star { module configuration { module backend {
//=============================================================================
/**
Provides functionality relating to common and supported entities
for a configuration data backend.
@see com::sun::star::configuration::backend::XBackend
@see com::sun::star::configuration::backend::XMultiLayerStratum
@since OOo 1.1.2
*/
published interface XBackendEntities : ::com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
/**
provides the entity id of the owner entity of the backend.
@returns
an entity identifier for the owner entity.
<p> The owner entity is the default entity for the backend.
For normal configuration data access the owner entity
should always be used.
</p>
@see com::sun::star::configuration::backend::XBackend::listOwnLayers()
@see com::sun::star::configuration::backend::XBackend::getOwnUpdateHandler()
*/
string getOwnerEntity() ;
//-------------------------------------------------------------------------
/**
provides the entity id of an entity for general administrative access.
<p> The admin entity is an entity that should be used to
read and manage configuration data that applies to all entities
within the backend.
</p>
@returns
an entity identifier for the admin entity or
an empty string, if there is no entity that can be used for
general administrative access.
*/
string getAdminEntity() ;
//-------------------------------------------------------------------------
/**
determines, if a given entity id exists in this backend.
@param aEntity
The name of an entity.
@throws com::sun::star::configuration::backend::BackendAccessException
if an error occurs while accessing the backend.
@returns
<TRUE/>, if aEntity is a valid, existing entity for this backend,
<FALSE/> otherwise.
*/
boolean supportsEntity([in] string aEntity)
raises( BackendAccessException );
//-------------------------------------------------------------------------
/**
determines, if two given entity ids denote the same entity.
@param aEntity
The name of an entity.
@param aOtherEntity
The name of another entity.
@returns
<TRUE/>, if aEntity and aOtherEntity denote the same entity
within this backend, <FALSE/> otherwise.
@throws com::sun::star::configuration::backend::BackendAccessException
if an error occurs while accessing the backend.
@throws com::sun::star::lang::IllegalArgumentException
if either entity does not exist.
*/
boolean isEqualEntity([in] string aEntity, [in] string aOtherEntity)
raises( BackendAccessException, com::sun::star::lang::IllegalArgumentException) ;
//-------------------------------------------------------------------------
} ;
//=============================================================================
} ; } ; } ; } ; } ;
#endif
|
