1d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5d1766043SAndrew Rist * distributed with this work for additional information 6d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10d1766043SAndrew Rist * 11d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12d1766043SAndrew Rist * 13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14d1766043SAndrew Rist * software distributed under the License is distributed on an 15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17d1766043SAndrew Rist * specific language governing permissions and limitations 18d1766043SAndrew Rist * under the License. 19d1766043SAndrew Rist * 20d1766043SAndrew Rist *************************************************************/ 21d1766043SAndrew Rist 22d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_configuration_backend_XLayerImporter_idl__ 24cdf0e10cSrcweir#define __com_sun_star_configuration_backend_XLayerImporter_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir#ifndef __com_sun_star_configuration_backend_XLayer_idl__ 31cdf0e10cSrcweir#include <com/sun/star/configuration/backend/XLayer.idl> 32cdf0e10cSrcweir#endif 33cdf0e10cSrcweir 34cdf0e10cSrcweir#ifndef __com_sun_star_configuration_backend_XBackend_idl__ 35cdf0e10cSrcweir#include <com/sun/star/configuration/backend/XBackend.idl> 36cdf0e10cSrcweir#endif 37cdf0e10cSrcweir 38cdf0e10cSrcweir#ifndef __com_sun_star_configuration_backend_MalformedDataException_idl__ 39cdf0e10cSrcweir#include <com/sun/star/configuration/backend/MalformedDataException.idl> 40cdf0e10cSrcweir#endif 41cdf0e10cSrcweir#ifndef __com_sun_star_lang_NullPointerException_idl__ 42cdf0e10cSrcweir#include <com/sun/star/lang/NullPointerException.idl> 43cdf0e10cSrcweir#endif 44cdf0e10cSrcweir#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 45cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl> 46cdf0e10cSrcweir#endif 47cdf0e10cSrcweir#ifndef __com_sun_star_lang_WrappedTargetException_idl__ 48cdf0e10cSrcweir#include <com/sun/star/lang/WrappedTargetException.idl> 49cdf0e10cSrcweir#endif 50cdf0e10cSrcweir 51cdf0e10cSrcweir//============================================================================= 52cdf0e10cSrcweir 53cdf0e10cSrcweirmodule com { module sun { module star { module configuration { module backend { 54cdf0e10cSrcweir 55cdf0e10cSrcweir//============================================================================= 56cdf0e10cSrcweir 57cdf0e10cSrcweir/** allows importing a layer into a <type>Backend</type> 58cdf0e10cSrcweir 59*0d3a54ffSJürgen Schmidt @since OpenOffice 1.1.2 60cdf0e10cSrcweir*/ 61cdf0e10cSrcweirpublished interface XLayerImporter : ::com::sun::star::uno::XInterface 62cdf0e10cSrcweir{ 63cdf0e10cSrcweir //------------------------------------------------------------------------- 64cdf0e10cSrcweir 65cdf0e10cSrcweir /** gets the target backend for importing. 66cdf0e10cSrcweir 67cdf0e10cSrcweir @returns 68cdf0e10cSrcweir the <type>Backend</type> into which layers are 69cdf0e10cSrcweir imported by <member>XLayerImporter::importLayer()<member/>. 70cdf0e10cSrcweir 71cdf0e10cSrcweir */ 72cdf0e10cSrcweir XBackend getTargetBackend(); 73cdf0e10cSrcweir 74cdf0e10cSrcweir //------------------------------------------------------------------------- 75cdf0e10cSrcweir 76cdf0e10cSrcweir /** sets the target backend for importing. 77cdf0e10cSrcweir 78cdf0e10cSrcweir @param aBackend 79cdf0e10cSrcweir a <type>Backend</type> into which layers should be 80cdf0e10cSrcweir imported by <method>XLayerImporter::importLayer()<method/>. 81cdf0e10cSrcweir 82cdf0e10cSrcweir @throws com::sun::star::lang::NullPointerException 83cdf0e10cSrcweir if the backend passed is <NULL/>. 84cdf0e10cSrcweir */ 85cdf0e10cSrcweir void setTargetBackend([in] XBackend aBackend) 86cdf0e10cSrcweir raises (com::sun::star::lang::NullPointerException) ; 87cdf0e10cSrcweir 88cdf0e10cSrcweir //------------------------------------------------------------------------- 89cdf0e10cSrcweir 90cdf0e10cSrcweir /** Imports the layer given into the backend. 91cdf0e10cSrcweir 92cdf0e10cSrcweir <p>This method imports data for the current entity of the backend.</p> 93cdf0e10cSrcweir 94cdf0e10cSrcweir @param aLayer 95cdf0e10cSrcweir a layer whose data will be imported into the backend 96cdf0e10cSrcweir 97cdf0e10cSrcweir @throws com::sun::star::lang::NullPointerException 98cdf0e10cSrcweir if the layer passed is <NULL/> or no backend is available. 99cdf0e10cSrcweir 100cdf0e10cSrcweir @throws com::sun::star::configuration::backend::MalformedDataException 101cdf0e10cSrcweir if the layer passed is invalid 102cdf0e10cSrcweir 103cdf0e10cSrcweir @throws com::sun::star::lang::IllegalArgumentException 104cdf0e10cSrcweir if the layer passed is for a component 105cdf0e10cSrcweir that doesn't exist in the backend 106cdf0e10cSrcweir 107cdf0e10cSrcweir @throws com::sun::star::lang::WrappedTargetException 108cdf0e10cSrcweir if an error occurs in the backend or source layer. 109cdf0e10cSrcweir 110cdf0e10cSrcweir @see com::sun::star::configuration::backend::XBackend::getOwnUpdateHandler() 111cdf0e10cSrcweir */ 112cdf0e10cSrcweir void importLayer([in] XLayer aLayer) 113cdf0e10cSrcweir raises (MalformedDataException, 114cdf0e10cSrcweir com::sun::star::lang::IllegalArgumentException, 115cdf0e10cSrcweir com::sun::star::lang::NullPointerException, 116cdf0e10cSrcweir com::sun::star::lang::WrappedTargetException) ; 117cdf0e10cSrcweir 118cdf0e10cSrcweir //------------------------------------------------------------------------- 119cdf0e10cSrcweir 120cdf0e10cSrcweir /** Imports the layer given into the backend for a given entity. 121cdf0e10cSrcweir 122cdf0e10cSrcweir <p>This method imports data for the current entity of the backend.</p> 123cdf0e10cSrcweir 124cdf0e10cSrcweir @param aLayer 125cdf0e10cSrcweir a layer whose data will be imported into the backend 126cdf0e10cSrcweir 127cdf0e10cSrcweir @param aEntity 128cdf0e10cSrcweir a entity into whose data the layer will be imported 129cdf0e10cSrcweir 130cdf0e10cSrcweir @throws com::sun::star::lang::NullPointerException 131cdf0e10cSrcweir if the layer passed is <NULL/> or no backend is available. 132cdf0e10cSrcweir 133cdf0e10cSrcweir @throws com::sun::star::configuration::backend::MalformedDataException 134cdf0e10cSrcweir if the layer passed is invalid 135cdf0e10cSrcweir 136cdf0e10cSrcweir @throws com::sun::star::lang::IllegalArgumentException 137cdf0e10cSrcweir if the layer passed is for a component 138cdf0e10cSrcweir that doesn't exist in the backend 139cdf0e10cSrcweir or if the entity doesn't exist in the backend. 140cdf0e10cSrcweir 141cdf0e10cSrcweir @throws com::sun::star::lang::WrappedTargetException 142cdf0e10cSrcweir if an error occurs in the backend or source layer. 143cdf0e10cSrcweir 144cdf0e10cSrcweir @see com::sun::star::configuration::backend::XBackend::getUpdateHandler() 145cdf0e10cSrcweir */ 146cdf0e10cSrcweir void importLayerForEntity([in] XLayer aLayer, [in] string aEntity) 147cdf0e10cSrcweir raises (MalformedDataException, 148cdf0e10cSrcweir com::sun::star::lang::IllegalArgumentException, 149cdf0e10cSrcweir com::sun::star::lang::NullPointerException, 150cdf0e10cSrcweir com::sun::star::lang::WrappedTargetException) ; 151cdf0e10cSrcweir 152cdf0e10cSrcweir //------------------------------------------------------------------------- 153cdf0e10cSrcweir} ; 154cdf0e10cSrcweir 155cdf0e10cSrcweir//============================================================================= 156cdf0e10cSrcweir 157cdf0e10cSrcweir} ; } ; } ; } ; } ; 158cdf0e10cSrcweir 159cdf0e10cSrcweir#endif 160