offapi/com/sun/star/sdbc/SQLException.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: SQLException.idl,v $
  10  * $Revision: 1.10 $
  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_sdbc_SQLException_idl__
  31 #define __com_sun_star_sdbc_SQLException_idl__
  32
  33 #ifndef __com_sun_star_uno_Exception_idl__
  34 #include <com/sun/star/uno/Exception.idl>
  35 #endif
  36
  37  module com {  module sun {  module star {  module sdbc {
  38
  39
  40 /** is an exception that provides information on a database access error.
  41
  42     <p>
  43     Each
  44     <type scope="com::sun::star::sdbc">SQLException</type>
  45     provides several kinds of information:
  46     </p>
  47     <p>
  48     <ul>
  49     <li>
  50     a string describing the error.  This is used as the
  51     <type scope="com::sun::star::uno">Exception</type>
  52     message.
  53     </li>
  54     </ul>
  55     </p>
  56  */
  57 published exception SQLException: com::sun::star::uno::Exception
  58 {
  59     /** returns a string, which uses the XOPEN SQLState conventions.
  60         The values of the SQLState string are described in the XOPEN SQL spec.
  61      */
  62     string                      SQLState;
  63
  64     /** returns an integer error code that is specific to each vendor.  Normally this will
  65         be the actual error code returned by the underlying database.
  66         A chain to the next Exception.  This can be used to provide additional
  67         error information.
  68      */
  69     long                        ErrorCode;
  70
  71     /** returns a chain to the next Exception.
  72         This can be used to provide additional
  73         error information.
  74      */
  75     any                         NextException;
  76 };
  77
  78 //=============================================================================
  79
  80 }; }; }; };
  81
  82 /*===========================================================================
  83 ===========================================================================*/
  84 #endif