offapi/com/sun/star/configuration/DefaultProvider.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_configuration_DefaultProvider_idl__
  28 #define __com_sun_star_configuration_DefaultProvider_idl__
  29
  30 #ifndef __com_sun_star_configuration_ConfigurationProvider_idl__
  31 #include <com/sun/star/configuration/ConfigurationProvider.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_util_XRefreshable_idl__
  35 #include <com/sun/star/util/XRefreshable.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_util_XFlushable_idl__
  39 #include <com/sun/star/util/XFlushable.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_lang_XLocalizable_idl__
  43 #include <com/sun/star/lang/XLocalizable.idl>
  44 #endif
  45
  46
  47 //=============================================================================
  48
  49 module com { module sun { module star { module configuration {
  50
  51 //=============================================================================
  52
  53 /**
  54     is a <type>ConfigurationProvider</type>, that is
  55     the default <type>ConfigurationProvider</type> for its
  56     <type scope="com::sun::star::uno">XComponentContext</type>.
  57
  58     <p>This object is accessible as singleton within the context</p>.
  59
  60     @since OOo 1.1.2
  61 */
  62 published service DefaultProvider
  63 {
  64     //-------------------------------------------------------------------------
  65
  66     /** characterizes the functionality.
  67       */
  68     service ConfigurationProvider ;
  69
  70     /**Provides refresh capabilities, data can be refreshed from the backend(s) into
  71        the in-memory cache.
  72     */
  73     [optional] interface com::sun::star::util::XRefreshable;
  74
  75     /** Enables the data to be flushed from the in-memory cache to the backend(s).
  76      */
  77     [optional] interface com::sun::star::util::XFlushable;
  78
  79     /** Enable setting/getting locale for Provider
  80
  81         @since OOo 2.0.0
  82      */
  83
  84     [optional] interface com::sun::star::lang::XLocalizable;
  85
  86     /** Property to enable/disable asynchronous write-back from in-memory cache to backend(s)
  87
  88         @since OOo 2.0.0
  89      */
  90
  91     [optional,property] boolean EnableAsync;
  92
  93     //-------------------------------------------------------------------------
  94 } ;
  95
  96 //=============================================================================
  97
  98 } ; } ; } ; } ;
  99
 100 #endif