offapi/com/sun/star/configuration/backend/XLayerImporter.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XLayerImporter.idl,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_configuration_backend_XLayerImporter_idl__
  31 #define __com_sun_star_configuration_backend_XLayerImporter_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_configuration_backend_XLayer_idl__
  38 #include <com/sun/star/configuration/backend/XLayer.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_configuration_backend_XBackend_idl__
  42 #include <com/sun/star/configuration/backend/XBackend.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_configuration_backend_MalformedDataException_idl__
  46 #include <com/sun/star/configuration/backend/MalformedDataException.idl>
  47 #endif
  48 #ifndef __com_sun_star_lang_NullPointerException_idl__
  49 #include <com/sun/star/lang/NullPointerException.idl>
  50 #endif
  51 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  52 #include <com/sun/star/lang/IllegalArgumentException.idl>
  53 #endif
  54 #ifndef __com_sun_star_lang_WrappedTargetException_idl__
  55 #include <com/sun/star/lang/WrappedTargetException.idl>
  56 #endif
  57
  58 //=============================================================================
  59
  60 module com { module sun { module star { module configuration { module backend {
  61
  62 //=============================================================================
  63
  64 /** allows importing a layer into a <type>Backend</type>
  65
  66   @since OOo 1.1.2
  67 */
  68 published interface XLayerImporter : ::com::sun::star::uno::XInterface
  69 {
  70     //-------------------------------------------------------------------------
  71
  72     /** gets the target backend for importing.
  73
  74         @returns
  75             the <type>Backend</type> into which layers are
  76             imported by <member>XLayerImporter::importLayer()<member/>.
  77
  78     */
  79     XBackend getTargetBackend();
  80
  81     //-------------------------------------------------------------------------
  82
  83     /** sets the target backend for importing.
  84
  85         @param aBackend
  86             a <type>Backend</type> into which layers should be
  87             imported by <method>XLayerImporter::importLayer()<method/>.
  88
  89         @throws com::sun::star::lang::NullPointerException
  90             if the backend passed is <NULL/>.
  91     */
  92     void setTargetBackend([in] XBackend aBackend)
  93         raises (com::sun::star::lang::NullPointerException) ;
  94
  95     //-------------------------------------------------------------------------
  96
  97     /** Imports the layer given into the backend.
  98
  99         <p>This method imports data for the current entity of the backend.</p>
 100
 101         @param aLayer
 102             a layer whose data will be imported into the backend
 103
 104         @throws com::sun::star::lang::NullPointerException
 105             if the layer passed is <NULL/> or no backend is available.
 106
 107         @throws com::sun::star::configuration::backend::MalformedDataException
 108             if the layer passed is invalid
 109
 110         @throws com::sun::star::lang::IllegalArgumentException
 111             if the layer passed is for a component
 112             that doesn't exist in the backend
 113
 114         @throws com::sun::star::lang::WrappedTargetException
 115             if an error occurs in the backend or source layer.
 116
 117         @see com::sun::star::configuration::backend::XBackend::getOwnUpdateHandler()
 118     */
 119     void importLayer([in] XLayer aLayer)
 120         raises (MalformedDataException,
 121                 com::sun::star::lang::IllegalArgumentException,
 122                 com::sun::star::lang::NullPointerException,
 123                 com::sun::star::lang::WrappedTargetException) ;
 124
 125     //-------------------------------------------------------------------------
 126
 127     /** Imports the layer given into the backend for a given entity.
 128
 129         <p>This method imports data for the current entity of the backend.</p>
 130
 131         @param aLayer
 132             a layer whose data will be imported into the backend
 133
 134         @param aEntity
 135             a entity into whose data the layer will be imported
 136
 137         @throws com::sun::star::lang::NullPointerException
 138             if the layer passed is <NULL/> or no backend is available.
 139
 140         @throws com::sun::star::configuration::backend::MalformedDataException
 141             if the layer passed is invalid
 142
 143         @throws com::sun::star::lang::IllegalArgumentException
 144             if the layer passed is for a component
 145             that doesn't exist in the backend
 146             or if the entity doesn't exist in the backend.
 147
 148         @throws com::sun::star::lang::WrappedTargetException
 149             if an error occurs in the backend or source layer.
 150
 151         @see com::sun::star::configuration::backend::XBackend::getUpdateHandler()
 152     */
 153     void importLayerForEntity([in] XLayer aLayer, [in] string aEntity)
 154         raises (MalformedDataException,
 155                 com::sun::star::lang::IllegalArgumentException,
 156                 com::sun::star::lang::NullPointerException,
 157                 com::sun::star::lang::WrappedTargetException) ;
 158
 159     //-------------------------------------------------------------------------
 160 } ;
 161
 162 //=============================================================================
 163
 164 } ; } ; } ; } ; } ;
 165
 166 #endif