xref: /aoo41x/main/offapi/com/sun/star/configuration/backend/OfflineBackend.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_configuration_backend_OfflineBackend_idl__
#define __com_sun_star_configuration_backend_OfflineBackend_idl__

#ifndef __com_sun_star_configuration_backend_BackendAdapter_idl__
#include <com/sun/star/configuration/backend/BackendAdapter.idl>
#endif

//=============================================================================

module com { module sun { module star { module configuration { module backend {

//=============================================================================

/**
    implements <type>BackendAdapter</type> that maintains a cache so it
    can operate even if the <type>SingleBackend</type> holding the data
    is inaccessible.

    @see com::sun::star::configuration::backend::OnlineBackend

    @since OOo 1.1.2
*/
published service OfflineBackend
{
	//-------------------------------------------------------------------------

    /** provides access to configuration data from a <type>SingleBackend</type>.

      <p>If no backend is provided during initalization or if the context
        contains an <code>Offline</code> flag that is <TRUE/>, then offline mode
        is activated. This may fail, if the offline cache has not been filled
        during a previous execution.
      </p>
      <p>Less entities may be available from <type>XBackendEntities</type>,
      when operating in offline mode than when operating with an online
      <type>SingleBackend</type>.
      </p>
      <p>If offline mode is not invoked, the implementation behaves
        like any other <type>BackendAdapter</type>.
      </p>

      */
    service BackendAdapter ;

	//-------------------------------------------------------------------------
} ;

//=============================================================================

} ; } ; } ; } ; } ;

#endif