xref: /AOO41X/main/offapi/com/sun/star/configuration/DefaultProvider.idl (revision 0d3a54ff6bdb7097ff606a601c4f65a5fc60b4b7)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_configuration_DefaultProvider_idl__
24#define __com_sun_star_configuration_DefaultProvider_idl__
25
26#ifndef __com_sun_star_configuration_ConfigurationProvider_idl__
27#include <com/sun/star/configuration/ConfigurationProvider.idl>
28#endif
29
30#ifndef __com_sun_star_util_XRefreshable_idl__
31#include <com/sun/star/util/XRefreshable.idl>
32#endif
33
34#ifndef __com_sun_star_util_XFlushable_idl__
35#include <com/sun/star/util/XFlushable.idl>
36#endif
37
38#ifndef __com_sun_star_lang_XLocalizable_idl__
39#include <com/sun/star/lang/XLocalizable.idl>
40#endif
41
42
43//=============================================================================
44
45module com { module sun { module star { module configuration {
46
47//=============================================================================
48
49/**
50    is a <type>ConfigurationProvider</type>, that is
51    the default <type>ConfigurationProvider</type> for its
52    <type scope="com::sun::star::uno">XComponentContext</type>.
53
54    <p>This object is accessible as singleton within the context</p>.
55
56    @since OpenOffice 1.1.2
57*/
58published service DefaultProvider
59{
60    //-------------------------------------------------------------------------
61
62    /** characterizes the functionality.
63      */
64    service ConfigurationProvider ;
65
66    /**Provides refresh capabilities, data can be refreshed from the backend(s) into
67       the in-memory cache.
68    */
69    [optional] interface com::sun::star::util::XRefreshable;
70
71    /** Enables the data to be flushed from the in-memory cache to the backend(s).
72     */
73    [optional] interface com::sun::star::util::XFlushable;
74
75    /** Enable setting/getting locale for Provider
76
77        @since OpenOffice 2.0
78     */
79
80    [optional] interface com::sun::star::lang::XLocalizable;
81
82    /** Property to enable/disable asynchronous write-back from in-memory cache to backend(s)
83
84        @since OpenOffice 2.0
85     */
86
87    [optional,property] boolean EnableAsync;
88
89    //-------------------------------------------------------------------------
90} ;
91
92//=============================================================================
93
94} ; } ; } ; } ;
95
96#endif
97