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