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_XLayerImporter_idl__
24#define __com_sun_star_configuration_backend_XLayerImporter_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_configuration_backend_XLayer_idl__
31#include <com/sun/star/configuration/backend/XLayer.idl>
32#endif
33
34#ifndef __com_sun_star_configuration_backend_XBackend_idl__
35#include <com/sun/star/configuration/backend/XBackend.idl>
36#endif
37
38#ifndef __com_sun_star_configuration_backend_MalformedDataException_idl__
39#include <com/sun/star/configuration/backend/MalformedDataException.idl>
40#endif
41#ifndef __com_sun_star_lang_NullPointerException_idl__
42#include <com/sun/star/lang/NullPointerException.idl>
43#endif
44#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
45#include <com/sun/star/lang/IllegalArgumentException.idl>
46#endif
47#ifndef __com_sun_star_lang_WrappedTargetException_idl__
48#include <com/sun/star/lang/WrappedTargetException.idl>
49#endif
50
51//=============================================================================
52
53module com { module sun { module star { module configuration { module backend {
54
55//=============================================================================
56
57/** allows importing a layer into a <type>Backend</type>
58
59  @since OOo 1.1.2
60*/
61published interface XLayerImporter : ::com::sun::star::uno::XInterface
62{
63	//-------------------------------------------------------------------------
64
65    /** gets the target backend for importing.
66
67        @returns
68            the <type>Backend</type> into which layers are
69            imported by <member>XLayerImporter::importLayer()<member/>.
70
71	*/
72    XBackend getTargetBackend();
73
74	//-------------------------------------------------------------------------
75
76    /** sets the target backend for importing.
77
78        @param aBackend
79            a <type>Backend</type> into which layers should be
80            imported by <method>XLayerImporter::importLayer()<method/>.
81
82        @throws com::sun::star::lang::NullPointerException
83            if the backend passed is <NULL/>.
84	*/
85    void setTargetBackend([in] XBackend aBackend)
86        raises (com::sun::star::lang::NullPointerException) ;
87
88	//-------------------------------------------------------------------------
89
90    /** Imports the layer given into the backend.
91
92        <p>This method imports data for the current entity of the backend.</p>
93
94        @param aLayer
95            a layer whose data will be imported into the backend
96
97        @throws com::sun::star::lang::NullPointerException
98            if the layer passed is <NULL/> or no backend is available.
99
100        @throws com::sun::star::configuration::backend::MalformedDataException
101            if the layer passed is invalid
102
103        @throws com::sun::star::lang::IllegalArgumentException
104            if the layer passed is for a component
105            that doesn't exist in the backend
106
107        @throws com::sun::star::lang::WrappedTargetException
108            if an error occurs in the backend or source layer.
109
110        @see com::sun::star::configuration::backend::XBackend::getOwnUpdateHandler()
111	*/
112    void importLayer([in] XLayer aLayer)
113        raises (MalformedDataException,
114                com::sun::star::lang::IllegalArgumentException,
115                com::sun::star::lang::NullPointerException,
116                com::sun::star::lang::WrappedTargetException) ;
117
118	//-------------------------------------------------------------------------
119
120    /** Imports the layer given into the backend for a given entity.
121
122        <p>This method imports data for the current entity of the backend.</p>
123
124        @param aLayer
125            a layer whose data will be imported into the backend
126
127        @param aEntity
128            a entity into whose data the layer will be imported
129
130        @throws com::sun::star::lang::NullPointerException
131            if the layer passed is <NULL/> or no backend is available.
132
133        @throws com::sun::star::configuration::backend::MalformedDataException
134            if the layer passed is invalid
135
136        @throws com::sun::star::lang::IllegalArgumentException
137            if the layer passed is for a component
138            that doesn't exist in the backend
139            or if the entity doesn't exist in the backend.
140
141        @throws com::sun::star::lang::WrappedTargetException
142            if an error occurs in the backend or source layer.
143
144        @see com::sun::star::configuration::backend::XBackend::getUpdateHandler()
145	*/
146    void importLayerForEntity([in] XLayer aLayer, [in] string aEntity)
147        raises (MalformedDataException,
148                com::sun::star::lang::IllegalArgumentException,
149                com::sun::star::lang::NullPointerException,
150                com::sun::star::lang::WrappedTargetException) ;
151
152	//-------------------------------------------------------------------------
153} ;
154
155//=============================================================================
156
157} ; } ; } ; } ; } ;
158
159#endif
160