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

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