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