configmgr/source/inc/defaultprovider.hxx

   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.hxx,v $
  10  * $Revision: 1.8 $
  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
  31 #ifndef CONFIGMGR_DEFAULTPROVIDER_HXX
  32 #define CONFIGMGR_DEFAULTPROVIDER_HXX
  33
  34 #include "sal/config.h"
  35
  36 #include "com/sun/star/uno/Exception.hpp"
  37 #include "sal/types.h"
  38
  39 #include "utility.hxx"
  40
  41 namespace configmgr
  42 {
  43     namespace configuration
  44     {
  45         class AbsolutePath;
  46     }
  47     //-------------------------
  48     class RequestOptions;
  49     //==========================================================================
  50     //= IDefaultableTreeManager
  51     //==========================================================================
  52     /* is a supplementary interface for an <type>OProviderImpl</type>.
  53        <p>Supports functionality to load default data into the managed tree</p>
  54     */
  55     class SAL_NO_VTABLE IDefaultableTreeManager
  56     {
  57     public:
  58         /** attempt to load default data into the tree named by a path using certain options
  59             and requiring a specific loading depth.
  60
  61             @returns
  62                 <TRUE/>,  if some default data is available within the tree
  63                 <FALSE/>, if no default data is available for the tree
  64         */
  65         virtual sal_Bool fetchDefaultData(configuration::AbsolutePath const& aSubtreePath,
  66                                           const RequestOptions& _xOptions
  67                                           ) SAL_THROW((com::sun::star::uno::Exception)) = 0;
  68
  69     };
  70
  71 ////////////////////////////////////////////////////////////////////////////////
  72
  73 } // namespace configmgr
  74
  75 #endif
  76