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
|
/* -*- 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_XBackendEntities_idl__
#define __com_sun_star_configuration_backend_XBackendEntities_idl__
#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/lang/IllegalArgumentException.idl>
#include <com/sun/star/configuration/backend/BackendAccessException.idl>
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
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
