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#ifndef __com_sun_star_configuration_backend_XLayerContentDescriber_idl__
24#define __com_sun_star_configuration_backend_XLayerContentDescriber_idl__
25
26#ifndef __com_sun_star_configuration_backend_PropertyInfo_idl__
27#include <com/sun/star/configuration/backend/PropertyInfo.idl>
28#endif
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34#ifndef __com_sun_star_configuration_backend_XLayerHandler_idl__
35#include <com/sun/star/configuration/backend/XLayerHandler.idl>
36#endif
37
38#ifndef __com_sun_star_lang_NullPointerException_idl__
39#include <com/sun/star/lang/NullPointerException.idl>
40#endif
41
42#ifndef __com_sun_star_configuration_backend_MalformedDataException_idl__
43#include <com/sun/star/configuration/backend/MalformedDataException.idl>
44#endif
45
46//=============================================================================
47
48module com { module sun { module star { module configuration { module backend {
49
50//=============================================================================
51
52/**
53   describe the contents of a layer to an XLayerHander object. The contents of
54   the layer is contained in the sequence of PropertyInfo structures
55   @see PropertyInfo
56
57*/
58interface XLayerContentDescriber : ::com::sun::star::uno::XInterface
59{
60	//-------------------------------------------------------------------------
61
62    /**
63      describes the contents of the layer to an <type>XLayerHandler</type>.
64
65      @param aHandler
66            Handler object that will receive calls
67            describing the contents of the layer
68
69      @param aPropertyInfos
70             sequence of PropertyInfo structs contained
71             all required property information
72
73      @throws com::sun::star::lang::NullPointerException
74              if a <NULL/> handler is passed.
75      @throws com::sun::star::configuration::backend::MalformedDataException
76              if the data read from the layer is rejected as invalid by the
77              <type>XLayerHandler</type>.
78	*/
79    void describeLayer([in] XLayerHandler aHandler,
80                       [in] sequence<PropertyInfo> aPropertyInfos)
81        raises (com::sun::star::lang::NullPointerException,
82                com::sun::star::lang::WrappedTargetException,
83                MalformedDataException) ;
84
85	//-------------------------------------------------------------------------
86} ;
87
88//=============================================================================
89
90} ; } ; } ; } ; } ;
91#endif
92