xref: /trunk/main/offapi/com/sun/star/configuration/backend/XLayerContentDescriber.idl (revision d1766043)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#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