/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XLayerContentDescriber.idl,v $
 *
 *  $Revision: 1.3 $
 *
 *  last change: $Author: rt $ $Date: 2005/09/07 22:41:16 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#ifndef __com_sun_star_configuration_backend_XLayerContentDescriber_idl__
#define __com_sun_star_configuration_backend_XLayerContentDescriber_idl__

#ifndef __com_sun_star_configuration_backend_PropertyInfo_idl__ 
#include <com/sun/star/configuration/backend/PropertyInfo.idl>
#endif

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif 

#ifndef __com_sun_star_configuration_backend_XLayerHandler_idl__
#include <com/sun/star/configuration/backend/XLayerHandler.idl>
#endif 

#ifndef __com_sun_star_lang_NullPointerException_idl__
#include <com/sun/star/lang/NullPointerException.idl>
#endif 

#ifndef __com_sun_star_configuration_backend_MalformedDataException_idl__
#include <com/sun/star/configuration/backend/MalformedDataException.idl>
#endif

//============================================================================= 

module com { module sun { module star { module configuration { module backend {

//============================================================================= 

/** 
   describe the contents of a layer to an XLayerHander object. The contents of
   the layer is contained in the sequence of PropertyInfo structures
   @see PropertyInfo
     
*/
interface XLayerContentDescriber : ::com::sun::star::uno::XInterface 
{
	//------------------------------------------------------------------------- 

    /** 
      describes the contents of the layer to an <type>XLayerHandler</type>.

      @param aHandler   
            Handler object that will receive calls 
            describing the contents of the layer

      @param aPropertyInfos
             sequence of PropertyInfo structs contained 
             all required property information

      @throws com::sun::star::lang::NullPointerException
              if a <NULL/> handler is passed.
      @throws com::sun::star::configuration::backend::MalformedDataException
              if the data read from the layer is rejected as invalid by the
              <type>XLayerHandler</type>.
	*/
    void describeLayer([in] XLayerHandler aHandler,
                       [in] sequence<PropertyInfo> aPropertyInfos) 
        raises (com::sun::star::lang::NullPointerException,
                com::sun::star::lang::WrappedTargetException,
                MalformedDataException) ;

	//------------------------------------------------------------------------- 
} ;

//============================================================================= 

} ; } ; } ; } ; } ; 
#endif
