xref: /aoo41x/main/offapi/com/sun/star/configuration/backend/BackendAdapter.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_BackendAdapter_idl__
#define __com_sun_star_configuration_backend_BackendAdapter_idl__

#ifndef __com_sun_star_configuration_backend_Backend_idl__
#include <com/sun/star/configuration/backend/Backend.idl>
#endif

#ifndef __com_sun_star_configuration_backend_XBackendEntities_idl__
#include <com/sun/star/configuration/backend/XBackendEntities.idl>
#endif

#ifndef __com_sun_star_lang_XInitialization_idl__
#include <com/sun/star/lang/XInitialization.idl>
#endif

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

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

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

/**
    implements <type>Backend</type> retrieving data
    from a <type>SingleBackend</type>.

    @since OOo 1.1.2
*/
published service BackendAdapter
{
	//-------------------------------------------------------------------------

    /** provides access to configuration data.
      */
    service Backend ;

	//-------------------------------------------------------------------------

    /**
      This interface, that is optional in <type>Backend</type>, is
      mandatory in this service.
      */
    interface XBackendEntities ;

	//-------------------------------------------------------------------------

    /**
      allows initializing the backend to use.

      <p>If this interface is present, a <type>SingleBackend</type>
        may be passed, that is used to access the data.
        Also a <type scope="com::sun::star::configuration::bootstrap">BootstrapContext</type>
        can be passed, that provides further settings for the backend.
      </p>

      <p>If this interface is missing, the real backend to use is determined
        from the <type scope="com::sun::star::uno">XComponentContext</type>.
      </p>
      */
    [optional] interface com::sun::star::lang::XInitialization ;

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

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

} ; } ; } ; } ; } ;

#endif