xref: /trunk/main/offapi/com/sun/star/configuration/backend/Backend.idl (revision 0d3a54ff)

/**************************************************************
 *
 * 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_Backend_idl__
#define __com_sun_star_configuration_backend_Backend_idl__

#ifndef __com_sun_star_configuration_backend_XBackend_idl__
#include <com/sun/star/configuration/backend/XBackend.idl>
#endif

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

#ifndef __com_sun_star_configuration_backend_XSchemaSupplier_idl__
#include <com/sun/star/configuration/backend/XSchemaSupplier.idl>
#endif

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

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

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

/**
    provides access to a configuration database composed of one or more
    storage backends containing settings used by software modules.

    <p> Configuration data is organized into layers which are selected
        by components and entities.
    </p>

    <p> Components are characterized by configuration schemas.
        A component contains configuration data for a particular
        application domain or software module.
    </p>
    <p> Entities are organised hierarchically in organisations,
        groups, roles and individual users. Each element of the associated
        hierarchy corresponds to a layer that applies to an entity.
    </p>
    <p> A layer contains data for multiple components
        associated to a single entity.
    <p>

    @since OpenOffice 1.1.2
*/
published service Backend
{
	//-------------------------------------------------------------------------

    /**
      provides access to configuration schemas.
      */
    interface XSchemaSupplier ;

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

    /**
      provides access to the layer data.
      */
    interface XBackend ;

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

    /**
      provides information about supported and special entities.
      */
    [optional] interface XBackendEntities ;

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

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

} ; } ; } ; } ; } ;

#endif