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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_configuration_backend_XLayerContentDescriber_idl__
  28 #define __com_sun_star_configuration_backend_XLayerContentDescriber_idl__
  29
  30 #ifndef __com_sun_star_configuration_backend_PropertyInfo_idl__
  31 #include <com/sun/star/configuration/backend/PropertyInfo.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_configuration_backend_XLayerHandler_idl__
  39 #include <com/sun/star/configuration/backend/XLayerHandler.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_lang_NullPointerException_idl__
  43 #include <com/sun/star/lang/NullPointerException.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_configuration_backend_MalformedDataException_idl__
  47 #include <com/sun/star/configuration/backend/MalformedDataException.idl>
  48 #endif
  49
  50 //=============================================================================
  51
  52 module com { module sun { module star { module configuration { module backend {
  53
  54 //=============================================================================
  55
  56 /**
  57    describe the contents of a layer to an XLayerHander object. The contents of
  58    the layer is contained in the sequence of PropertyInfo structures
  59    @see PropertyInfo
  60
  61 */
  62 interface XLayerContentDescriber : ::com::sun::star::uno::XInterface
  63 {
  64     //-------------------------------------------------------------------------
  65
  66     /**
  67       describes the contents of the layer to an <type>XLayerHandler</type>.
  68
  69       @param aHandler
  70             Handler object that will receive calls
  71             describing the contents of the layer
  72
  73       @param aPropertyInfos
  74              sequence of PropertyInfo structs contained
  75              all required property information
  76
  77       @throws com::sun::star::lang::NullPointerException
  78               if a <NULL/> handler is passed.
  79       @throws com::sun::star::configuration::backend::MalformedDataException
  80               if the data read from the layer is rejected as invalid by the
  81               <type>XLayerHandler</type>.
  82     */
  83     void describeLayer([in] XLayerHandler aHandler,
  84                        [in] sequence<PropertyInfo> aPropertyInfos)
  85         raises (com::sun::star::lang::NullPointerException,
  86                 com::sun::star::lang::WrappedTargetException,
  87                 MalformedDataException) ;
  88
  89     //-------------------------------------------------------------------------
  90 } ;
  91
  92 //=============================================================================
  93
  94 } ; } ; } ; } ; } ;
  95 #endif