offapi/com/sun/star/configuration/backend/BackendSetupException.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: BackendSetupException.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
  31 #ifndef __com_sun_star_configuration_backend_BackendSetupException_idl__
  32 #define __com_sun_star_configuration_backend_BackendSetupException_idl__
  33
  34 #ifndef __com_sun_star_configuration_CannotLoadConfigurationException_idl__
  35 #include <com/sun/star/configuration/CannotLoadConfigurationException.idl>
  36 #endif
  37
  38 module com { module sun { module star { module configuration {
  39 module backend {
  40
  41 /**
  42   Generic exception thrown when setting up a connection to an underlying
  43   backend fails.
  44   <p>Indicates an error that originates in the underlying access layer.</p>
  45
  46     @since OOo 1.1.2
  47   */
  48 published exception BackendSetupException : ::com::sun::star::configuration::CannotLoadConfigurationException {
  49
  50     /** The exception that is raised by the underlying backend implementation.
  51         <p>May be a numeric error code, a message <atom>string</atom> or <void/>,
  52         if the original exception is not represented as a
  53         <type scope="com::sun::star::uno">Exception</type>.
  54         </p>
  55      */
  56     any BackendException;
  57 } ;
  58
  59 } ;
  60 } ; } ; } ; } ;
  61
  62 #endif