blob: 74dc11e27820bb378731e026939d57aa64e32036 (
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
|
/*************************************************************************
*
* 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_XCompositeLayer_idl__
#define __com_sun_star_configuration_backend_XCompositeLayer_idl__
#ifndef __com_sun_star_configuration_backend_XLayer_idl__
#include <com/sun/star/configuration/backend/XLayer.idl>
#endif
#ifndef __com_sun_star_lang_NullPointerException_idl__
#include <com/sun/star/lang/NullPointerException.idl>
#endif
#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif
#ifndef __com_sun_star_lang_WrappedTargetException_idl__
#include <com/sun/star/lang/WrappedTargetException.idl>
#endif
#ifndef __com_sun_star_configuration_backend_MalformedDataException_idl__
#include <com/sun/star/configuration/backend/MalformedDataException.idl>
#endif
//==============================================================================
module com { module sun { module star { module configuration { module backend {
//==============================================================================
/**
provides read access to layers that contain sublayers accessible through an
additional criterion (for instance the locale they contain data for).
@since OOo 1.1.2
*/
published interface XCompositeLayer : XLayer
{
//--------------------------------------------------------------------------
/**
Returns a list of the criteria that can be used to access the
sublayers.
@return
a list supported sublayer identifiers
@throws com::sun::star::lang::WrappedTargetException
if an error occurs in the retrieval of the data.
*/
sequence<string> listSubLayerIds()
raises (com::sun::star::lang::WrappedTargetException) ;
//--------------------------------------------------------------------------
/**
Describes the content of a particular sublayer to
an <type>XLayerHandler</type>.
@param aHandler
Handler object that will receive calls
describing the contents of the sublayer.
@param aSubLayerId
Identifier of the sublayer to be read.
<p> Must be one the identifiers returned by
<member>XCompositeLayer::listSubLayerIds()</member>
</p>
@throws com::sun::star::lang::NullPointerException
if a <NULL/> handler is passed.
@throws com::sun::star::lang::IllegalArgumentException
if the identifier is invalid.
@throws com::sun::star::lang::WrappedTargetException
if an error occurs in the access to or processing of the data.
@throws com::sun::star::configuration::backend::MalformedDataException
if the data read from the layer is rejected as invalid by the
<type>XLayerHandler</type>.
*/
void readSubLayerData([in] XLayerHandler aHandler, [in] string aSubLayerId)
raises (com::sun::star::lang::NullPointerException,
com::sun::star::lang::IllegalArgumentException,
com::sun::star::lang::WrappedTargetException,
MalformedDataException) ;
//--------------------------------------------------------------------------
} ;
//==============================================================================
} ; } ; } ; } ; } ;
#endif
|
