xref: /aoo42x/main/offapi/com/sun/star/configuration/DefaultProvider.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_configuration_DefaultProvider_idl__
#define __com_sun_star_configuration_DefaultProvider_idl__

#ifndef __com_sun_star_configuration_ConfigurationProvider_idl__
#include <com/sun/star/configuration/ConfigurationProvider.idl>
#endif

#ifndef __com_sun_star_util_XRefreshable_idl__
#include <com/sun/star/util/XRefreshable.idl>
#endif

#ifndef __com_sun_star_util_XFlushable_idl__
#include <com/sun/star/util/XFlushable.idl>
#endif

#ifndef __com_sun_star_lang_XLocalizable_idl__
#include <com/sun/star/lang/XLocalizable.idl>
#endif


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

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

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

/**
    is a <type>ConfigurationProvider</type>, that is
    the default <type>ConfigurationProvider</type> for its
    <type scope="com::sun::star::uno">XComponentContext</type>.

    <p>This object is accessible as singleton within the context</p>.

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

    /** characterizes the functionality.
      */
    service ConfigurationProvider ;

    /**Provides refresh capabilities, data can be refreshed from the backend(s) into
	   the in-memory cache.
	*/
	[optional] interface com::sun::star::util::XRefreshable;

	/** Enables the data to be flushed from the in-memory cache to the backend(s).
	 */
	[optional] interface com::sun::star::util::XFlushable;

	/** Enable setting/getting locale for Provider

        @since OOo 2.0
	 */

	[optional] interface com::sun::star::lang::XLocalizable;

	/** Property to enable/disable asynchronous write-back from in-memory cache to backend(s)

        @since OOo 2.0
	 */

	[optional,property] boolean EnableAsync;

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

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

} ; } ; } ; } ;

#endif