offapi/com/sun/star/configuration/backend/OfflineBackend.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_backend_OfflineBackend_idl__
  28 #define __com_sun_star_configuration_backend_OfflineBackend_idl__
  29
  30 #ifndef __com_sun_star_configuration_backend_BackendAdapter_idl__
  31 #include <com/sun/star/configuration/backend/BackendAdapter.idl>
  32 #endif
  33
  34 //=============================================================================
  35
  36 module com { module sun { module star { module configuration { module backend {
  37
  38 //=============================================================================
  39
  40 /**
  41     implements <type>BackendAdapter</type> that maintains a cache so it
  42     can operate even if the <type>SingleBackend</type> holding the data
  43     is inaccessible.
  44
  45     @see com::sun::star::configuration::backend::OnlineBackend
  46
  47     @since OOo 1.1.2
  48 */
  49 published service OfflineBackend
  50 {
  51     //-------------------------------------------------------------------------
  52
  53     /** provides access to configuration data from a <type>SingleBackend</type>.
  54
  55       <p>If no backend is provided during initalization or if the context
  56         contains an <code>Offline</code> flag that is <TRUE/>, then offline mode
  57         is activated. This may fail, if the offline cache has not been filled
  58         during a previous execution.
  59       </p>
  60       <p>Less entities may be available from <type>XBackendEntities</type>,
  61       when operating in offline mode than when operating with an online
  62       <type>SingleBackend</type>.
  63       </p>
  64       <p>If offline mode is not invoked, the implementation behaves
  65         like any other <type>BackendAdapter</type>.
  66       </p>
  67
  68       */
  69     service BackendAdapter ;
  70
  71     //-------------------------------------------------------------------------
  72 } ;
  73
  74 //=============================================================================
  75
  76 } ; } ; } ; } ; } ;
  77
  78 #endif