1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_configuration_backend_XCompositeLayer_idl__
25#define __com_sun_star_configuration_backend_XCompositeLayer_idl__
26
27#ifndef __com_sun_star_configuration_backend_XLayer_idl__
28#include <com/sun/star/configuration/backend/XLayer.idl>
29#endif
30
31#ifndef __com_sun_star_lang_NullPointerException_idl__
32#include <com/sun/star/lang/NullPointerException.idl>
33#endif
34
35#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
36#include <com/sun/star/lang/IllegalArgumentException.idl>
37#endif
38
39#ifndef __com_sun_star_lang_WrappedTargetException_idl__
40#include <com/sun/star/lang/WrappedTargetException.idl>
41#endif
42
43#ifndef __com_sun_star_configuration_backend_MalformedDataException_idl__
44#include <com/sun/star/configuration/backend/MalformedDataException.idl>
45#endif
46
47//==============================================================================
48
49module com { module sun { module star { module configuration { module backend {
50
51//==============================================================================
52
53/**
54  provides read access to layers that contain sublayers accessible through an
55  additional criterion (for instance the locale they contain data for).
56
57    @since OpenOffice 1.1.2
58  */
59published interface XCompositeLayer : XLayer
60{
61    //--------------------------------------------------------------------------
62
63    /**
64      Returns a list of the criteria that can be used to access the
65      sublayers.
66
67      @return
68            a list supported sublayer identifiers
69
70      @throws com::sun::star::lang::WrappedTargetException
71            if an error occurs in the retrieval of the data.
72      */
73    sequence<string> listSubLayerIds()
74        raises (com::sun::star::lang::WrappedTargetException) ;
75
76    //--------------------------------------------------------------------------
77
78    /**
79      Describes the content of a particular sublayer to
80      an <type>XLayerHandler</type>.
81
82      @param aHandler
83            Handler object that will receive calls
84            describing the contents of the sublayer.
85
86      @param aSubLayerId
87            Identifier of the sublayer to be read.
88            <p> Must be one the identifiers returned by
89                <member>XCompositeLayer::listSubLayerIds()</member>
90            </p>
91
92      @throws com::sun::star::lang::NullPointerException
93              if a <NULL/> handler is passed.
94      @throws com::sun::star::lang::IllegalArgumentException
95              if the identifier is invalid.
96      @throws com::sun::star::lang::WrappedTargetException
97              if an error occurs in the access to or processing of the data.
98      @throws com::sun::star::configuration::backend::MalformedDataException
99              if the data read from the layer is rejected as invalid by the
100              <type>XLayerHandler</type>.
101      */
102    void readSubLayerData([in] XLayerHandler aHandler, [in] string aSubLayerId)
103        raises (com::sun::star::lang::NullPointerException,
104                com::sun::star::lang::IllegalArgumentException,
105                com::sun::star::lang::WrappedTargetException,
106                MalformedDataException) ;
107
108    //--------------------------------------------------------------------------
109} ;
110
111//==============================================================================
112
113} ; } ; } ; } ; } ;
114#endif
115