xref: /aoo42x/main/offapi/com/sun/star/configuration/DefaultProvider.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_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